Business Events

Business events give a complete history and a quick 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.

Please note that 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 policy enrollment events created in the policy version compare. A policy enrollment event captures the details of the changes between the active policy version and the new policy version in detail.

A Business event rule selects policy enrollment events that have a special business meaning like:

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

Descr

Description of a 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 describe the business event in a user friendly way. For example, a display text for an address change can be configured as following:

\{0} address changed per \{1}.

The associated policy enrollment event has specific parameters, so the display text is presented as Mailing address changed per 01-MAY-2022.

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