Connect HTTP form – Completing the Service tab

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

Service properties

Field Description
Endpoint URL Enter the URL of the external system 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 HTTP 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 path Enter the location in the WSDL that describes the operation.
HTTP method Select which HTTP method to use to send the string: GET or POST.
HTTP version Select a version known to be compatible with the server that this connector is connecting to. As a best practice, because HTTP versions are backward compatible, set the HTTP version to the lowest known compatible version. For example, if it is not known whether the server is 1.1 compatible, set the connector HTTP Version to 1.0.
Request only When the HTTP method is set to POST, select to indicate that Pega Platform is to send the message and close the connection without waiting for a response.
Allow redirects Select to enable the connector to, based on information returned from the service, retry a request using a different service address.

Authentication

Field Description
Use authentication If selected, Pega Platform includes authentication credentials in the HTTP header of the message.
Note: If you open a Connect HTTP instance configured in a version prior to Version 6.2, the rule form will contain a Username property and Password property field. To update the rule to use the Authentication Profile, save the rule and refresh rule form. The Username property and Password property fields will be replaced with the Authentication profile field populated with a new profile.
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.

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

Use the fields in this section only when the Request only field is cleared.

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 pyHTTPTimeout. 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 previous 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 HTTP connector rules that are to share the session data.

Error handling

Field Description
Error Handling  
Status value property Optional. Select a property to hold the status code of the Connect HTTP method. You can use the standard property @baseclass.pyStatusValue. The literal value Good identifies success.
Status message property Optional. Select a property to hold status descriptions or return values from the external system returned by the Connect HTTP method. You can use the standard property @baseclass.pyStatusMessage.
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 HTTP 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 HTTP method, as enabled by the values in these two fields.)

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

Blank is equivalent to immediate execution.

Queuing, when selected, occurs only if also specified in the Connect HTTP 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 HTTP rule. See More about HTTP Connector rules.

Testing and simulations

Field Description
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 Creating connect simulators.