Modifying a Workspace/Folder/Doc

Job

Optional

createormodify

workspace

Denotes the job type

AddFolders

Optional: Adds missing folders

AddFolders=1 then adds any missing folders to the template structure.

AddFolders=0, then skip adding any missing folders.

If a workspace is not linked to CAM and has a different folder structure than the template used for the workspace, the missing folders can be either added dynamically, or skipped/not added to keep the template structure.

AddFolders: 1

Unique Metadata Fields

Mandatory

String/Integer

The fields within CAM that are set as unique

• Best practice: Set the unique metadata field to a field that is unlikely to change during the life of the matter/project (eg SystemId).

•  Other metadata fields such as Client and Matter can be set as unique within CAM, but if these values are changed at a later point, a new workspace may be created (see the opening notes for further details on the Create Workspace process)

Other Metadata Fields

Recommended

Dependent on Metadata Field

These are the metadata values you want to apply to the Workspace and folders

To download sample, sample modify workspace in iManage.csv, click Here

Systems

Mandatory

imanage

Denotes the system you wish to change a Workspace in

This replaces the ‘CreateIniManage’ column, although this is still supported. If you use this column instead, the supported values are 1 (true) or 0 (false)

Server

Optional

String

If not included, CAM will use the default server set within External System Configuration

Database

Optional

String

If not included, CAM will use the default database set within External System Configuration

DefaultSecurity

Recommended

Private, Public or View

The default security of the workspace – include if you want this to change on the workspace

Userid

Optional

String

iManage UserID or UserEmail.

Security

Optional

String – see example

The format for the security column:

[useremail]  |  {allow or deny=true or false]  #  [expiration date]  *  [role]  $  [isGroup=true or false]

Roles are defined as the roles mapped with the source system here: Source System Integration | Role Permission Mapping

CAM also supports the following parameter setting for the matter/user/group security:

@MatterTeam@/@userid@/@groupid@

Examples are as follows:

 Users:

Adding an Admin ( iManage Full Access) bob.bradely@demofirm.com|true#23/12/2019*Admin$true

Adding an Editor (iManage Read/Write access)

firstnamelastname2@firmname.com|true#null*Editor$true

Adding a Watcher (iManage Read only)

firstnamelastname3@firmname.com|true#null*Watcher$true

Denying Access (iManage No Access)

firstnamelastname4@firmname.com|false#null*Deny$true

Groups:

For example, adding an editor group

PartnersGroup|true#11/3/2021*Editor$true

Changing Default Security to Private

The original column may look like: view?Change#null*null

Change it to: private?Change#null*null

RemoveSecurity

Optional

String (see example)

Use this field to remove a user’s or group’s access from the Workspace

Remove User: bob.bradley@demo-firm.com|User OR userid=sampleuser@firm.com|isgroup=0

Remove Group: Partners|Group OR groupid=Partners|isgroup=1

 Remove User from Group: bob.bradley@demo-firm.com|Partner

RefileDocsAndFolders

Optional

1 (true) or 0 (false)

Use this field to pull through any changes to the Folders' and Documents' Profiles from the modified Workspace Profile. Security refile is not done by this parameter, as only the profile is updated here. See the Copy SecuritytoDocuments parameter below to do security for documents.

copysecuritytodocuments

Optional

1 (true) or 0 (false)

Copies the security to the document profile from the workspace profile.

UpdatemoreSecuredDocuments

Optional

1 (true) or 0 (false)

If you have documents on a parent folder that are more secured, and you have the rights to modify, you can update them using this parameter.

WorkspaceName

Optional

String

Changed Workspace Name - include if you want this to change on the workspace

AddToMyMatters

Optional

iManage UserID or UserEmail

This field adds the workspace to a user’s My Matters section in iManage. Please note: My Matters needs to be enabled in iManage for the applicable user/s.

ALEXEY.MARCUS or alexey.marcus@demo-firm.com

Category

Optional (AddToMyMatters required)

String

This column is used for the My Matter Category you want to add the Workspace to (applies to the users specified in AddToMyMatters). If category does not exist, then CAM will create it. To add the Workspace to a sub-category, use the below format:

 Category/Second level/Third level/ etc

Folder 1 or Folder 1/Folder 2/ Folder 3 (see notes)

Job

Optional

createormodifyworkspace

Denotes the job type

Unique Metadata Fields

Mandatory

String/Integer

The fields within CAM that are set as unique

• Best practice: Set the unique metadata field to a field that is unlikely to change during the life of the matter/project (eg SystemId).

•  Other metadata fields such as Client and Matter can be set as unique within CAM, but if these values are changed at a later point, a new workspace may be created (see the opening notes for further details on the Create Workspace process)

Other Metadata Fields

Recommended

Dependent on Metadata Field

These are the metadata values you want to apply to the Workspace and folders

To download sample, sample modify workspace in NetDocuments.csv click here.

Systems

Mandatory

netdocuments

Denotes the system you wish to change a Workspace in

This replaces the ‘CreateInNetDocuments’ column, although this is still supported. If you use this column instead, the supported values are 1 (true) or 0 (false)

Repository

Optional

String

If not included, CAM will use the default repository set within External System Configuration

CabinetName

Optional

String

If not included, CAM will use the default Cabinet set within External System Configuration

Cabinet

Optional

String

Cabinet ID

If not included, CAM will use the default cabinet set within External System Configuration

Security

Optional

String

The format for the security column – include if you want this to change on the workspace:

[useremail]  |  {allow or deny=true or false]  #  [expiration date]  *  [role]  $  [isGroup=true or false]

This column assigns user/group access level.

Examples:

User: Bob.bradley@demo-firm.com|true#NULL*Admin$false

Group: Partners|true#NULL*Editor$true

 If multiple entries are included in this column, separate each entry by a comma and save the file as tab delimited. CAM will recognise a tab-delimited file when uploading as a CSV file in the Jobs tab.

RemoveSecurity

Optional

String (see example)

Use this field to remove a user’s or group’s access from the Workspace

Remove User: bob.bradley@demo-firm.com|User

 Remove Group:Partners|Group

Remove User from Group: bob.bradley@demo-firm.com|Partner

RefileDocsAndFolders

Optional

1 (true) or 0 (false)

Use this field to pull through any changes to the Folders' and Documents' Profiles from the modified Workspace Profile. Security refile is not done by this parameter, as only the profile is updated here. See the Copy SecuritytoDocuments parameter to do security.

copysecuritytodocuments

Optional

1 (true) or 0 (false)

Copies the security to the document profile from the workspace profile.

UpdatemoreSecuredDocuments

Optional

1 (true) or 0 (false)

If you have documents on a parent folder that are more secured, and you have the rights to modify, you can update them using this parameter.

WorkspaceName

Optional

String

Changed Workspace Name - include if you want this to change on the workspace

Queue

Optional

1

Include this column if you use the same CSV/script again with no changes to the values

Priority Queue

Optional (only applicable with C4 or C5 licensing)

String

Use this column when you want the job to run in a CAM Priority Queue

Name of the Priority Queue