Processing-Context-Out: Definition tab

About the Definition tab

What the Definition tab shows

Using the right pane

Using the left pane

Completing the Rules tab

Completing the Check tab

Completing the Printable accounting fields tab

Using the Linked Rule versions tab

About the Definition tab

Use this tab to define the processing options to apply to the Output-Events that use this Processing-Context-Out.

What the Definition tab shows

The Definition tab comprises three panes as schematically illustrated in the following diagram:

Processing options

 

Check

Printable Accounting fields

Rules:

Linked Rule versions

Dynamic pane displaying definition fields for the selected processing option

Tree structure of Business-Documents associated with the Processing-Context-Out object

 

Output-Business-Documents

Using the right pane

The right pane displays a drop-down list of existing output Business-Documents available for the Processing-Context-Out object to use. When you select a Business-Document, this pane displays a tree of the segments in the selected Business-Document.

The Processing-Context-Out object is comprised of a set of attributes whose values are set in either of the following methods:

  • You type in the values explicitly.
  • The values are provided dynamically in the Output-Event segments. With this method you must define the position/length details of the values in the segment itself. To do this, select the Business-Document field and then Cut/Paste it from the Business-Document tree structure to the selection zone of the given attribute.

    If you do not select a Business-Document, then the only method possible is to enter the values explicitly.

    The Business-Document you select is a template. The Business-Document of the processed Output-Event can differ from it. However, the Business-Document fields you select in the Processing-Context-Out to set the attribute values must have the same position, length and data type in all the Business-Documents used by the Output-Events processed by this Processing-Context-Out.

Whichever method you select, Composer runs coherence checks to validate the length and data type of each Processing-Context-Out attribute.

Using the left pane

The left pane contains four categorieswhere you set or view the processing options:

  • Rules: Define the Rules to apply to the Processing-Context-Out object:
    • Aggregation-Rules
    • Balancing-Rules
    • Audit-Rules
  • Check: Define the accounting references to check.
  • Printable accounting fields: Define the fields whose contents you want printed out.
  • Linked Rule versions: Display the list of Rules linked to this Processing-Context-Out, organized by Ruletype.

When you select one of these categories, Composer displays the corresponding fields that you must define for that option in the middle pane.

Completing the Rules tab

Use the Rules tab to define the aggregation, balancing and audit processing to apply to the Output-Event objects associated with this Processing-Context-Out, as specified in the Processing-Context-In object. [FOR  DETAILS: Defining Processing-Context-Out parameters in the Processing-Context-In]

Select the Rules that you want to apply to the Output-Events via this Processing-Context-Out object:

  • Balancing-Rule
  • Aggregation-Rule
  • Audit-Rule

For each Rule, you can specify one of the following:

  • Value: to apply a specific Rule to this Processing-Context-Out. From the drop-down list, select an existing Rule. Use this option to apply a single rule to the Processing-Context-Out. For example, the Processing-Context-Out activates one Balancing-Rule, one Aggregation Rule and one Audit-Rule.
  • In leaf: to use different Rules depending on the Output-Events produced for this Processing-Context-Out. A Processing-Context-Out can only reference a single Business-Document. Drag-and-drop a field from the list of Business-Document leafElement nodes to the In Leaf field. Use this option to apply several rules of the same type to the Output-Events associated with this Processing-Context-Out.
    You do this via the Rule selection dual list. Select one or several Rules in the Available list and click Add or Add All to transfer them to the Selected list.

Associating the Processing-Context-Out with a Rule

If the name of the Rule is located in the Output-Event (defined by mapping), you must set the position and length used to pinpoint the Rule name in the Output-Event.

All the Output-Events associated with the Processing-Context-Out must include a field that is either:

  • mapped with the name of the Rule to be applied
  • not mapped, if no Rule is to be applied to the Output-Events

AccountingIntegrator Enabler  Rule Engine uses the position and length of this field (as defined when you created the Business-Document) to find the name and properties of the Rule to apply.

To associate the Processing-Context-Out with... Do this...

Aggregation-Rule

  1. Select the Aggregation-Rule category.
    Composer displays the Aggregation Rules tab in the middle pane.
  2. Select the Aggregation Rule check box to activate the options on the tab.
  3. Select an Aggregation-Rule using either the Value or In leaf methods.

