Skip to main content
WM User Data File

Describes the format of user data files for the provisioning and maintenance of 4U users.

Updated over a year ago

General Format

A description of the csv file format can be found in the accompanying article.

Column Descriptions

Column Name

Required?

Type

Unique?

email

Yes

string (255 characters)

yes

first_name

Yes

string (1024 characters)

no

last_name

Yes

string (1024 characters)

no

entitlement

Yes

string with predefined values: home office, field, or admin.

no

user_id

Required to support email changes

string (255 characters)

yes

territory_id

Required for complete application functionality

string (255 characters)

no

Notes

  1. entitlement: If a user should be granted multiple entitlements, then there should be one line per entitlement with the other user data repeated across each line. If there are multiple rows for a single user, the rows must be adjacent to each other. They cannot be separated.
    ​
    All users must be entitled as either a home office or a field user. Additionally, a home office user can be an admin. field users cannot be admins.
    ​
    Entitlement values are not case sensitive. For example, Home Office and home office are equivalent.

  2. user_id: A unique identifier of the user within your system. The user_id is not displayed within the 4U Platform and is necessary to support changing a user's email without triggering the deactivation of the user's account and the creation of a new account under the new email address.

  3. territory_id: A unique identifier of the location (eg branch or office) that the user is associated with. Territory data must be separately loaded. If the user is associated with multiple locations, then there should be one row per location with the other data repeated. Any territory_ids that are unrecognized (ie not previously loaded) will be ignored.

Sample Files

Single Branch Per User

In this example, the first user (Ada) does not have any location data and the other users (Grace and Anna) are each assigned to a single branch.

user_id,email,first_name,last_name,entitlement,territory_id
234,ada.lovelace@example.com,Ada,Lovelace,home office,
234,ada.lovelace@example.com,Ada,Lovelace,admin,
456,grace.hopper@example.com,Grace,Hopper,field,branch1
789,anna.winlock@example.com,Anna,Winlock,field,branch2

Some Users belong to Multiple branches

This example is the same as the first except that the last user (Anna) is assigned to multiple branches.

user_id,email,first_name,last_name,entitlement,territory_id
234,ada.lovelace@example.com,Ada,Lovelace,home office,
234,ada.lovelace@example.com,Ada,Lovelace,admin,
456,grace.hopper@example.com,Grace,Hopper,field,branch1
789,anna.winlock@example.com,Anna,Winlock,field,branch2
789,anna.winlock@example.com,Anna,Winlock,field,branch3

Please contact us at Support@4uplatform.com for additional assistance.

Did this answer your question?