ConnectorLib Java 25.1
ConnectorLib Java SDK Programming Guide

# Create Identifiers

Although a document's reference should identify a unique file or item in the repository, it might not be sufficient for the connector to retrieve it again efficiently (this might be necessary, for example, in response to a `collect` request). You can therefore add additional information to a document's identifier. The identifier always holds the reference, but can also hold a set of key-value pairs to help retrieve the document.

To illustrate this, the following code sample creates a document for an imaginary e-mail archive system:

           DocInfo doc = new DocInfo(
                task.getTaskConfig(),
                "32998F5A-852D-404A-BD7B-730724D89784",
                "tempFile.msg",
                true);

In this system each message has a unique GUID, which is a good choice for the reference. However, imagine the system does not provide a way to retrieve a document by GUID, other than by searching through every folder of every mailbox. To help retrieve the message efficiently you might add additional information to the document's identifier:

           doc.getId().setProperty("Mailbox", "someone@example.com");
           doc.getId().setProperty("Folder", "/Inbox");

Now, given only the document identifier, the connector can quickly find the original message from which the document was created. When the document is indexed, the identifier is stored in the `AUTN_IDENTIFIER` document field.

NOTE: The identifier should include information for finding the document, but not for connecting to the repository. Do not include information such as web service URLs, user credentials and so on. This information is not document-specific and can be stored in the connector's configuration file. Storing connection details in the configuration file means that document identifiers continue to be valid if the connection details change. This also helps to minimize the length of the `AUTN_IDENTIFIER` field.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery ConnectorLib Java 25.1

Topic Title: Create Identifiers