Audit-Rule

  1. Select the Audit-Rule category.
    Composer displays the Audit Rules tab in the middle pane.
  2. Select the Audit Rule check box to activate the options on the tab.
  3. Select an Audit-Rule using either the Value or In leaf methods.
  4. To define which Stamping identifier the system uses to check that the Output-Event was traced by the Audit-Rule, set audit trace attestation options using the Event Stamping code section.
    From the right pane, drag-and-drop the field that contains the Stamping identifier and then select one of the following stamping methods:
  • Timestamp writes the date and time the Audit-Rules was executed on the Output-Event. The stamp identifier is alphanumeric, 25 characters long and comprises:

    Stamp code [5A]
    +operating date [YYYYMMDD]+stamp time [HHMMSS]+identifying letter [1A]+stamping counter in base 36 [A5] (physical length)
     
  • Serial numeric stamping writes a sequential number which increments with each audited Output-Event. The stamp identifier is alphanumeric, 2-19 characters long and comprises:

    Identifying letter [1A]
    +stamping counter[N1to N18] (physical length)
     
  • Serial packed stamping writes a sequential number using the Packed Data Type. The stamp identifier is alphanumeric, 2-19 characters long and comprises:

    Identifying letter [1A]
    +stamping counter[P1 to P18] (physical length)
  1. In the Event stamping code in leaf to specify the field where the Audit-Rule writes the Stamping identifier you defined in Step 4 '

Balancing-Rule

  1. Select the Balancing-Rule category.
    Composer displays the Balancing Rules tab in the middle pane.
  2. Select the Balancing Rule check box to activate the options on the tab.
  3. Select a Balancing-Rule using either the Value or In leaf methods.

Completing the Check tab

When the Output-Event refers to an accounting application, use the Check tab to create an accounting check. An accounting check:

  • specifies the accounting-related fields that must exist in the Output-Event
  • checks that the accounting-related fields meet the constraints set for them

If one of these mandatory fields is absent or fails one of the constraint tests, AccountingIntegrator Enabler rejects the Input-Event as an exception.

Defining an accounting check

  1. Select the Accounting Check check box to activate the accounting reference elements.
  2. For each accounting reference element, drag-and-drop the appropriate field from the list of Leaf elements in the Business-Document field.

The following table describes each field.

Accounting reference element Description

Amounts

Enter the credit and /or debit amounts of the accounting operation. The fields are not editable but you can drag-and-drop a leaf element from the output Business-Document. By default both fields are set to <none>.

The production session checks whether this field contains a non-null, numeric or packed value in the Output-Event.

Account

Enter the account name. Specify the position, length and type used to read the account name in the Output-Event. The type can be:

  • A (alphanumeric): max length = 256 characters
  • N (numeric): max length = 28 characters
  • P (packed): max length = 28 characters

The session checks that this field is defined in the Output-Event.

Currency

Specify a currency code (3 numeric characters) or a currency name (3 alphanumeric characters).

Direction

Define whether the transaction is a credit, reversal credit, debit or reversal debit operation (up to 256 characters). If the current Folder is an UTF-16 folder, you can enter UTF-16 characters.

Restriction: You cannot drag-and-drop any item into these fields.

Default values are:

  • C: credit value
  • D: debit value
  • 1: reversal debit value
  • 2: reversal credit value

Default values are displayed in gray and cannot be deleted. When you enter text, it is displayed in black. If you delete this text, the default value is displayed again.

The value of the Direction field is reversed during the reversal accounting operation.

Sign

Select this the Sign check box to confirm what you set in the Direction field.

By default both fields are set to <none>. They are not editable but you can drag-and-drop a leaf element from the output Business-Document.

Output-Event with null amount allowed

Select this option if you want AccountingIntegrator Enabler to accept as valid an Output-Event with null in the Amount field.

If you do not check this option, AccountingIntegrator Enabler rejects the Input-Events with null in their Amount fields.

Completing the Printable accounting fields tab

Printable accounting fields summarize the accounting operation (debit or credit)represented by an Output-Event generated by a transformation session. This tab can only be accessed if you requested accounting checks for this Processing-Context-Out in the Check category.

To obtain printable accounting fields, drag-and-drop Leaf Element nodes from the right pane to the Accounting field field in the left pane. Each field of the Business-Document defines the position, length and type of the field you want to print out:

  • position: the position in the Output-Event from which to start reading
  • length: the length of the data to read (from the starting position indicated by the position)
  • type: the data type of the field in the Output-Event:
    • Alphanumeric
    • Numeric
    • Packed (from AccountingIntegrator Enabler)
    • Signed

If a label is already defined for the field, the text is added to the Label field. Alternatively, enter a free-text description of the field.

The total length of the selected fields must not exceed 256 characters. The maximum number of selected fields is 20.

Using the Linked Rule versions tab

Composer provides the Linked Rule versions tab for you to view and verify the version of each of the Rules you selected in the Aggregation-, Audit- and Balancing-Rule categories.

When you send the Processing-Context-Out object to Production, the system automatically sends all the rule versions linked to it to Production as well.

Note: You cannot modify the properties of the Rules you selected from this tab.

To view the properties of a Rule, right click the Rule and select Properties from the contextual menu. Composer displays the Properties window of the Rule in read-only mode.

Back to top

Related Links