The CSV user data file contains standard data elements. There are required, optional, and custom fields.
Use the optional fields to specify defaults that Inkling uses when processing the file and creating user accounts.
You can use one or more custom fields to import user data unique to your company’s needs. For example, you can use the custom fields to contain metadata about your users, such as job title and geographic location.
You then use this metadata to create distribution rules. Distribution rules determine whether a user receives a particular Inkdoc based on specified criteria. For more information about distribution rules, search for Configure Distribution Rules in the Inkling Authoring Guide.
Your Inkling representative will send you a template of a properly formatted CSV file at the beginning of the implementation process.
The table lists the fields for an example CSV file. The custom fields are only an example of distribution rule metadata you can set to configure these rules. Work with your Inkling representative to determine which optional and custom fields your CSV file should include.
| CSV column heading | Field type | Description |
|---|---|---|
| UserID | Required | This is the unique system identifier for each user in your system. You can modify this value on the user’s account page. This field is case sensitive and cannot contain any non-ASCII characters, leading or trailing whitespace characters, or any whitespace within the value. If you modify this value on a user’s account page, be sure to update the CSV file with the correct value. When a UserID in the CSV file does not match a user in the system, Inkling will attempt to create a new user, possibly leading to conflict errors with duplicate emails or usernames. |
| Status | Required | There are two possible statuses: active (1) or inactive (0). |
| Username | Required | Your employees use this to log in to the system. It should be unique within your system, and ideally match the credentials already used by your employees to login to your systems. |
| FirstName | Required | Employee’s first name. |
| LastName | Required | Employee’s last name. |
| Required | Employee’s email address. Inkling uses this value to authenticate users during login and also to send emails with password reset links. This field is required for all Habitat users, and Inkling library users that log in with an email address instead of a username. Users without a valid email address in their profile cannot use the password reset functionality, which is activated from the login window with the Forgot password? link. | |
| Timestamp | Optional | This field can be used to indicate the time and date at which a user record was changed. Enables processing multiple changes for one user in one import, in the correct order. |
| HabitatUser | Optional | Indicates whether a user should be allowed to use Habitat as well as reading apps. |
| Title | Custom | Employee’s title, optionally used for distribution rules. |
| Manager User ID | Custom | Employee’s manager, optionally used for distribution rules. |
| Division | Custom | Employee’s division, optionally used for distribution rules. |
| Department | Custom | Employee’s department, optionally used for distribution rules. |
| Location | Custom | Employee’s location, optionally used for distribution rules. |
| Job Code | Custom | Employee’s job code, optionally used for distribution rules. |