Field

Description

Enter the external name of the header field.

Describe the purpose of the header.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Enter the name of the input query string.

Describe the purpose of the query string.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Field

Description

Select one of the following conditions:

Optional, but required if the Condition value is set to When or Queue When. Specify the name — second key part — of a when condition rule to evaluate for this condition. The system uses the first key part — the Applies To class — of the service activity as the first key part of the when condition rule.

Select text/plain, text/html, or text/xml for the header in the outgoing message.

Select application/xml for the header when the request body is formatted in XML.

Select application/json for the header when the request body is formatted in JSON.

Optional. Enter an HTTP status code to return to the external application with the response.

By default, PRPC sets values for the REST headers Server, Cache-Control, Content-Type, Content-Length, and Date in the response. Additionally, if the Processing Mode in the service package is set to Stateful, the system sends the Requestor ID value automatically to the client application as a token, in a cookie with the prefix PegaRULES.

If the response is include a header other than the ones that are set by default, complete the fields in this section. The data type of a header field is String.

Enter the external name of the header field.

Enter a short description of the header field.

Specify the source or the type of source of the value in PRPC.

• Clipboard — Map from the page name or property on the clipboard specified by the Map From Key field.
• Constant — The data is a fixed value.
• If additional choices appear, they identify a custom function rule in a MapFrom library (Rule-Utility-Function). Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field.

• If the Map From value is Clipboard, enter the property name to which the data is mapped at runtime.
• If the Map From value is a Rule-Utility-Function from a MapFrom library, enter or select property that holds the value pass to the custom function at runtime.
• If the Map To value is Constant, enter the value of the constant, surrounded by double quote characters.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the source or the type of source of the value in PRPC:

• Clipboard — The source is a property or a page on the clipboard.
• Constant — The source is a fixed value that does not change.
• JSON — The source is a stream of JSON data formatted by a Page or Page List property.
• XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
• HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
• HTML Frame — The source is a stream of HTML data generated by the service activity.

If additional choices appear, they identify a custom function rule in a MapFrom library. Review the function rule to determine what it does.

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

Field

Description

Enter the external name of the header field.

Describe the purpose of the header.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Enter the external name of the header field.

Describe the purpose of the header.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the destination or the type of destination for the value in PRPC:

• Clipboard — Map to the page name or property on the clipboard specified by Map To Key field.
• XML ParseRule — The incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule (an instance of the Rule-Parse-XML rule type).
• JSON — The incoming data is a JSON formatted stream that must be mapped to a Page or a Page List property on the clipboard.
• Delimited ParseRule — The incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited).
• Structured ParseRule — The incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
• HTML PostData — The incoming data value form the sending application is a stream of data from and HTML form that contains property key/value pairs.

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 is to be mapped.
• If the Map To value is XML Parse Rule, enter the Namespace name (second key part) and the Element Name name — third key part — of the appropriate Parse XML rule. Separate the Namespace from the Element name with a space using the syntax "NamespaceName ElementName" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
• If the Map To value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.
• If the Map To value is Delimited ParseRule, enter the Namespace and Record Type names (second and third key parts) of the appropriate delimited parse rule. The system uses the Applies To class of this service rule as the first key part of the parse rule.
• If the Map To value is Structured ParseRule, enter the Record Type (third key part) of a structured parse rule. The system uses the Applies To class of this service rule as the first key to the parse rule.
• If the Map To value is HTML PostData, leave this field blank. The name/value pairs in the string will be mapped to the parameter page of the service activity rather than the primary page.
• If the Map To value is a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at runtime.

Field

Description

To override any of those codes, specify a response on this tab. Define each condition with the following four fields:

Select one of the following conditions:

Optional, but required if the Condition value is set to When or Queue When. Specify the name — second key part — of a when condition rule to evaluate for this condition. The system uses the first key part — the Applies To class — of the service activity as the first key part of the when condition rule.

Select text/plain, text/html, or text/xml for the header in the outgoing message.

Select application/xml for the header when the request body is formatted in XML.

Select application/json for the header when the request body is formatted in JSON.

Optional. Enter an HTTP status code to return to the external application with the response.

