Columns | Description | Supported Values |
---|---|---|
FirstName | Enter the user first name | String |
LastName | Enter the user last name | String |
MiddleName | Enter the user middle name | String |
PrimaryEmail | The email address of the user | String. Needs to contain proper Email formatting, example: *****@***.com |
SecondaryEmail | Any secondary email. User defined | String. Needs to contain proper Email formatting, example: *****@***.com |
Telephone | Phone number | String |
Office | Office | String |
StreetAddress | Address | String |
City | City | String |
PostalCode | Zip code | Integer |
Country | Country | String |
JobTitle | Title of User | String |
Department | Department | String |
Company | Company | String |
Location | User's location. This doesn’t work for iManage, see iManage section below | String |
Id | Metadata Id in CAM | Integer |
RecordType | The type of record | String |
Role | Role from CAM or source system | String. E.g. Administrator, NRTAdmin |
Owner | Sets the owner of the metadata/workspace/object. | String |
Disabled | Set the flag to disable a user/group in CAM | String: Set True/1 1= disabled, 0= enabled |
IsCAMUser | Set to 1 to import or create a CAM user. Set to 0 to not import a user. | String: Set True/1 Integer 0=Do not import/create. 1= Create The default value is 0. |
IsCAMGroup | Set to 1 to import or create a CAM group. | String: Set True/1 Integer. 0=Do not import/create. 1= Create |
UniqueSystemWorkspaceColumns | To specify unique system metadata. Is case insensitive. | Note pass client id and matterid columns as well in the csv if using the ids here. |
UserID | Add user ID to login | String. E.g. a.marcus - One of the required fields for user creation. Note: iManage requires userid’s be encased in %%. Like %alexey.marcus% |
Username | Adds the username | String. E.g. alexey.marcus NOTE: You must add the full username to add the user to a group. |
Usertype | Type of user | Integer. 1= external, 0= internal |
Usercontainertype | For netdocuments | Integer. 1= Repository, 2= cabinet. |
DisplayName | Adds the full name (display name) of the user. | String. E.g. Alexey Marcus. - One of the required fields for user creation. |
MailNickname | Adds the email (nickname) of the user | String Typically same as username E.g. alexey.marcus - One of the required fields for user creation. Optional for Microsoft teams creation. |
Type | Specify if adding as a user or group | String (user/group) user - add as user, group- add as group |
ContainerType | Type of container to add. (Id of container type) | Netdocuments has two types: Repo (1) and cabinet (2). iManage has one type (2), Office365 has one type (1) |
ExtContainerId | The id of the container. | Integer. Needed for searching for duplicate emails. |
ExtContainerName | The name of the container. | String. |
Important: For iManage, extContainerId and extContainerName are the same value; For netDocuments, when searching for documents, users can also see the cabinetName column in the grid by creating separate metadata for that and mapping it to extContainerName. In Layout config, users have the option select if they want to see metadata in the search layout only or in the results grid. | ||
GroupContainerType | Type of the container. | Integer. 1= Repository level, 2= Cabinet level |
GroupType | Type of group | Integer. 0= Public, 1=Private/ Personal |
Groups | Add group name | String. NOTE: Full name of the group is required so users can be added. |
Groupid | Id of the group | String. NOTE: Groupids for Office365 will inherit the Microsoft id. This looks like: d4dfe2ae-c58b-4efd-939a-02ea5cfeae6d |
Imanageadmingroup | Add user to iManage Admin Group | Boolean (y/n) y to add n to skip |
AddtoMyMatters | Sets if the workspace will be added as shortcut, to the My Matters page. Type in the user email to add to their my matters. | String Users separated by comma character ",". userid/emailaddress, userid/emailaddress, userid/emailaddress… For e.g.: alexey.marcus@prosperoware.com |
AddtoMyFavorites | Sets if the workspace is added to the favorites page. Type in the user email to add to their my favorites. | String Users separated by pipe character "|"; userid or emailaddress|user For e.g.: alexey.marcus@prosperoware.com|User |
IsExternal | Sets up external users/groups | Boolean. true or false. Is not case sensitive. |
WelcomeEmail | Sends the CAM Welcome email to a new user in the system. Can be used in Data Uploader as well. | Integer, 1= send the email, 0= don’t send |
FolderSecurity | This parameter assigns dynamic security on private folders. | String Use the groupname you will assign here to have security. Comma separated values allow for multiple groups. |
Server | The server. Note iManage’s docserver is not currently supported from their API. |
iManage Specific
NetDocuments Specific
Samples
File | Description |
---|---|
A bulk user creation script with a group | |
User creation with an SPM policy. | |
NetDocuments group modification with the parameter isexternal set to false. | |
NetDocuments group modification with the parameter isexternal set to true. | |
A user import for iManage with UserLoc, DocServer and General. | |
An update to a User creation in NetDocuments. | |
Create a Group in NetDocuments. | |
Add a User to a Group in NetDocuments. | |
An update to a User creation in Office365. | |
A Group creation in Office365. | |
Add a User to a Group in Office365. |
Creating CSVs
Create a CSV file using Text Editor
Open any text editor and enter the data, separating each value with a comma and each row with a new line, as shown in the illustration below:
Save the file with extension .csv
Create TSV file using Text Editor
Open any text editor and enter the data, separating each value with a tab and each row with a new line, as shown in the illustration below:
Save the file with extension .tsv
Create a CSV/TSV file using Excel
Open an Excel sheet and enter the data.
To save the spreadsheet as CSV, select File → Save As and select CSV (Comma delimited) as the type.
To save the spreadsheet as TSV, select File → Save As and select Text (Tab delimited) as the type.
Excel will display a dialog box indicating some Excel features may be lost in the format chosen. Click on Yes to continue to save the file in CSV/TSV format.
Tip: A text editor like Notepad can suffice for creating and editing simple CSV files. However, if you are working with large data, using an application like Excel is preferable.
Note: If you plan to set workspaces with no templates in the Workspace Wizard or CSV Import, you will need to setup a metadata field for NoTemplate in CAM.
This format would be:
Metadata name= NoTemplate
Type= Boolean
Value= 1 if you want to set no template. 0 if you want a template set.