Get Related operation

Retrieves a list of IDs for all documents that are related to the specified document.

For information about the General and Route Evaluation property groups, see Common operation properties.

Login Settings properties

Login settings for invoking the Content Repository Connector for EMC Documentum service.

Login Mode

A com.adobe.livecycle.emcdocumentumcontentrepositoryconnector.client.type.impl.LoginSettings value that represents how the operation will be authenticated with Documentum. Valid values are INVOCATION_CONTEXT (Use Credentials from process context), USER_CREDENTIALS (Use User Credentials), and TOKEN (Use Documentum Login Ticket).

If you provide a literal value, select one of the following options:

Use Credentials from process context:
Uses the LiveCycleUser Management credential from the process context for the Documentum authentication.

Use User Credentials:
Uses the User Name and Password properties to authenticate with Documentum. Ensure that the user name is valid for the repository that is specified in the Repository Name property in the Relationship Information property group for this operation.

Use Documentum Login Ticket:
Uses the Documentum Login Ticket and User Name properties to authenticate with Documentum. This login ticket must be valid in the current Documentum Foundation Class (DFC) session, and the user name must be set to the correct user of the DFC session.

User Name

(Optional) A string value that specifies the user name to use when this operation is authenticated with Documentum. No default is provided.

This field is used only when the Login Mode property is set to USER_CREDENTIALS (Use User Credentials) or TOKEN (Use Documentum Login Ticket).

Password

(Optional) A string value that specifies the password associated with the user name that is specified in the User Name property to use when this operation is authenticated with Documentum. No default is provided.

This field is used only when the Login Mode property is set to USER_CREDENTIALS (Use User Credentials).

Documentum Login Ticket

(Optional) A string value that specifies the value of an existing Documentum login ticket for a valid DFC session. No default is provided.

This field is used only when the Login Mode property is set to TOKEN (Use Documentum Login Ticket).

Relationship Creation Settings properties

Specifies the properties for the relationship you want to establish.

Repository Name

A string value that represents the name of the Documentum repository. You can choose from the list of available repositories from your current connection broker defined in Administration Console. (See LiveCycle Administration Help.)

Relationship Type

A string value that specifies the type of relationship to create between the parent document and the child document.

Document ID Or Path

A string value that indicates either the document ID number or the folder location within the repository of the document you want to refer to.

If you provide a literal value, type the path or the ID, or click Browse to select the folder from the Documentum repository.

When typing the folder path, use the following rules:

  • Do not include the repository name in the folder path.

  • Use a forward slash (/) to separate folder names, as shown in this example:

    /[CabinetName]/[FolderPath]/[documentName]

Is Parent In Relationship?

A boolean value that indicates whether to return all documents that participate as children in the relationship (True) or all documents that participate as parents in the relationship (False).

Result properties

Specifies the property for the result of the Get Related operation.

Get Related Result

A list value that contains the IDs of documents related to the specified document. (See Accessing data in data collections.)

For information about retrieving values from a list, see Accessing data in data collections.

Exceptions

This operation can throw a RepositoryException exception.