Exits and external calls

Exits

The table below shows the exits you can use and what they do:

  Possible Actions

1

Reformat the Input-Events on receipt of the message
This is specific to MQSeries or JMS

2

Restructure the Input-Events

3

Enrich the Input-Events during aggregation

4

Check and enrich the Input-Events before the Transformation-Phases are applied

5

Check and enrich the Input-Event segments for a specific Transformation-Rule

6

Identify and check the Output-Events

7

Enrich the Output-Events during aggregation by group

8

Enrich the Output-Events during aggregation (all groups together)

9

Restructure the Output-Events

10

Reformat the transformation products before a message is issued. This is specific to MQSeries or JMS

AI Enabler launches the exits related to step T (4 to 6), whereas the other exits are activated in the Script file in the Axway Rule Engine environment.

The table below shows the values that you can use for all the exits listed above, with the exception of the MQSeries-specific and the JMS-specific reformatting exits:

Value Use

Yes_C

Activates  the C language version of the exit

Yes_Cobol

Activates  the Cobol language version of the exit

Yes_Rdj53

Exit compatible with version 1.5.3

No

The exit is not activated

The following sections describe the keywords to which you assign the above values.

For a full description of the use of these exits, refer to Manage exits and external calls, which gives details of the entry points and the data that is exchanged between the main program and these modules.

Reformat the Input-Events on receipt of the message (MQSeries mode only)

This exit, written in C, reformats the data contained in Event messages as they are received, before they are processed in any way by a transformation session.

This exit is activated directly by the definition of an Input-Event exchange zone in script.mqs.

Queue= MQS , "Manager=Qmngr;Queue=queuename; Reformatting=Yes,Blocking=Yes;Buffer=nb"

Rules to follow:

Rule Meaning

1

Reformatting:

Optional parameter

If this parameter is not supplied, the exit is not activated

  • Yes: The reformatting exit is activated
  • No: The reformatting exit is not activated

Reformat the Input-Events on receipt of the message (JMS mode only)

This exit, written in C, reformats the data contained in Event messages as they are received, before they are processed in any way by a transformation session.

This exit is activated directly by the definition of an Input-Event exchange zone in script.jms.

Queue= MQS , "Manager=QCF;Queue=queuename; Reformatting=Yes,Blocking=Yes;Buffer=nb"

Rules to follow:

Rule Meaning

1

Reformatting:

Optional parameter

If this parameter is not supplied, the exit is not activated

  • Yes: The reformatting exit is activated
  • No: The reformatting exit is not activated

Restructure Input-Events (File mode only)

This exit restructures the Input-Events immediately after they have been read in.
It allows you to:

  • Create
  • Merge
  • Re-order
  • Delete
  • Change the contents of Input-Event segments

This exit can be activated while the Input step (E) is active.

Parameter settings in script.fic and sys.dat

Keyword Description/Values

>sys.dat>ScriptConfiguration< Section

I_Exit_Restructuring_IEvent

Yes_C or No

>Script.ges< Section

I_Tmp_IEvent_Restructuring

Temporary exchange zone into which the restructured Input-Events are written

Enrich Input-Events during aggregation (File mode only)

This exit modifies or enriches the data in the Input-Event segments before and after they are aggregated. It is only activated if the Input-Events are to be aggregated.

This exit can be activated while the Input step (E) is active.

Parameter settings in sys.dat

Keyword Description/Values

>ScriptConfiguration< Section

Yes_C or Yes_Cobol or Yes_rdj53 or No

E_Exit_Agregation_Cre

Yes_rdj53 is compatible with ITR025

Check and enrich Input-Events before transformation

This exit checks or enriches the data in the Input-Event segments before they are processed in the Transformation-Phases.

This exit can be activated while the Processing step (T) is active.

Parameter settings in script.ges

Keyword Description/Values

>Configuration< Section

Turnoff_Exit_

ISegt

  • No
  • Yes: Turns the exit off

Check and enrich the Input-Event segments for a specific transformation-Rule

This exit modifies, enriches or checks the data in the Input-Event segments before each application of a change or Transformation-Rule.

This exit can be activated while the Processing step (T) is active.

