External interface

Triggering API

This section briefly describes the application programming interface (API) for Triggering.

The Triggering API is stored in the datrgapi library. This library contains functions to:

  • Create a trigger
  • Check whether a trigger exists to be used from the Exchange module
  • Invoke a trigger
  • Delete a trigger

The library does not contain functions to change an existing trigger, except functions for adding components such as conditions or actions.

Points of attention
  • Triggers are run synchronously
  • Component and attribute names cannot exceed 40 characters in length
More information

For detailed information on the Triggering API, refer to the specifications of the datrgapi library.

You can retrieve the library specifications from the library objects. At operating-system level, use explode6.2 to locate the library object, and subsequently use bic_info6.2 with the -eu options.

For example:

$ explode6.2 odatrgevent

/mybse/application/myvrc/odatrg/otrgevent

$ bic_info6.2 –eu /mybse/application/myvrc/odatrg/otrgevent

This shows the documentation of the event handling functions.

This method provides the following:

  • Prototypes, including the function name and type and parameters and their types, of the functions in the library
  • A description of the functions and their input and output
  • The preconditions and post-conditions.