Business Events

Business events provide a comprehensive history and a concise overview of what happens to a policy and why, and they can also trigger an output.

Business Event Rule

Table 1. Business Event Rule

Field	Description
Code	The code of the business event rule.
Event Action	The policy enrollment event action (add, update, delete, and time valid change).
Entity	The entity for which the policy enrollment event was raised. The API accepts entity names (without spaces and starts with a capital) defined in the object model. For example, Address or PolicyEnrollmentProduct.
Attribute	The attribute in the entity for which the business event rule is defined.
Old Value	The attribute value in the current active policy.
Old Value Empty	An indicator for available value in an active policy.
New Value	The attribute value in the new policy version.
New Value Empty	An indicator for available attribute value in the new policy.
Priority Category	Category of business event rules that logically belong together.
Priority	Priority within a priority category.
Condition Dynamic Logic	Reference to a condition dynamic logic.
Business Event Definition	Reference to a business event definition.
Recalculate?	Generate policy event of type Recalculation along with the policy enrollment event of type Business?
Function Dynamic Logic	Reference to a function dynamic logic to determine the effective date for the policy event.

Constraints:

• Function dynamic logic is mandatory when indicator recalculate is set to true.

A business event rule evaluates the changes detected in the policy version compare.

A business event rule selects changes to a policy that have the following special business meaning:

• New Policy, Add Member, and Add Product.

• Cancel Policy and Cancel Member.

• Term policy enrollment (including term reason) and Term policy enrollment product.

• Transfer policy to another group account and Transfer member to another product.

• Reinstate Policy and Reinstate Policy Enrollment.

• Address change.

Business Event Definition

A business definition defines the way a business event is presented.

Table 2. Business Event Definition

Field	Description
Code	The code of the business event definition.
Description	Description of the business event definition.
Display Text	The display text for a policy enrollment event of type Business. The display text can have up to 10 substitution parameters.
Priority	The priority can be used to determine which 'message' to communicate with the customer in case multiple policy enrollment events exist.

The display text is used to present the business event in a clear and understandable way for users. The display text can hold up to 10 placeholders called substitution parameters. These parameters will be replaced with real values when the event occurs.

For example, a display text for an address change can be configured as follows:

{0} address changed per {1}.

When the event is triggered, the associated policy enrollment event has specific parameters, and the placeholders are replaced with actual details, so the display text is presented as Mailing address changed per 01-MAY-2022.

The first four substitution parameters are reserved for system-generated values.

Table 3. System Substitution Parameters

Parameter	Meaning
{0}	Identification.
{1}	Start Date.
{2}	Old value (only applicable to update rules).
{3}	New value (only applicable to update rules).

Parameters 4 to 9 can be used for custom parameters defined in dynamic logic.

Notification Definition

A notification definition defines the creation and emission of an enrollment event notification and its notification payload for a business event. The notification payload contains a JSON or XML representation of the changes made to policy.

Table 4. Notification Definition

Field	Description
Code	The code of the notification definition.
Description	Description of a notification definition.
Emit Notification	Stage when a notification is send: Pre Approval Post Approval
Revert Policy?	Defines if the policy needs to revert or not once the notification is sent: Yes No
Notification Payload	Reference to a dynamic logic (function) with signature notification payload to define the payload of a notification.
Condition	Reference to a dynamic logic (condition) with signature notification definition.
Business Event Definition	Reference to a business event definition.

See Enrollment Event Notifications for more information on processing of notifications.