Change package pre-processing parameters

The following table describes the parameters that appear after the common header in the communication area for a change package pre-processing exit.

The communication area has the same layout for every change package pre-processing exit. However, while the layout is the same, not all of the parameter values in that layout are initialized for every exit point. The server initializes only the parameter values that are relevant to each exit point. Also, user exit programs can only alter (pass back to the server) selected parameters. The following table describes the parameters, and identifies the exit points for which the parameter values are initialized, and the exit points that can alter these parameter values.

Start of changeMember CCVXCRC of the sample library SCCVSAMP shows a pre-processing exit point parameter list as a COBOL sample.End of change

Start of change
Table 1. User exit parameters: change package pre-processing
Parameter User exit access to parameter: read-only (R), modifiable (M), or not supplied (×)
Approve Backout Start of changeCreate, Update, or DeleteEnd of change Disapprove Discard or Newcopy Import Install Migrate Ready or Unready
Change package ID R R R R R R R R R
External reference R R M R R R R R R
Migration scheme R R × R R R R R R
Approval profile R × M R × × × × ×
Pointer to package-scheme R R × R R R R R R
Pointer to XML API command request R R × R R R R R R
Check state of Approve command  2  M × × × × × × M ×
Approval status  1  M R × M R × × R ×
Approver role R × × R × × × M ×
Approver user ID R × × R × × × M ×
Check state of Disapprove command  2  × × × M × × × × ×
Check state of Import command  2  × × × × × R × × ×
Migration status  3  × R × × × × × R ×
Check state of Ready command  2  × R × × R × R × R
Ready status  4  × R × × R R R R R
Creator user ID R R R R R R R R R
Description R R M R R R R R R
Notes R R M R R R R R R
Start of changeLast-command parameters 5 End of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change Start of changeREnd of change
End of change
 1 
Approval status values:
A
Fully approved
P
Partially approved
N
No approvals
 2 
The command "check state" flags indicate whether the command would normally (without the influence of a return code from the exit program) succeed or fail.
 3 
Migration status value of the change package:
N
Never been migrated using this migration scheme
Y
Has previously been successfully migrated using this migration scheme
 4 
Ready status value of the change package:
N
Not ready
Y
Ready
Start of change 5 End of change
Start of changeInformation about the last API command that processed the change package. Eight last-command parameters are available:
  • Name of API command
  • Migration scheme
  • Date in store clock (STCK) format
  • Date in YYYY/MM/DD HH:MM:SS::hh format
  • User ID
  • Event ID
  • Return code
  • Reason code

The values of the last-command parameters do not change as a result of an Update command, such as when you edit the description of a change package.

End of change