Setting Up ERMS System

This chapter provides an overview of email response management system (ERMS) setup and discusses how to:

• Define correspondence management for ERMS.

• Define system settings for email processing.

• Define mail servers.

• Define mail filters.

• Define mailboxes.

• Define email audit history tracking.

Understanding ERMS Setup

This overview describes:

• Mail servers and mailboxes.

• Email handling options.

• Email classification.

• ERMS application engine processes.

Note. This section does not discuss routing rules for structured or unstructured email.

See Also

Defining Structured Email Handling

Defining Unstructured Email Routing Rules

Mail Servers and Mailboxes

The ERMS system integrates with mail servers and mailboxes that you establish outside of the PeopleSoft system. You use PeopleSoft MultiChannel Framework and PeopleTools Integration Broker to manage the connection with these external systems.

You also establish mail server definitions and mailbox definitions within the ERMS system. The mail server definition is minimal: just the name of the physical mail server. The mailbox definition is more extensive. It includes connection-related settings (such as the password that is used to access the mailbox and the frequency with which the ERMS system fetches email from the external mailbox) as well as email handling options such as:

• Default group worklists to use for structured and unstructured emails.

• Time limits after which the system sends notifications that an email has not yet been closed.

• Auto-acknowledgement processing.

• The From address that is to be used for automatic responses to email that comes to this mailbox.

• Whether the mailbox is used for email from external customers or internal customers, which in turn controls which types of business objects can be associated with email sent to this mailbox.

  • Email sent to external mailboxes can be associated with consumers.

  • Email sent to internal mailboxes can be associated with workers.

    Use internal mailboxes in conjunction with PeopleSoft HelpDesk or PeopleSoft HelpDesk for Human Resources.

Note. Although you use pages in the Mailbox Definition component to set up the mailbox's routing rules for unstructured email, this chapter does not discuss those pages. Refer instead to the documentation for structured and unstructured email routing rules.

See Also

Understanding Structured Email

Understanding Unstructured Email Routing

Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft MultiChannel Framework

Email Handling Options

In addition to the mailbox-level options, there are several system-wide options.

Business Object Associations

The Mail Reader process (RB_MAIL_READ), which fetches email from an external mailbox and saves the email to PeopleSoft tables, analyzes the email's from address and looks for a customer, partner or worker (depending on the mailbox type: external, internal or partner) to associate with the email.

Every inbound email must be associated with a PeopleSoft CRM business object. If the Mail Reader process cannot identify the sender, select in each mailbox definition whether it should create a user based on the email address, or associate the email with a specific person record that you've chosen to represent all unknown users. The same unknown user setting applies to all mailboxes.

Email Reply Settings

In the System Installation component, define the following settings for email replies:

• The correspondence template that controls the format of the email history that the system automatically enters into the body text of an email reply.

  PeopleSoft delivers a template called Email History - Model 1 that you can use. If you do not explicitly select a template, the following default text appears above the text of the original email:

  <===== Received from <[email protected]> on <date.time>======>

• Whether the email history appears at the beginning or end of the reply.

  Initially, the email history is the only body text in the reply. Agents can manually add text anywhere. But if they apply templates, the system inserts the template text before or after the existing text depending on this system setting. That is, if you configure the system to keep the reply at the end of the reply, then newly applied template text is added to the beginning of the existing body text instead of being added at the end of the message.

• The greeting text to use when replying to an email. PeopleSoft delivers a template called EmailGreeting that you can use.

• The closing text to use when replying to an email. PeopleSoft delivers a template called EmailClosing that you can use.

• The subject text to use when replying to an email that has no subject.

Mail Filters

To boost the performance of the ERMS system and the productivity of the users who respond to email, PeopleSoft provides the ability to filter spam email and keep the spam from being analyzed and routed.

You can set up mail filtering based on the sender's email address—either a fully qualified email address or an entire domain. You can also use PeopleTools application classes to create your own email filters. The pages where you define mail filtering include an option to identify a custom application class to use.

You can choose whether to remove the spam entirely or whether to keep it in an exception area, where it remains available if you want to analyze filtering activity or if you want to look for email that was erroneously filtered out.

Email History Tracking

