Aggregation Profile

Session UDR Type

Click on the Browse... button and select the Session UDR Type. The Session UDR is defined in Ultra. For further information, see Session UDR Type.

Storage

Select the type of storage for aggregation sessions. The available settings are File Storage, Couchbase Storage, Redis Storage, Elasticsearch Storage, SQL Storage and Memory Only.

File Storage and Memory Only can be used in batch and real-time workflows.

Elasticsearch Storage and SQL Storage can only be used in batch workflows.

Couchbase Storage and Redis Storage can only be used in real-time workflows. These storage types allow highly available systems with geographic redundancy. The session data that is replicated within the storage is available across workflows, EC Groups, and systems. This serves to minimize data loss in failover scenarios.

UDR Types

Click on the Add button to select a UDR Type in the UDR Internal Format dialog. The selected UDR type will then appear in this field. Each UDR type may have a list of rules attached to it. Selecting the UDR type will display its rules as separate tabs to the right in the Aggregation profile configuration.

Primary Expression

The Primary Expression is optional. Enter an APL code expression that is going to be evaluated before the ID Fields are evaluated. If the evaluation result is false the rule is ignored and the evaluation continues with the next rule.

Use the  input  variable to write this filtering expression.

ID Fields

Click on the Add button to select additional ID Fields in the ID Fields dialog. These fields, along with the Additional Expression settings enable the system to determine whether a UDR belongs to an existing session or not. If the contents of the selected fields match the contents of a session, and an Additional Expression evaluation results in true, the UDR belongs to the session.

Additional Expression

The Additional Expression is optional. Enter an APL code expression that is going to be evaluated along with the ID Fields.

Use the  input variable to write this filtering expression.

The Additional Expression is useful when you have several UDR types with a varying number of ID Fields, that are about to be consolidated. Having several UDR types requires the ID fields to be equal in number and type. If one of the types requires additional fields that do not have any counterpart in the other type or types, these must be evaluated in the Additional Expression field. Save the field contents as a session variable, and compare the new UDRs with it. For an example, see Association - Radius UDRs in Aggregation Example - Association of IP Data.

Create Session on Failure

Select this check box to create a new session if no matching session is found. If the check box is not selected, a new session will not be created when no matching session is found.

If the order of the input UDRs is not important, all the rules should have this check box checked. This means that the session object is going to be created regardless of the order in which the UDRs arrive.

However, if the UDRs are expected to arrive in a particular sequence, Create Session on Failure must only be selected for the UDR type or field that is considered to be the master UDR, i e the UDR that marks the beginning of the sequence. In this case, all the slave UDR types or fields are targeted for error handling if they arrive before their master UDR.

For further information about all available system properties, see System Properties.

Add Rule

Click this button to add a new rule for the selected UDR Type. The rule will appear as a new folder to the right of the UDR Types in the Aggregation profile configuration.

Usually, only one rule is required. However, in a situation where a session is based on an IP number, stored in either a target or source IP field, two rules are required. The source IP field can be listed in the ID Fields of the first rule and the target IP field listed in the ID Fields of the second rule.

Remove Rule

Click this button to remove the currently displayed rule.

Storage Host

Select a Storage Host from the drop-down list.

For storage of aggregation sessions select either a specific EC Group or Automatic. If you select Automatic, the same EC Group that has been used by the running workflow will be applied. Alternatively, if the Aggregation Session Inspector is used, a storage host is selected automatically. Refer to Aggregation Session Inspector for further information on the Aggregation Session Inspector.

Directory

Enter the directory on the Storage Host where you want the aggregation data to be stored.

If this field is grayed out with a stated directory, it means that the directory path has been hard-coded using the mz.present.aggregation.storage.path property. This property is set to false by default.

Partial File Count

In this field, you can enter the maximum number of partial files that you want to store. Consider the following:

Startup: All the files are read at startup. It takes longer if there are many partial files.

Transaction commitment: When the transactions are committed, many small files (large Partial File Count) increase performance.

In a batch workflow, use this variable to tune performance.

Max Cached Sessions

Enter the maximum number of sessions to keep in the memory cache.

This is a performance-tuning parameter that determines the memory usage of the Aggregation agent. Set this value to be low enough so that there is still enough space for the cache in memory, but not too low, as this will cause performance to deteriorate. For further information see the section below, Performance Tuning with File Storage.

Enable Separate Storage Per Workflow

This option enables each workflow to have a separate session storage. Multiple workflows are allowed to run simultaneously using the same Aggregation profile.

If this checkbox is selected, a workflow will never see a session from another workflow.

Profile

Select a Couchbase profile. This profile is used to access the primary storage for aggregation sessions.

Mirror Profile

Selecting this Couchbase profile is optional. It is used to access secondary storage, providing read-only access for aggregation sessions. Typically, the Mirror Profile is identically configured to a (primary) Profile, that is used by workflows on a different EC Group or other system. This is useful to minimize data loss in various failover scenarios. The read-only sessions can be retrieved with APL commands. For more information and examples, see Aggregation Functions in the APL Reference Guide.

Elasticsearch

Select an Elasticsearch profile. This profile is used to access the storage for aggregation sessions.

Profile

Select a Redis profile. This profile is used to access the storage for aggregation sessions.

Profile

Select an SQL profile. This profile is used to access the storage for aggregation sessions.

Index Fields

Click the Add button to select the UDR type.

Table SQL Script

This text box will generate the SQL statements for the selected UDRs' table schema and indexes for Id, TxId. The schema will be generated based on the number of UDRs in the UDR Type Mapping table.