Connect JCA rules – Completing the Service tab

Use the Service tab to identify the resource adapter the connector sends requests to and to specify properties and details for the connector requests.

Note: Connect JCA rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect JCA rules does not follow Pega development best practices. Consider other implementation options instead.

Service properties

Field Description
Adapter name

Select the name of the resource adapter data instance ( Data-Admin-Connect-JCAAdapter class ) that represents the resource adapter you want this connector rule to communicate with.

Interaction specification

Field Description
Interaction specification implementation class This field displays the Java classes listed under the Supported Interaction Specs section on the Metadata tab of the resource adapter instance you selected in the Adapter name field. Select the one that this connector will use.
Interaction verb Select the mode of the interaction between this connector rule and the external Enterprise Information System (EIS):
  • SYNC_SEND — The connector sends an input record but does not receive an output record.
  • SYNC_SEND_RECEIVE — The connector sends an input record and receives an output record synchronously. This is the default behavior.
  • SYNC_RECEIVE — The connector retrieves an output record.
Execution timeout Enter the number of milliseconds to wait for the external Enterprise Information System (EIS) to complete the adapter function before closing the connection and returning a timeout message.

Integration system

Field Description
Integration system Enter the integration system to use as the system of record.

Custom properties

Use this section to define any additional property/value pairs if the Interaction specification implementation class requires properties in addition to the standard ones listed above.

Field Description
none Enter the name of the property in the Property field and specify the Index name. To add more properties, click Add a row icon.
Note: The data type of the property can be either string or integer; the default is string. To specify that the data type is integer, use the following syntax when specifying the value of the custom property: $int: + [value of property]. For example: $int:538.

Connection

Field Description
Property holding connection specification properties Use this field to override or add to the default values specified for the Connection specification properties of the resource adapter data instance specified in the Adapter name field.

Select a property of mode Value Group. Then, in the activity that calls this connector rule, set the values for the Connection specification properties into this property before the activity step that calls the connector.
Initialize connection Specify how Pega Platform obtains a connection for the connector rule request:
  • Always create new connection — obtain a new connection from the resource adapter ConnectionFactory, which maintains a connection pool.
  • Create new connection if one does not exist — attempt to obtain a connection from the property specified as the Connection handle property in the next field. If a reference to the connection is not cached in the property, get one from the resource adapter ConnectionFactory.
  • Always re-use old connection — obtain a connection from the reference in the property specified as the Connection handle property. If this property contains no connection information, display an exception message.
Connection handle property Optional. Select a property of mode Java Object to hold on the clipboard a reference to a connection object when the request is finished. This field is required if you specify Store connection handle in the Finalize field and specify Always re-use old connection in the Initialize field.
Finalize connection Specify what to do with a connection when the connector rule request has finished:
  • Always close connection — returns the connection object to the resource adapter's connection pool.
  • Store connection handle — keeps the connection and stores a reference to the connection object in the property specified in the Connection handle property field.

Error handling

Field Description
Status value property Optional. Identify a Single Value property that can hold a status value returned by the connector. The literal value Good identifies success. You can use the standard property @baseclass.pyStatusValue.
Status message property Optional. Identify a Single Value property that can receive a text error message returned by the connector. You can use the standard property @baseclass.pyStatusMessage.
Error handler flow Optional. Identify a flow rule that is to be started when this connector rule is started by a flow rule but fails. The default flow rule Work-.ConnectionProblem provides one approach for handling such problems. See Handling connector exceptions.