Business Event Definition

Prerequisite: To create a Business Event Definition, you have to have a Journal Line Definition already defined. If you do not have a Journal Line Definition created, an error message informing you that there is no existing Journal Line Definition will appear when you open the Business Event Definition screen.

1. Go to Configuration > Accounting Configuration > Business Event Definition.
2. On the Business Event Definition screen, click the Edit button. You can add obligatory and optional fields. The obligatory fields constitute Systemic Fields (for more information, see above) and Subledger Nodes (it is obligatory to have a minimum one Subledger Node). Optional fields are attributes configured by you. By default, when you click the Add button and a new record appears, the Systemic Field Type is left blank, i.e., is set to an optional attribute, and the Field Type is set to text.
3. Add a Field Label for the new record. The system will automatically fill out the Field Name. You can type a Field Name different from the Field Label. Once you type a different Field Name and then change the Field Label, the Field Name will not change. However, if you add a mandatory Systemic Field Type, the Field Name will be set to a hardcoded value for this Systemic Field Type.
4. Field Source determines whether the field will draw data from an input file or an enriching attribute.
   1. Set Input File if you want the field to draw the data from an input file.
   2. Set the Reference Name if you want the field to draw the data from an enriching attribute.
      A prerequisite for defining Enriching Fields is having references defined for the Business Event Definition. Please refer to How to Define a Reference for Business Event Definition? and How to Configure Enriching Fields? tutorials below for more details.

5. Select the Systemic Field Type if you wish to configure a mandatory field or leave this field blank if you wish to configure an additional field. If you select a mandatory Systemic Field Type, e.g., Core Date, the Field Type will automatically be set to the data type required for this Systemic Field, e.g., date for Core Date, and the Field Name will also be automatically set and will not be editable. Once you configure a mandatory Systemic Field Type, it will no longer be available in the Systemic Field Type list to ensure the mandatory Systemic Fields are not duplicated
   Remember all Systemic Fields have to be configured.

   A validation icon, in the form of a red x or a green tick sign, is available next to the Cancel icon in the editing pane on the top of the screen. Real-time validation of the Business Event Definition configuration is provided. If you click the icon, it will show validation messages regarding your current configuration, red for warnings, and green for the correct configuration.

6. In the Id column, select the field that will be used to identify the Business Event in the system. You can choose one or more fields.
   This identification will constitute the Primary Key and will be used for logging validation errors. If you do not select any fields, you will not be able to identify a failed Business Event in the error log.

7. Once all validation messages are green, the Save button will become active and you will be able to save your Business Event Definition.

1. Go to Configuration > Accounting Configuration > Business Event Definition.
2. On the Business Event Definition screen, click the Edit button.
3. Click the Add reference button.
   The screen will automatically scroll down to the new reference configuration section.

4. To configure a reference:
   1. Type a Reference Label.
   2. The Reference Name is filled by default by a technical version of the Reference Label. You can change it if required.
   3. Select the Referenced Entity from the drop-down list.
   4. You can add an optional description.
   5. In the Connecting attributes section, create connections between referenced Entity attributes and Business Event Definition fields.
      The minimum connection has to include the Primary Key attributes of the referenced Entity.

   The Primary Key attributes are by default selected for connection. 6. Select the type of connection:
   1. matches - a reference to between an attribute in the referenced Entity and a Business Event Definition field
      You can also create a connection to a field from another Reference Entity, which will create a linked reference. To learn more about linked references, refer to the How to Configure Linked References? tutorial below.

   2. value - reference where the defined attribute in the referenced Entity has to have a constant determined value
   3. For ‘matches’ type connections, select a matching field from the drop-down list.
   4. For ‘value’ type connections, configure the value.
   5. If you want to expand the mapping beyond the Primary Key attributes of the referenced Entity, click the Add button and select an additional attribute.
5. Once all validation messages are green you can click the Save button to save your reference. If you click the Save button before the validation icon is green, an error will be thrown and the Business Event Definition will not be saved.

You can create a more complex enrichment by creating a reference based on a field from a different reference.

In order to set this up correctly, it is best if you do it in stages:

Stage 1

Define the first reference, e.g., Instrument Enrichment:

• Reference Label: Instrument Enrichment
• Reference Name: instrumentEnrichment
• Referenced Entity: instrument
• Referenced Entity Attribute: instrumentCode
• Connection: matches
• Value: instrumentCode

Stage 2

Define an enriching field using a field from the referenced Entity, in this example, this is the “Instrument Sub Type Code” field:

• Field Label: Instrument Sub Type Code
• Field Source: instrumentEnrichment
• Enriching Attribute: instrumentSubTypeCode
• Field Type: text
• Field Name: instrumentSubTypeCode

Stage 3

Now, when creating a “hook” for another reference, you can use the “Instrument Sub Type Code” field. This will simplify validations, as the system will not be required to call the referenced Entity, because the field is already part of the Business Event Definition:

• Reference Label: Instrument Sub Type Enrichment
• Reference Name: instrumentSubTypeEnrichment
• Referenced Entity: instrumentSubType
• Referenced Entity Attribute: instrumentSubTypeCode
• Connection: matches
• Value: instrumentSubTypeCode

An alternative version would be to create a link between the two references without creating a new field on the Business Event Definition:

where in the definition of the reference in the Value for connecting attribute you have created a “hook” for another reference by selecting a field from an already defined reference in the drop-down,

here:

• intrumentEnrichment is the name of another reference
• instrumentSubType Code is the name of a field in another Entity called by the instrumentEnrichment reference

1. Go to Configuration > Accounting Configuration > Business Event Definition.
2. On the Business Event Definition screen, click the Edit button.
3. Click the Add field button.
   The screen will automatically scroll down to the new field configuration section.

4. To configure an enriching field:
   1. Type a Field Label. The system will automatically fill out the Field Name. You can type a Field Name different from the Field Label. Once you type a different Field Name and then change the Field Label, the Field Name will not change. However, if you add a mandatory Systemic Field Type, the Field Name will be set to a hardcoded value for this Systemic Field Type.
   2. In the Field Source column, select the name of the reference that creates the connection with the Referenced Entity with the Enriching Attribute.
   3. Select the Enriching Attribute, the field in the Reference Entity from which data will be drawn.
   4. You can choose to set the Enriching Field as a Systemic Field by configuring the Systemic Field Type in the Systemic Field Type column.
   5. The Field Type will by default inherit the field type of the Enriching Attribute. This setting cannot be changed.
5. Once all validation messages are green, the Save button will become active and you will be able to save your enrichment.