Service HTTP form - Completing the Service tab

Complete the Service tab to identify the activity called by this Service HTTP rule.

Field Description
Primary Page  
Page Class Specify the Applies To class of the service activity.
Data Transform Optional. Identify a data transform in the class identified in Page Class. The system applies this data transform immediately after it creates the page.
Page Name Enter a page name for the class specified in the Page Class field. This page is the top-level clipboard page that the Pega Platform uses as the primary page when running the activity called by this HTTP service. The property values can 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 an unnamed page to the activity.

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

Note: Parameter values from the incoming request override values set on this tab.
Processing Options  
End requestor when done? When services in the service package are stateful, select this option to have the system end the requestor after the activity ends and the response is sent.

This option applies only when the Processing Mode field on the service package data instance is set to Stateful. If the services are stateless, this value in this field is ignored.

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 Working with the License Compliance facility.
Execution Mode Select one of the following options:
  • Execute synchronously — select this when you want the service to run the request immediately.
  • Execute asynchronously — select this when you want the service to queue the request for asynchronous execution, return the Queue Item ID to the external application, and end the service call while the processing starts. Choose this option 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. (When the queued service request executes the execution is performed with the authorization profile of the service. )

For more information, see Pega Community articles How asynchronous service processing works and Configure a service to process requests asynchronously.

Request Processor If you select Execute asynchronously in the Execution Mode field or you configure a Queue When condition on the Response 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.