Select Transactions into Set

This activity comes in two flavors:

Select Financial Transactions into a new Financial Transaction Set
Select Financial Transactions into an existing Financial Transaction Set

Select Financial Transactions into a new Financial Transaction Set

Parameters

The activity has the following parameters:

Financial Transaction Set Code

The code of the new financial transaction set. If an existing code is passed as a parameter for a new financial transaction set, error message FIN-VL-SIFS-001 is created as an activity message for this activity. If no code is provided, the system generates a unique code for the financial transaction set. This will be a numeric value. The lowest available number is used to create the financial transaction set.

Description

The description of the new financial transaction set.

Transaction Creation Date From + Transaction Created Time From / Transaction Creation Date To + Transaction Created Time To

Evaluates to true for a financial transaction if the audit column creation date of the financial transaction is between (inclusive) the criteria. If the time element is not specified, it works as follows:

if the time element for Transaction Creation Date From is left unspecified, it translates to 00:00
if the time element for Transaction Creation Date To is left unspecified, it translates to 23:59
Payment Due Date From / Payment Due Date To

Evaluates to true for a financial transaction if the due date of the financial transaction process data is between (inclusive) the criteria.

Penalty Date From / Penalty Date To

Evaluates to true for a financial transaction if the penalty date of the financial transaction process data is between (inclusive) the criteria.

Brand Code

Evaluates to true for a financial transaction if one of its financial transaction detail has a product brand code equal to it.

Grouping

Evaluates to true for a financial transaction if the financial transaction set grouping of the financial transaction process data matches the specified criterion (when unspecified, no restriction is imposed).

Processing

Processing of the Select Transactions into a new Set activity has an impact on the following objects in common 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 actions are described in more detail in the next sections.

Actions on 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. The lowest possible unique numeric value will be used.
If the Description parameter has a value, it is used. If no description is provided, the description is set to Generated Set.

Rules for adding Financial Transactions to the Set

Each financial transaction that meets the activity parameter selection criteria is added to the financial transaction set. The following conditions apply for adding financial transactions to a financial transaction set (this is evaluated per financial transaction).

The financial transaction is not already included in a financial transaction set. This condition is not reported by a message.
If there are financial transactions for the same base financial object that have not been handled by the Generate Financial Message activity (financial message result on the financial transaction process data is empty) is included in a financial transaction set, the financial transaction can only be added to the same financial transaction set (see example Add Financial Transaction to a Set)

If a financial transaction cannot be added to the financial transaction set as a result of this condition, message FIN-FL-SIFS-001 is created as an activity message. This will not stop the processing of other transactions that were selected by this activity.

Base Financial Object Actions

When one or more Financial Transactions are added to the Financial Transaction Set, the status of the related base financial object is set to Changed.

Additional actions may be required on financial transactions for the same base financial object already present in the financial transaction set:

Add previous Financial Transaction versions for the same Base Financial Object that are not already included in a financial transaction set to the same financial transaction set.

Note that later versions of the financial transaction are not automatically included in the financial transaction set.

For each financial transaction that is included in a set, also include the accompanying reversal financial transaction where needed.

The Select Transactions into a new Set activity can result in the following messages:

The messages with elementId attribute set to the claim code and version (separated by a space; for example element Id="1234567890 1"):

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.

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.

The messages without elementId attribute:

Code	Sev	Message
FIN-VL-SIFS-001	Fatal	Financial Transaction Set Code {code} is already in use.
FIN-VL-SIFS-006	Fatal	Transaction Creation Date From cannot be after Transaction Creation Date To
FIN-VL-SIFS-007	Fatal	Payment Due Date From cannot be after Payment Due Date To
FIN-VL-SIFS-008	Fatal	Penalty Date From cannot be after Penalty Date To
FIN-VL-SIFS-009	Fatal	Brand Code {0} is unknown

Code

Sev

Message

FIN-VL-SIFS-001

Fatal

Financial Transaction Set Code {code} is already in use.

FIN-VL-SIFS-006

Fatal

Transaction Creation Date From cannot be after Transaction Creation Date To

