Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Allows you to create users in your system using .csv job upload

...

. You can set the password expiry using CSV job upload

Table of Contents
minLevel2
maxLevel4
include
outlinefalse
indent
excludeOverview
typelist
class
printablefalse

General

Columns

Description

Supported Values

isGlobalUserManagement

If this is set to 1, this allows to edit or delete or create users or groups on a global level. This includes the user properties of such user. Deletion of a user or group will be reflected on all databases or libraries if applied globally. Enabling the user gives admins abilities to assign the users on other databases/libraries. For

Status
colourGreen
titleCloud imanage

0/1

Example: We want to disable a user on one library but not globally. Set isglobalusermanagement=0, then set the disable flag=1 on the library of choice. E.g iManage US

Example: A user needs a username change. This we want to do globally to change the username on all libraries. Set isglobalusermanagement=1 and update the username column to the correct value.

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 OR another system

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

Info

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

...

; Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () \ [] " ; : <> , SPACE. 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.

Info

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.

Info

NOTE: Full name of the group is required so users can be added.

Groupid

Id of the group

String.

Info

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.

...

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

Users separated by comma character ",".

userid/emailaddress, userid/emailaddress, userid/emailaddress…

For e.g.: alexey.marcus@prosperoware.com

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.

Info

Note iManage’s docserver is not currently supported from their API.

CAMImportReference

This is CAM’s import reference to determine if an account email or name has changed.

Name+email+id if not imported by AD; if imported by AD this is the AD object GUID

Note iManage supports only this field if the username or email changes to detect changes.

SkipUpdateIfExists

This parameter can be used with an AD sync or without one based on where you want users and groups to be imported. Set this setting here in AD configurations if you want the user to come from the AD system. 0 will update the user or group in both CAM and the external system, 1 will skip the external system and update only in CAM.

1, 0

For details visit:

For AD: https://pdocs.atlassian.net/wiki/spaces/CCAM/pages/33456864/Configure+Data+Uploader#Anatomy-of-the-ADmapping.config-File

For CSV/iManage etc: https://pdocs.atlassian.net/wiki/spaces/CCAM/pages/33456864/Configure+Data+Uploader#Passing-Users-via-CSV

iManage Specific

Expand
titleiManage

Columns

Description

Supported Values

Deletefromimanage

Deletes a user or group from iManage

Yes=1, 0=No

DisplayName

Specify the display name, which you want to reflect on the iManage system

String: testing may 7

CreateInImanage

Specify the value whether user can create in iManage

The default value is 1.

Integer: 1

1 - to create user in iManage

0 - to skip the user creation

PasswordExpired

Specify the value to set the password expiry

The default value is False.

String: False

False -

...

Enables the password expiry in iManage.

True -

...

Skips the password expiry update in iManage.

ForceUserToChangePassword

Specify the value where user can skip the password change on first time login.

The default value is

...

False.

...

String:

...

False

...

True - to

...

force the user to change password in iManage

...

False- to

...

not force the user

...

to change their iManage password

Server

The server

Info

Note iManage’s docserver field is not currently supported from their API.

String: worksite2020

Database

Specify which database name, you want to create the user

String: testcam

Disabled

Specify the disable value to show the user state whether user is active in Active Directory (AD).

Integer: 1

General

Allows adding the general parameter from iManage

String

Office

Allows adding the user’s location. Note one cannot for iManage add the location parameter, it must be office.

String

NetDocuments Specific

Expand
titleNetDocs

Columns

Description

Supported Values

Netdocumentsadmingroup

Add user to NetDocuments Admin Group

Boolean (y/n)

y to add n to skip

DeletefromNetDocs

Delete a record from netdocuments.

1= yes delete, 0= no do not.

Samples

File

Description

Applying a user disablement, and a user change globally in iManage

View file
nameCAMUserBulkdisable.csv

Bulk user disabling script

View file
nameBulkUserCreationWithGroup.csv

A bulk user creation script with a group

View file
nameUserCreatinSPMPolicy.csv

User creation with an SPM policy.

View file
nameIs External False.csv

NetDocuments group modification with the parameter isexternal set to false.

View file
nameIs External True.csv

NetDocuments group modification with the parameter isexternal set to true.

View file
nameUseriManage with Loc Server and General.csv

A user import for iManage with UserLoc, DocServer and General.

View file
nameNDUserCreationUpdation.csv

User creation in NetDocuments.

View file
nameNDGroupCreation.csv

Create a Group in NetDocuments.

View file
nameNDAddUserInGroup.csv

Add a User to a Group in NetDocuments.

View file
nameOffice365UserCreationUpdation.csv

User creation in Office365.

View file
nameOffice365GroupCreation.csv

Group creation in Office365.

View file
nameOffice365AddUserinGroup.csv

Add a User to a Group in Office365.

Learn how to create your own CSV/TSV files with a Text Editor or Excel.