Documentum
On This Page
Overview
The Documentum connector in DryvIQ allows you to analyze, migrate, copy, and synchronize files between your Documentum account and cloud storage repositories and on-premise network file shares. The first step is to create the Documentum connection by providing the connection information required for DryvIQ to connect to the server. The connector can be created using any Documentum user account with permissions to access the content.
DryvIQ currently supports Documentum 7.3.
Create Connection | User Interface
Select Connections > Add connection.
Select Documentum as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Test the connection to ensure DryvIQ can connect using the information entered.
Select Done.
Add connection modal - Documentum
Field | Description | Required |
|---|---|---|
Display as | Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists. If you do not add a display name, the connection will automatically be named using the CMIS URL. For example, Documentum (http://XX.XX.XX.XXX:XXXX/emc-cmis/resources). If it will be useful for you to reference the connection by the URL, you should use the default name. | Optional |
CMIS URL | Enter the URL for the Content Management Interoperability Services (CMIS) server. | Required |
User name | Enter the username that should be used to log on to the server. This needs to be an account with permissions to access the content that will be processed. | Required |
Password | Enter the password for the username added in the previous field. | Required |
Repository | Enter the Documentum repository name. | Required |
Item Type | Enter the item type that should be assigned to uploaded items. For example, cmis:document. | Optional |
Secondary Item Types | Enter the secondary item types that should be applied. This is a comma or semicolon delimited list of item types for properties being retained as metadata. This is user defined and will vary by instance. | Optional |
Agent URL | Enter the URL for the computer where the Documentum agent is installed. The Documentum agent provides access to additional functionality. This is an optional entry, but DryvIQ uses the entry to determine if additional features should be turned on for the connection. If this field is populated, DryvIQ turns on the additional features; if it is blank, DryvIQ assumes the agent is not being used and doesn’t turn on the additional features. See Documentum Agent under Features and Limitations for more information about the features enabled through the Documentum agent. | Optional |
Lifecycle | Enter the lifecycle state that should be applied to the document when it is created. The DryvIQ extension module must be installed to use this option. | Optional |
Connection Test Succeeded
Features and Limitations
Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. The information below is platform specific. Use the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations. Additional information about Documentum can be found in on the EMC Documentum Help.
Files and Folders
Below is list of Documentum’s supported and unsupported features as well as additional file/folder restrictions.
Supported Features | Unsupported Features | Other Features/Limitations |
|---|---|---|
Path length maximum: 255 | ||
Author/Owner preservation | Invalid characters: \ \\ / < > : | ? * | |
No Leading whitespace | ||
No trailing whitespace before extensions | ||
Account map | No trailing whitespace after extensions | |
Group map |
| |
Permission preservation |
|
|
|
|
Linked Documents
Per information in the EMC Documentum Help, links are used to associate items in the repository with different repositories or locations. Cabinets, folders, or files may be linked to a location in the repository, another repository, or a location on the local machine.
A location in the repository
Linking an item to a location in the repository allows it to be accessed from the new location the same way it is accessed from the original location. You cannot link a locked item until the owner unlocks it.
Another repository
You can link an item from one repository to another. This creates a shortcut to the selected item, allowing you to perform most of the standard file and folder operations on shortcut (such as exporting, copying, and check outs). When you perform an operation on the shortcut, the Documentum Administrator performs the operation on the original item in the original repository.
DryvIQ’s Handling of Linked Documents
DryvIQ migrates each link as an actual item. This means one full file will be migrated for each link. For example, if five people have a link to a file, DryvIQ migrates the full file five times--once for each of the five users.
Virtual Documents
Per information in the EMC Documentum Help, a virtual document (also called the parent document) is a file that contains one or more nested files (also called descendants or children). Nested files can also be virtual documents, providing multiple levels of nesting.
Descendant documents may be of different file formats than the parent document. For example, a Microsoft Word parent file can contain an Excel spreadsheet and image files as descendants.
DryvIQ’s Handling of Linked Documents
DryvIQ breaks apart the virtual document and migrates each piece as an individual document. The parent and each nested file are individually migrated.
Documentum Agent
Documentum offers an optional agent that provides additional functionality. In order for you to use the following features, you will need to install the agent.
Audit Trail Support: This feature allows for the preservation of CreatedBy and ModifiedBy.
Author/Owner Preservation: If Documentum is the destination connection, this feature allows the reading and writing of the author for the file. Without the agent, the author can be read but not applied.
Querying Accounts: This feature provides the ability to search for user accounts. This is used behind the scenes for Audit Trail Support and in the DryvIQ user interface for account mapping.
Querying Groups: allows the ability to search for groups. This is used behind the scenes for Audit Trail Support and in the DryvIQ user interface for group mapping.
Permissions: This features allows for getting and modifying the permissions of an item.
The agent is a file named “documenutm-usermapping.war” and should be placed in the root of the webapps directory. Restarting the web server will unpack the agent and install it automatically.
This information applies only to Tomcat Apache 8.5.
Create Connection | REST API
A basic Documentum connection can be made using the example below.
POST {{url}}v1/connections/ |
|---|
{
"name": "display name goes here",
"platform": {
"id": "documentum"
},
"auth": {
"uri": "http://CMIS URL",
"username": "username",
"password": "password",
"repository": "repository name",
"item_type": "cmis:document",
"secondary_item_types": "property1;property2;property3",
"agent_url": "http://CMIS URL/documentum-usermapping",
"lifecycle": "lifecycle state"
}
} |
Create a Job | DryvIQ API Job Configuration Example
Below is an example Job for a connection created as standard user, no impersonation.
POST {{url}}v1/jobs |
|---|
{
"name":"Simple Job",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "Source Connection ID" },
"target": {
"path": "/sourceDocumentLibrary"
}
},
"destination": {
"connection": { "id": "Destination Connections ID" },
"target": {
"path": "/destinationFolder"
}
},
"simulation_mode": false
},
"schedule": {
"mode": "manual"
},
"stop_policy": {
"on_success": 5,
"on_failure": 5,
"on_execute": 25
},
"category": {
"name": "Report {Name}"
}
} |