Example: Documentum upload

Edit online

The Documentum Connector Upload actions configure the connection between the Datacap application and the Documentum Docbase repository.

Use the Documentum Connector actions to upload a single page file into Documentum Docbase. You can also upload an image that contains multiple pages and their associated index values from Datacap.

The examples in the following table describe the sequence in which you must add the actions to the ruleset for this upload scenario.

Upload a single page file

Table 1. The sequence of actions for uploading a single page document file into Documentum.
Action	Description
`DM_Logon("Domain","Servername","Userid", "Password")`	Log the Datacap Client on to the Documentum Content Server that links Datacap to the repository that you specify as a parameter. A rule with the DM_Logon action must begin your Documentum upload procedures.
`DM_SetContentType("tiff")`	Assigns the Content Type to be TIFF for the page that you are uploading to the repository
`DM_SetFolderName("/MyPage")`	Name of the target folder on Documentum to which the file is uploaded. This parameter can be the path to the folder with forward slashes or the ObjectID of the folder as defined in Documentum. To get the ObjectID of the folder, you can use the Documentum client to view the folders on Documentum.
`DM_SetObjectName("@ID")`	Sets the Object Name value to the uploaded file. If you use this action when you upload the file, the file name is changed to this name in Documentum. For example, if the file name was XYZ when you uploaded the page, the page is named XYZ in Documentum.
`DM_UploadPage()`	Uploads the images that are associated with the current Page object of the document hierarchy to Documentum repository.

Upload a multiple page file

You can upload a single document that consists of multiple TIFF pages by using the DM_UploadDocument action on the document level.

If you want to merge the pages of the document into multiple TIFF files, you can use a rule that contains TifMerge actions to combine multiple pages image files into a file. Then, you can assign that multiple image file to one document. For more information about TifMerge actions, see the TifMerge reference topic.

You can use a subsequent rule that uploads the multiple page document file to a specified Documentum repository.

You can create a single RuleSet Type with actions from both actions files, or you can create rules from different RuleSet Types. In either case, the actions must be similar to the following sequence.

Table 2. The sequence of actions for uploading a multiple page document file into Documentum.
Action	Description
`TifMerge_SetFileName("@ID",".tif")`	Optional: Define the name of the multiple TIFF files that is uploaded to the Documentum repository.
`TifMerge_MergeImages("all")`	Optional: During processing, merge all the images of the pages that are associated with the current document.
`DM_Logon("Domain","Servername","Userid", "Password")`	Log the Datacap Client on to the Documentum Content Server that links Datacap to the repository that you specify as a parameter. A rule with the DM_Logon action must begin your Documentum upload procedures.
`DM_SetContentType("tiff")`	Assign the content type to be TIFF for the page that you are uploading to the repository.
`DM_SetFolderName("/MyPage")`	Name of the target folder on Documentum to which the file is uploaded. This parameter can be the path to the folder with forward slashes or the ObjectID of the folder as defined in Documentum. To get the ObjectID of the folder, you can use the Documentum client to view the folders on Documentum.
`DM_SetObjectName("@ID")`	Specifies the Object Name value name of the final uploaded file. This example assigns the value in a smart parameter.
`DM_UploadDocument()`	Upload the document and its multiple page file to the Documentum repository.

The following example describes an ExportDocumentumByPage ruleset that logs on to the Documentum server and uploads a single page file into Documentum repository.

The ruleset contains the Login and Page Upload rules, functions, and actions. The Login rule is bound to the batch level. The PageUpload rule is bound to the page level.

The Login function logs in the application to Documentum. The PageUpload function contains actions that set the format of the page to TIFF and define the folder from which the page is uploaded. These actions also set the object name to use for the page and upload the page to Documentum Docbase.

ExportDocumentumByPage ruleset

Login rule
- Login function
  - DM_Logon("dmsrv","userid","password")
Page Upload rule
- Page Upload function
  - DM_SetContentType("tiff")
  - DM_SetFolderName("/MyDocument")
  - DM_SetObjectName("@ID")
  - DM_UploadPage()