By default, PRPC sets values for the HTTP headers Server, Cache-Control, Content-Type, Content-Length, and Date in the response. Additionally, if the Processing Mode in the service package is set to Stateful, the system sends the Requestor ID value automatically to the client application as a token, in a cookie with the prefix PegaRULES.

If the response is include a header other than the ones that are set by default, complete the fields in this section. The data type of a header field is String.

Enter the external name of the header field.

Enter a short description of the header field.

Specify the source or the type of source of the value in PRPC.

• Clipboard — Map from the page name or property on the clipboard specified by the Map From Key field.
• Constant — The data is a fixed value.
• If additional choices appear, they identify a custom function rule in a MapFrom library (Rule-Utility-Function). Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field.

• If the Map From value is Clipboard, enter the property name to which the data is mapped at runtime.
• If the Map From value is a Rule-Utility-Function from a MapFrom library, enter or select property that holds the value pass to the custom function at runtime.
• If the Map To value is Constant, enter the value of the constant, surrounded by double quote characters.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the source or the type of source of the value in PRPC:

• Clipboard — The source is a property or a page on the clipboard.
• Constant — The source is a fixed value that does not change.
• JSON — The source is a stream of JSON data formatted by a Page or Page list property.
• XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
• HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
• HTML Frame — The source is a stream of HTML data generated by the service activity.

If additional choices appear, they identify a custom function rule in a MapFrom library. Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field:

Field

Description

Enter the external name of the header field.

Describe the purpose of the header.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Enter the name of the input query string.

Describe the purpose of the query string.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the destination or the type of destination for the value in PRPC:

• Clipboard — Map to the page name or property on the clipboard specified by Map To Key field.
• XML ParseRule — The incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule (an instance of the Rule-Parse-XML rule type).
• JSON — The incoming data is a JSON formatted stream that must be mapped to a Page or a Page List property on the clipboard.
• Delimited ParseRule — The incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited).
• Structured ParseRule — The incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
• HTML PostData — The incoming data value form the sending application is a stream of data from and HTML form that contains property key/value pairs.
• 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 is to be mapped.
• If the Map To value is XML Parse Rule, enter the Namespace name (second key part) and the Element Name name — third key part — of the appropriate Parse XML rule. Separate the Namespace from the Element name with a space using the syntax "NamespaceName ElementName" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
• If the Map To value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.
• If the Map To value is Delimited ParseRule, enter the Namespace and Record Type names (second and third key parts) of the appropriate delimited parse rule. The system uses the Applies To class of this service rule as the first key part of the parse rule.
• If the Map To value is Structured ParseRule, enter the Record Type (third key part) of a structured parse rule. The system uses the Applies To class of this service rule as the first key to the parse rule.
• If the Map To value is HTML PostData, leave this field blank. The name/value pairs in the string will be mapped to the parameter page of the service activity rather than the primary page.
• If the Map To value is a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at runtime.

Field

Description

To override any of those codes, specify a response on this tab. Define each condition with the following four fields:

Select one of the following conditions:

Optional, but required if the Condition value is set to When or Queue When. Specify the name — second key part — of a when condition rule to evaluate for this condition. The system uses the first key part — the Applies To class — of the service activity as the first key part of the when condition rule.

Select text/plain, text/html, or text/xml for the header in the outgoing message.

Select application/xml for the header when the request body is formatted in XML.

Select application/json for the header when the request body is formatted in JSON.

Optional. Enter an HTTP status code to return to the external application with the response.

By default, PRPC sets values for the REST headers Server, Cache-Control, Content-Type, Content-Length, and Date in the response. Additionally, if the Processing Mode in the service package is set to Stateful, the system sends the Requestor ID value automatically to the client application as a token, in a cookie with the prefix PegaRULES.

If the response is include a header other than the ones that are set by default, complete the fields in this section. The data type of a header field is String.

Enter the external name of the header field.

Enter a short description of the header field.

Specify the source or the type of source of the value in PRPC.

• Clipboard — Map from the page name or property on the clipboard specified by the Map From Key field.
• Constant — The data is a fixed value.
• If additional choices appear, they identify a custom function rule in a MapFrom library (Rule-Utility-Function). Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field.

• If the Map From value is Clipboard, enter the property name to which the data is mapped at runtime.
• If the Map From value is a Rule-Utility-Function from a MapFrom library, enter or select property that holds the value pass to the custom function at runtime.
• If the Map To value is Constant, enter the value of the constant, surrounded by double quote characters.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the source or the type of source of the value in PRPC:

