Use the Connect-REST method to start an HTTP request/response interaction between the Pega 7 Platform and the external system identified by a Connect REST rule (Rule-Connect-REST rule type).
Parameters
This method accepts three required and one optional parameter.
Parameter
|
Description
|
| ServiceName
|
Service name of the Connect REST rule to run.
|
| EndPointURL
|
Optional. Specify the URL of an external system to which you want to connect. A value specified for this parameter overrides the value set in the End Point URL field on the Service tab of the Connect REST rule.
|
| MethodName
|
HTTP method to execute. Select GET, POST, PUT or DELETE.
|
| ExecutionMode
|
Select to indicate the timing of execution
Run — Execute the connector synchronously; the next step of the activity containing the Connect-REST method does not execute until the connector response is received. (This is the default.)Run in Parallel — This connector is to run in parallel as a child requestor of the current requestor. If selected, use the Connect-Wait method later in the current or a follow-on activity to access results from the connector. By default, an invoked connector retains control of the requestor session until it returns a response. Select this parameter if you want the connector to return control of the session directly after completing the request without waiting for a response. If a subsequent connector in the flow has a shape to accomplish, that connector can send its request before the first connector returns a response.Queue — Add this connector request to a queue, defined by a Connect Request Processor data instance, for background processing by the Pega-IntSvcs ProcessConnectQueue agent. This mode works only if the Request Processor field on the Service tab of the Connect REST rule identifies a Data-Admin-RequestProcessor-Connect data instance. When the agent executes a queued connector request, the execution is performed with the authorization profile of the original requestor.
|
Results
The Connect-REST method works as follows:
- Using rule resolution, locates the Connect REST rule identified by the ServiceName parameter and the class of the step page or primary page.
- Uses the HTTP method identified by the MethodName parameter to assemble a HTTP request message.
- If the step page does not exist, creates a new page, of the class identified in the Pages & Classes tab.
- Checks whether simulation is in force for this rule. If true, results depend on the Execution mode value:
Run — Executes the simulation activity synchronouslyRun In Parallel — Executes the simulation activity in a separate requestorQueue — Queues the simulation activity
- If simulation is not in force, calls the Web service, or queues the request, depending on the Execution mode value:
- Run — Calls the Web service and waits for a response.
Run In Parallel — Executes in a separate requestor. (This temporary requestor has the same access group and clipboard as the original. At most 10 such child requestor sessions can be active at once.) Queue — Creates a queue item based on the class and other characteristics identified in the Connect Request Processor, for later background processing by the Pega-IntSvcs agent.
- Processes the response message when it is received. (No response is available for queued connector requests.)
Methods and instructions by function
Open topic with navigation