PeopleSoft provides two levels of email history tracking:

• An event history that is implemented in PeopleCode. The system automatically creates an email history record when one or more of these conditions take place:

  • An email is newly created.

  • Change of email status to canceled or complete.

  • Change of group worklist name, for example, when the email is reassigned.

  • An agent accepts the email.

• An audit history.

  The audit history displays field-level and record-level changes to email data. You set up audit processing using PeopleSoft Application Designer and the Audit - Setup page.

User Settings

The ERMS system leverages the user settings that you define for correspondence management, including:

• Approval processing.

  If you designate an approver for a specific user, any email replies that the user sends are routed to the approver, who can either approve or reject the reply. Use this option to ensure the quality and consistency of your customer communications and to monitor the development of your workforce.

• Default routing for responses to ad hoc email.

  If you use the ERMS system, each ad hoc email that is sent from the PeopleSoft CRM system includes a context tag. If the recipient replies to an ERMS mailbox, and if the reply contains the context tag, the system uses the context tag to identify the user who sent the original ad hoc email. The system then routes the reply to that user's default group worklist.

• Default From addresses for email replies that are sent by the agent.

  By sending replies from a system email address rather than a personal email address, agents can be sure that any response from the customer will be handled by ERMS. There are different defaults depending on whether the email is from an external mailbox, an internal mailbox, or an internal human resources mailbox.

System Activities

In the email workspace, agents can search for transactions that can be associated with the emails they work on, or create new transactions that support the completion of the emails, such as creating a lead, order or case. The ERMS system provides the infrastructure for you to reference the application class methods that are used to create those transactions for emails in the email workspace.

See Also

Defining System Settings for Email Processing

Setting Up Auditing for Cases and Inbound Email

Specifying User Settings

Email Classification

The ability to correctly identify the intent of unstructured email allows for more accurate suggestions to be given on solutions or actions to resolve customer issues or on templates when sending replies. In the ERMS system, an email can be classified using one or more of the following attributes:

• Category: high-level classification of an email (for example, inquiry, problem or spam).

• Type: subdivision under a given category (for example, hardware problem or software problem).

• Product Group: high-level product grouping (for example, air conditioner or refrigerator).

