Service REST form
Completing the Service tab

Field

Description

Required. Select the page class for the primary page for the data returned by this service.

Optional. You can select from the menu a data transform to use with this service to normalize the data received.

Field

Description

Optional. Enter the URL of the web service.

Enter the name of the dynamic resource parameter in the resource path.

Enter a description for this parameter.

Specify the destination or the type of destination for the value in the Pega 7 Platform:

• Clipboard — Map to the page name or property on the clipboard specified by the Map To Key field.
• If additional choices appear, they identify a custom function rule (Rule-Utility-Function rule type) in a MapTo library. Review the function rule to determine what it does.

Specify the key to locating the property or the rule in the destination specified in the Map To field:

• If the Map To value is Clipboard, enter the property name to which the data be mapped at runtime.
• If the Map To value is a Rule-Utility-Function from a MapTo library, either select a property to hold the results of the function or leave this field blank, as appropriate for the function.

Specify the Applies To class of the service activity.

Optional. Identify a data transform in the class identified in Page Class. The system applies this data transform immediately after it creates the page.

Enter a page name for the class specified in the Page Class field. This page is the top-level clipboard page that PRPC uses as the primary page when running the activity called by this REST 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.)

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.

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.

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 PDN articles How asynchronous service processing works and Configure a service to process requests asynchronously.

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.

After you save this form, click to view a tree of the components that comprise the service package. See About the Integration viewer.