Application API

API Routine: APINAPPL
Parameters: UGNLPARM, UAPLAPPL

The Application API allows users to add, modify or display (retrieve) information about a particular application. The following functions are valid:

A Add application.
D Display application (Retrieve).
M Modify an existing application.

This document covers the following topics:


Local Data Area UAPLAPPL

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

Field Name Format Description
APPLICATION A32 Name of the application. You may use application name or alias for the Display and Modify functions.
TITLE A60 Title of the application.
PREFIX A3 Prefix of the application.
LEVEL A10 Level of the application.
GEN-NUMBER P5 Number to be used during event name generation.
PRD-XREF-FORCE A1 Force Predict documentation. Valid options are:
    Y Predict documentation entries must be present before a Natural program can be migrated into PAC.
    N Default.
PCA-USAGE A1 Predict Case usage. Valid options are:
    Y Natural objects for this application have been composed by Predict Case.
    N Default.
DEF-NAT-LIB-DEV A8 Name of the default Development library.
DEF-NAT-LIB-INC A8 Name of the default Incorporation library.
DEF-NAT-LIB-MAINT A8 Name of the default Maintenance library.
#FILLER-PROD A8 Not used.
DEF-NAT-LIB-TEST A8 Name of the default Test library.
MCG A4 The machine code generator MCG option. Valid options are:
    blank MCG is not used.
    N MCG OFF
    Y MCG ON
    I INDX is to be activated.
    O OVFLW is to be activated.
    M MIX is to be activated.
FILE-SECURITY A1 Default DDM use mode. Valid options are:
    A Reading access only.
    D Disallowed.
    U Update.
MIN-CURR-VERS P3 Minimum current versions.
CURR-RETENTION-PERIOD P3 Current retention period.
MIN-ARCH-VERS P3 Minimum archive versions.
ARCH-RETENTION-PERIOD P3 Archive retention period.
LOG-PURGES A1 Log all object purges. Valid options are:
    Y All purges through the Purge Object Version function are to be logged.
    N Default.
MOD-TIME T Date and time application was last modified.
MOD-BY A8 User that last modified application.
MOD-TID A8 Terminal that last modified application.
ADD-TIME T Date and time application was added.
ADD-BY A8 User that added application.
ADD-TID A8 Terminal that added application.
DB2-SUPPORT A1 Access to DB2 files. Valid options are:
    Y Yes.
    N No.
APPL-TYPE-CODE A1 Type of the application. Valid options are:
    D Predict
    N Natural
APPL-SYSDIC-NAME A32 Name of the Predict application carrying the DDMs for application [APPLICATION].
COMPILE-STEPLIBS-1-4 A32 (1:4) Names of default step applications 1 to 4.
COMPILE-STEPLIBS-5-8 A32 (1:4) Names of default step applications 5 to 8.

Application API Return Codes

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