Invoking user exit programs after receiving a notification

You can invoke a user exit program after receiving a notification in Management Console.

You may prefer to set up a user exit that triggers certain operations upon specific CDC Replication events.

If you want to invoke user exit programs when CDC Replication generates a notification, the library list for the job description that is used by CDC Replication jobs must include the libraries where the user exit programs reside. Since the library list for the default job description references the CDC Replication product library, it is recommended that you place the user exit programs in the product library to ensure they are found during replication.

Return Code (RTNCD)
The return code that indicates whether or not the user exit program was successful.
In the user exit program, return blank characters if no errors occurred in the user exit program or non-blank characters if an error occurred.
User Exit Program Name (PGMNM)
The name of the user exit program that was called.
This is the name of the program that you specify in Management Console.
Source (Publisher) or Target (Subscriber) Indicator (ENGTYP)
The environment in which the user exit program was called.
These are the possible returns:
  • 1: Publisher
  • 2: Subscriber
Publisher ID or Subscription (SRTGTN)
The source identifier (if program was called from a target) or the name of the subscription (if program was called from a source) from which the user exit program was called.
Source identifiers and subscriptions are defined in Management Console.
Zone (ZONE)
The functional zone for which the user exit program was invoked.
If Source (Publisher) or Target (Subscriber) Indicator is set to 1, one of the following zone settings apply:
  • 1: SCRAPE/REFRESH
  • 2: COMMUNICATIONS
  • 3: ENVIRONMENT
  • 4: JOURNAL/LOG MAINTENANCE
If Source (Publisher) or Target (Subscriber) Indicator is set to 2, one of the following zone settings apply:
  • 1: APPLY
  • 2: COMMUNICATIONS
  • 3: ENVIRONMENT
Category (CTGRY)
The message category for which the user exit program was invoked.
These are the possible returns:
  • 1: Fatal
  • 2: Error
  • 3: Informational
  • 4: Status
  • 5: Operational
Area (AREA)
A parameter reserved for future development.
Message Id (MSGID)
The identifier of the message that caused the user exit program to be invoked.
Message Text (MSGTXT)
The text that has been substituted into the message.
Message Length (MSGLN)
The length of the text (in bytes) that has been substituted into the message.
Send Date (SNDDTE)
The date when the message was sent.
The date is expressed in *ISO format.
Send Time (SNDTME)
The time when the message was sent.
The time is expressed in *ISO format.
Journal Sequence Number (JOSGN)
The sequence number assigned to the journal entry by the system.
Journal Name (JOJRN)
The name of the journal.
Journal Library (JOJLIB)
The name of the library where the journal is located.
Journal Receiver Name (JORCNM)
The name of journal receiver attached to the journal.
Journal Entry Code (JOCODE)
The primary category of the journal entry.
Journal Entry Type (JOENT)
The type of user-created or system-created entry.
System Entry Type (JRENT)
The type of system-created entry.
Journal Entry Timestamp (JOTST)
The system date and time when the entry was journaled.
Publisher Job Name (JOJOB)
The name of the job that generated the journal entry.
Publisher Job User (JOUSR)
The user profile of the user that started the job.
Publisher Job Number (JONBR)
The job number of the job that generated the journal entry.
Publisher Program Name (JOPGM)
The name of the program associated with the journal record.
Source Table Name (JOOBJ)
The name of the source for which the journal entry was generated.
Source Table Library (JOLIB)
The name of the library containing the source table.
Source Table Member Name (JOMBR)
The name of the source member.
Publication RRN (JOCTR)
The relative record number (RRN) of the row that caused the journal entry or a count that is pertinent to the specific type of journal entry.
Journal Flag (JOFLG)
Based on the type of entry, indicates whether or not there is extended information.
The following values determine whether or not extended information is presented:
  • 1--Extended information is available.
  • 0--No extended information is available.
The extended information is placed immediately after the Entry Specific Data and will have the following structure:
Length (4 bytes)
Total length of the extended entry.
Format (7 bytes)
Format of extended information.
Currently, it is ‘DM_0100'.
Extended Object Name (128 bytes)
Full name of source table.
Extended Schema Name (137 bytes)
Full name of source schema.
Commit Cycle ID (JOCID)
The number that identifies the commit cycle. This number only applies to an entry associated with a commitment transaction.
Publisher Job User (JOUSPF)
The name of the user profile under which the job was running when the entry was created.
Publication Server Name (JOSYNM)
The name of the system on which the journal entry was generated.
Target Table Name (TGTTBL)
The name of the target table that has been identified to receive transferred data.
Target Table Library (TGTLIB)
The name of the library where the target table is located.
Target Table Member (TGTMBR)
The name of the member in the target table that has been identified to receive transferred data.