Business Events
Business events give a full history and give a quick overview what has happened and why but can also be used to trigger output generation.
Business Event Rule
Field | Description |
---|---|
Code |
The code of the business event rule |
Event Action |
The policy enrollment event action (Add, Update, Delete, Time Valid Change) |
Entity |
The entity for which the policy enrollment event was raised. Please note that the API accepts entity names as defined in the object model, so without spaces and starting with a capital. E.g. 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 |
Indicator if the attribute value in the current Active policy has a value |
New Value |
The attribute value in the new policy version |
New Value Empty |
Indicator if the attribute value in the new policy has a value |
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 |
Business event rules evaluate policy enrollment events created in the policy version compare. Policy enrollment events capture changes between the current active policy version and the new policy version in detail.
Business event rules select policy enrollment events that have a special business meaning like:
-
New Policy, Add Member, Add Product
-
Cancel Policy, Cancel Member
-
Term policy enrollment (including term reason), Term policy enrollment product
-
Transfer policy to another group account, Transfer member to another product
-
Reinstate Policy, Reinstate Policy Enrollment
-
Address change
Business Event Definition
A business definition defines the way a business event is presented.
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. E.g. a display text for an address change can be configured like this:
{0} address changed per {1}.
The associated policy enrollment event has the 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 enrollment event notification on generated business events that contains the payload of changes made to policy which is fetched from policy enrollment events.
Field | Description |
---|---|
Code |
The code of the notification definition |
Description |
Description of notification |
Emit Notification |
When to send notification
|
Revert Policy? |
Defines if the policy needs to revert or not once the notification is sent:
|
Notification Payload |
Reference to dynamic logic (function) with signature 'Notification Payload' to define payload |
Condition |
Reference to dynamic logic (condition) with signature 'Notification Definition' |
Business Event Definition |
Reference to business event definition |
Refer Enrollment Event Notifications for more information on processing of notifications.