Service REST form - Completing the Service tab
Complete the Service tab to identify the activity called by this Service REST rule.
Primary Page
Field | Description |
---|---|
Page Class | Required. Select the page class for the primary page for the data returned by this service. |
Data Transform | Optional. Select a data transform to use with this service to normalize the data received. |
Page Name | Required. Provide a name for the primary page. The name cannot include spaces or special characters. |
Resource Properties
Field | Description |
---|---|
Service endpoint URL |
The complete URL for the REST endpoint.
|
URI template or Resource Path | The URI template that was created or edited on the Create service REST page. This field is named Resource Path for rules that were created before 8.1. |
URI path parameters | URI path parameters are automatically populated from the URI template that was created or edited on the Create service REST page. These parameters can be literal or variable values. Variable parameters are populated with values at runtime. |
Name | The name of the variable resource parameter in the resource path. |
Description | A description for this parameter. |
Map To | The destination or the type of destination for the value in the Pega Platform :
|
Map To Key | The key used to locate the property or the rule in the destination that is
specified in the Map To field:
|
Processing options
End requestor when done | When the Processing Mode field on the service package
data instance is set to Stateful , select this option to
have the system end the requestor after the activity ends and the response is sent
If the services are stateless, the value in this field is ignored. |
Method is read-only | Leave this option cleared in most cases. Select this option 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:
For more information, see the Pega Community articles How asynchronous service processing works and Configure a service to process requests asynchronously. |
Request Processor | If you select the Execute asynchronously check box in
the Execution Mode field or you configure a Queue
When condition on the Response tab, you must also select the name of the
service request processor (the 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. |
Service monitoring | Click the Gear icon to specify whether to monitor this
rule, and when monitoring, whether to include the clipboard state. Service package
monitoring configuration settings are used only if the
service/EnableGlobalMonitoring Dynamic System Setting is set to
Deferred and the service package is set to As
defined on service rule.
|