Connect REST form – Completing the Service tab

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

Note: When you open a REST connector that was created before version 8.2 of Pega Platform, you can upgrade the connector so that it supports all URL components. To upgrade a REST connector, click Upgrade to new endpoint configuration.

URL Configuration

The displayed resource properties settings are relevant for the current production level.

Field Description
Endpoint URL Enter the URL of the external resource to which this rule connects.

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

Environment settings Click Environment settings to view the endpoint URL configuration settings for the system to connect to for your development, state, and production environments.
Note: This information is read-only and only available for Connect-REST instances that were created in App Studio. If you modify a REST connector that was created in App Studio, environment settings are no longer used.
Note: Curly braces {} in the URL denote a dynamic resource parameter that must be mapped to a clipboard property or a constant in the Resource path parameters section. For example, in the URL http://restServiceHostName/CustomerDB/resources/entities.customer/{id}, the parameter ID is the dynamic resource parameter.

Parameters

Field Description
Name Enter the name 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 that is 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 you map from Clipboard, enter the property name from which the data is mapped at run time.
  • If you map from Constant, enter the value of the constant surrounded by double quotation marks.
Empty behavior Specify which action to perform if a query string parameter is empty:
  • Throw error/required — The parameter value is required and cannot be empty. An error occurs if the value is empty at run time.
  • Name only — Only the parameter name is appended to the URL.
  • Name= blank value — The parameter name and an = character is appended to the URL.
  • Skip — The parameter is not appended to the URL.
Encoding Specify whether to do URL encoding on a query string parameter:
  • URL — Encodes the parameter value before the parameter is appended to the URL
  • Already encoded — Does not encode the parameter value before the name-value pair is appended to the URL.

Integration system

Select the integration system to use as the system of record. You can select any user-defined system or robotics. The Pega integration system is not available in this list.

Authentication

Field Description
Authentication profile Select the authentication profile that contains the authentication details that the remote service requires.

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.

Environment settings Click Environment settings to view the authentication settings for your development, stage, and production systems.
Note: This information is read-only and only available for Connect-REST instances that were created in App Studio If you modify a REST connector that was created in App Studio, environment settings are no longer used.

Secure protocol configuration

Configure a secure protocol to connect to the external system.

Field Description
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 Pega Platform client's private/public key pair that is used by the server to authenticate the client.

For more information about Keystores, see About Keystore data instances.

Connection

Field Description
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 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 shares 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

Field Description
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 that are 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 method to be processed asynchronously in parallel with the calling activity, or in the 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.

Field Description
Intended for Optional. Select:
  • immediate execution — the REST connector run 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 a Connect Request Processor data instance that defines the classes and other characteristics of the queued connector requests. The Connect Request Processor data instance must also have a ruleset key part that matches the ruleset of this Connect REST rule.

Simulation status

Field Description
Test connectivity After you complete and save this rule, click this button to test whether Pega Platform Pega Platform can connect to the external system. Pega Platform 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, which identifies 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.