Aggregation-Rule: Start here

What is an Aggregation-Rule

Where is an Aggregation-Rule

How you define an Aggregation-Rule

How you use an Aggregation-Rule

What is an Aggregation-Rule?

Use Aggregation-Rules to group segments in a Business-Document (that have the same structure) into a single segment. You can apply aggregation to the following objects:

  • Output-Events, via the associated Processing-Context-Out object
  • Input-Events, via the Preprocessing configuration in the Input-Event

Aggregation applies only to segments with identical criteria. In the Aggregation Fields tab, specify the fields in the segment (designated as criteria fields) that Composer compares to determine if the segments are identical.

Note: In addition to the user-defined criteria that you set here, AccountingIntegrator Enabler can also add the following supplementary technical criteria:

  • Processing-Context-Out: implicit criteria that is always used
  • Group:Optional criteria activated in the sessions configuration file, that is, the script file
  • Financial-Tag: Optional criteria activated in the Aggregation-Rule

Aggregation functions

Aggregation is often used for technical purposes, to optimize performance and reduce the volume of data to be processed.

To compact the data, use the following statistical functions:

  • Average: Calculates the average (arithmetic mean) of the fields selected (the result is an integer)
  • Min: Determines the smallest value among the set of aggregated fields
  • Max: Determines the largest value among the set of aggregated fields
  • Count:Calculates the number of lines in each set of aggregated fields
  • Sum: Adds the values in all the number fields selected in each set of aggregated fields

About Input-Event aggregation

To define how segments in an Input-Event are aggregated, use Input-Event Preprocessing. For each segment type in an Input-Event, you can only associate one Aggregation-Rule.

The structure of the segment to be processed must be compatible with the basic structure of the Aggregation-Rule.[FOR DETAILSBusiness-Document Structure Compatibility]

About Output-Event aggregation

Define Output-Event aggregation via the Processing-Context-Out object associated with the Output-Event.

Note: The name of the Processing-Context-Out is an implicit criterion for aggregating Output-Events. This is independent of any other criteria you define for the Output-Events.

You can activate aggregation for a given Processing-Context-Out in one of two ways:

  • Group by group: aggregates each set of generated Output-Events by including the group code as part of the aggregation criteria. Use this option to aggregate sets of Output-Events related to one Input-Event group. This solution ensures that the Input-Event group is consistent throughout the whole production line.

    Keep in mind that the Input-Event group code is an implicit aggregation criterion for the sets of Output-Events.

  • All groups: aggregates the generated Output-Events by excluding the group code from the aggregation criteria. This solution does not ensure that the Input-Event group is consistent throughout the whole production line.

    The name of the Processing-Context-Out is an implicit aggregation criterion for the Output-Events, regardless of which aggregation option you select for the Output-Events.

[FOR DETAILSAssociating an Aggregation-Rule with a Processing-Context-Out]

Where is an Aggregation-Rule?

Axway module

AccountingIntegrator Enabler

Workbench

Integration-Services: Finance tab

Object dependencies

When you define or import an object, it is stored in the metadata repository and is available for reuse by other objects. Typically, the objects that you define exist in a specific object hierarchy. That is, objects:

  • use objects below them in the hierarchy
  • are used by objects above them in the hierarchy

To help you manage the interlinked network of objects, the software provides the Object Dependencies Browser that displays the object dependencies for a selected object.

The following table lists the objects that use and are used by Aggregation-Rules.
 

Aggregation-Rules

Use

Are used by

Aggregation-Rules are reusable by multiple Input-Events and Output-Events.

For each Business-Document in an Input-Event, you can only define one Aggregation-Rule. However, you can use the same Aggregation-Rule for several Business-Document segments in different Input-Events of the same type.

You can only use one Aggregation-Rule in an Output-Event. You associate one with the other via the Processing-Context-Out object.

How you define an Aggregation-Rule

Before you define an Aggregation-Rule

Before you create an Aggregation-Rule, you must define the Business-Document that defines the structure of the segments to be aggregated.

Defining an Aggregation-Rule

Create the Aggregation-Rule object from the Dictionary tab.

To define a new Aggregation-Rule object, complete the following tabs:

In addition, the Aggregation-Rule properties window contains the following tabs:

  • Signature tab
  • Description tab

After you define an Aggregation-Rule

After you define an Aggregation-Rule object, you can use it in:

When you have exported your parameters to a session in progress, remember to update the parameters by setting values for the script.ges file.

for more information, refer to the AccountingIntegrator Enabler  Rule Engine Reference Manual.

How you use an Aggregation-Rule

To use an Aggregation-Rule:

  1. Define the object type to be aggregated (Input-Event or Output-Event segment).
  2. Create the Aggregation-Rule if it does not exist and Check it.
  3. Aggregate the Input-Event, if the object type is an Input-Event. [FOR DETAILS Input-Event preprocessing]
  4. Aggregate the Output-Event, if the object type is an Output-Event. [FOR DETAILS Defining Output-Event processing]

You can perform all basic operations on Aggregation-Rule objects, depending on your user rights. [FOR DETAILS: Working with objects: Start here]

The Aggregation-Rule object does not follow the standard object life cycle. You cannot explicitly send this object to Production.

Back to top

Related Links