Event Framework
R24 AMR | Min(s) read

Editing Flows Without Using Event Designer

Integration Framework provides various exit points to capture business events and data events. Each exit point has associated flow. These flows defines the data to capture and the parameters that defines where to route the captured data, priority of events, etc. To edit the flows, one need Event Designer including the parameters that require changes based on the deployments. Event Designer is licensed and Designers are not allowed in production environments. This section shows you how to edit flows without using the event designer.

Editing a Flow by Using a Temenos Transact Application

The IF.FLOW.OVERRIDE application allows you to edit a particular flow. You need to create a record in this application with a valid flow name as its record ID.

The following are the fields present in the IF.FLOW.OVERRIDE application:

  • DESCRIPTION – Holds the description of the flow attributes entered by the user in various languages.
  • MERGE.TO.FLOW – Denotes the value of next set of fields that need to be merged to the IF.INTEGRATION.FLOW.CATALOG.

    Value

    Action

    None

    Apply the changed value to the flow if the flow is available

    Y

    Apply the changed value to the flow if the flow is available and clear the value

    N

    Authorise the record but don’t merge the data to the flow

  • EVENT.PRIORITY – Denotes the priority of the flow. If no value is provided, then the existing event priority in the flow will not be amended.
  • DELIVERY.MODE – Denotes the mode of delivery to be applied. This can be any one of the following values:

    Value

    Action

    None

    The default delivery mode set via Event Designer is retained for the flow record in the IF.INTEGRATION.FLOW.CATALOG table with no changes.

    CLASSIC

    The mode of delivery is switched to integration service or adapter based on the IF.INTEGRATION.SERVICE.PARAM configuration or adapter. This removes the RAW-XML attribute if chosen. The IF event data values are stored in IF.EVENTS.INTERFACE.TABLE as a key value pair FIELD.NAME, FIELD.VALUE and OLD.FIELD.VALUE.

    CLASSIC.RAW.XML

    The flow attribute RAW-XML is added in the IF.INTEGRATION.FLOW.CATALOG record. Also, the mode of delivery is switched to integration service or adapter based on the IF.INTEGRATION.SERVICE.PARAM configuration or adapter. The IF event data values are stored in IF.EVENTS.INTERFACE.TABLE as an internal XML representation in the EVENT.DATA and OLD.EVENT.XML fields.

    WRITE.TO.QUEUE

    The RAW-XML attribute is added and the delivery mode posts the message to the queue mentioned in the QUEUE.NAME field.

    WRITE.TO.OUTBOX

    The WRITE_TO_OUTBOX flow attribute is added. The IF event is redirected to outbox.

    STREAMING.EVENT

    The STREAMING_EVENT flow attribute is added in the corresponding IF.INTEGRATION.FLOW.CATALOG record. The IF event is redirected to DES.

  • QUEUE.NAME – Allows events to be delivered to a specific queue. It holds the destination to deliver the events. If the delivery mode is WRITE.TO.QUEUE, then the queue name should be provided. This represents the queue to which the Raw IF event is posted when using direct posting.
  • WRITE.TO.ARCHIVE – Adds the WRITE_TO_ARC and RAW_XML attributes in the IF.INTEGRATION.FLOW.CATALOG record, when selected. It is enabled when the DELIVERY.MODE is WRITE.TO.QUEUE. This option writes to $ARC file if the direct posting had posted the message to queue successfully.
  • COMPANIES – Provides the list of valid companies for which the event needs to be triggered.
  • DISABLE.FLOW – Allows you to disable a flow, means integration event will not be generated for the disabled flow. Also, you can enable the flow that is disabled already. When authorizing the change, the details on a flow being disabled or enabled would be marked in the FLOW.DISABLED field of IF.EXIT.POINTS. Below are the values and the actions for this field:
    ValueAction

    None or any other value other than Y or N (including small case)

    This field is ignored when merging the changes.

    Y

    The flow is disabled.

    N

    A flow if disabled, will be enabled and start generating integration events.

After authorisation, the record in the IF.FLOW.OVERRIDE application updates the IF.INTEGRATION.FLOW.CATALOG and IF.EXIT.POINTS records with the required values.

Editing a Flow by Using Command Line Utilities

The following section shows a table with the utilities required to edit the flows.

Utility Description
Update event priority

A new utility program need to be written to update the priority. This updates the EVENT.PRIOTITY field of flow record.

The name of the utility is IF_UpdateEventPriority and the corresponding syntax to call the program is:

IF_UpdateEventPriority <OFS Source> -flowName=<valid flow name> -priority=<a value from 0>

Update the queue name

Updates the queue name and the DESTINATION field of flow record.

The name of the utility is IF_UpdateDestination and the corresponding syntax to call the program is:

IF_ UpdateDestination <OFS Source> -flowName=<valid flow name> -destination=<any string that represents queue name>

Update the WRITE_TO_ARC attribute

When a direct message is posted to the queue, there is an option to write the IF event to archive table. This is managed by the flow attribute WRITE_TO_ARC. This utility needs to update the FLOW.ATTRIBUTE with the archive write setting of flow record.

The name of the utility is IF_UpdateArchiveOption and the corresponding syntax to call the program is:

IF_ UpdateArchiveOption <OFS Source> -flowName=<valid flow name> -writeToArchive=< y or n>

Modify companies list

Integration Framework allows integration event to be triggered for specific companies. This option should be customized using utility. The company name needs to be a valid lead company and you can also add the value ALL to the companies list.

The name of the utility is IF_UpdateCompaniesList and the corresponding syntax to call the program is:

IF_UpdateCompaniesList <OFS Source> -flowName=<flowName> -add=<comma separated company Names> -remove=<comma separated company names>

Update delivery mode

Integration Framework supports the following delivery modes:

  • Classic – Denotes integration service or adapter based polling
  • Classic Raw XML – Similar to classic but the data is stored in raw XML format instead of key value pair
  • Streaming event – Events are redirected to streaming platform
  • Write to outbox – Events are redirected to outbox
  • Write to queue – Events are redirected to queue

This utility is used to update the event delivery mode set in flow record. The name of the utility is IF_UdpateDeliveryMode and the corresponding syntax to call the program is:

IF_UdpateDeliveryMode <OFS Source> -flowName=<flowName> -deliveryMode=<CLASSIC|CLASSIC.RAW.XML|STREAMING.EVENT|WRITE.TO.OUTBOX|WRITE.TO.QUEUE –queueName=<optional but mandatory for WRITE.TO.QUEUE> -writeToArchive=<Y or N, optional but may be present for WRITE.TO.QUEUE>

Enable or disable flow

A utility program IF.EnableDisableFlow, which enables or disables a flow using command line. The syntax of the utility is:

IF.EnableDisableFlow <OFS Source> -flowName=<flow name> -disable=<Y or y or N or n>

Copyright © 2020- Temenos Headquarters SA

Published on :
Monday, May 27, 2024 4:41:15 PM IST