Metadata is the information about your document
...
.
The term metadata refers to information about other data, not the content of the data itself, such as the text or image. There are many types of metadata, including Descriptive metadata which is information to describe the resource.
All the documents, folders, and workspaces' metadata associated with the external systems are listed here. You can manually add metadata and assign values to the metadata to be applied to workspaces and template folders.
| Panel | ||
|---|---|---|
| ||
Best Practice- Don’t use invalid characters in the metadata creation or mapping. |
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
| Note |
|---|
Spaces are now removed from CAM field keys to prevent problems with several source system integrations. Do not use non-alphanumeric characters in metadata key names or ID’s. The only supported non-alphanumeric character is underscore. |
Context
CAM Master Metadata Overview and Key Concepts
CAM Master Metadata is crucial for all CAM processes, including workspace provisioning, form/layout management, request workflows, and several Service Desk operations. Understanding the key concepts of CAM Master Metadata, how to create CAM Master Metadata, and how to map external system metadata to its corresponding CAM Master Metadata are necessary to properly use CAM.
CAM Master Metadata Key Concepts
· Use the CAM Master Metadata definition for all CAM processes.
· Access CAM Master Metadata from the Administration tab, Metadata feature and find two tabs:
§ Use the Manage Metadata page to manually create new CAM Master Metadata, with or without an external system connection, and to view and manage existing CAM Master Metadata.
§ Use the Metadata Mapping page to manually create new mappings to CAM Master Metadata from connected external system metadata. The Metadata Mapping page can also be used to view and manage existing mappings. The Auto Discovery tool is available on the Metadata Mapping page only for external systems where no mappings exist.
· Important CAM Master Metadata Key Point! When multiple external systems are connected, they may use different identifiers for the same data. For example, each connected external system may have a field designated to hold "Practice" information, with one system utilizing “custom11” labeled as “Practice,” another system also using “custom11” but labeled as “PracticeInfo,” and yet another system using “custom29” with a completely different label. Despite these variations, all fields contain the same type of "Practice" data. The key concept is that, regardless of the varied identifiers or labels, all external system “Practice” data should be mapped to a single master “Practice” CAM Master Metadata.
· Certain functions within CAM may require manually creating “Additional” internal CAM Master Metadata. These “Additional” CAM Master metadata are usually mapped to CAM only and are used for CAM processes requiring specific metadata parameters to interact with the DMS API, for example:
§ Provisioning “Last 7 Days” type search folders.
§ Provisioning email folders.
§ Performing “is checked out?” and “document number” searches in Service Desk.
Unique ID Key Metadata
· A Unique ID metadata must be defined for each external system (library/cabinet) connected in CAM. The Unique ID metadata serves as the primary identifier for workspaces in the library ensuring each can be distinguished from the others.
· The Unique ID metadata is assigned during the external system mapping process.
...
· All workspaces in the same external system must use the same Unique ID metadata.
· Important Unique ID metadata Key Point: Changing the Unique ID metadata for a connected and active external system requires careful consideration. You should discuss the impact of changing the Unique ID metadata with the customer, review their current CAM setup, then contact Litera to discuss the change.
Example of different Unique ID metadata needs for workspaces in different libraries:
In a library for managing legal work, where each workspace is uniquely identified by the combination of Client and Matter values, use Client and Matter as the Unique ID metadata.
In administrative or personal libraries, where workspaces can share the same combination of Client and Matter values, you cannot use Client and Matter as the Unique ID metadata because this combination is not unique to each workspace. In this case, look in the source system for a single value field to use as the Unique ID metadata, for example “Matter Uno” in Aderant, or another single unique value such as “SystemID.” If no such single unique identifier exists, construct a Unique ID metadata by combining columns in the source system to form a distinct identifier for the workspaces.
Example of different Unique ID metadata needs for workspaces in the same library:
When workspaces with different Unique ID metadata needs coexist in the same library, you must identify one Unique ID metadata to satisfy the identification requirements for all workspaces in the library. The Unique ID metadata should be based on the most inclusive criteria. For example, in a library with both legal workspaces and administrative workspaces where the legal workspaces require the combination of Client and Matter values be unique and administrative workspaces are identified solely by the Client value, the Unique ID metadata for all workspaces in the library should be Client and Matter. For the administrative workspaces requiring only the Client value, hardcode a generic or placeholder value for the non-unique Matter value during the provisioning process.
Unique ID metadata challenges for integrating existing workspaces
In many cases, CAM is introduced into an environment with existing workspaces, provisioned by an older process that CAM replaced. Workspaces created from the old process may not have Unique ID metadata values, which are now required for new workspaces provisioned by CAM. Integrating existing workspaces into CAM for management presents unique challenges. Specifically, each existing workspace must have a Unique ID metadata value before a Link Workspace job can be run, which is the critical step for bringing these workspaces into CAM.
· Existing workspaces have Unique ID metadata values. For example, the Unique ID metadata for new workspaces will be the combination of Client and Matter values, and when the existing workspaces already have these values, run a Link Workspace job to integrate the existing workspaces into CAM.
· No Unique ID metadata values are present in existing workspaces. For example, if the new process is using a single value identifier, like Aderant’s “Matter Uno” as the Unique ID metadata, but the existing workspaces do not have this value, you'll need to create a process to assign the value before running a Link Workspace job.
§ iManage Cloud customers, contact iManage for assistance to populate the designated custom field for existing workspaces, then once populated, a Link Workspace job is performed to integrate the workspaces into CAM.
§ iManage On-prem customers can populate the custom field independently, then perform a Link Workspaces job to integrate the existing workspaces into CAM for management.
Metadata Auto Discovery Overview
Auto Discovery uses the metadata discovered in an external system to automate the creation of CAM Master Metadata and automatically maps the external system’s metadata to its corresponding CAM Master Metadata.
It is important to investigate, verify, and confirm external system metadata captions/attributes before using Auto Discovery.
Auto Discovery can only be used once per external system and not at all if a mapping already exists for the external system.
A careful review of the discovered metadata is necessary to avoid creating unnecessary or duplicate CAM Master Metadata and to ensure accurate mappings.
Use the Master [1] column on the Auto Discovery screen to determine when Auto Discovery will create new CAM Master Metadata and when Auto Discovery is only mapping to existing CAM Master Metadata.
An “i” icon [2] will appear when the external system will only be mapped to existing CAM Master Metadata.
An “-“ notation [3] will display when the process will create new CAM Master Metadata and map the external system’s metadata to it.
To avoid creating unnecessary or duplicate CAM Master Metadata, deselect questionable metadata from the Auto Discovery workflow and address these items manually.
User Window
In the Administration tab, select Metadata
...
...
Perform a metadata operation (Add/Update/Delete)
...
using CAM provisioning with the bulk of configuration pre-defined in templates and workflows with less system validation.
...
The metadata pipeline will sync every operation
...
utilizing the following pieces of the metadata functionality:
Metadata Definition Define the Metadata key.
Metadata Mapping Map the metadata value across all external systems and CAM
Metadata Values Define the Metadata values that come with the definition.
Users now will perform metadata operations (Add/Update/Delete) using Metadata
...
The configure metadata in the following ways -
...
Manage Metadata
...
Configure metadata using:
Manage Metadata
Manage Metadata
Helps you to manage all metadata definitions
...
that are created in CAM
Allows you to create, update, delete the metadata definition, and manage the systems (iManage, NetDocuments, M365, CAM,
...
and others) and entities (Workspace, Folder, Documents) where metadata applies.
...
...
Internal Metadata
...
Click on Reserved Internal Metadata, the following dialog opens -
...
Displays list of the reserved metadata keys
...
Flags/Internal Keys
The following dialog displays Reserved metadata keys, called internal keys, a set of metadata keys included in CAM and used as parameters in CSV jobs, Request workflow, Source System integration, and data uploader to determine the workflow of the flag provision. For example, server and repository
The included reserved metadata keys specify the purpose of the metadata respectively. For example, the CreateiManage internal key specifies creating a workspace in the iManage system
Filter Metadata allows searching for a specific reserved metadata key
Click Close to cancel the dialog
...
...
Filter
Allows you to filter the specific metadata details and displays the list
...
Fields | Description |
|---|---|
Text Box | Enter metadata key, description, comment, code field |
Data Type | Select data type from the list |
Select System | Select system from the list |
Select Entity | Select entity from the list Note: Once select system, entity filed will be visible. |
Click Filter to display the specific metadata details list and click X to reset the filter.
Metadata
...
Results
The following is what the search for metadata returns with:
...
Field | Description |
|---|---|
Display Name (CAM) | Shows the metadata display name list |
Id Field: Description Field | Shows the metadata description list along with Metadata Id |
System | Shows the system list with entities |
Authority | Shows the Authority list |
Metadata Type | Shows the metadata type |
Editable | Click Show Mappings, the following dialog opens |
...
: 
|
...
| ||
Last Modified On | Shows last updated date and time | |
Actions |
|
...
|
| Expand | ||
|---|---|---|
| ||
Edit Metadata
|
...
|
...
|
...
Metadata Definition |
...
 4. You can update the Metadata definition field in the window.
