Delete Journal Receiver Exit Program
Required Parameter Group:
| 1 | Delete journal receiver exit information | Input | Char(*) |
| 2 | Status information | Output | Char(*) |
QSYSINC Member Name: EDLTRCV1
Exit Point Name: QIBM_QJO_DLT_JRNRCV
Exit Point Format Names: DRCV0100
The Delete Journal Receiver exit program is called when a journal receiver is to be deleted.
When a journal receiver is to be deleted, the operating system calls the user-written exit programs through the registration facility. The exit programs will be called before the journal receiver is actually deleted and can indicate whether the exit program considers the receiver eligible for deletion.
The exit point supports an unlimited number of exit programs. For information about adding an exit program to an exit point, see the Registration Facility.
Note: If the Delete Journal Receiver exit program returns any error messages, the journal receiver will not be considered eligible for deletion.
Restrictions
- When a user specifies DLTRCV(*YES) as an attribute of a journal, the system
will attempt to delete the journal receiver when the system sees it is no
longer required for recovery purposes. Before the journal receiver is deleted,
the system will call all of the exit programs registered for the
QIBM_QJO_DLT_JRNRCV exit point. If any of the exit programs give an indication
that the journal receiver is not eligible for deletion, then the journal
receiver will not be deleted. Instead, the system will retry the deletion in
the time specified for the DLTRCVDLY value for the journal. These system
deletion attempts take place in system jobs, during an IPL and during the vary
on of an independent ASP; therefore, the exit program will be allowed to run
for only 5 minutes when called during either of these conditions. If the exit
program has not completed in that time, the system cancels the call, and the
journal receiver will not be considered eligible for deletion.
Note: Since these attempts do occur in system jobs, we recommend that the exit program not send any diagnostic, informational, or completion messages to the job log because those messages would only be in the system job logs.
- If the delete journal receiver is called as part of process end, the exit
program can run for only 5 minutes. If it exceeds 5 minutes, the call is
canceled, and the journal receiver is not eligible for deletion.
- During the call to the exit programs, the debug functions, accessed via
Start Debug (STRDBG), are not available to help debug any exit program
problems.
- During the call to the exit programs the ASP group associated with the job
will not be able to be changed. The ASP group associated with the job will be
the ASP group associated with the journal receiver to be deleted.
- The exit programs must exist in the system Auxiliary Storage Pool (ASP) or in a basic user ASP. It cannot exist in an independent ASP. Any ASP group could be associated with the job when the exit program is called. If the exit program is not found, the journal receiver will not be considered eligible for deletion.
Authorities and Locks
- User Profile Authority
- *ALLOBJ and *SECADM to add exit programs to the registration facility
- *ALLOBJ and *SECADM to remove exit programs from the registration facility
Program Data
When you register the exit program, the following program data can be optionally provided. This program data specifies the user profile under which the exit program being registered will run. If the program data is not provided, the exit programs will run under the QUSER user profile.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Char(10) | User profile |
Required Parameter Group
- Delete journal receiver exit information
- INPUT; CHAR(*)
Information that is needed by the exit program for notification of any journal receiver deletions. For details, see Format of Delete Journal Receiver Exit Information.
- Status information
- OUTPUT; CHAR(*)
Information that is returned by the exit program stating whether the deletion can occur or not. For details, see Format of Status Information.
Format of Delete Journal Receiver Exit Information
The following table shows the structure of the delete journal receiver exit information for exit point format DRCV0100. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Delete journal receiver exit information length |
| 4 | 4 | CHAR(20) | Exit point name |
| 24 | 18 | CHAR(8) | Exit point format name |
| 32 | 20 | CHAR(10) | Journal receiver name |
| 42 | 2A | CHAR(10) | Journal receiver library name |
| 52 | 34 | CHAR(10) | Journal name |
| 62 | 3E | CHAR(10) | Journal library name |
| 72 | 48 | CHAR(1) | Called by system job |
| 73 | 49 | CHAR(1) | Called during IPL or vary on of an independent ASP. |
| 74 | 4A | CHAR(1) | Called during process end |
| 75 | 4B | CHAR(1) | Journal type |
| 76 | 4C | CHAR(1) | Remote journal type |
| 77 | 4D | CHAR(1) | Save status |
| 78 | 4E | CHAR(1) | Partial status |
| 79 | 4F | CHAR(13) | Detached date and time |
Format of Status Information
The following table shows the structure of the status information. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Delete status information length |
| 4 | 4 | CHAR(1) | Delete status |
Field Descriptions
Called by system job. Whether this call was from a user job or a system job. The possible values are:
| 0 | The call is from a user job. |
| 1 | The call is from a system job, and is therefore limited to 5 minutes. |
Called during IPL or vary on of an independent ASP. Whether this call was during an IPL or during the vary on of an independent ASP. The possible values are:
| 0 | The call is not during an IPL or vary on of an independent ASP. |
| 1 | The call is during an IPL or vary on of an independent ASP, and is therefore limited to 5 minutes. |
Called during process end. Whether this call was during process end. The possible values are:
| 0 | The call is not during process end. |
| 1 | The call is during process end. |
Delete journal receiver exit information length. The length in bytes of all data passed to the delete journal receiver exit program.
Delete status. The status value that indicates whether the exit program considers the journal receiver eligible for deletion. The possible values are:
| 0 | The journal receiver is not eligible for deletion. Therefore, the delete journal receiver command will be ended, and the receiver will not be deleted. |
| 1 | The journal receiver is eligible for deletion. |
Note: If any other value is specified for this item, it will be ignored, and the journal receiver will not be eligible for deletion.
Delete status information length. The length in bytes of all data returned from the Delete Journal Receiver exit program. The only valid value for this field is 5. If anything else is entered, the receiver is not considered eligible for deletion.
Detached date and time. The date and time that this journal receiver was detached from the journal. For a journal receiver that was attached to a *REMOTE journal, this is the date and time that the journal receiver was detached on the local system. This field is in the CYYMMDDHHMMSS format as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YYYY | Year |
| MM | Month |
| DD | Day |
| HH | Hours |
| MM | Minutes |
| SS | Seconds |
If the journal receiver was never attached to a journal, this field will be blank. If the journal receiver was never detached from a journal, or if this journal receiver is a partial receiver, this field will be all zeros.
Exit point format name. The format name for the delete journal receiver exit program. The possible format name follows:
| DRCV0100 | The format name that is used before a user journal receiver is to be deleted. |
Exit point name. The name of the exit point that is calling the exit program.
Journal library name. The library name of the journal that is associated with the journal receiver library being deleted. If there is no journal associated with this journal receiver, this field will be blank.
Journal name. The name of the journal that is associated with the journal receiver being deleted. If there is no journal associated with this journal receiver, this field will be blank.
Journal receiver library name. The name of the journal receiver library being deleted.
Journal receiver name. The name of the journal receiver being deleted.
Journal type. An indication of whether the journal currently associated with the journal receiver being deleted is local or remote. The possible values are:
| blank | The journal receiver has not yet been attached to any journal or the receiver is not currently associated with any journal. |
| 0 | *LOCAL |
| 1 | *REMOTE |
Partial status. An indication of whether the journal receiver is a partial receiver. A journal receiver is partial for one of the following reasons:
- It was restored from a version that was saved while it was attached to the
journal. Additional journal entries may have been written that were not
restored.
- It was one of a pair of dual journal receivers, and it was found damaged
while attached to the journal. The journal receiver has since been detached.
This journal receiver is considered partial because additional journal entries
may have been written to the dual journal receiver.
- It is associated with a remote journal and it does not contain all the journal entries that are in the associated journal receiver attached to the source journal.
The possible values are:
| 0 | The journal receiver is not a partial journal receiver. |
| 1 | The journal receiver is a partial journal receiver. |
Remote journal type. If this journal receiver was attached to a remote journal, this field is the remote journal type for that journal, when this journal receiver was attached. The possible values are:
| blank | The journal receiver has not yet been attached to any journal. |
| 0 | The journal receiver was attached to a local journal. |
| 1 | The journal receiver was attached to a *TYPE1 remote journal. |
| 2 | The journal receiver was attached to a *TYPE2 remote journal. |
Save status. An indication of whether the journal receiver has been saved after it was detached. The possible values are:
| 0 | The journal receiver has not been saved after it was detached. |
| 1 | The journal receiver has been saved after it was detached. |
User profile. The exit program will be called under this user profile. If the user profile is not valid at the time the exit programs are called, the QUSER user profile will be used.
IPL Processing Guidelines
The following operations may be performed during the IPL. If any other actions take place, the Delete Journal Receiver exit program may not run successfully or the results will be unpredictable.
- Working with physical files, including creating, changing, opening,
closing, clearing, and deleting
- Database input and output operations
- Working with data areas, including creating, changing, retrieving, and
deleting
- Working with data queues, including creating and deleting
- Working with message queues, including creating, clearing, changing, and deleting
Some examples of things your exit program might not be able to do during IPL are:
- Signal any inquiry messages
- Submit any other jobs
- Use or attempt to start any remote communications activities
- Start any subsystems
Exit program introduced: V4R2
[ Back to top | Journal and Commit APIs | APIs by category ]