Batch Update Users

This feature allows you to batch update user properties, custom fileds, devices, and user tags using simple CSV files.


Batch Update Users

This feature allows you to batch update user properties, custom filed, devices, and user tags using simple CSV files.

Install and Setup
  • Install Patch.v4 version 4.0.0.4659 or higher
  1. Login to SiteAdmin
  2. Navigate to Plugins
  3. In the My plugins list find Patch.v4 and ensure it version is at leats 4.0.0.4659
  4. If the version of Patch.v4 is below 4.0.0.4659, update Patch.v4 by clicking on the Update button
  • Enable the _BatchUpdateUsers privilege
  1. Login to SiteAdmin
  2. Navigate to Applications
  3. Select (by clicking on its name) the application in which you want to enable the Batch Update Users feature
  4. Expand the Privileges and Features section
  5. Enable the _BatchUpdateUsers privilege under the Admin section

Batch Update Users Privilege

General information and requirements

If it is the first time you’re using this feature, it is recommended that you start with a small batch of users since all changes will take effect immediately and there is no undo functionality.
For each Batch Update type, the username field is mandatory since this is how the system identifies users.
All Batch Update are using CSV files; examples of each CSV header will be provided for each type of Batch Update.

Batch Update Properties

Using the Batch Update User Properties function you can update users names, surnames, passwords, phone numbers, emails, descriptions, and expected fuel consumption.
Since users are identified by their usernames, usernames cannot be modified using this method.

The header for the Properties looks as follows:

username,password,name,userphonenumber,surname,email,description,fuelconsumption

All fields, except username, are optional and therefore you should only include what you would like to modify. Unknown header fields will be ignored.
Fuel Consumption is in SI (International System of Units) and therefore it is L/m (liter per meter)

Batch Update Custom Fields

Using the batch Update Custom Fields function you can update users custom fields.

The header includes the username, the customfield word follows by a dot (.) and the custom field name. Here is an example of the header to be used while Batch Updating Custom Fields:

username,customfield.Vehicle model,customfield.License plate

Using the above header you would modify 2 custom fields: one called ‘Vehicle model’ and the second one called ‘License plate’.

Batch Update User Devices

The Batch Update user devices can be useful it cases where you’re updating multiple devices on your fleet. When you choose the Device update type you will be presented with a list of 3 Devices which you can enable. Once you enable one of them, you have a choice to select the Device Type, it corresponding Device Mapper, or simply remove the device from the users.
This can be used to Batch Update complete devices (Device Type, Mapper, and IMEI), or partially update devices by, for example, only updating the Device Mappers.

Batch Update User Devices

A header for the Batch Update Devices looks as follows:

username,deviceX.IMEI,deviceX.phonenumber

The X can be 1, 2, or 3, depending on which device you want to update.
Once again, the username field is mandatory and the rest is optional. If the header doesn’t contain the IMEI or phoneumber field, those will be taken from the corresponding users or left empty if no previous info exists.

Batch Update User Tags

Using the Batch Update user tags allows you to add or remove users from different user tags. The CSV header includes a username followed by usertag dot (.) and the tag name.
An example of the CVS file header is below:

username,usertag.Central district,usertag.Southshore

Using the above header the system will update users in a tag called ‘Central district’ and another one with the name ‘Southshore’.

To add a user to a Tag use true, 1, or yes as values. Everything else will remove the user from the tag.
As an example, to add user1 to the Central district tag while removing the same user from the Southshore tag you would use the following CSV file:

username,usertag.Central district,usertag.Southshore
user1,yes,no

Final notes

Each Batch Update type will only look at the information it need, meaning that you can reuse the same CSV file with different Batch Update types. An example for this would be this header:

username,name,userphonenumber,usertag.Southshore

When Batch Updating Properties, it will update only name and user phone number, and if the same file is used to update user tags, only the Southshore tag will be affected.


  Discuss this blog post on the forum please



Download free GpsGate Server

Install it on your own server. The installation is free for 5 users.

Download Now