Select Financial Transactions into Set
The system selects the Financial Transactions into a set and by this a unit of work, the Financial Transaction Set to perform financial processing. The subsequent financial processes (supersede and generate financial message) work on this set. The user can define the criteria for the financial transactions to be picked up and grouped into a set by selecting values for the activity parameters.
This activity has two variants; the user can choose to either…
-
create a new Financial Transaction Set and add financial transactions to it,
-
or add financial transactions to an existing Financial Transaction Set
Select Financial Transactions into a new Financial Transaction Set
This activity type has the following parameters:
| Parameter | Description |
|---|---|
Financial Transaction Set Code |
The unique code of the new Financial Transaction Set. If no code is provided, the system generates a unique numeric code for the Financial Transaction Set. |
Description |
The description of the new Financial Transaction Set |
Group Account |
The list of group accounts separated by semicolon. The activity includes only transactions that are produced for policies of these group accounts. If unspecified is included in the list, the activity also picks up transactions produced for policies without an account (individual policies). If no value is provided, no restriction on group account is applied. |
Financial Transaction Type |
Restricts the selection to type of financial transactions in the set 1) Premium, 2) Premium Based Commission or 3) Fee. When specified, the activity includes only transactions that belong to the base financial object having the selected type; when unspecified, no restriction is imposed. |
Transaction Creation Date From |
Evaluates to true for a financial transaction if the creation date (audit column) of the financial transaction is between (inclusive) the criteria. If the time element is not specified, it works as follows:
|
Transaction Created Time From |
|
Transaction Creation Date To |
|
Transaction Created Time To |
|
Grouping |
When specified, the activity includes only transactions that have a matching financial transaction set grouping specified on the financial transaction process data; when unspecified, no restriction is imposed. |
Ignore Transactions for Changed Group Clients? |
If set to Yes, the activity will ignore all financial transactions that are for group clients with the status CHANGED |
Processing
Processing of this activity has an impact on the following objects in financial:
-
Financial Transaction Set
-
Financial Transactions in a Financial Transaction Set
-
Base Financial Objects related to the financial transactions added to the Financial Transaction Set
These objects are described in the data model section. The actions are described in more detail in the following sections.
Financial Transaction Sets
The following values are set:
-
The status of the Financial Transaction Set is set to Open.
-
If the Financial Transaction Set Code parameter has a value, it is used. If no code is provided, the code will be generated as a numeric code.
-
If the Description parameter has a value, it is used. If no description is provided, the description is set to 'Generated Set'.
Financial Transactions in a Financial Transactions Set
Each financial transaction that meets both the activity parameter criteria and the conditions listed below, is added to the Financial Transaction Set.
-
The financial transaction is not already included in any Financial Transaction Set.
-
There are no other financial transactions in another open Financial Transaction Set, for the same Base Financial Object, that have not been handled by the Generate Financial Message activity yet.
-
If the financial transaction is for a policy that is part of a group client and the activity parameter 'Ignore Transactions for Changed Group Clients?' is set to Yes, the group client should not have the status CHANGED
In case of (2), the financial transaction can only be added to the other open Financial Transaction Set. If this happens, message FIN-FL-SIFS-001 is created as an activity message. This will not stop the processing of other financial transactions that are selected by the activity.
Condition (3) does not raise a message, the transaction is ignored. A transaction belongs to a group client if the member was enrolled in a group account for that group client during the calculation period of the transaction.
Base Financial Object
As soon as a financial transaction is added to a Financial Transaction Set, the status of the related base financial object is set to 'Changed' and the General Financial Processing Complete Datetime is cleared. Also, this activity automatically adds:
-
all previously created financial transactions for the same Base Financial Object, that are not included in another Financial Transaction Set.
-
all reversal transactions for the same base object, that reverse a transaction preceding one of the included transaction.
Note that later versions of the financial transaction are not automatically included in the Financial Transaction Set.
Select Financial Transactions into an existing Financial Transaction Set
This activity can be started within the context of an open Financial Transaction Set. This activity type has the following parameters
| Parameter | Description |
|---|---|
Group Account |
If specified, the system only picks up financial transactions of the policies for that group account. If not, then the it picks up financial transactions from any account. If unspecified is selected, only the financial transactions of the individual policies are picked up. |
Financial Transaction Type |
Restricts the selection to type of financial transactions in the set 1) Premium, 2) Premium Based Commission or 3) Fee. When specified, the activity includes only transactions that belong to the base financial object having the selected type; when unspecified, no restriction is imposed. |
Transaction Creation Date From |
Evaluates to true for a financial transaction if the creation date (audit column) of the financial transaction is between (inclusive) the criteria. If the time element is not specified, it works as follows:
|
Transaction Created Time From |
|
Transaction Creation Date To |
|
Transaction Created Time To |
|
Grouping |
When specified, the activity includes only transactions that have a matching financial transaction set grouping specified on the financial transaction process data; when unspecified, no restriction is imposed. |
Ignore Transactions for Changed Group Clients? |
If set to Yes, the activity will ignore all financial transactions that are for group clients with the status CHANGED |
Processing
Processing of the Select Financial Transactions into an existing Financial Transaction Set activity has an impact on the following objects in common financial:
-
Financial Transactions in a Financial Transaction Set
-
Base Financial Objects related to the financial transactions added to the Financial Transaction Set.
These actions are described in more detail in the next sections.
Financial Transactions in a Financial Transactions Set
Each financial transaction that meets both the activity parameter criteria and the conditions listed below, is added to the Financial Transaction Set.
-
The financial transaction is not already included in any Financial Transaction Set.
-
There are no other financial transactions in another open Financial Transaction Set, for the same Base Financial Object, that have not been handled by the Generate Financial Message activity yet.
In case of (2), the financial transaction can only be added to the other open Financial Transaction Set. If this happens, message FIN-FL-SIFS-001 is created as an activity message. This will not stop the processing of other financial transactions that are selected by the activity.
Base Financial Object
As soon as a financial transaction is added to a Financial Transaction Set, the status of the related base financial object is set to 'Changed' and the General Financial Processing Complete Datetime is cleared. Also, this activity automatically adds:
-
all previously created financial transactions for the same Base Financial Object, that are not included in another Financial Transaction Set.
-
all reversal transactions for the same base object, that reverse a transaction preceding one of the included transaction.
Note that only earlier transactions for the same base object are automatically included; later transactions are not.
When a financial transaction is added to the set, the system iterates over each preceding transaction for the same base object, starting with the most recent. On each iterated transaction the 'supersede' indicator is set to 'no'. The iteration stops - before setting the indicator - as soon as a transaction has its 'message mandatory' indicator set to 'yes' or is already handled. This iteration creates a 'clean slate' for the Supersede Financial Transaction activity. == Messages
The activities can generate the following messages. Messages with elementId set to the calculation period, policy GID, Financial Transaction Version and Group Client Id (separated by a space; for example element Id=" 1-1-2015 1234567890 2 88776655"):
| Code | Sev | Message |
|---|---|---|
FIN-FL-SIFS-001 |
Informative |
Cannot add financial transaction to the transaction set because another version of this transaction is included in a set {code} that is open. |
Messages without elementId:
| Code | Sev | Message |
|---|---|---|
FIN-VL-SIFS-001 |
Fatal |
Financial transaction set code {0} already exists |
FIN-VL-SIFS-005 |
Fatal |
Cannot add financial transactions to financial transaction set with code {0} because the set is Closed |
FIN-VL-SIFS-006 |
Fatal |
Transaction Creation Date From cannot be after Transaction Creation Date To |
FIN-VL-SIFS-007 |
Fatal |
Group account code {0} is unknown |