• Product: specific products under a given product group (for example, air conditioner with product ID A123 or fridge with product ID F234.

• Mood: email sender's general disposition (for example, disappointed, neutral, or happy).

• Priority: priority of the email.

• Language: language used in the email.

If natural language processing (NLP) integration is available, it returns and populates email classification data on the email workspace automatically based on content analysis. Agents can manually adjust these classification values if they need modification or if NLP is not available to provide automated suggestion. ERMS uses these values as search criteria to find matching solutions and actions that may resolve customer issue raised in the email, and matching templates to use for the email response.

See Also

Managing Email

Defining Template Categories and Types

Setting Up Products

Understanding Natural Language Processing

ERMS Application Engine Processes

ERMS relies on several PeopleSoft Application Engine processes to read email from an external mailbox, analyze and route the emails, reply automatically to structured email, and send alerts when email is not handled within the specified time period. The Understanding PeopleSoft ERMS chapter describes what these processes do; this section discusses setup tasks for the processes.

See ERMS Processes.

Process Parameters

To set up ERMS, you define:

• The number of emails that the Mail Reader process works with at a time.

• The process scheduler server where the ERMS processes run.

• The run frequency for processes other than the Mail Reader process.

  The Mail Reader process frequency is based on the polling frequencies that you define for your ERMS mailboxes.

• Run control information for the Build Collection process, which runs as part of the Unstructured Content Analysis job.

  The Build Collection process creates a Verity search collection that is used during email content-based routing.

Process Notifications

Because ERMS is dependent on its PeopleSoft Application Engine processes, prompt notifications of process failures can be important.

PeopleSoft Process Scheduler enables you to set up notifications that are sent when a process or job finishes successfully or when an error occurs in the process or job.

When you set up your ERMS system settings, process-specific links navigate you directly to the PeopleTools pages where you set up these notifications.

Defining Correspondence Management for ERMS

Correspondence management functionality is common to all PeopleSoft CRM applications. ERMS leverages this functionality extensively. Correspondence management is documented in detail in the PeopleSoft Enterprise CRM 8.9 Automation and Configuration Tools PeopleBook.

These correspondence management implementation steps are crucial to ERMS:

• Define worklists.

  If you use the Group Worklist page to create queues (so that agents can use the MultiChannel Console to accept inbound email), define your ERMS system settings before creating worklists. ERMS system settings include certain defaults that are required when creating queues from the Group Worklist page.

  See Defining Worklists.

  See Defining System Settings for Email Processing.

• Define general settings for correspondence.

  In particular, be sure to define agent settings such as approval requirements and default From addresses for outbound email.

  See Defining General Settings for Correspondence.

• Define settings for template-based correspondence.

  See Defining Settings for Template-Based Correspondence.

• Define correspondence templates.

  See Setting Up Correspondence Templates.

Defining System Settings for Email Processing

To define system settings for email processing, use the System Installation (RB_ERMS_INSTAL) component.

This section lists prerequisites and discusses how to:

• Define system settings for email processing.

• Define reply with history templates.

• Specify email greetings.

• Define subject text for replies to email with no subject.

• Specify email closing text.

• Define ERMS process notifications.

• Define system activities.

Prerequisites

Before you set up system settings for ERMS:

• Define the person who will represent all unknown senders.

  Set up this person in the worker component, and enter the minimum required data. The person's name appears on all emails whose sender is not identified, so enter a name such as Unknown Sender. This is, however, not necessary if you specify in the mailbox definition that you want the system to create a user automatically for unidentified email senders.

• Define correspondence templates that control the presentation of the email history that the system enters into the body text of the reply.

  You can use the delivered template Email History - Model 1 as a model for this. If you do not explicitly select a template, the following default text appears above the text of the original email:

  <===== Received from <[email protected]> on <date.time>======>

• If agents use the MultiChannel Console to receive inbound email, define the default multichannel queue clusters.

  This enables you to create multichannel queues from the CRM Group Worklist page; the queues use the default queue cluster that you establish.

See Also

Setting Up Correspondence Templates

Setting Up the Universal Queuing Infrastructure

Defining Workers

Common Elements Used in This Section

Pages Used to Define System Settings for Email Processing

Defining System Settings for Email Processing

Access the System Installations page.

System Settings

Mailbox And Queue Defaults

Content Analysis And Time Out Scheduler Sleep Time

Reply With History, No Subject, Verity Run Control

See Also

Setting Up and Using Worklists

Understanding PeopleSoft CRM Searching

Defining Reply with History Templates

Access the History Templates page.

Template Name

Select the template for the system to use when entering the text of the original inbound email to the body of the new outbound email. Select a template, not a template package. At a minimum, the templates that you select must contain the text of the original email; use the delivered History Email Body term for this. Optionally, you can include front matter or end matter in the appropriate language.

See Also

Setting Up Correspondence Templates

Specifying Email Greetings

Access the Greeting Templates page.

Template Name

Select the template for the system to populate a greeting in the new outbound email. Select a template, not a template package.

See Also

Setting Up Correspondence Templates

Defining Subject Text for Replies to Email with No Subject

Access the No Subject Phrase page.

Language Code	Enter a language code. At runtime, the preferred language of the user who is sending the email determines which settings are used.
No Subject Phrase	Enter a default subject to use for replies to email with no subject text, to avoid sending replies with insufficient identifying information in the subject.

Specifying Email Closing Text

Access the Closing Templates page.

Template Name

Select the template for the system to populate a closing message in the new outbound email. For example, a disclaimer from your company. Select a template, not a template package.

See Also

Setting Up Correspondence Templates

Defining ERMS Process Notifications

Access the Process Notifications page.

The grid on this page lists all ERMS processes: five PeopleSoft Application Engine processes and one job, which consists of two other PeopleSoft Application Engine processes.

See Also

Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Process Scheduler

Defining System Activities

Access the System Activities page.

Enable	Select the transactions that agents can search for or create within the email workspace and associate them with email.
Activity Type	Select the CRM object that agents can create from the email workspace.
Application Class ID and Application Class Path	Specify the path and ID of the application class program that is written to create transactions of the corresponding CRM object.

See Also

Related Transactions

Defining Mail Servers

This section lists prerequisites and discusses how to register mail servers in the ERMS system.

Prerequisites

Before you define mail servers and mailboxes within the ERMS system, you must:

1. Set up the external mail servers and mailboxes that the ERMS system will monitor.

   You set up physical mail servers and mailboxes outside of the PeopleSoft system. The PeopleSoft ERMS system supports both POP3 and IMAP4 email protocols.

2. Set up the integration between these external systems and your PeopleSoft system:

   1. Configure the PeopleSoft Integration Broker gateway for the email channel.

   2. Configure the GETMAILTARGET connector properties on the MCF_GETMAIL node.

      Make sure that all of the transactions of MCF_GETMAIL node are set to active in the Transaction Detail page. For more information on nodes, refer to the Administering Basic Integrations part of the PeopleSoft Integration Broker PeopleBook.

      See Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Integration Broker

The PeopleSoft MultiChannel Framework documentation discusses these processes in the chapter on configuring the email channel.

See Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft MultiChannel Framework

Page Used to Define Mail Servers

Registering Mail Servers in the PeopleSoft System

Access the Mail Server Definition page.

Mail Server Name

Enter a row of data for each mail server that the ERMS system will access. The name that you enter here must match the name of the physical mail server. When you set up mailboxes, you will associate each mailbox with one of the mail servers that are listed here. This association gives the Mail Reader process the information it needs to find the external mail server from which the mailbox's emails are fetched.

Defining Mail Filters

To define mail filters, use the System Parameters/Defaults (RB_ERMS_SETUP) component.

This section discusses how to:

• Set up address-based and domain-based filters.

• Create application classes for custom mail filtering.

• Apply email filters.

Pages Used to Define Mail Filters

Setting Up Address-Based and Domain-Based Filters

Access the Spam List page.

Email Address/Domain Name	Enter a full email address or a domain name from which you want to block all email.
Type	Select Email or Domain to indicate the type of address being blocked.

Note. To activate the filters that you set up on this page, access the Mail Filters page and ensure that the delivered SYS_SPAM_LIST filter is active.

Creating Application Classes for Custom Mail Filtering

To implement mail filtering other than by email address or domain, create an application class method that identifies the emails to be discarded.

PeopleSoft provides a base class called MailFilter that you extend when creating your own filters. The delivered base class is in the RB_MCF_SETUP package. PeopleSoft also delivers the SYS_SPAM_LIST class, which you can clone as a starting point.

Properties of the Base Class

This table explains the base class properties:

MailFilter(&Row1 As Row) Method

The MailFilter(&Row1 As Row) method uses the &Row1 parameter to populate the DomainName, FromEmailAddress, and EmailRow properties of the class. It accepts this parameter:

There are no return parameters.

IsFromEmailAddressValid() Method

IsFromEmailAddressValid() sets a Boolean value that indicates whether the email is valid. When you create your own mail filters, your custom logic goes here. The returned value is trapped by the Mail Reader process and used as follows:

Sample Code

This sample code filters out email from [email protected]:

import RB_MCF_SETUP:*;

class CstmFilter1 extends MailFilter;
   method CstmFilter1(&Row1 As Row);
   method IsFromEmailAddressValid() Returns boolean;
end-class;


method CstmFilter1
   /+ &Row1 as Row +/
   %Super = create MailFilter(&Row1);
   
end-method;

method IsFromEmailAddressValid
   /+ Returns Bool +/
   If (%This.FromEmailAddress = "[email protected]") Then
      Return False;
   Else
      Return True;
   End-If;
   
end-method;

See Also

Enterprise PeopleTools 8.45 PeopleBook: PeopleCode Developer's Guide

Enterprise PeopleTools 8.45 PeopleBook: PeopleCode Reference

Applying Email Filters

Access the Mail Filters page.

Mail Filter ID and Description	Enter a name and description for your custom mail filter. PeopleSoft delivers a mail filter with the ID SYS_SPAM_LIST. This filter blocks email from the addresses and domains that you enter on the Spam List page. You cannot edit or delete the data for this filter.
Active Flag	Select to activate the mail filter. The email addresses and domain filters that you set up on the Spam List page are active only if you activate the SYS_SPAM_LIST filter here.
Package Tree Viewer, Application Class ID, and Application Class Path	Enter the ID and path for an application class that performs custom mail filtering. Click the Package Tree Viewer link to access the Application Packages Lookup page, where you can browse for application classes and select one to use.
Retain Email Body As Exception	If selected, the ERMS Mail Reader process saves the text of any email that has been blocked by this filter. The blocked email is not routed for handling, but an administrator can review the blocked emails on the Exception Email Details page. If cleared, you can still review summary information about the email on the Mail Reader Process Log page, but you will not be able to view the email's body text.

See Also

Using Application Classes

Reviewing Exception Email

Defining Mailboxes

To define mailboxes, use the Mailbox Details (RB_MAILBOX_DEFN) component.

This section lists prerequisites and discusses how to:

• Define mailbox settings.

• Clone a mailbox.

Note. This section discusses only the general-purpose pages in the Mailbox Details component: the Mailbox Definition page and the Clone Mailbox page. Other pages in the component are used to set up email routing rules and are described in that context.

See Also

Defining Unstructured Email Routing Rules

Prerequisites

Before you begin defining mailboxes, define the mail server for the mailbox.

Also, define these users and group worklists that are associated with the mailbox:

• The worklist owner (a worker).

• The mailbox's default group worklist.

• The group worklist to which structured email is sent if the application service cannot send an automated reply.

These prerequisites are required only if you want to implement the associated functionality:

• To define an auto-acknowledgement message for this mailbox, first create the template and a template package that contain the text of the auto-acknowledgement message.

• To define customer-based routing, first create the application class that is invoked during customer-based routing.

Pages Used to Define Mailboxes

Defining Mailbox Settings

Access the Mailbox Definition page.

Mailbox ID and Description	Displays the mailbox ID and enter a mailbox description. The ID is used for internal purposes only and does not have to relate to the actual email address that is represented by this mailbox. The description appears in several places throughout the system, so be sure to enter a meaningful description.
Status	Select a status. Options are Active and Inactive. The Mail Reader process fetches inbound email only from active mailboxes.
Clone Mailbox	Click the button to access the Clone Mailbox page and create a new mailbox based on this mailbox definition.
Mailbox Type	Select External if this mailbox receives email from external customers. For example, your sales and customer support email boxes are external. Select Internal if you use this mailbox in conjunction with PeopleSoft HelpDesk, and select Internal HR if you use this mailbox in conjunction with PeopleSoft HelpDesk for Human Resources. This setting controls which types of people (workers or customers) are associated with the email that this mailbox receives. Also, when agents reply to such email, this setting determines the default From address of the reply. Configure the default From addresses on the Agent Setup page for correspondence management.

Email Address Information

The Mail Reader process uses the information in these fields to fetch email from this mailbox. These fields are relevant to both structured and unstructured email.

Email Handling

Auto Acknowledgement

Create New Customer

Use this group box to configure how the mailbox behaves if the mail reader process cannot identify email senders from the database.

Unstructured Email Processing

See Also

Specifying User Settings

Defining Unstructured Email Routing Rules

Setting Up Automated Mail Processing

Email Sender Identification

Using Application Classes

Cloning a Mailbox

Access the Clone Mailbox page.

Save As Mailbox ID and Description

Enter IDs and descriptions for the mailboxes that you want to create.

Click the OK button to create mailbox definitions using the IDs and descriptions that you entered. The new mailbox definitions are exact duplicates of the current mailbox definitions except for the ID and description fields.

Defining Priorities and Moods

This section discusses how to:

• Define priorities.

• Define moods.

Pages Used to Define Priorities and Moods

Define Priorities

Access the Priority Setup page.

Values in this grid are used to give priority to email after the content analysis. It is displayed for email in the email workspace.

Defining Moods

Access the Mood Setup page.

Values in this grid are used to describe what the customer mood is in email after the content analysis. It is displayed for email in the email workspace.

Defining Email Audit History Tracking

This section discusses how to define email audit history tracking in the CRM system.

Page Used to Define Email Audit History Tracking

Defining Email Audit History Tracking

See Setting Up Auditing for Cases and Inbound Email.