Retrieve Item operation

Retrieves a document from the IBM Content Manager repository.

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 AEM forms 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 AEM forms 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.

Retrieve Item Settings properties

Property to specify the item to retrieve from the repository.

PID

A string value that represents the unique identifier of the item to retrieve from the repository. 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.

Meta-Data properties

Properties to specify the metadata properties for the retrieved document.

Item Type

(Optional) A string value that represents the item type of the item to retrieve from the repository. The value specified in this property is used to populate the map value in the Attributes property so that you can assign values from process variables to attributes for the item type.

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

Note: When no value is provided, no attributes are populated in the map value in the Attributes property.

Attributes

A map value for mapping attributes to process variable values. The attributes are available only when a value is specified in the Item Type property. The process variables that you map to attributes must be the same data type. For example, if an attribute is a string , it must be mapped to a process variable of data type string . The name of an attribute is used as the key.

If you provide a literal value, the list of attributes in the table is based on the item you specified in the Item Type property. You can select a process variable from the Value column to assign to each attribute in the Name column.

Note: No value is provided for this property when no value exists in the Item Type property.

Results properties

Properties to store the results of the operation.

Document Information

The location to store the value that represents the attributes and contents of the item that was retrieved. The data type is DocInfo .

PID

The location to store the value that represents the unique identifier (PID) of the item retrieved. The PID (Persistent Identifier) is an identifier used by the IBM Content Manager server to uniquely identify all items. The data type is string .

Item Type

The location to store the value that represents the item type of the item retrieved. The data type is string .

Item Version

The location to store the value that represents the version for the item retrieved. The data type is string .

Item Content

The location to store the value that represents the contents of the item retrieved. The data type is document .

Attributes

The location to store the value that represents the attribute names and values of the item type for the retrieved item. The data type is map . (See Accessing data in data collections .)

Exceptions

This operation can throw a RepositoryException exception.

// Ethnio survey code removed