Setting Up ERMS System

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

Click to jump to parent topicUnderstanding ERMS Setup

This section discusses:

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

See Also

Understanding Structured Email

Understanding Unstructured Email Routing

Click to jump to top of pageClick to jump to parent topicMail 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: it is 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:

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 unstructured email routing rules.

See Also

Understanding Structured Email

Understanding Unstructured Email Routing

Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft MultiChannel Framework

Click to jump to top of pageClick to jump to parent topicEmail Handling Options

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

Business Object Associations

The mail reader process, which fetches each email from an external mailbox and saves it to PeopleSoft tables, analyzes the from address of the email and looks for a customer, partner, or worker (depending on the mailbox type: external, partner, or internal) 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:

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 filtered out erroneously.

Email History Tracking

PeopleSoft provides two levels of email history tracking:

User Settings

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

Note. These user settings are available for setup on Supervisor Desktop.

System Activities

On the email workspace, agents can search for transactions that can be associated with the emails that 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 on the email workspace.

See Also

Defining System Settings for Email Processing

Understanding Audit Information

Defining User Settings

Click to jump to top of pageClick to jump to parent topicEmail Classification

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

Agents can manually adjust these classification values if needed. ERMS uses these values as search criteria to find matching solutions and actions that may resolve customer issues raised in the email, and to find matching correspondence templates for the email response.

See Also

Associating Categories with Recommended Actions

Managing Email

Defining Template Categories and Types

Setting Up Products

Click to jump to top of pageClick to jump to parent topicERMS Application Engine Processes

ERMS relies on several PeopleSoft Application Engine (AE) processes to read emails from an external mailbox, analyze them, take proper email actions, and send alerts when they are not handled within the specified time period. The ERMS Processes section of the Understanding ERMS chapter describes what these processes do; this section discusses setup tasks for these processes.

See ERMS Processes.

Process Parameters

To set up ERMS, you define:

Process Notifications

Because ERMS depends on its PeopleSoft AE 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.

Click to jump to top of pageClick to jump to parent topicMail Reader Error Handling Options

ERMS Mail Reader uses PeopleTools APIs to fetch emails from the mail server. When an email is not fetched successfully, these APIs return an error code. Mail Reader invokes the Error Mail Handler using this error code to take the appropriate action.

The setup for handling mail reader errors includes these steps:

  1. Define actions.

    See Defining Actions.

  2. Define action groups.

    See Defining Action Groups.

  3. Map action groups and error codes.

    The system triggers desired actions based on the error that occurs.

    See Mapping Action Groups and Error Codes.

Delivered Actions

This table provides a list of system-delivered action codes:

Action Code

Description

CUSTM

Customized Action List Application Class

DELEML

Delete Email from Mail Server

INACTM

Inactive or Skip the same Mailbox

LGTBL

Log into Exceptional Table

NDFWL

Not to Routing To Default Worklist

NSTEML

Not to store Email in CRM tables

NTFY

Notify Action

RETEML

Retain Email from Mail Server

STEML

Store Email in CRM table

Delivered Action Groups

This table provides a list of system-delivered action groups:

Action Group

Description

000

Successful

001

Connector Size Overflow

002

PSFT IB threshold Size Overflow

004

Connecting to the mail server failed

007

Unsupported Encoding

008

Cannot write to the attachment Repository

009

Messages were downloaded to repository and deleted from mail server

010

Generic Email Connect Error

013

Internal Error

9993

Integration Broker or Gateway Problem. Please Check with the Administrator

9994

Not able to fetch further email. Too many bad emails

9995

UID Empty

9996

Inbound Email CI Save Error!

9997

Inbound Email CI Create Error!

9998

Abort Error

9999

Unknown Error

See Also

Viewing Email Error Logs

Click to jump to parent topicDefining 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 9.1 Automation and Configuration Tools PeopleBook.

These correspondence-management implementation steps are crucial to ERMS:

Click to jump to parent topicDefining 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 common elements and discusses how to:

Click to jump to top of pageClick to jump to parent topicPrerequisites

Before you set up system settings for ERMS:

See Also

Setting Up Correspondence Templates

Setting Up Universal Queuing

Defining Workers

Setting Up an Anonymous Business Object

Click to jump to top of pageClick to jump to parent topicCommon Element Used in This Section

Language Code

Select the language for which you are defining templates. The language that you select limits the prompt on the Template Name field so that you can select only templates of the appropriate language. At runtime, the preferred language of the user who is sending the email determines which settings are used.

Click to jump to top of pageClick to jump to parent topicPages Used to Define System Settings for Email Processing

Page Name

Definition Name

Navigation

Usage

System Installations

RB_ERMS_SYSDEFN

Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, System Installations

Define settings for email processing, including:

  • General email handling options.

  • Mailbox and queue defaults.

  • Processing rules for the mail reader process and other ERMS processes.

History Templates

Greeting templates

No Subject Phrase

Closing Templates

RB_ERMS_TMPL_DEFN

  • Click the Set Up History Template button on the System Installations page.

  • Click the Set Up Greeting Template button on the System Installations page.

  • Click the Set Up Closing Template button on the System Installations page.

  • Click the Set Up No Subject Phrase button on the System Installations page.

  • Define reply with history templates.

  • Specify email greetings.

  • Define the default subject text to use when replying to an email that has no subject.

  • Specify closing text for email.

Process Notifications

RB_PRCS_NOTIFY

Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, Process Notifications

Define notifications for the PeopleSoft AE processes that are used in ERMS.

Job Notification

PRCSJOBNOTIFY

On the Process Notifications page, click the Setup Process Notifications link next to an unstructured content analysis job.

Define the messages that are to be sent when a job finishes successfully or when an error occurs in the job.

See Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft Process Scheduler

System Activities

RB_EM_ACTIVITY

Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, System Activities

Define system activities.

CRM objects can be created from the email workspace. Specify corresponding application classes that are used to create them on this page.

Click to jump to top of pageClick to jump to parent topicDefining System Settings for Email Processing

Access the System Installations page (Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, System Installations).

System Settings

Commit Frequency For Emails

Enter the number of emails that the mail reader process handles between commits. The mail reader process reads emails from an external mailbox and copies the data into the PeopleSoft CRM database. The data is saved only when the mail reader process issues a commit command.

Higher numbers improve performance. Lower numbers minimize the amount of reprocessing that must be done when a process failure occurs. (Because the mail reader process removes email from the external mailbox only after committing the data, mail reader process interruptions cause reprocessing, but do not result in lost data.) The default value is 10.

ERMS Process Scheduler

Enter the process scheduler server on which the ERMS processes run. Because ERMS is process-intensive, setting up a dedicated ERMS process scheduler server improves performance.

Use Email Workspace while responding to an existing notification

Select to have the system launch the email workspace for agents to compose and send response to existing email. If this option is clear, the system launches the Outbound Notification page for sending email replies.

Process customer response as new email

Select to have the system route any incoming threaded email as a new mail, namely using the usual routing rules for unstructured email. For example, if the system successfully identifies a context tag in the incoming threaded email, it sends the inbound email to the last group worklist associated with the previous inbound email.

See Routing Methods.

If this option is clear, the inbound email is routed to the group worklist to which the sender of the previous outbound email belongs.

Add every notification as Note to the Associated Case

Select to have the system add a note to a case whenever an inbound email is received or outbound email sent for that case. If the email contains attachments, they are added as case note attachments. The system creates an interaction for each inbound and outbound email.

This feature applies to reminders as well (for cases).

See Understanding Notes and Attachments.

Mailbox and Queue Defaults

Warning Notification, Routing Rule Type, Auto Acknowledgement, and Automatic Routing

Set default values for the identically named fields on the Mailbox Definition page. These fields control mailbox-level characteristics, such as email routing, response time alerts, automatic acknowledgements, and so on.

See Defining Mailboxes.

REN Server Cluster ID (real-time event notification server cluster ID)

Set a default queue cluster to be associated with queues that the system creates when you set up queues and agents using PeopleSoft CRM group worklists.

Maximum Workload and Skill level

Set default values to be associated with agent definitions that the system creates when you set up queues and agents using PeopleSoft CRM group worklists. The values in these fields are used to determine an agent's capacity to accept additional work and thus to determine the agent to whom a new email is routed.

Content Analysis and Time Out Scheduler Sleep Time

Mail Processor Sleep Time

Enter the frequency with which to run the email process, which attempts to trigger proper email actions, including routing emails to worklists. This frequency determines how quickly new email is routed to agents for handling and thus can affect your agent's ability to meet email due dates.

Time Out Scheduler Sleep Time

Enter the frequency with which to run the Time Out Process Handler process, which schedules reminder notifications for emails that have not been closed within the mailbox-level or worklist-level response times.

Unit of Time

For each sleep time that you define, enter Minutes, Hours, or Days as the unit of time.

Build Collection Run Control, Directories, Reply With History On, Templates and No Subject Phrase

Build Collection Run Control

Enter the run control name to be used when running the Build Collection process. When you save the page, the system creates a run control for the Build Collection process using the run control name that you enter here. The run control that the system creates is for the search collection CRM_RB_ERMS. PeopleSoft delivers definitions for the collection and its search index templates.

After saving this page, access the Build Search Collection page to complete the run control settings. In particular, be sure to set up the collection directory.

Collection Directory

Enter the directory path for the collection. The path is relative to the Process Scheduler server where the process runs, not to the computer where the request is made. If Process Scheduler is running on the application server, the path that you enter here matches the Verity collection path on the application server.

Any mapped drive must be set as part of the PS_CFG_HOME environments variable.

Reply With History On

Select Bottom or Top to determine whether the text of an inbound email is kept at the beginning or end of a reply. For example, if you select Bottom, then applying a template to the outbound email inserts the template text before any existing body text.

Spam Category

Specify the category to be used for spam mail. The system-delivered category is called Spam.

Set Up History Template

Click to access the History Templates page, where you select language-specific templates to be applied when agents choose to include the original email text in an email reply.

If you do not explicitly set up history templates, the following default text appears above the text of the original email:

<===== Received from <address@service.domain> on <date.time>======>

Set Up Greeting Template

Click to access the Greeting Templates page, where you select language-specific greeting text phrases to be applied when agents respond to incoming email.

Set Up Closing Template

Click to access the Closing Templates page, where you select language-specific closing text phrases to be applied when agents respond to incoming email.

Set Up No Subject Phrase

Click to access the No Subject Phrase page, where you enter language-specific text phrases to be used as the subject of an email reply when the original email does not have a subject.

See Also

Setting Up and Using Worklists

Understanding PeopleSoft CRM Searching

Click to jump to top of pageClick to jump to parent topicDefining Reply With History Templates

Access the History Templates page (click the Set Up History Template button on the System Installations 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

Click to jump to top of pageClick to jump to parent topicSpecifying Email Greetings

Access the Greeting Templates page (click the Set Up Greeting Template button on the System Installations page).

Template Name

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

See Also

Setting Up Correspondence Templates

Click to jump to top of pageClick to jump to parent topicSpecifying Email Closing Text

Access the Closing Templates page (click the Set Up Closing Template button on the System Installations page).

Template Name

Select the template for the system to include 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

Click to jump to top of pageClick to jump to parent topicDefining Subject Text for Replies to Email with No Subject Text

Access the No Subject Phrase page (click the Set Up No Subject Phrase button on the System Installations page).

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.

Click to jump to top of pageClick to jump to parent topicDefining ERMS Process Notifications

Access the Process Notifications page (Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, Process Notifications).

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.

Setup Process Notifications

Click to access the Processes - Notification page (for any of the PeopleSoft AE processes) or the Job Notification page (for the unstructured content analysis job). These are both PeopleSoft Process Scheduler pages. Use these pages to define messages to be sent when the process or job finishes successfully or when an error occurs in the process or job.

See Also

Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft Process Scheduler

Click to jump to top of pageClick to jump to parent topicDefining System Activities

Access the System Activities page (Set Up CRM, Product Related, Multichannel Definitions, Email, System Installation, System Activities).

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

Click to jump to top of pageClick to jump to parent topicIdentifying Email Workspace Fields for Mapping

See Identifying Email Workspace Fields for Mapping.

Click to jump to parent topicDefining Mail Servers

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

Click to jump to top of pageClick to jump to parent topicPrerequisites

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 on the Service Operations: General page. For more information about nodes, refer to the Configuring Nodes chapter of the Enterprise PeopleTools 8.50 PeopleBook: Integration Broker Administration.

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

See Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft MultiChannel Framework

Click to jump to top of pageClick to jump to parent topicPage Used to Define Mail Servers

Page Name

Definition Name

Navigation

Usage

Mail Server Definition

RB_MAILSERVER_DEFN

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Mail Server Definition

Define mail servers in the ERMS system.

Click to jump to top of pageClick to jump to parent topicRegistering Mail Servers in the ERMS System

Access the Mail Server Definition page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Mail Server Definition).

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 that it needs to find the external mail server from which the mailbox's emails are fetched.

Click to jump to parent topicDefining Mail Filters

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

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Define Mail Filters

Page Name

Definition Name

Navigation

Usage

Spam List

RB_SPAM_LIST_DEFN

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Spam List

Set up address-based and domain-based filters.

Mail Filters

RB_ERMS_SETUP

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Mail Filters

Activate the filters that you set up on the Spam List page, and apply your own custom email filters.

Click to jump to top of pageClick to jump to parent topicSetting Up Address-Based and Domain-Based Filters

Access the Spam List page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Spam List).

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.

Click to jump to top of pageClick to jump to parent topicCreating 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:

Property

Description

EmailRow

Identifies a row of data that is retrieved by the PeopleTools MCFGetMail application programming interface (API) using the Message Structure MCFEM_RES_READALL. This message is made up of the MCFEM_RES_MAIN record and its child record MCFEM_RES_PART.

DomainName

The domain from the sender's email address.

The MailFilter constructor populates this property for the specified email.

FromEmailAddress

The sender's full email address.

The MailFilter constructor populates this property for the specified email.

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:

Input Parameter

Description

&Row1

A row type object for which the main record is MCFEM_RES_MAIN.

No return parameters are available.

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 is used in this way:

Return Value

Description

False

The email is considered to be an exception email and is discarded before any further processing takes place.

True

The email is valid.

Sample Code

This sample code filters out email from support@abc.com:

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 = "support@abc.com") Then Return False; Else Return True; End-If; end-method;

See Also

Enterprise PeopleTools 8.50 PeopleBook: PeopleCode Developer's Guide

Enterprise PeopleTools 8.50 PeopleBook: PeopleCode Language Reference

Click to jump to top of pageClick to jump to parent topicApplying Email Filters

Access the Mail Filters page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, System Parameters/Defaults, Mail Filters).

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.

Status

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.

Application Class ID, Package Tree Viewer, 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

Select to have the ERMS mail reader process to save 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 this option is 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

Click to jump to parent topicDefining Mailboxes

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

This section lists prerequisites and discusses how to:

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

Understanding Unstructured Email Routing

Click to jump to top of pageClick to jump to parent topicPrerequisites

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:

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

Click to jump to top of pageClick to jump to parent topicPages Used to Define Mailboxes

Page Name

Definition Name

Navigation

Usage

Mailbox Definition

RB_MAILBOX_DEFN

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Mailbox Definition

Define a mailbox, its connection settings, and its email handling options.

Recommended Actions

RB_MB_RECMDACTIONS

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Recommended Actions

Associate categories with actions, which appear in email workspace as recommended actions.

Mailbox Activity List

RB_MBOX_ACTIVITY

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Mailbox Activity List

Specify the list of activities to be used in the email workspace for users to search for recent activities and create new ones.

Clone Mailbox

RB_MBOX_SAVEAS

Click the Clone Mailbox button on the Mailbox Definition page.

Clone an existing mailbox.

Default Solution Template

RB_EM_SOL_TMPL

Click the Set Default Solution Template button on the Mailbox Definition page.

Select a default solution template.

Click to jump to top of pageClick to jump to parent topicDefining Mailbox Settings

Access the Mailbox Definition page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Mailbox Definition).

Mailbox ID and Description

Displays the mailbox ID. 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.

Be sure to enter a meaningful description for the mailbox because the description appears in several places throughout the system.

Status

Select a status: Active or Inactive. The Mail Reader process fetches inbound email from active mailboxes only.

Clone Mailbox

Click 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 H (Internal HR) if you use this mailbox in conjunction with PeopleSoft HelpDesk for Human Resources.

Select Higher Ed if you use this mailbox to receive Higher Education-specific email messages.

Select Partner if you use this mailbox to receive email messages for partners.

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 or from the Supervisor Desktop.

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

Mail Server Name

Enter the name of the mail server for this mailbox.

Email Account

Enter the name of the mailbox on the mail server. This is the name that your email system uses to identify the email account; it may not match the email address.

Password and Confirm Password

Enter a password that the ERMS mail reader process can use to access the mailbox. Passwords are case-sensitive. To keep your password secure, the system displays asterisks instead of the text that you enter. Because you cannot visually verify that you have entered the correct password, you must confirm your data entry by entering the password twice.

Email Handling

Reply to Address

Enter the email address from which automatic replies are sent. The reply to address can be the same as the current mailbox, or it can be any other mailbox that you set up in the ERMS system.

This is also the default from address for manual email responses that are sent by users who do not have a user-specific default from address.

Mailbox Owner

Enter the name of the person in the CRM system who has the overall responsibility for the mailbox. The system sends this person notifications for each email that has not been closed (indicated with a Complete status) within the warning and final notification time frames. The mailbox owner can accept or take ownership of any email if he is also a member of the worklist to which the email is routed.

Admin Group Worklist (administrator group worklist)

Select the group worklist where emails are routed when processor or system-related errors occur. For example, if the automatic mail processing (AMP) rules engine fails and cannot process emails, they are sent to this worklist and reviewed by administrators. This is a required field.

Default Group Worklist

Enter the default group worklist. Email that is sent to this mailbox is routed to the default group worklist in these situations:

  • The automatic routing option is not selected for this mailbox.

    If the Automatic Routing check box is clear, all incoming email messages are sent to the default worklist directly and they do not go through any mail processes.

  • The inbound email contains a context tag, but the thread-based routing routine is unable to identify a worklist.

  • The mail process is unable to identify a worklist.

  • The rules engine for AMP is unable to perform actions on the email.

Warning Notification, Final Notification, and Unit of Time

Enter the time period after which the system will send notifications to the mailbox owner if the email has not yet been closed. Select Minutes, Hours, or Days as the unit of time for these time periods.

The external mailbox records the time and date when the email arrives in the ERMS system; this is the starting point for the warning and final notification period deadline. The time period is calculated using a 24-hour clock, without regard to your organization's business hours.

The final notification time is the deadline for responding to and closing the email. The warning notification time alerts the mailbox owner that the organization is at risk for missing the deadline. Therefore, the warning notification time is shorter than the final notification time.

The system resets the external time that the email is forwarded to another mailbox.

Polling Frequency and Unit of Time

Enter the frequency with which the mail reader process pulls incoming email from the mail server into the PeopleSoft database. Select Minutes, Hours, or Days as the unit of time for the polling frequency.

To minimize connection-related overhead while still ensuring prompt receipt of incoming email, poll mailboxes that receive the heaviest traffic are polled more frequently than less-frequently used mailboxes.

Language Code

Select the language in which the mailbox is processing.

Default Business Unit

Enter a business unit for the mailbox definition to be used for the creation and search of transactions, as well as for business object search that is initiated from email. For example, if an agent creates a case from an email, the business unit that is specified in this email's mailbox becomes the business unit for the newly created case. If you perform a business object search on an email, the search is refined by the mailbox's business unit.

If the feature to create cases for inbound email is enabled for a group worklist, and in order to create a case for an inbound email, the system needs to access the mailbox definition of that inbound email to identify the email business unit, the default business unit is then used as the email business unit to derive the appropriate business unit and display template family for the new case. This condition applies if the mailbox that is associated with the inbound email is of type Internal, Internal H, or Higher Education.

This field is unavailable for external or partner type mailboxes.

See Defining Group Worklists.

Set Default Solution Template

Click to specify a template that is used to apply to solutions that can be submitted along with emails.

To make a template available for solutions, add the solution usage to this template's package.

Templates are language-specific.

Email Business Unit Mapping

This section appears if the mailbox type is External, or Partner. This customer setID and email business unit mapping is used for the feature that, when enabled for a group worklist, creates cases for inbound email that are routed to that group worklist. The system uses the business unit and display template family code that are specified in group worklist definition to construct the case prior to populating email data to the case. If these default values are not specified for the group worklist, the system goes to the mailbox definition for the inbound email to collect the needed information from the email business unit mapping. First of all, the system identifies the setID of the email sender, who is also the customer of the new case. Then, it looks at the mapping to find out the matching email business unit. From the definition of the matching email business unit, the system knows which business unit and display template family to use for the case.

For mailboxes of types Internal and Internal HR, the default business unit is used as the email business unit to derive the corresponding business unit and display template family for case creation.

Information in this section is not used if the case defaulting information is already specified in the group worklist definition.

Default, Customer Setid and Email Business Unit

Enter a setID of case customers and map it with an email business unit, which is associated with business units and display template families that the system uses to create cases and other supported CRM transactions. The selected setID determines the list of email business units available for selection by tableset control.

If a customer setID cannot be identified from the inbound email successfully, the entry marked as Default is used for case creation.

See Defining Group Worklists.

Auto Acknowledgement

Always Auto-Acknowledge

Select to make the system automatically send an acknowledgement response to every email that is sent to this mailbox. The automated acknowledgement is sent after the email is routed to a worklist.

Only while not Auto-Responding

Select to make the system automatically send an acknowledgement response only if it cannot provide an automated reply. This option works with the rule and action setup for AMP. If the action that the rules engine can trigger for an email is an auto-response, no automated acknowledgement response is sent. Otherwise, an automated acknowledgement is sent to the email sender.

Determine from Rule

Select to let the rules engine decide whether to send automated acknowledgement for email.

At runtime, the rules engine processes each email that arrives and triggers automated acknowledgement action if the conditions are satisfied. If the action cannot be performed, it will be recorded in the AMP log.

If you select this option, you may want to add the auto-acknowledgement action to all the rules that are associated with the mailbox, because the rules engine triggers the auto-acknowledgement action only if this option is selected. This action is bypassed if another option in this group box is selected.

Never Auto-Acknowledge

Select to stop the system from sending any automatic acknowledgment response.

Template Package

Select the template package that defines the text of the acknowledgement email if you select Always Auto-Acknowledge or Only while not Auto-Responding. This package must include a template that can be used for the email channel. Because the system may not be able to identify the person to whom the acknowledgement is being sent, the template should not include any recipient-based terms.

PeopleSoft delivers a package called Auto Acknowledgement that you can use for this purpose.

Create New Customer

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

Create new user based on Email

Select to let the system create a new user based on the setting of the business unit that is associated with the mailbox. The ERMS system creates the user with a role type that is appropriate to the type of the mailbox (for example, the user is in a role type of worker if the mailbox is for internal use). The mail reader process derives the user name from the email address. For the email address user@domain.com, the first name of the user would be user@ and the last name domain.com.

Using Anonymous User

Select to let the system assign the email to the anonymous user who is specified on the Anonymous Object page of the Installation Options component. If the mailbox type is Internal or Internal HR, the system uses the default Anonymous Employee entry (with the Worker role type) to derive the BO ID; for other mailbox types, the Anonymous User entry (with the Individual Consumer role type) is used. When you view the email from the email workspace, the role type of this unknown user is not provided and the representing information is unavailable.

Unstructured Email Processing

Application Class ID, Application Class Path, and Package Tree Viewer

Enter the ID and path for the application class to be used to activate customer-based routing rules that you have programmed using application classes. 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.

PeopleSoft does not deliver any application classes for customer-based routing; you must create your own. For example, if you integrate with PeopleSoft Enterprise Performance Management, you could create an application class that routes email based on the customer value.

See Defining Customer-Based Routing Rules.

Routing Rule Type

Select the method to be used when calculating worklist scores for this mailbox's email. Two ways to calculate worklist scores are available: Average Query Group Score and Highest Query Group Score. The system routes the email to the worklist with the highest worklist score.

Automatic Routing

Select to route all incoming email based on processing by Verity search.

Clear this check box to bypass any email process (such as the thread-based, customer-based, context-based, and content-based routing) and send all incoming email directly to the mailbox's default group worklist.

See Also

Defining User Settings

Understanding Unstructured Email Routing

Understanding Automated Mail Processing

Email Sender Identification

Using Application Classes

Click to jump to top of pageClick to jump to parent topicAssociating Categories with Recommended Actions

Access the Recommended Actions page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Recommended Actions).

For each selected category on this page, associate it with one or more ERMS-related actions. When an email is assigned a category (either as default by the system or manually by an agent) at runtime, the associated recommended actions appear on the Email page (under the Assistance section). The sequence number dictates the order in which the actions appear at runtime.

See Also

Assistance

Click to jump to top of pageClick to jump to parent topicConfiguring the Activity List

Access the Mailbox Activity List page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Servers and Security, Mailbox Details, Mailbox Activity List).

Recent Activity Default Rows

Enter the maximum number of activity rows that users see from the activity result grid on the Recent Activities tab on the Email page.

Activity Type

Select the types of transactions (activities) that can appear when the email workspace retrieves the default activity result list initially.

At runtime, all the transactions that are enabled, together with emails, appear in the Activity Type field on the Recent Activities tab on the Email page.

Create New

Select to enable users to create the corresponding transaction at runtime by clicking the Create New link that appears on the Recent Activities tab on the Email page. The link appears when the transaction that has this option enabled is selected in the Activity Type field. If users do not have the permission to create that transaction, they are notified with a system message.

Quick Create

Select to let the system display the Create New <CRM transaction> button for the corresponding transaction at runtime.

For example, if you select this check box for the support case transaction, the Create New Support Case button appears on the Email: Main page.

See Also

Assistance

Click to jump to top of pageClick to jump to parent topicCloning a Mailbox

Access the Clone Mailbox page (click the Clone Mailbox button on the Mailbox Definition 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.

Click to jump to parent topicDefining Email Business Units

This section discusses how to define email business units.

Click to jump to top of pageClick to jump to parent topicUnderstanding Case Creation for Inbound Email

At the group worklist level, an option is available that, when selected, allows the system to automatically create a case for every unstructured inbound email routed to that group worklist. The system uses the business unit and display template family that are specified in the group worklist definition to generate cases for inbound email.

If this information is not available in the definition, the system accesses the mailbox definition of the inbound email and uses the setID of the email sender (which is also the customer of the new case) to derive the corresponding email business unit from the Email Business Unit Mapping section.

In an email business unit definition, you specify the default business units for a list of common CRM transactions, which are used for creating these transactions. Additionally, you specify the display template family to be used for each mailbox type for the purpose of case creation.

See Defining Group Worklists.

Click to jump to top of pageClick to jump to parent topicPage Used to Define Email Business Units

Page Name

Definition Name

Navigation

Usage

Email Definition

BUS_UNIT_TBL_RB

Set Up CRM, Business Unit Related, Email Definition, Email Definition

Associate an email business unit with business units of other CRM transactions and case display template families, which are used for creating transactions from email.

Click to jump to top of pageClick to jump to parent topicDefining Email Business Units

Access the Email Definition page (Set Up CRM, Business Unit Related, Email Definition, Email Definition).

Business Unit Definition

Description and Short Description

Enter a long and a short descriptions for the email business unit, which are required.

These fields are prepopulated if the business unit that you are adding is already an existing business unit.

Support Business Unit, Help Desk Business Unit, Service Order Unit, Sales Unit, Online Marketing Unit, and Order Capture Unit

Specify a business unit for each listed CRM transaction, which is used by the system to create and search for the corresponding transaction for email. For example, if an agent creates a case from an email on the email workspace (or the system creates a case automatically for an inbound email), the business unit that is specified in this email's mailbox becomes the business unit for the newly created case.

Create Business Unit

Click to create the email business unit.

This button appears if the business unit that you are adding does not already exist in the CRM system.

Case Display Template Details

Use this section to specify a display template family for each mailbox type. The system uses the selected display template family for creating cases, if the Create Case for every new inbound Email feature is enabled for a group worklist but the display template family is not already specified in the group worklist definition.

Click to jump to parent topicDefining Priorities and Moods

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Define Priorities and Moods

Page Name

Definition Name

Navigation

Usage

Priority Setup

RB_PRIORITY_SETUP

Set Up CRM, Product Related, Multichannel Definitions, Email, Priorities, Priority Setup

Define priorities to appear for email on the email workspace.

Mood Setup

RB_MOOD_SETUP

Set Up CRM, Product Related, Multichannel Definitions, Email, Moods, Mood Setup

Define mood attributes for email on the email workspace.

Click to jump to top of pageClick to jump to parent topicDefining Priorities

Access the Priority Setup page (Set Up CRM, Product Related, Multichannel Definitions, Email, Priorities, Priority Setup).

Values in this grid are used to give priority to email after the content analysis. The priority appears for email in the email workspace.

Click to jump to top of pageClick to jump to parent topicDefining Moods

To define moods, use the Mood Setup (RB_MOOD_SETUP) component.

Access the Mood Setup page (Set Up CRM, Product Related, Multichannel Definitions, Email, Moods, Mood Setup).

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

Click to jump to parent topicDefining Email Audit History Tracking

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

Click to jump to top of pageClick to jump to parent topicPage Used to Define Email Audit History Tracking

Page Name

Definition Name

Navigation

Usage

Audit - Setup

RC_COMP_AUDIT

Set Up CRM, Common Definitions, Audit Trail - Setup, Audit - Setup

Define auditing behavior for inbound email.

Click to jump to top of pageClick to jump to parent topicDefining Email Audit History Tracking in the CRM System

See Setting Up Auditing for Cases and Inbound Email.

Click to jump to parent topicDefining Mail Reader Error Handling

This section discusses how to:

See Also

Mail Reader Error Handling Options

Viewing Email Error Logs

Click to jump to top of pageClick to jump to parent topicPages Used to Define Mail Reader Error Handling

Page Name

Definition Name

Navigation

Usage

Define Action Code

RB_MAIL_ACT_DEFN

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Define Actions, Define Action Code

Define actions to handle possible mail reader errors.

Define Action Groups

RB_MAIL_ACT_GRP

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Define Action Group, Define Action Groups

Define action groups to categorize actions.

Map Error and Action Group

RB_MAIL_ERR_ACT

Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Map Error and Action Group, Map Error and Action Group

Map error codes with action groups.

Click to jump to top of pageClick to jump to parent topicDefining Actions

Access the Define Action Code page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Define Actions, Define Action Code).

Use this page to define an action that needs to be taken when an error is encountered. The system delivers a number of actions, such as deleting email from the mail server, notifying action, inactivating or skipping a mailbox and so on. You can add new actions to the system as well, which require new PeopleCode to be written to support these actions.

Action ID

Displays the unique identifier of the action code. An action ID can contain a maximum of 10 characters.

Description

Enter the description of the action code, which can contain up to 100 characters.

Application Class ID and Application Class Path

Enter the application class details, including the application class ID and path (application package and sub-package details) to handle the error. An application package and classes are provided for system-delivered action codes.

Click to jump to top of pageClick to jump to parent topicDefining Action Groups

Access the Define Action Groups page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Define Action Group, Define Action Groups).

Action Group

Displays the unique identifier of the action group, which can contain a maximum of 10 characters.

Description

Enter the description of the action group, which can contain up to 100 characters.

Order by

Enter the order in which actions listed in the section to be taken.

Action ID

Enter the ID of the action to be taken.

Active

Click to set the status of the corresponding action to active. Only active actions can be triggered.

Click to jump to top of pageClick to jump to parent topicMapping Action Groups and Error Codes

Access the Map Error and Action Group page (Set Up CRM, Product Related, Multichannel Definitions, Email, Define Errors and Actions, Map Error and Action Group, Map Error and Action Group).

Use this page to map standard error codes (returned by PeopleTools API) to action groups. For example, when the connection to the email server is failed, an error code of 4 is returned. This error code is mapped to the action group that contains 3 actions. At runtime, when PeopleTools API returns an error code of 4, the ERMS system performs these 3 actions according to their order by numbers.

Error ID

Displays the unique identifier of the error code, which is defined by PeopleTools API.

Description

Enter a description for the mapping.

Action Group

Enter the ID of the action group to associate with the error code.

The system performs the actions listed in this action group when the corresponding error occurs.

Notify Error Email Addresses

Enter the email addresses to which notifications about the corresponding error are sent.