Configuring the request for Service Email rules

Use the Request tab to map the data from the messages that this service processes to the clipboard.

  1. On the Request tab, in the Message header section, map data from the header of the message:
    1. In the Field name field, press the Down arrow key to select To, CC, From, Subject, Date, Sent Date, or Thread-Topic.
      The Thread-Topic message header of a message that originated from Pega Platform flow processing contains the work item ID and the correspondence ID, in addition to the original subject text.
    2. Optional: To define this mapping, in the Description field, enter a text description.
    3. In the Map to field, press the Down arrow key, and then click the destination or the type of destination for the value in Pega Platform.
      • Select Clipboard to map to the page name or property on the clipboard that is specified by the Map to key field.
      • Select XML ParseRule to specify that the incoming data is a stream of XML that must be parsed using the actions that are defined in a parse XML rule.
      • Select Delimited ParseRule to specify that the incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited).
      • Select Structured ParseRule to specify that the incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
      • Select HTML PostData to specify that the incoming data value from the sending application is a stream of data from an HTML form that contains property key/value pairs.

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

    4. In the Map to key field, specify the key for locating the property or the rule in the destination that is set in the Map to field:
      • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

        You can use standard properties. See More about Service Email Rules.

      • If the Map to value is XML ParseRule, 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 "Namespace ElementName" and not "Namespace.ElementName".

        The system uses the page class of this service rule as the first key part of the parse rule.

      • 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 a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at run time.
      • If the Map to value is HTML PostData, leave this field blank.

        The name/value pairs in the string are mapped to the parameter page of the service activity rather than the primary page.

  2. Optional: To override the default behavior of the message subject, select Override default subject formatting.
    When selected, this check box overrides the pyGetInboundEmailSubject activity in the primary page class on the service. By default, if the subject is empty, the subject in the return message is formatted as "Message from <Sender>". If the subject line already contains a subject, the original subject is sent in the return message.
  3. If the service rule manages delivery failure messages for email correspondence that originated from Pega Platform flow processing (outbound email), complete the fields in the Delivery status notification (DSN) data section to map DSN data.
    Note: The email listener for this service must have the Process Delivery Status Notifications option selected or it does not route DSN messages to the service.
    1. In the Field name field, press the Down arrow key to select one of the following DSN fields:
      • Reporting-MTA – Identifies the server that sent the message.
      • Action – Specifies the action the Reporting-MTA performs in an attempt to deliver the message to the recipient address. For example: success, failed, delayed.
      • Status – Specifies the DSN status code that indicates the delivery status of the message.
      • Original-to – Specifies the intended recipient of the original message.
      • Original-from – Specifies the email address that is set in the From field of the original message.
      • Original-subject – Specifies the text from the subject of the original message.
      • Original-sentdate – Specifies the date the message was first sent.
      • Original-text-plain – Contains the original email plain text, if available.
      • Original-text-html – If the original text used HTML formatting, contains the HTML of the original email message.
    2. Optional: In the Description field, enter a text description of this mapping.
    3. In the Map to field, press the Down arrow key to specify the destination or the type of destination for the value in Pega Platform:
      • Select Clipboard to map to the page name or property on the clipboard that is specified by the Map to key field.
      • Select XML ParseRule to specify that the incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule.
      • Select Delimited ParseRule to specify that the incoming data is in a delimited format that a delimited parse rule must process (an instance of Rule-Parse-Delimited).
      • Select Structured ParseRule to specify that the incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
      • Select HTML PostData to specify that the incoming data value from the sending application is a stream of data from an HTML form that contains property key/value pairs.

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

    4. In the Map to key field, specify the key for locating the property or the rule in the destination that is set in the Map to field:
      • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

        You can use standard properties. See More about Service Email Rules.

      • If the Map to value is XML ParseRule, 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 "Namespace ElementName" and not "Namespace.ElementName".

        The system uses the page class of this service rule as the first key part of the parse rule.

      • 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 a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at run time.
      • If the Map to value is HTML PostData, leave this field blank.

        The name/value pairs in the string are mapped to the parameter page of the service activity rather than the primary page.

  4. In the Message data section, map the body of the message:
    1. Optional: In the Description field, enter a description of the data being mapped.
    2. In the Map to field, press the Down arrow key to specify the destination or the type of destination for the value in Pega Platform:
      • Select Clipboard to map to the page name or property on the clipboard that is specified by the Map to key field.
      • Select XML ParseRule to specify that the incoming data is a stream of XML that must be parsed using the actions defined in a parse XML rule.
      • Select Delimited ParseRule to specify that the incoming data is in a delimited format that must be processed by a delimited parse rule (an instance of Rule-Parse-Delimited ).
      • Select Structured ParseRule to specify that the incoming data has a fixed format with fixed length fields and must be processed by a structured parse rule.
      • Select HTML PostData to specify that the incoming data value from the sending application is a stream of data from an HTML form that contains property key/value pairs.

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

    3. In the Map to key field, specify the key for locating the property or the rule in the destination that is set in the Map to field:
      • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

        You can use standard properties. See More about Service Email Rules.

      • If the Map to value is XML ParseRule, 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 "Namespace ElementName" and not "Namespace.ElementName".

        The system uses the page class of this service rule as the first key part of the parse rule.

      • 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 a Rule-Utility-Function from a MapTo library, select or enter the property that holds the results of the custom function at run time.
      • If the Map to value is HTML PostData, leave this field blank.

        The name/value pairs in the string are mapped to the parameter page of the service activity rather than the primary page.

    4. In the Handle HTML content field, specify how to process email messages with HTML formatting:
      • As HTML attachment – HTML content in email is in the attachment page as an HTML file. Mapping uses the text body of the email.
      • Inline - prefer text – If any text body exists, it is used for mapping and any HTML is discarded. If no text body is available, the HTML content is used for mapping.
      • Inline - prefer HTML – If any HTML body exists, it is used for mapping and any text body is discarded.
      Note: This feature works with email listener inline image embedding which is designed for HTML message data. In that case, this setting has either the As HTML attachment or Inline - prefer HTML option selected.
  5. Click Save.
What to do next: Configure the response for your Service Email rule. For more information, see Configuring the response for Service Email rules.