Get Related operation

Login Mode

A com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.impl.LoginSettings value that represents how the operation will log in to the FileNet repository. Valid values are INVOCATION_CONTEXT (Use Credentials from process context), USER_CREDENTIALS (Use User Credentials), and TOKEN (Use FileNet Credentials Token).

Use Credentials from process context:

Uses the LiveCycle User Management credential from the process context for the FileNet authentication.

Use User Credentials:

Uses the User Name and Password properties to authenticate with FileNet. Ensure that the user name is valid for the FileNet P8 Content Engine that is specified in Administration Console.

Use FileNet Credentials Token:

Uses the FileNet Credentials Token property to authenticate with the FileNet Content Engine. This login token must be valid in the current FileNet session.

User Name

A string value that specifies the account name to use when connecting to the FileNet object store.

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

Password

A string value that specifies the password that is associated with the account name that is specified in the User Name property to use when connecting to the FileNet object store.

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

FileNet Credentials Token

A string value that represents the location of an existing FileNet credentials token.

This field is used only when the Login Mode property is set to TOKEN (Use FileNet Credentials Token).

Object Store

A string value that represents the name of the FileNet object store. You can choose from the list of available object stores from your current FileNet Content Engine defined in Administration Console. (See LiveCycle Administration Help.)

Relationship Type

A string value that specifies the type of relationship to create between the head document and the tail document.

Document GUID Or Path

A string value that indicates either the document GUID or the folder location within the object store of the document that you want to refer to.

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

When typing the folder path, use the following rules:

• Do not include the object store name in the folder path.

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

    /[FolderPath]/[documentName]

Is Head in Relationship?

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

Get Related Result

A list that contains the IDs of documents that is related to the specified document.

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