Event Authorization API

API Routine: APINAUTH
Parameters: UGNLPARM, UMELAUTH

The Event Authorization API allows users to add, display, or purge information about a particular migration event authorization. The following functions are valid:

A Authorize a migration event.
D Display authorization information for a specific migration event.
P De-authorize a migration event.

This document covers the following topics:


Local Data Area UMELAUTH

The fields to be passed to the API as the second parameter are in the supplied local data area UMELAUTH. The following is a detailed description of these fields:

Field Name Format Description
EVENT A32 Name of the event.
FM-LIBRARY A8 Output - From library name.
FM-FUSER-DBID N5 Output - Database of the Natural system file where the From library is located.
FM-FUSER-FNR N5 Output - File of the Natural system file where the From library is located.
FM-FDIC-DBID N5 Output - Predict database for the From library.
FM-FDIC-FNR N5 Output - Predict file for the From library.
TO-LIBRARY A8 Output - To library name.
TO-FUSER-DBID N5 Output - Database of the Natural system file where the To library is located.
TO-FUSER-FNR N5 Output - File of the Natural system file where the To library is located.
TO-FDIC-DBID N5 Output - Predict database for the To library.
TO-FDIC-FNR N5 Output - Predict file for the To library.
JOB A32 Name of the job that is to perform the migration event.
EXPAND-OPT A1 Auto Expansion option. Valid options are:
    C Include all subordinates
    E Include all subordinate and referenced objects
    R Include referenced objects
    U Include used-by objects
    N Do not Auto Expand
EXPAND-STATUS A32 Name of the status to be used during object list expand.
BATCH-ONLINE A1 Run migration event in batch or online. Valid options are:
    B Migration event is to be run in batch.
    O Migration event is to be run online.
WORKFILE-USAGE A1 Work file usage. Valid options are
    Y (batch migrations only) Work file is to be used during the processing of migration events.
    N Objects to be migrated directly to the target location without using a work file.
COPY-MOVE-INCLUDE A1 Copy, move or include objects.
    C Objects are to be copied, retaining a copy in the source location.
    M Objects are to be moved from the source location with no copy retained. `Move' is only valid when the origin status is a development, test, or maintenance status.
    I Objects are to be included from a work file. `Include' is only valid for batch migrations when the origin status is a development or incorporation status.
REPLACE A1 Replace objects at target destination (Y/N). Valid for development and maintenance destination statuses only.
SCHED-DATE (T) The earliest date and time this event may be submitted.
APPLYMODS A50 Applymods(s) to be switched on during processing of the migration event.
TRANSLATION-TABLE A32 Name of the file translation table (FTT) to be used during processing of the migration event.
CAT-FLAG A1 Alignment events (from CONTROL to CONTROL) and events of migrations from neighbour statuses to CONTROL provide a tripositional switch to be set at authorization time. Valid options are:
    D Default value. Natural objects will be catalogued only if they have been previously catalogued.
    N Natural objects will not be catalogued.
    Y Natural objects will be cataloqued regardless of how they have been immigrated into PAC.
GENERATION-DEFAULTS A8 Predict Generation Defaults to be used during the migration.
AUTH-TIME T Date and time event was authorized.
AUTH-BY A8 User that authorized event.
AUTH-TID A8 Terminal that authorized event.

Event Authorization API Return Codes

7251 Migration Event not found.
7253 Migration Event authorization added.