• Clipboard — The source is a property or a page on the clipboard.
• Constant — The source is a fixed value that does not change.
• JSON — The source is a stream of JSON data formatted by a Page or Page List property.
• XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
• HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
• HTML Frame — The source is a stream of HTML data generated by the service activity.

If additional choices appear, they identify a custom function rule in a MapFrom library. Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field:

Field

Description

Enter the external name of the header field.

Describe the purpose of the header.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Enter the name of the query string.

Describe the purpose of the query string.

Specify the destination or the type of destination for the value in PRPC:

• 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.

Field

Description

To override any of those codes, specify a response on this tab. Define each condition with the following four fields:

Select one of the following conditions:

Default	Send this response when there are no errors to report. If you plan to set up more than one condition, configure the Default condition as the last one in the list. To send an HTTP response code other than 200, specify a different code for the Default condition in the HTTP Response Code field.
When	The system evaluates the when condition specified by the When Key field. If the condition is true, the system returns the response message data. If the condition is false, the system evaluates the next when condition rule in the list. If all listed when condition rules are false, it returns the default response data. Use this feature to extend the normal set of fatal error conditions that result in exceptions returned to the client, such as inappropriate inputs to the service activity or other tests you define.
Queue When	The system evaluates the when condition rule specified by the When Key field. If the condition evaluates to true, the system queues the service request and returns the queue item ID of the service request. If you configure a Queue When condition, you must specify a request processor in the Request Processor field on the Service tab. For more information, see PDN article Configure a service to queue a failed service request for another attempt.
Mapping Error	If an error occurs while mapping incoming data from a request message to the clipboard, the service returns the specified response message data. If the list of response conditions does not include an entry for mapping errors, PRPC returns the HTTP status code 500.
Security Error	If an error occurs while authenticating the client credentials, PRPC returns the specified response message data. If the list of response conditions does not include an entry for security errors, PRPC returns the HTTP status code 401.
Service Error	If a valid instance of the service activity cannot be found, the system sends the specified response message data. If the list of response conditions does not include an entry for service errors, PRPC returns the HTTP status code 500.

Optional, but required if the Condition value is set to When or Queue When. Specify the name — second key part — of a when condition rule to evaluate for this condition. The system uses the first key part — the Applies To class — of the service activity as the first key part of the when condition rule.

Select text/plain, text/html, or text/xml for the header in the outgoing message.

Select application/xml for the header when the request body is formatted in XML.

Select application/json for the header when the request body is formatted in JSON.

Optional. Enter an HTTP status code to return to the external application with the response.

By default, PRPC sets values for the HTTP headers Server, Cache-Control, Content-Type, Content-Length, and Date in the response. Additionally, if the Processing Mode in the service package is set to Stateful, the system sends the Requestor ID value automatically to the client application as a token, in a cookie with the prefix PegaRULES.

If the response is include a header other than the ones that are set by default, complete the fields in this section. The data type of a header field is String.

Enter the external name of the header field.

Enter a short description of the header field.

Specify the source or the type of source of the value in PRPC.

• Clipboard — Map from the page name or property on the clipboard specified by the Map From Key field.
• Constant — The data is a fixed value.
• If additional choices appear, they identify a custom function rule in a MapFrom library (Rule-Utility-Function). Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field.

• If the Map From value is Clipboard, enter the property name to which the data is mapped at runtime.
• If the Map From value is a Rule-Utility-Function from a MapFrom library, enter or select property that holds the value pass to the custom function at runtime.
• If the Map To value is Constant, enter the value of the constant, surrounded by double quote characters.

Use the fields in this section to define the data for the response. The data type of the message data is String.

Enter a short description of the incoming string.

Specify the source or the type of source of the value in PRPC:

• Clipboard — The source is a property or a page on the clipboard.
• Constant — The source is a fixed value that does not change.
• JSON — The source is a stream of JSON data formatted by a Page or Page List property.
• XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
• HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
• HTML Frame — The source is a stream of HTML data generated by the service activity.

If additional choices appear, they identify a custom function rule in a MapFrom library. Review the function rule to determine what it does.

Specify the key to locating the property or rule in the source specified in the Map From field: