Case Manager portal — My Events tab

Creating and subscribing to business events

Business event definitions comprise both the conditions and resulting actions of a business event.

For example, the event condition could be whenever a work item in the Adjustments application becomes resolved with a status of Resolved-Writedown and the principal amount is more than $10,000. The related action could be that the system sends an email notification to a specific group of people. For an example including screen shots, see PDN article 26370 How to create and subscribe to business events.

Privileges and access

To make use of event definitions, you need:

Access to a portal that includes the business events features and functionality, in order to create event definitions. The Case Manager Portal includes these features by default, and is used here as a reference portal.
Appropriate privileges. Privileges required for working with business event definitions are
- PegaAccel-CEPSetup.pxViewEventDefinitions
- PegaAccel-CEPSetup.pxEditEventDefinitions
The standard roles PegaRULES:SysAdm4 and PegaRULES:WorkMgr4 provide the required privileges.
The Events Processing RuleSet. A single fixed RuleSet, EventProcessing-Internal:01-01-01 serves all application users who work with event definitions. Add the RuleSet to the Production RuleSets list of each access group used by operators who need to create or work with business events. Make sure the highest RuleSet version is unlocked.
Important: do not delete rules you may encounter in this RuleSet, even though the RuleSet is not locked. Deleting rules can have unexpected and negative effects on business events that are important to others.

Developers can also make use of the Business Events API to create and manage business event definitions.

When you have the correct configuration to be able to work with Event Definitions, you need to locate them in your portal. The steps indicated here are based on the location of Event Definitions in the Case Manager Portal.

Log in to the portal.
Open the My Events tab.
The top left of the My Events tab has a What's Happening header. Locate the Event Subscriptions link below the header, and click it.

The tab that appears is headed "Event Definitions". The main display shows information about all event definitions for this application.

The tab also provides these functions:

Main display
- Hover the cursor over the name of any event definition to display a SmartInfo form with further details about the event definition.
- Click any column header to sort the display by the values in that column.
Other controls. Several buttons and clickable icons are available:
- New: Click this button to display a form for specifying a new event definition. See Creating Event Definitions.
- Debug Log: Click this button to display the debug log. See Debugging Event Definitions
- Export Event Definitions: Click the export icon to package event definitions for import into another PRPC system. See below.
- RSS: Click this link to access or activate an RSS feed to receive event definition messages.

Business event definitions and declarative triggers

Business event definitions are not meant to replace declarative trigger rules. The two rule types have different functionality, user audiences, and purposes:

	Event Definitions	Declarative Triggers
Response	Near real time	Real time
User audience	Can be created and maintained by reasonably-sophisticated business end users	Developers only
Included functionality	Subscription feature with multiple notification modes Referencing of related instances in other classes using associations (pre-defined joins) Easy-to-use debug feature	No special features
Complex event triggers	Reasonably easy to describe patterns involving multiple correlated events of different classes and types occurring (or not occurring) over a selected time range	No easy way to design complex triggers

Creating business event definitions

Tip Following a case can automatically create an event definition and subscription that notifies subscribers of any change in status by RSS Feed.

When you click the New button on the main Event Definitions display, a form appears where you specify information about the new event definition. The form is divided into several sections:

Section

Field

Description

Overview

Name

Required. Provide a name for the event definition.

Description

Required. Provide a description to elaborate on the event name.

Evaluate When an Instance of

Required. Select a class of data for the event definition to monitor. The options available are the data classes of the work types available to your work pool.

When you make your selection a new required field appears, with the prompt "Select type of change...". The changes the new event definition can monitor are:

is created or updated
has a new attachment
has new correspondence
has failed to meet an assignment goal or deadline

Enable This Event

Check the checkbox to make this event definition active.

You can also specify start and end dates and times: if you specify dates and time, the event will be inactive before the start time, and will become inactive again after the end time you specify. You can specify a starting date/time, and ending date/time, or both. The start date/time must be later than the present moment, and the end data/time must be later than the start date/time.

Other Data Types Needed

Specify here any other data types that need to be evaluated in the event definition. For instance, if you want the event to be triggered when a certain event takes place to a work item currently assigned to a particular operator, you may need that person's operator ID, which is stored in Data-Admin-Operator-ID.

After you specify data types here, they can be referenced in the event definition's conditions for evaluation.

Data Type

Select from the options provided the Data Type needed.

Prefix

Select the association from the options provided.

Add rows for more required data types by clicking the + button; remove rows by clicking the trash can icon at the right of each row you want to remove.

Conditions

In this section specify the filter conditions and the logic that connects them. Each row of the Conditions grid is a separate condition; the event definition can have as many conditions as are needed to limit triggering the event to precisely the situation the event definition is monitoring.

Logic

In this field state how the rows of conditions relate to each other, using each row's labels. Every row in the grid must be included in the Logic field. The Logic statement uses the row labels, the reserved words AND, OR, and NOT, and parentheses to make statements such as "(A OR B) AND C NOT D".

Label

