Enhancements to the control group exit program
The exit program now has the ability to run at the end of the control group (in addition to, or instead of after each item backed up).
New information in the user space header to the exit program includes:
o Completion Type
B = For a Backup Item C= For the Control Group
...
The interface has been updated to reflect the functionality.
BKUI0200–Backup Item Entry Information
The following table defines the enhanced format for backup item entry information. This format is only valid for backup control groups.
Offset | Type | Field | |
|---|---|---|---|
Dec | Hex | ||
0 | 0 | Binary(4) | Number of entries |
4 | 4 | Binary(4) | Length of entry information |
8 | 8 | Binary(4) | Starting message key |
12 | C | Binary(4) | Ending message key |
16 | 10 | Binary(4) | Offset to first entry |
20 | 14 | Char(1) | Completion type |
21 | 15 | Char(1) | Completion status |
22 | 16 | Char(7) | Completion error message |
The following fields repeat for each entry. | |||
|
| Binary(4) | Offset to next entry |
|
| Binary(4) | Length of entry |
|
| Binary(4) | Offset to command |
|
| Binary(4) | Length of Command |
|
| Binary(4) | Sequence |
|
| Char(10) | Backup item |
|
| Char(4) | Backup item type |
|
| Char(10) | Backup item auxiliary storage pool device |
|
| Char(*) | Command |
Using the enhanced functionality
Backup item auxiliary storage pool device
The auxiliary storage pool device for the backup item. See the help on the Edit Backup Control Group Entries display for additional information and possible values returned in the field. This field may be blank for entries which do not support this field.
Backup item
The backup item just processed. See the help on the Edit Backup Control Group Entries display for additional information and possible values returned in the field.
Backup item type
The backup item type just processed. See the help on the Edit Backup Control Group Entries display for additional information and possible values returned in the field.
Command
The command just processed for *EXIT backup items. The command is returned in UNICODE CCSID 1200.
Completion error messageThis message
This is the error message for a backup item or control group that completes processing with errors or fails. If completion status is, N, this field will be blank.
Completion status
The completion status for the backup item or control group is designated with:
N | Normal completion |
E | Completed with errors |
F | Failed to complete |
Completion type
Indicates the type of completion information:
B | Backup item |
C | Backup control group |
Ending message key
This is the ending message key for receiving messages generated by the processed entries. The exit program can receive messages for processed entries beginning with the starting message key through the ending message key.
...
This is the starting message key for receiving messages generated by the processed entries. The exit program can receive messages for processed entries beginning with the starting message key through the ending message key.
Using the Old World Call
To set the exit program to use format BKUI0200 which runs the exit program only at the end of the control group run one of the following commands:
In 7.3 and 7.4 run the following commands:
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPFM2 ' '*JOB') - set up for current job only
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPFM2' '*SYS') - set up to affect all jobs
In 5770-BR2 7.4, 5770-BR2 7.5, and 5770-BR1 7.5 run the following command:
SETFCNBRM ACTION(*ADD) FUNCTION(BUEPFM2) SCOPE(*SYS)
| Info |
|---|
The SCOPE parameter also supports *JOB to only affect the current signed on job. |
To set the exit program to use format *BOTH which runs the exit program after each backup item and again at the end of the control group run one of the following commands:
In 5770-BR1 7.3 and 7.4 run the following commands:
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPALL ' '*JOB') - set up for current job only
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPALL' '*SYS') - set up to affect all jobs
To In 5770-BR2 7.4, 5770-BR2 7.5, and 5770-BR1 7.5 run the following command:
SETFCNBRM ACTION(*ADD) FUNCTION(BUEPALL) SCOPE(*SYS)
| Info |
|---|
The SCOPE parameter also supports *JOB to only affect the current signed on job. |
To set the exit program back to the default format BKUI0100 which runs the exit program after each backup item run one of the following commands:
In 5770-BR1 7.3 and 7.4 run the following commands:
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPFM1' '*JOB') - set up for current job only
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*SET ' 'Q1ABUEPFM1' '*SYS') - set up to affect all jobs
In 5770-BR2 7.4, 5770-BR2 7.5, and 5770-BR1 7.5 run the following command:
SETFCNBRM ACTION(*ADD) FUNCTION(BUEPFM1) SCOPE(*SYS)
| Info |
|---|
The SCOPE parameter also supports *JOB to only affect the current signed on job. |
To remove:
These ALL remove the Data Area at the job level, no need to run it for each function name.
In 5770-BR1 7.3 and 7.4 run the following commands:
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPFM1' '*JOB') - remove for current job only
or CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPFM2' '*JOB') - remove for current job only
or CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPALL' '*JOB') - remove for current job only
These ALL remove the Data Area for all jobs, no need to run it for each function name.
CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPFM1' '*SYS') - remove for all jobs
or CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPFM2' '*SYS') - remove for all jobs
or CALL QBRM/Q1AOLD PARM('SETUPFUN ' '*REMOVE ' 'Q1ABUEPALL' '*SYS') - remove for all jobs
In 5770-BR2 7.4, 5770-BR2 7.5, and 5770-BR1 7.5 run one of the following command:
SETFCNBRM ACTION(*REMOVE) FUNCTION(BUEPFM1) SCOPE(*SYS)
SETFCNBRM ACTION(*REMOVE) FUNCTION(BUEPFM2) SCOPE(*SYS)
SETFCNBRM ACTION(*REMOVE) FUNCTION(BUEPALL) SCOPE(*SYS)
| Info |
|---|
The SCOPE parameter also supports *JOB to only affect the current signed on job. |
To check what is setup:
In 5770-BR1 7.3 and 7.4 run the following:
These ALL return the same info, no need to run it for each function name.
CALL QBRM/Q1AOLD PARM('SETUPFUN' '*DISPLAY' 'Q1ABUEPFM1' )
or CALL QBRM/Q1AOLD PARM('SETUPFUN' '*DISPLAY' 'Q1BUEPFM2' )
or CALL QBRM/Q1AOLD PARM('SETUPFUN' '*DISPLAY' 'Q1ABUEPALL' )
In 5770-BR2 7.4, 5770-BR2 7.5, and 5770-BR1 7.5 to display what the current setting is run the following command:
DSPFCNBRM FUNCTION(*ALL) then press F10 to see the detailed results.