Note: The Key Name cannot be modified. Manage System |
...
|
| Expand | ||
|---|---|---|
| ||
Delete Metadata
 |
...
3. This allows you to check your metadata dependency before deleting the metadata. 4. Click Check Dependency to view metadata dependency |
...
which opens the following screen |
...
. Click Cancel to close the dialog.  4. Enter the character “confirm“ , as shown; case sensitive before deleting 5. Click Delete Metadata to delete the metadata and click Cancel to close the dialog |
...
It is also possible to delete Metadata from CAM and a related system by submitting a job through a CSV file that includes the HardDelete parameter.
| ||||||||||||||||||
Create/Add Metadata
Allows you to create a new metadata definition along with the associated
Allows you to perform metadata operations (Add/Update/Delete)
...
with a single click.
To configure or to know each Metadata item mapped on which systems (iManage, NetDocuments, M365,
...
and others) and system entities (Workspace, Folder, Documents, Teams, Channel) within the system, use this option.
The following screen describes how to create metadata
...
after clicking Create Metadata.
...
Fields | Description |
|---|
...
Reserved Keys
...
Displays the list of the reserved internal metadata keys.
Key Name | Enter the unique Metadata key name. |
Display Name (CAM) | Enter the display name reflected in the column name in the grid on the Cases tab in the CAM app. |
ID Field Name | Enter the valid Metadata id name. |
Description Name | Enter the description about the metadata. It is an optional field. |
Type Field Name | New in 2023, allows to set or import the type name. For example, when using a piece of metadata like Author from NetDocuments, they type would come over from ND. |
Comments | Enter the more information about the metadata. |
Data Type | Select the data type from the list. |
Authority | Select the Authority from the list. |
...
| Note |
|---|
Warning: The entities must be enabled for assigning the metadata value against each entities. |
CAM -
...
This allows you to configure metadata in the CAM system.
...
Field | Description |
|---|---|
CAM | Check the CAM system to enable the listed entities. |
Project | Select project metadata value from the list. |
Workspace | Select workspace metadata value from the list. |
Folder | Select folder metadata value from the list. |
Document | Select document metadata value from the list. |
Teams | Select teams metadata value from the list. |
Channel | Select channel metadata value from the list. |
Site | Select site metadata value from the list. |
2. iManage -
...
This allows you to configure metadata in the iManage system.
...
Field | Description |
|---|---|
iManage | Check the iManage system to enable the listed entities. |
Workspace | Select workspace metadata value from the list. |
Folder | Select folder metadata value from the list. |
Document | Select document metadata value from the list. |
3. NetDocuments -
...
This allows you to configure metadata in
...
the NetDocuments system.
...
Field | Description |
|---|---|
NetDocuments | Check the NetDocuments system to enable the listed entities. |
Workspace | Select workspace metadata value from the list. |
Folder | Select folder metadata value from the list. |
Document | Select document metadata value from the list. |
...
4. Office365 (M365)-
...
This allows you to configure metadata in the M365 system.
...
Field | Description |
|---|---|
Office365 | Check the Office365 (M365) system to enable the listed entities. |
Teams | Select teams metadata value from the list. |
Channel | Select channel metadata value from the list. |
Site | Select site metadata value from the list. |
Folder | Select folder metadata value from the list. |
Document | Select document metadata value from the list. |
...
Metadata Mapping
Allows you to
...
Field
...
Description
...
HighQ
...
Check the HighQ system to enable the listed entities.
...
Site
...
Select site metadata value from the list.
...
Folder
...
Select folder metadata value from the list.
...
Document
...
Select document metadata value from the list.
Save - Click Save to save the configured metadata against system
Save & Continue - Click Save & Continue to save and procced to create metadata mapping screen. For more information refer Create Metadata.
Close - Click Close to cancel the dialog
| Info |
|---|
Tip: To map the metadata to the external system click on Metadata Mapping. |
Metadata Mapping
Allows you to map the created metadata to the respective external system configured in the external system configuration
The following screen opens:
...
Fields
...
Description
...
System
...
Select system name from the list
...
Repository
...
Select repository name from the list
...
Database
...
Select the database from the list
...
Filter by Entity Type
...
Select the entity type from the list
...
Search by metadata
...
Enter the specific metadata
Note: Primary repository information displays only when you selects external systems like iManage, NetDocuments, HighQ, M365.
...
Click the following icon to perform search operation
...
map the created metadata to the respective external system configured in the external system configuration/ source system integration.
For iManage to CAM metadata mapping references, visit iManage to CAM Metadata Mapping or see the PDF in the Litera Customer Center.
The following screen opens:
...
Search Fields - This allows you to search and filter the specific metadata
Primary Repository Information - To view the Repository, storage, and system URL information against the selected system
Note: Primary repository information is visible for external system except CAM system.
3. Create Mapping - This allows you to create, update metadata mapping
4. Auto Discover - This allows you to map the metadata programmatically to the selected system in the selected database.
Note: Displays only when the repository and database are used for the first time to map the metadata.
Search Fields & Result List
...
Fields | Description |
|---|---|
System | Select system name from the list. |
Repository | Select repository name from the list |
Database | Select the database from the list |
Filter by Entity Type | Select the entity type from the list |
Search by metadata | Enter the specific metadata |
Metadata (CAM Display Name) | Displays metadata name |
Metadata Key | Displays metadata key |
System Key | Displays system key |
Unique | Display status of metadata |
Lookup | Display status of look up metadata |
Parent Metadata | Display parent metadata if configured |
Metadata Type | Display metadata type E.g. User Defined, Internal |
Last Modified On | Display metadata modified date and time |
Manage Data | Allows you to manage respective metadata values. For more details refer the following Manage data section |
Edit | Allows you to update existing metadata, For more details refer the following Edit data section opens the following screen: 
|
Delete Metadata Mapping |
|
If duplicate mappings exist, a warning appears saying Duplicate mapping for the given system for the given metadata.
Example 1: Document number
Mapping docnum in iManage to CAM is simple. Docnum is automatically imported from iManage if you autodiscovered it.
Map it to the CAM field document_number.
MetadataType: Number
CAM MetadataType: String
Name: Document_Number
Exclude: true
Example 2 Custom Metadata
If a firm wants to use and map custom25-28 metadata, here’s how to set up these boolean fields:
Map custom 25 with isecho column
...
Map custom 26 with c26 column
...
Map custom 27 with n7
...
Map custom28 with n8
...
Unsupported Metadata
CAM doesn’t support the checked_out_date or the in_use metadata because the iManage API doesn’t support using them.
| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Manage MetadataAllows you to manage respective metadata values, including adding and updating new metadata values. 
4. List values from all system/repositories/libraries - Check the checkbox 5. Add - Click Add, the following screen opens:  6. Allows to add new metadata value
7. Click Save to add metadata value and click Close to cancel the dialog 8. Click the following button to refresh the list  |
Primary repository information
Displays this option only when you select external systems like iManage, NetDocuments, M365.
Click + sign to Expand to view the repository information
...
3. This includes the following information -
Field | Description |
|---|---|
Repository | Display the repository name. |
Storage | Display the storage name. |
System URL | Display the system URL. |
Last Modified By | Display the user name who modified recently. |
Note: Primary repository information is visible for external system except CAM system.
4. Click the following button to perform search operation
5. Click X to reset the search options fields
Create Mapping
Allows you to map metadata for select systems against selected entities
Click Create Mapping, and the following screen opens:
...
Fields | Description | ||
|---|---|---|---|
Metadata | Select the metadata from the list. | ||
Parent Metadata (If Any) | Select the parent metadata from the list. | ||
System Attribute | Select the system attribute from the list. | ||
Is Unique? | Select an option | ||
Is Lookup? | Select an option Note: Lookup Type displays only when ‘Is Lookup’ option set to 'Yes' | ||
Lookup Type | Select lookup type from the list. Key only allows setting the key. Key and description allows to input a description with the key.
|
3. Click Save to save the metadata mapping and click Close to cancel the dialog
Auto discover
Click the following button to perform the Auto Discover operation -
...
2. Select the checkbox to view the saved discovered metadata in CAM
3. Click Preview to update and save the metadata mapping and click Close to cancel the dialog
4. After clicking Preview the following dialog opens -
...
Displays the selected mapping list
5. Click Edit to select the metadata mapping
6. Click Save to save the selected metadata mapping and displays the metadata mapping list
...
7. Click Close to cancel the dialog
Job Information
Metadata Jobs now will display the metadata information right in the name displayed on the Jobs tab.
This improved naming convention is Job Name: ID value- Name value.