Provide a unique label for each row. The label should start with a letter and include only alphanumeric characters and no spaces.

Condition

Choose from the options available in each presented field to construct a statement such as ".pxCreateOperator Is Not Equal .pxUpdateOperator."

Add rows for more conditions by clicking the + button; remove rows by clicking the trash can icon at the right of each row you want to remove.

Conditions Involving Other Events

In this section you can identify further conditions that may limit triggering this event definition.

"If above conditions are met..."

When this checkbox is checked, if the conditions specified in the Conditions section, above, return True, the system check whether the conditions specified in this section also return True. If so, the event is triggered.

Condition structure

Using the fields provided, create a condition structure of the form "The number of rows returned by [Report Definition] [Select the name of the report definition], when run [in [n] days or in [n] hours] [the value of N] [Is Equal {or another statement of relationship)] [the value to compare with].

Important: uncheck Enable Paging on the report definition you use for this condition. If paging is enabled, the report will only return the number of entries on its first page, not the number of entries in the full report. This can lead to the condition not responding True even though its condition has been met.

Actions

When an event occurs that satisfies the conditions of this event definition, it can perform multiple actions. Add a row in the Action To Take list for each action, using the + button; remove rows by clicking the trash can icon at the right of each row you want to remove.

Action To Take

The possible actions are:

Notify Subscribers
Call an Activity
Call a Flow

Params

After you select an action to take, click the magnifying glass icon in the Params column for that action to set the action's parameters.

Action

Params

Notify Subscribers

The form that appears lets you create formatted email and RSS feed messages subscribers will received when the event definitions conditions are met.

To dynamically insert field values into the texts, use SmartPrompt to select a property in the top field. When you have selected it, a formatted version of the property name appears: copy this string and paste it into the subject line or body of the Email message, and/or the title or body of the RSS message. For example, if you select .pxCreateOperator, the form displays <<.pxCreateOperator>> for you to copy.

Note: verify that outgoing email settings have been established for this instance of PRPC. Without such settings, email is not sent. The email account configuration page is also where you establish what will appear as the "sender email". See About Email Account data instances and Integration Category — Email page.

Call an Activity

In the fields provided

Select an activity to call
The access group field defaults to the one associated with your Operator ID.
If the activity requires properties from the work item as parameters, identify the properties using the SmartPrompt control, and copy and paste the resulting string (<<PropertyName>>) into the input field provided.

Call a Flow

In the fields provided

Select a flow to execute
The access group field defaults to the one associated with your Operator ID.
If the flow requires parameters from the work item, identify the parameters using the SmartPrompt control, and copy and paste the resulting string (<<ParameterName>>) into the input field provided.

Click Submit to save your work; click Cancel to close the form without saving your changes.

Click OK to create the event definition; click Cancel to close the form without creating anything.

Updating business event definitions

On the main Event Definitions display, double-click the event definition you wish to edit. The Update Event Definition form appears in read-only mode. Click Edit at the bottom of the form to switch to edit mode. When you have updated the form, click Save to save your changes. Click Cancel to abandon your changes and close the form.

Deleting business event definitions

On the main Event Definitions display, double-click the event definition you wish to delete. The Update Event Definition form appears in read-only mode. Click the Edit button at the bottom of the form to switch to edit mode. Click Delete to delete the event definition. Click Cancel to close the form.

Subscribing to business event definitions

To subscribe to an event definition, on the main Event Definitions display click the icon in the Subscription column to the event definition to which you wish to subscribe, or for which you wish to update your subscription. The Event Subscription form appears:

Control	Description
Subscribe to event definition	Check this checkbox to activate a subscription. Select one or more of the forms of notification: E Mail You receive an email each time the business event is triggered. RSS Feed Your RSS feed receives a notices each time the business event is triggered. Summary Report Each time the business event is triggered, data is added to the standard pxEventActionsReport. If this is embedded in your portal, you can see it there. Otherwise, you can add the report to your Report Browser by using the Add Reports to Browser tool. Add the Monitor Processes category. When the import is complete, search for pxEventActionsReport. You can schedule and subscribe to the report, as described in Using the Report Browser.
Notify only if my role is:	If you check this checkbox, select the role that you need to have in relation to the work item triggering the event, in order to get a notification. The options that appear are work party roles that can be specified in the work item or its case hierarchy, so the list will vary from one event definition to another.

Click Submit to save your choices, or click Cancel to close the form.

Debugging business event definitions

You may want to verify that the business event definition catches the correct event and initiates the correct action in response. To test the event definition, use the debugging features:

Select a work item to test with, and note its work item ID.
In the list of existing business event definitions, select a row, then click theicon in the Debug column to display the Debug form. Enter the work item ID in the Debug Info for Item field, and click Submit.
Perform an action on the work item that should be noticed by the event definition. For example, if the event definition is watching for a "create or update" event, advance the work item in its flow or update its data.
Click the Debug Log button to display the Event Debug Report.
If the event definition is correctly configured, and if the system performed an action on the selected work item that stimulates the event definition, an entry appears in this report.