Formatting your CSV Input File

The following topics explained in this article will help you create your comma separated values (CSV) file that will upload supplementary information to your SnapComms users.

• Mandatory Fields

• Optional Fields

• Mapping of Fields from CSV to Content Manager

• Use Cases for CSV Import

  • Group Creation

  • Adding Attributes

  • Employee Offboarding
     

Mandatory Fields

• userName

• userDomain

• userType (values are user or machine)

• userStatus (for Cloud hosted Content Manager values are Active or Disabled) or
  userActive (for non-cloud Content Manager values are TRUE or FALSE)

• groupName

• groupDomain

• groupActive (values are TRUE or FALSE)
   

OPTIONAL FIELDS

• userFullname

• userFirstname

• userLastname

• userDN (distinguished name of the user)

• userOU (organisational unit of the user)

• groupOU (organisational unit of the group)

• mobileUsername (mobile app login username)

• mobilePassword (mobile app login password)

• email (email address associated with the user)

• sms (mobile phone number in international format)
   

Mapping of Fields from CSV to Content Manager

The CSV Import Feature reads the userName and userDomain values from the file and uses it to match to an existing user in your Content Manager via their User Name and Base Domain Name (or Domain Name if they have the same value). Therefore, these two columns from the CSV should have the exact same values in your Content Manager.

Sample CSV file:

From your Content Manager > Users page

For cloud hosted Content Manager, if exporting the users' Active Directory domain is not possible, you can use their User Principal Name instead. To do this you will need to have two columns: userPrincipalName and matchbyUserPrincipalName. However, you still need to retain the userDomain field in your CSV file for backward compatibility. The matchbyUserPrincipalName must have a value of TRUE to be able to match users using the User Principal Name. Otherwise, the system will use the default matching using the userName and userDomain fields, then the value from the userPrincipalName will only be treated as an attribute.

Sample CSV file for matching using User Principal Name:

From your Content Manager > Users page

Use Cases for CSV Import

Group Creation
The most common use for the CSV import feature is creating user groups based on a data source other than the Active Directory. A user may be assigned to multiple groups by having multiple rows in one CSV file with each row having the same user information except for the groupName. 

Note: A group is uniquely identified by the combination of the groupName and groupDomain. Groups created via CSV can't be merged with groups that are pulled from the Active Directory. 

You can opt to have a single CSV file for all multiple groups as long as the data isn't too big, or you can create multiple CSV files for each group (e.g. Country, Region, etc.). A CSV file is associated with a User Category. Each new import for the User Category overrides all data that was uploaded from the previous import. For best practice, we recommend having the same name for both your CSV file and User Category for easy recognition and in case you need to modify data in your file and re-upload it.

Sample CSV file for Group Creation

Again, the userPrincipalName and matchbyUserPrincipalName are optional fields for cloud-hosted Content Manager and may be removed if you prefer matching users using userName and userDomain.
 

Adding User Attributes
If your users are not authenticating via Active Directory (or these attributes are not updated in your AD and you need an immediate way to add these for your users), the following optional columns can be added to map a user attribute to a user account in the SnapComms Content Manager: 
userFullname, userFirstname, userLastname, email, sms, UserPrincipalName, userDN, userOU.

Sample CSV files Adding Attributes

If you decide to manage the user attributes via the CSV import feature while users are also authenticating via Active Directory, the collection of these attributes must be disabled from your Active Directory by changing the ’Include User Attributes’ settings in your Windows App Profile to avoid conflicting data sources (refer to https://support.snapcomms.com/hc/en-us/articles/19361033854363-Windows-App-Management-App-Profiles for details). 

Employee Offboarding
The CSV Import feature can also be used to immediately offboard from your cloud hosted Content Manager users by changing the value for the userStatus field to Disabled. 

Sample CSV file for Offboarding Users

Again, the userPrincipalName and matchbyUserPrincipalName are optional fields for cloud hosted Content Manager and may be removed if you prefer matching users using userName and userDomain. Note that the userStatus will only change if the 'Process Memberships only (do not create users)' setting in the 'Users & Groups Sync section' is not selected.