/
Link Workspace

Link Workspace

Overview

Link Workspace allows you to import existing workspaces from your DMS to CAM so that the workspaces can be managed by CAM going forward, including managing the workspace through Template Editor or using the Manage Folder command.

There are several methods available for linking workspaces, including:

  • Manually configuring a Link Workspaces Layout form, then launch the configured form from the Jobs tab, fill out the details, and submit the job.

  • Manually configuring a CSV with the parameters to perform a Link Workspace job, and upload the CSV from the Jobs tab to submit the job.

  • Automatically configuring a Link Workspace SQL script for use with Data Uploader, then scheduling the job.

Background Job Details

  1. When Users submit a Link Workspace job via Data Uploader, it is identified as a Background Job.

  2. Once submitted, the job appears in the Background Jobs area of CAM

  3. The details displayed on the Background Jobs grid are as follows

    1. Name = Job Description / Title

    2. Type = Data Upload - Link Workspace

    3. Schedule = n/a

    4. Last trigger date = Job submission

    5. Next trigger date = n/a

    6. Status = In Progress / Complete

  • You have the option to Stop or Pause the linking of the workspaces on the Background Jobs details page for Link Workspace.

  • Stopping the process will end the linking of the workspace. You can restart it from the beginning.

  • Pause option shall temporarily stop the workspace linking process. You can resume it and the progress will continue from the last linked workspace.

  • Based on these new actions, the following statuses for the Workspace Linking display in Background Jobs.

    • In-progress

    • Paused

    • Stopped

    • Completed

Samples

File

Description

Updated

 

Sample of a Link Workspace.csv

If you submit this through Data Uploader, this will be a background job. If you submit it through the Jobs tab, it will be a regular job.

Q3 2025

Sample of a Link Workspace.sql

2024

Supporting Link Workspace CSV Parameters

Columns

When Required?

Description

Supported Values

Columns

When Required?

Description

Supported Values

Job

Mandatory

Job to link a workspace with another.

String. linkworkspace

UniqueSystemWorkspaceColumns

Mandatory

This parameter accepts unique system metadata.

ClientId and MatterId parameters are case insensitive.

Spaces in this field are automatically removed so the correct workspace is linked.

The parameter names should not be changed and must be in this format:
ClientId=<value>&MatterId=<value>

Note: The Link Workspace job fails if ClientId and MatterId parameters have additional info before or after this set of parameters.

String. E.g. ClientId=gh12&MatterId=771g

ProjectId

Optional

ProjectId from WS table on Milan

Integer. E.g. projectId from WS table on Milan (for Milan workspaces).

Library

Mandatory

Database where workspace exist

String. E.g. Database (imanage), CabinetName(NetDocuments)

ObjectType

Optional

Type from imanage systems

String. E.g. "work"

CreatedBy

Optional

The username of the creator

String

OldServerName

Optional

Old server name where workspace existed

String. For Milan workspaces only

NewServerName

Optional

New Server name where you want to link

String. E.g. Current server name on CAM

Source

Mandatory

Source system for object

String. E.g. Milan

System

Mandatory

The external system

Enum. E.g. imanage, netdocuments

Server

mandatory

The server name

String. E.g. iManage_EU

CloudId

Mandatory

Unique id of workspace from source system

String. E.g. worksite2020!876

TemplateId

Mandatory

Sets a specific template to be used available on CAM.

String. E.g. Litigation Template

skipWorkspaceStructure

Optional

Set to skip folder structure of workspace copy to CAM

String

1 Or true Or yes = Do not copy folder structure to CAM

0 Or false Or no = Copy folder structure to CAM

skipWorkspaceSecurity

Optional

Set to skip linking security of workspace to CAM

String

1 Or true Or yes = Do not copy security (ACL) to CAM

0 Or false Or no = Copy security (ACL) to CAM

LinkMetadataValues

Mandatory

Set to copy workspace' metadata to CAM

String

1 Or true Or yes = Copy metadata to CAM

0 Or false Or no = Do not copy metadata to CAM

BackgroundJob

Optional

Enforces the job to be a background job type. Put the name of the job type under this column.

If you submit this through Data Uploader, this will be a background job. If you submit it through the Jobs tab, it will be a regular job.

JobType

E.g. linkworkspaces

 

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.

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

Let's Connect📌

☎ +1 630.598.1100
☎ ‪+44 20 3880 1550‬
📧 support@litera.com
💻 https://www.litera.com/support/

📝 Support is available:
4 am - 8 pm US Eastern
(9 am - 1 am GMT/BST
7 pm - 11 am AET) on normal business days (excluding holidays)

© 2024 Litera