Create Relationship operation

Creates a relationship between two items in an IBM Content Manager repository. Each relationship has a source and a target.

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

Login Settings properties

Properties for specifying the login settings for invoking the Content Repository Connector for IBM Content Manager service.

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.

Note: Use Credentials From Process Context works only when both IBM Content Manager and LiveCycle are synchronized to the same LDAP server.

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.

Create Relationship Settings properties

Properties for specifying the parameters for the relationship to create.

Source PID

A string value that represents the unique identifier of the source item. 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 unique identifier (PID) of the source item

Target PID

A string value that represents the unique identifier for the target item. 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 of the target item.

RelationType

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

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

New Relationship

A boolean value that sets whether to create the relationship type if it does not exist. A value of True means to create the relationship type if it does not exist. A default of False means not to create the relation type.

If you provide a literal value, select the New Relationship check box to create a relationship type if the value specified in the RelationType property does not exist. Deselect the New Relationship check box to not create a relationship type if it does not exist.

Important: When you either deselect the New Relationship or set the value to False and then specify a value in the RelationType property that does not exist, an exception is thrown.

Result properties

Properties to store the results of the operation.

Relationship Information

The location to store the result of the operation. The data type is RelationInfo.

Relationship Type

The location to store the relationship type that was created from performing the operation. This data type is string.

RelationshipType Description

The location to store the description of the relationship type. The data type is string.

Source Document Information

The location to store the document information of the source item in the newly created relationship. The data type is DocInfo.

Use XPath expressions and the Set Value service to obtain the data items in the DocInfo value.

Target Document Information

The location to store the document information of the target item in the newly created relationship. The data type is DocInfo.

Exceptions

This operation can throw a RepositoryException exception.

// Ethnio survey code removed