Parameter settings in script.ges

Keyword Description/Values

>Configuration< Section

Turnoff_Exit_Rule

  • No
  • Yes: Turns the exit off

Identify and check Output-Events

This exit enriches or checks the Output-Events, or identifies the output, before the Output-Events are processed. This exit is enabled in AI Enabler.

This exit can be activated while the Processing step (T) is active.

Parameter settings in script.ges

Keyword Description/Values

>Configuration< Section

Turnoff_Exit_OSegt

  • No
  • Yes: Turns the exit off

Enrich Output-Events during aggregation by group (File mode only)

This exit enriches the data in the Output-Event segments before and after they are aggregated. It is only activated if the Output-Events are to be aggregated.

This exit can be activated while the Processing step (T) is active.

Parameter settings in sys.dat

Keyword Description/Values

>ScriptConfiguration< Section

Yes_C or Yes_Cobol or Yes_rdj53 or No

P_Exit_Aggregation_OSegt_Group

Yes_rdj53 is compatible with ITR615

Enrich Output-Events during aggregation - All groups together
(File mode only)

This exit enriches the data in the Output-Events before and after they are aggregated. It is only activated if the Input-Events are to be aggregated.

This exit can be activated while the Output step (S) is active.

Parameter settings in sys.dat

Keyword Description/Values

>ScriptConfiguration< Section

O_Exit_Aggregation_OSegt

  • Yes_C or Yes_Cobol or Yes_rdj53 or No
  • Yes_rdj53 is compatible with ITR615

Restructure Output-Events (File mode only)

This exit restructures the data in the Output-Event just before they are physically written out. It allows you to:

  • Create
  • Merge
  • Delete
  • Change the contents of Output-Events

This exit can be activated while the Output step (S) is active.

Parameter settings in sys.dat

Keyword Description/Values

>ScriptConfiguration< Section

O_Exit_Restructuring_OSegt

Yes_C or No

Reformat the transformation products before issuing a message
(MQSeries mode only)

This exit, written in C, reformats the data contained in Output-Event messages and other products immediately before they are sent, after the completion of processing in a transformation session.

This exit is activated directly by the definition of an exchange zone for the product concerned in script.mqs.

Queue= MQS , "Manager=Qmngr;Queue=queuename; Reformatting=Yes,Blocking=Yes;Buffer=nb"

Rules to follow:

Rule Meaning

1

Reformatting:

Optional parameter

If this parameter is not supplied, the exit is not enabled

  • Yes: The reformatting exit is enabled
  • No: The reformatting exit is not enabled

Reformat the transformation products before issuing a message
(JMS mode only)

This exit, written in C, reformats the data contained in Output-Event messages and other products immediately before they are sent, after the completion of processing in a transformation session.

This exit is activated directly by the definition of an exchange zone for the product concerned in script.jms.

Queue= MQS , "Manager=QCF;Queue=queuename; Reformatting=Yes,Blocking=Yes;Buffer=nb"

Rules to follow:

Rule Meaning

1

Reformatting:

Optional parameter

If this parameter is not supplied, the exit is not enabled

  • Yes: The reformatting exit is enabled
  • No: The reformatting exit is not enabled

External calls

External calls comprise a set of independent modules all stored in the ITR501 module. They are activated automatically by the Data Manipulation Language $SEARCH and $CHECK commands. These are the only keywords which activate the external calls.

In the same way as for the exits, the use of this external call is described in the Rule Engine Exits and External Calls Manual, which gives details of the entry points and the data that is exchanged between the main program and this module.

Implement the Oracle $SEARCH function in a file, MQSeries or JMS-based environment

You must supply the following variables, in procedure rdjexp, to allow the ITR501 external calls to connect to the database that you want to access:

Name Use

RDJ_EXIT501_ORACLE_SRV

Name of the database server to be accessed

RDJ_EXIT501_ORACLE_USER

User name for connecting to the database

RDJ_EXIT501_ORACLE_PWD

Password associated with the above user name

This module exists in C (ITR501C) and Cobol (ITR501).

For more information on Exits and External calls, refer to Exits and External Calls.

Related Links