Service REST form
|
|
Complete the Service tab to identify the activity called by this Service REST rule.
Field |
Description |
Page Class |
Required. Select the page class for the primary page for the data returned by this service. |
Data Transform |
Optional. You can select from the menu 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 should have no spaces and use no special characters. |
Field |
Description |
Resource Path |
Optional. Enter the URL of the web service. |
Resource Params | |
Name |
Enter the name of the dynamic resource parameter in the resource path. |
Description |
Enter a description for this parameter. |
Map To |
Specify the destination or the type of destination for the value in the Pega Platform:
|
Map To Key |
Specify the key to locating the property or the rule in the destination specified in the Map To field:
|
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 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.) |
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 |
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:
For more information, see PDN 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 |
Enable service SLA with fallback activity |
Optional. This option is displayed for synchronous 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. |