Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Configuring service processing for Service Email rules

Updated on April 5, 2022

Email listeners route email messages to a Service Email rule. Pega Platform uses Service Email rules to determine which service activity to use for processing the email message. For example, an email listener might route an email message from a job applicant to a Service Email rule for adding attachments to recruiting cases. The service activity in the email service rule attaches the job candidate's resume to the case.

In this task, create the Service Email rule and identify the activity that provides the service processing for the Service Email rule.

Note: Your system might contain Service Email rules in which the Service Package or Service Class fields are blank. These older rules remain valid; although, new rules must include these two key parts.
  1. In the navigation pane of Dev Studio, click Records.

  2. Expand the Integration-Services category, and then click Service Email.

  3. Click Create.

  4. In the Service Email Record Configuration section, define the rule's name, the service package to which the rule belongs, and the name of the service class that is used to group related service rules:

    1. In the Label field, enter a short description or title that describes the purpose of this record.

    2. In the Customer Package Name field, press the Down arrow key to select the name of a service package (instance of the Data-Admin-ServicePackage class).

    3. In the Customer Class Name field, enter the name of the service class.

      This name is used only to group related service rules. Start the name with a letter and use only letters and digits.
  5. Click Create and open.

  6. On the Service tab, in the Primary page section, configure the page:

    1. In the Primary page class field, enter the applies to class of the service activity.

    2. In the Data transform field, select a data transform for the system to use for creating the page that you specify in the Page name field.

    3. In the Page name field, enter a page name for the class that you specify in the Page Class field.

      This page is the top-level clipboard page that the Pega Platform uses as the primary page when running the activity that is called by this email service.
      You can enter any page name or accept the default value MyServicePage. (This page name has no special characteristics.)
  7. In the Service activity section, in the Activity name field, specify the name of the activity that provides the processing for this service rule.

    For example: The activity can start a work item in a flow, or perform a flow action on an existing work item. This activity is known as the service activity.
    The system uses the value you enter in the Primary page class field as the applies to key part of the activity. The system creates a page with the name that you provide in the Page name field, and then passes that name to the activity as the primary page. If the Page name field is blank, the system passes the activity an unnamed page.

    Parameter values from the incoming request override the values that you set on this tab. On the Request tab, fields that map to keys that begin with param. override the values that you specify in this field.

  8. If you edit the parameters in the activity that you specified in the Activity name field in step 2, click Refresh parameters to display the changes in this section.

    If you edit the parameters in the activity that you specified in the Activity name field, click Refresh parameters to display the changes in this section.

    Note: The changes that you make in the service activity render in all service rule forms that use the service activity.
  9. To indicate that each use of this service is not to count as a service invocation under the terms of your license agreement, in the Processing options section, select Method is read-only.

    For more information, see Working with the License Compliance facility and service invocation.
  10. Click Save.

Configure the request for your Service Email rule. For more information, see Configuring the request for Service Email rules.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us