CM 8.x Confirm Document

In SharePoint Connector link management, auditing, and stub cleanup task routes,the CM 8.x Confirm Document task attempts to confirm the existence of a document in IBM® Content Manager.

Task summary

Table 1. CM 8.x Confirm Document task summary
Characteristic Value
Task name CM 8.x Confirm Document
Main purpose Checks if a document exists in the IBM Content Manager repository
Usable with which source connectors? Email Connector, IBM Connections Connector, File System Source Connector, SharePoint Connector
Usable with which target connectors? IBM Content Manager Connector
When needed? Required in link management task routes such as SP Manage CM Links and SP Audit CM Links and in cleanup task routes
Placement in task route Must appear before the SP Manage Link task in link management task routes
Produces which metadata? CM 8.x Confirm Document, Task Status
Configuration options

Connection

Select the appropriate connection to enable access to the target repository by IBM Content Collector.

Shortcut Link

The shortcut link is the URL that is used when a shortcut is added to an archived document. A shortcut link is required for specific File System or Microsoft SharePoint post-processing: creating shortcuts for File System documents or replacing Microsoft SharePoint documents with links. Based on the URL definition in the entry field, Content Collector generates a shortcut URL for each document that is processed by the task. Do not change the URL in the entry field. Only replace HOST and PORT with the name and port number of the IBM Content Collector Web Application service:
https://HOST:PORT/AFUWeb/RD.do?
r=%PID_ENCRYPTED&sum=%URL_CHECKSUM%&repositoryID=%REPOSITORY_ID_ENCRYPTED%&filename=%FILENAME%
To provide secure links to archived documents that require users to log on to the repository before they can access the content, provide the URL in this format:
https://HOST:PORT/AFUWeb/SRD.do?
r=%PID_ENCRYPTED%&sum=%URL_CHECKSUM%&repositoryID=%REPOSITORY_ID_ENCRYPTED%
&am=%CHALLENGE_MODE%&filename=%FILENAME%
In this case, the repository connection is established with the user's credentials and access to the item in the repository is granted based on the user's access rights.
  • Replace HOST and PORT with the name and port number of the IBM Content Collector Web Application service.
  • Do not alter any of the tokens %token_name% and adhere to the order of the parameters except for the parameter &sum. This parameter can appear anywhere in the parameter list.
  • If you have customized a user client and require the URL to contain more parameters, you can use the following tokens in the URL:
    • %PID_ENCRYPTED%: the encrypted persistent identifier of the item in Content Manager
    • %URL_CHECKSUM%: the checksum of the encrypted values
    • %REPOSITORY_ID_ENCRYPTED%: the encrypted unique identifier of the Content Manager repository
    • %CHALLENGE_MODE%: the access mode for the repository when secure links are used
    • %FILENAME%: the file name of the archived document
  • The ENCRYPTED tokens are encrypted with an algorithm that is compatible with the IBM Content Collector Web Application service. This means that you cannot use %PID_ENCRYPTED%, %ITEMTYPE_ENCRYPTED%, or %URL_CHECKSUM% with applications that do not use the IBM Content Collector Web Application service.

Repository ID

Starting with IBM Content Collector Version 3.0, a repository ID is added to each document stub to ensure that the correct repository is searched. If you want to manage stubs created in earlier Content Collector versions, you must supply a default repository ID. Use the Content Manager item type property called ICCRepositoryGUID as the repository ID.

Important: You must configure one CM 8.x Confirm Document task per repository. To route the collected stubs to the proper path, use rules that evaluate either one of the Re-collection system metadata properties, namely Repository Name or Repository ID.