Connect REST form – Completing the Service tab

Use the Service tab to identify the external system with which this connector rule communicates.

Resource properties

Field Description
Resource path Enter the URL of the external resource to which this rule connects.
Note: This URL can change over time, or can change when you move between a test system and a production system. However, after the RuleSet version containing this connector rule is locked, you cannot update this field. If your application needs to override the value in this field, complete the EndPointURL parameter of the Connect REST method in the connector activity that calls this connector rule.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). For more information, see Using the Global Resource Settings feature.

Resource params  
Param name Enter the name of the resource parameter.
Description Enter a short description of the resource parameter.
Map from Specify the source or the type of source of the value:
  • Clipboard — Map from the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.
Map from key Specify the key to locate the property in the source specified in the Map from field.
  • If the Map from value is Clipboard, enter the property name from which the data is mapped at run time.
  • If the Map from value is Constant, enter the value of the constant surrounded by double quote characters.
Note: Usage: If the Resource path specified is http://restServiceHostName/CustomerDB/resources/entities.customer/{id}, the parameter ID is the dynamic resource parameter that needs to be mapped to a clipboard property or a constant in the Resource parameters section as described above.

Authentication

Use authentication If selected, Pega Platform includes authentication credentials in the HTTP header of the message.
Authentication profile Required, if Use authentication is selected. Select the authentication profile that contains the authentication details required by the remote service.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pyAuthenticationProfile. For more information, see Using the Global Resource Settings feature.

Secure protocol configuration

Configure a secure protocol to connect to the external system.

Lowest allowable SSL/TLS version Select the version of SSL or TLS protocol that you want to use to securely connect to the external system with which this connector rule communicates.

Security settings

Configure the truststore and keystore settings to secure your connection with the external system.

Field Description
Truststore Select or create a Truststore record that contains the server certificate to use in the TLS/SSL handshake.
Keystore Select or create a Keystore record that stores the Pega Platform client's private/public key pair that is used by the server to authenticate the client.

For more information, see About Keystore data instances.

Connection

Response timeout Optional. Enter the number of milliseconds after which this rule times out with a failure message if it does not receive a response. Enter zero or leave blank to wait indefinitely.

This field is disabled and ignored at run time when the Intended for field is set to queuing.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pyResponseTimeout. For more information, see Using the Global Resource Settings feature.

Maintain session Select to use HTTP token-passing as the mechanism for maintaining a stateful session with the Web service provider. If selected, enter a Connection ID value in the following field.

This field is disabled and ignored at run time when the Intended for field is set to queuing.
Connection ID Optional. If the external system uses HTTP token passing to maintain stateful session data between requests, you can use this field to specify that a group of logically related connectors are to share a single session. Enter an arbitrary text value in this field, and enter the same text value in the other REST connector rules that are to share the session data.

Error handling

Status value property Optional. Select a property to hold the status code of the Connect REST method. The literal value Good identifies success. You can use the standard property @baseclass.pyStatusValue.
Status message property Optional. Select a property to hold status descriptions or return values from the external system returned by the Connect REST method. You can use the standard property @baseclass.pyStatusMessage.

This field is disabled and ignored at run time when the Intended for field is set to queuing.
Error handler flow Optional. Identify a flow rule to route work items that cannot continue in its current flow because this connector rule was unable to connect to the external system. The default flow rule Work-.ConnectionProblem provides one approach for handling such problems. See Handling connector exceptions.

Processing options

You can allow connector requests from this Connect REST to be processed asynchronously in parallel with the calling activity, or in background by an agent. (The mode of execution of each connector request is determined by the Execution mode parameter of the Connect REST method, as enabled by the values in these two fields.)

Intended for Optional. Select:
  • immediate execution — the REST connector executes synchronously; the calling activity waits for results.
  • queuing (response will not be available) — the REST connector executes asynchronously, with calls placed in a queue. The calling activity continues without waiting for results.

Queuing, when selected, occurs only if also specified in the Connect REST method.
Request processor Optional. If you selected queuing for the Intended for field, identify here a Connect Request Processor data instance that defines the classes and other characteristics of the queued connector requests, and for which the RuleSet key part matches the RuleSet of this Connect REST rule.

Testing and simulations

Test connectivity After you complete and save this rule, click this button to test whether Pega Platform can connect to the external system. Pega Platform verifies the connectivity to the service URL/endpoint. It does not confirm the ability to authenticate with the service.

The system presents test results in a separate window, identifying the parameters used in the test, the steps attempted, and the outcome of each step.
Simulations Click to create a simulator for this connect rule. See Connect Simulators.