FIN-VL-SIFS-007

Fatal

Payment Due Date From cannot be after Payment Due Date To

FIN-VL-SIFS-008

Fatal

Penalty Date From cannot be after Penalty Date To

FIN-VL-SIFS-009

Fatal

Brand Code {0} is unknown

Select Financial Transactions into an existing Financial Transaction Set

Parameters

It is not allowed to add financial transactions to a set with status Closed. Trying so will result in error message FIN-VL-SIFS-005 as an activity message.

Nor is it allowed to add financial transactions to a set that is blocked (the indicator to block additions can be set and unset using the HTTP API). Trying so will result in error message FIN-VL-SIFS-010 as an activity message.

The activity has the following parameters:

Transaction Creation Date From + Transaction Created Time From / Transaction Creation Date To + Transaction Created Time To

Evaluates to true for a financial transaction if the audit column creation date of the financial transaction is between (inclusive) the criteria.

If the time element is not specified, it works as follows:
- if the time element for Transaction Creation Date From is left unspecified, it translates to 00:00
- if the time element for Transaction Creation Date To is left unspecified, it translates to 23:59
  - Payment Due Date From / Payment Due Date To

Evaluates to true for a financial transaction if the due date of the financial transaction process data is between (inclusive) the criteria.

Penalty Date From / Penalty Date To

Evaluates to true for a financial transaction if the penalty date of the financial transaction process data is between (inclusive) the criteria.

Brand Code

Evaluates to true for a financial transaction if one of its financial transaction detail has a product brand code equal to it.

Grouping

Processing

Processing of the Select Transactions into an existing 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.

Rules for adding Financial Transactions to the Set

These are identical to the rules for adding financial transaction into a new set.

Base Financial Object Actions

When a Financial Transaction is added to the Financial Transaction Set, the status of the related base financial object is set to Changed and the General Financial Processing Completion Date is cleared.

Additional actions may be required on financial transactions for the same base financial object already present in the financial transaction set:

Add previous Financial Transaction versions for the same Base Financial Object that are not already included in a financial transaction set to the same financial transaction set.Note that later versions of the financial transaction are not automatically included in the financial transaction set.
For each financial transaction that is included in a set, also include the reversal financial transaction.
Reset supersede indicator

If a financial transaction is added to the financial transaction set, the Superseded Indicator on the process data is set to No for financial transactions for the same Base Financial Object. This action is done up to (not including) the newest financial transaction with financial message mandatory indicator set to Y or the newest financial transaction that was handled by the generate financial message activity - whichever one comes first.

Error Messages

The Select Transactions into an existing Set activity can result in the following messages:

Messages with elementId set to the claim code and version (separated by a space; for example element Id="1234567890 1"):

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 that is open.

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 that is open.

Messages without elementId:

Code	Sev	Message
FIN-VL-SIFS-005	Fatal	Cannot add financial transactions to financial transaction set with code {code} because the set is closed
FIN-VL-SIFS-006	Fatal	Transaction creation date from should not be greater than Transaction creation date to
FIN-VL-SIFS-007	Fatal	Payment due date from should not be greater than Payment due date to
FIN-VL-SIFS-008	Fatal	Penalty date from should not be greater than Penalty date to
FIN-VL-SIFS-009	Fatal	Brand code {0} is unknown
FIN-VL-SIFS-010	Fatal	Cannot add financial transactions to financial transaction set with code {code} because the set is blocked

Code

Sev

Message

FIN-VL-SIFS-005

Fatal

Cannot add financial transactions to financial transaction set with code {code} because the set is closed

FIN-VL-SIFS-006

Fatal

Transaction creation date from should not be greater than Transaction creation date to

FIN-VL-SIFS-007

Fatal

Payment due date from should not be greater than Payment due date to

FIN-VL-SIFS-008

Fatal

Penalty date from should not be greater than Penalty date to

FIN-VL-SIFS-009

Fatal

Brand code {0} is unknown

FIN-VL-SIFS-010

Fatal

Cannot add financial transactions to financial transaction set with code {code} because the set is blocked