Check Input-Events (EXIEEN)

This exit is available in COBOL and C language.

Characteristics

Description

This exit can be used to enrich or check the content of Input-Event segments before applying the transformation phases.

This feature is also provided in the ITR506 module. For more information, refer to section ITR506 compatibility with EXIEEN, EXIERG, and EXIEME .

Operating principle

The exit is called for each segment to be processed (detail or aggregation result).

Specific features

When a segment is checked in this exit, the Input-Event that contains the segment may be rejected or the session may be closed. The subsequent functions in the processing phases are then applied to the contents of the Input-Event segments enriched by this exit.

The data in the rejected Input-Event is the enriched data. As a result, when programming this exit, you must handle the case in which Input-Events that have already been enriched are being processed.

Exchanged data

Alphanumeric fields may have different descriptions depending on the programing language and the Latin or UTF-16 format used. For more information, refer to Exits and external calls.

INPUT data

Name in C Name in COBOL Characteristics / Length Use

szSourceCode

 

Alphanumeric / 25

Processing-Context-In code associated with the session(only data available on initialization)

nEntryCode

L10TYPTRT

Numeric / 1

Entry point code

szIEventCode

 

Alphanumeric / 25

Name of the type of Input-Event that contains the segment to be processed

szIEventVersion

 

Alphanumeric / 25

Reference value that defines the version of the processed Input-Event:

  • Date in the YYYYMMDD format
  • Three-digit number

nIEventVersionType

 

Numeric / 1

Version identification type of the processed Input-Event:

  • 1: Version defined by number
  • 2: Version identified by the date value (above)

szIEventInstCode

 

Alphanumeric / 34

Instance code of the Input-Event that contains the segment to be processed

nSegmentNumber

 

Numeric / 4

Number of the segment to be processed in the Input-Event

szSegtCode

 

Alphanumeric / 25

Name of the type of segment to be processed

nSegtLenght

L10LGCRE

Numeric / 4

Length of the segment to be processed

sSegt

F8CRE

Alphanumeric / 4000 max.

Content of the segment to be processed

 

OUTPUT data

Name in C Name in COBOL Characteristics / Length Use

*szErrorLabel

L10ZONERR

Alphanumeric / 50

 

Description of the detected anomaly

nSegtLenght

L10LGCRE

Numeric / 4

Length of the segment optionally enriched.

 

 

 

 

sSegt

F8CRE

Alphanumeric / 4000 max.

Content of the segment optionally enriched.

Return value

L10RETOUR

 

  • 0 zero (PLG_nNOERREUR)
  • 1 (PLG_nANOMALIE), Input-Event rejection request
  • 9 (PLG_nERREURSYSTEME), if a system error is detected, in which case the session is closed

 

Implementation

Description conventions

  Description

1.

You must specify the output data via the function that you have developed at the selected entry point

2.

By default, the return code is zero (OK). If you change it, it must be set to one of the values shown in the preceding table

3.

The Input-Event has already been identified when it is passed to this exit
You cannot modify the identifier values using this exit
However, changes to the content are taken into account during any subsequent transformations

The system keeps the initial values of the identifiers when calling $ENV

4.

By default, the output segment is identical to the input segment

5.

If you request that the Input-Event be rejected (return code = 1) or there is a program error, you must set the error message field containing the error description

 

Parameter settings

This exit can be executed during step T.

script.ges file

Keyword Description/ Value to be defined
>Configuration< Section

 

Turnoff_Exit_IEvent

  • No: Do not cancel exit execution
  • Yes: Cancel exit execution

sys.dat file

Keyword + Section Description/ Value to be Defined
>Enrich_ Exit < Section

 

Segment

  • Yes_C: Execute EXIEEN
  • Yes_Cobol: Execute EXIEEN.cbl
  • No: Do not execute the exit

Module names

Implementation

Platform Directory Name C Program COBOL Program  Equivalent to C Program

Windows

%RDJ_EXEC%\exit

EXIEENC.c

plgdllh.h header file

EXIEEN.cbl

UNIX

$RDJ_EXEC/exit

EXIEENC.c

plgdllh.h  header file

EXIEEN.cbl

MVS

&RDJEXEC..SRCLIB

EXIEENC , plgdllh.h header file

EXIEEN

 

Processing Type Entry Point Label

Open

PLG_nINIT

TRT-INIT (typtrt = 1)

Close

PLG_nFERM

TRT-FIN (typtrt = 3)

Check and enrich segments before processing

PLG_nIDENT_

ENRICHISSEMENT

TRT-CRE (typtrt = 2)

Related Links