Migration Path API

API Routine: APINPATH
Parameters: UGNLPARM, UMPLPATH

The Migration Path API allows users to add, modify or display (retrieve) information about a particular migration path. The following functions are valid:

A Add migration path.
D Display migration path (retrieve).
M Modify an existing migration path.

This document covers the following topics:


Local Data Area UMPLPATH

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

Field Name Format Description
APPLICATION A32 Name of the application linked to the statuses.
FM-STATUS A32 Name of the status from which the application is to be migrated.
TO-STATUS A32 Name of the status to which the application is to be migrated.
EXPAND-STATUS A32 Name of the status to be used during object list expand.
JOB A32 Name of the job that is to perform that migration event.
AUTO-EXPAND A1 Autoexpansion option.
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 Work file is to be used during the processing of migration events, valid for batch migrations only.
    N Default.
COPY-MOVE-INCLUDE A1 Copy, move, or include objects:
    C Objects are to be copied, but still exist in the origin location.
    M Objects are to be moved from the origin location with no copy to exist in the origin location. `Move' is only valid from a development, test, or maintenance status.
    I Objects are to be included from a work file. `Include' is only valid for batch migrations from a development or incorporation status.
SEPARATE-AUTHORITY A1 Authorizer of the event who is different from the person who created the event.
AUTHORIZERS A8 (1:8) ID of the user or group who can authorize the event.
ADD-TIME T Date and time the migration path was added.
ADD-BY A8 ID of the user who added the migration path.
ADD-TID A8 ID of the terminal at which the migration path was added.
MOD-TIME T Date and time the migration path was last modified.
MOD-BY A8 ID or the user who last modified the migration path.
MOD-TID A8 ID of the terminal at which the migration path was last modified.

Migration Path API Return Codes

7250 Migration path exists.
7251 Migration path not found.
7253 Migration path added.
7254 Migration path has been modified.