LinkedIn
Copied!

Table of Contents

Service SOAP form - Completing the Service tab

Version:

Only available versions of this content are shown in the dropdown

Complete the Service tab to identify the activity that this Service SOAP rule calls. See More about Service Packages.

  1. About
  2. New
  3. Service
  4. Request
  5. Response
  6. Faults
  7. XML Page
  8. Advanced
  9. Test Cases
  10. More...
Field Description
Primary Page
Page Class Specify the Applies To class of the service activity.
Data Transform Optional. You can identify a data transform in the class identified in Page Class. If you do, the system applies the data transform immediately after it creates the page.
Page Name Enter a page name for the class specified in the Page Class field. This is the top-level clipboard page that Pega Platform uses as the primary page by the activity being called through the SOAP service. The activity property values may be written to or read from this page.

Enter any page name, or accept the default value MyServicePage. (This page name has no special characteristics.)

Service Activity
Activity Name Specify the name of the activity that provides the processing for this service rule. For example, the activity can start a work item in a flow, or perform a flow action on an existing work item. This activity is known as the service activity.

The system uses the value you enter in the Page Class field as the Applies To key part of the activity. The system creates a page with the name provided in the Page Name field and passes it to the activity as the primary page. If the Page Name field is blank, the system passes the activity an unnamed page.

You can use the Params button to provide constant values for the parameters of the service activity, in case not all values are being mapped from the inbound service request data.

For example, if a parameter value is the same for every service request, you can set that parameter's value here rather than requiring a client application to supply it in each request. If a service activity starts a flow for a work item and the organization is always the same, you can specify the name of the organization on this tab.

If a parameter value is set here and also mapped from inbound request data, the inbound request data value overrides the value set on this tab.
Style and Use
Style and Use Specify the style (RPC or Document) and the use (literal or encoded) of the SOAP messaging format for this service. Pega Platform supports the following bindings:
  • Document/literal

    The preferred style when all request and response data is contained in XML literal parameters. Use when all data is mapped using XML mapping rules.

  • RPC/encoded

    This style is not WS-I compliant. This style is deprecated, but provided for backward compatibility.

  • RPC/literal

    The preferred style when either the request or response data contains simple parameter values. Use when mapping data to or from the clipboard.

Processing Options
Enable MTOM? Select to apply the W3C Message Transmission Optimization Mechanism formatting to binary data in SOAP messages. Selected by default as the recommended format.
End requestor when done? Select to have the system end this requestor session when the activity completes.

This check box affects only stateful processing. This check box is ignored when the Processing Mode on the service package data instance is set to Stateless.

Method is read-only Leave cleared in most cases. Select to indicate that each use of this service is not to count as a service invocation under the terms of your license agreement. See Creating a license.
Execution Mode There are four options, two each for synchronous and asynchronous (queue for execution) modes. Each pair has an option for using Request/Response, and a "one way" option for sending the service call and only receiving the HTTP Response status code (i.e., 2xx).

Synchronous -- Select one of these options when you want the service to run the request immediately:

  • Execute synchronously - Process the request and return the SOAP response.
  • Execute synchronously (one-way operation) - Process the request and return only the HTTP Response code.

Asynchronous -- Select one of these options when you want the service to queue the request. Choose one of these options only if a Service Request Processor data instance ( Data-Admin-RequestProcessor-Service class) exists with a key that matches the Service Package key part of this service rule:

  • Execute asynchronously (queue for execution) - Queue the request, return the response with the Queue Item ID to the caller, and end the service call while processing starts.
  • One-way operation (queue for execution) - Queue the request, return only the HTTP Response status code and end the service call while processing starts.

When a queued service request executes the execution is performed with the authorization profile of the service.

For instructions and an example, see Pega Community articles How asynchronous service processing works and Configure a service to process requests asynchronously.

Request Processor If you select one of the asynchronous options in the Execution Mode field or you configure a Queue When condition on the Faults tab, select the name of the service request processor (instance of Data-Admin-RequestProcessor-Service ). The list in this field displays only the request processors that are defined for the same service package as this service rule.
Enable service SLA with fallback activity Optional. This option is displayed for asynchronous execution modes. When selected, you can configure a fallback activity for a time-out. For example, when the service activity is not finished after a configured amount of time and the maximum number of violations has occurred, the fallback activity is called. No further requests are attempted until the retry interval has passed. If the next attempt is successful, normal processing is resumed.

Using a service SLA ensures that a logical response is made in a timely manner. Configure the fallback activity on the Methods tab. If a fallback activity is not configured, the default response is sent back.

Maximum duration for service activity (milliseconds) This option is displayed when you select Enable service SLA with fallback activity. Enter the amount of time, in milliseconds, after which the service activity is considered to have failed. The default is 500 milliseconds.
Maximum consecutive violations This option is displayed when you select Enable service SLA with fallback activity. Enter the number of SLA violations that must occur before the fallback activity is called. The default is 3.
Retry interval (seconds) This option is displayed when you select Enable service SLA with fallback activity. Enter the amount of time, in seconds, to wait before attempted to process the service activity. The default is 10 seconds.
Fallback activity name This option is displayed when you select Enable service SLA with fallback activity. Select a fallback activity for the response when the SLA fails. For example, the fallback activity can display a default offer to an ATM customer instead an offer based on the particular customer's data. If you do not select a fallback activity, the default response is sent back.
Parameters If a parameter value is the same for every service request, you can set that parameter's value rather than requiring a client application to supply it in each request.
Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.