Get Related Items operation

Login Mode

A LoginMode (com.adobe.livecycle.connectorforibmcm.dsc.client.type.LoginMode) value that represents how the operation will be authenticated with IBM Content Manager. Valid values are Use Credentials From Process Context and Use User Credentials.

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

Use Credentials From Process Context:

Uses the LiveCycle User Management credential from the process context for the IBM Content Manager authentication. The User Name, Data Store, Password, and Connection String properties are not used.

Note: To invoke a process with Workbench that uses this operation, type the login name in the Username box using the format [User Name]@[Data Store]:[Connection String]. In this format, [User Name] identifies the user ID, [Data Store] is the name of the repository to connect to, and [Connection String] is the list of options to use to connect to the repository.

Use User Credentials:

Uses the User Name and Password properties to authenticate with IBM Content Manager. Ensure that the user name is valid for the repository that is specified in the Data Store property for this operation.

When this value is selected, provide values for the Data Store, User Name, Password, and Connection String properties.

Data Store

(Optional) A string value that specifies the name of the data store that the user is to connect to.

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

If you provide a literal value, type the name of the data store.

User Name

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

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

If you provide a literal value, type the user ID.

Password

(Optional) A string value that specifies the password associated with the user name that is specified in the User Name property. The password is used when this operation is authenticated with IBM Content Manager. No default is provided.

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

If you provide a literal value, type the password.

Connection String

(Optional) A string value that specifies additional options to use for connecting to IBM Content Manager, such as SCHEMA=[schemaName], where [schemaName] is a case-sensitive value that represents a schema.

If you provide a literal value, type the additional connection options.

PID

A string value that specifies the unique identifier (PID) of the item to retrieve the related items for. The PID (Persistent Identifier) is an identifier used by the IBM Content Manager server to uniquely identify all items.

If you provide a literal value, type the value that represents the PID.

Relationship Type

A string value that specifies the name of the relation type to retrieve. A relation type can be a maximum of 15 characters.

If you provide a literal value, type the value that represents the relation type.

Is Source PID

A boolean value that sets whether the value specified in the PID property is the source or target of the relation. A value of True means that the value configured in the PID property is the source relation. The default is False, which means that the value configured in the PID property is the target relation.

If you provide a literal value, select the Is Source PID check box to specify that the value in the PID property is the source relation. Deselect the Is Source PID check box to specify that the value in the PID property is the target relation. The default for the Is Source PID check box is deselected.

Related Result

The location to store the related items that are retrieved from the repository. The data type is a list of DocInfo.

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