Business-Document: start here

What is a Business-Document?

Structure Compatibility

Intrinsic limits for Business-Documents

Where is a Business-Document?

How you define a Business-Document

How you use a Business-Document

What is a Business-Document?

A Business-Document is a fundamental object in AccountingIntegrator Enabler that describes the structure of a segment in either an Input-Event or Output-Event. Each of the Rules in AccountingIntegrator Enabler, that is the Audit, Aggregation, Balancing, Enrichment, and Transformation-Rules, also use a Business-Document to describe the processing they apply to data sent to them.

The following table explains the differences between the two types of Business-Document available in AccountingIntegrator Enabler.

Business-Document type Purpose Maximum name length

Input Business-Document

Describes the structure of incoming events

25 characters

Output Business-Document

Describes the structure of incoming and outgoing events

3 characters

Each Business-Document comprises a set of fields. Some of the fields contain data, while others, referred to as Fillers, simply separate groups of fields.

Structure Compatibility

Business-Document segments are deemed structurally compatible when the usable fields in these structures have a common definition. That is when they have the same:

  • Internal position
  • Length
  • Data type

The notion of usable fields depends on the type of Rule in which you apply the Business-Document. The following table summarizes the usable fields in each Rule.

Rule type Usable fields in Business-Document

Aggregation-Rule

  • Criteria fields
  • Number fields
  • Report fields
  • Other fields

Audit-Rule

  • Fields to audit

Balancing-Rule

  • Criteria fields
  • Cumulative field
  • Filter field

Enrichment-Rule

  • Fields to modify

Importance of compatibility

Compatibility is crucial because:

  • Each Rule definition references a Business-Document.
  • The fields the Rule contains describe the processing to run. For example, the fields to audit in an Audit-Rule and the fields to modify in an Enrichment-Rule.
  • During execution, to process the Rules correctly AccountingIntegrator Enabler needs to ensure that the relevant data is stored in the correct position, has the correct length and uses the correct data type. For example, when the system processes an Audit-Rule, the compatibility ensures that the Audit fields start at a given position relative to the beginning of the segment that it is currently processing, the Audit fields have the same length and data type.
    In other words, what is important at execution, are the usable fields in the structure of the Business-Document on which the Rule is defined.

Intrinsic limits for Business-Documents

The following table summarizes the technical limits related to Business-Documents.

Business-Document element Limit

Length

4000 characters

Field

  • 1500 fields
  • 5 levels of nested fields

Where is a Business-Document?

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 are the objects that use and are used by Business-Documents.

Use: Business-Fields

Are used by:


How you define a Business-Document

Before you define a Business-Document

No previous steps are mandatory.

Defining a Business-Document

Use any of the following methods to create the Business-Document object:

In addition, the Business-Document properties window contains the following generic tabs:

  • Signature tab
  • Description tab

After you define a Business-Document

After you define a Business-Document, use it to define the following objects:

How you use a Business-Document

You can perform all basic operations on Business-Document objects, depending on your user rights. [FOR DETAILS: "Working with objects" in the Composer User Guide.]

The Business-Document object does not follow the standard object life cycle. You cannot send the Business-Document to Production.

Back to top

Related Links