Functions provided by the autoinstall terminal model manager

Table 2 summarizes the external subroutine interfaces provided by the autoinstall terminal model manager. It shows the subroutine call formats, the level-1 trace point IDs of the modules providing the functions for these formats, and the functions provided.

Table 2. Autoinstall terminal model manager’s subroutine interfaces
Format Trace Function
AIIN
AP 0F10
AP 0F11
START_INIT
COMPLETE_INIT
AIIQ
AP 0F18
AP 0F19
LOCATE_TERM_MODEL
UNLOCK_TERM_MODEL
INQUIRE_TERM_MODEL
START_BROWSE
GET_NEXT
END_BROWSE
AITM
AP 0F08
AP 0F09
ADD_REPL_TERM_MODEL
DELETE_TERM_MODEL

AIIN format, START_INIT function

The START_INIT function of the AIIN format is used to attach a CICS® task to perform initialization of the AITM manager.

Input parameters

None.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR

AIIN format, COMPLETE_INIT function

The COMPLETE_INIT function of the AIIN format is used to wait for the initialization task attached by the START_INIT function to complete processing.

Input parameters

None.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR

AIIQ format, LOCATE_TERM_MODEL function

The LOCATE_TERM_MODEL function of the AIIQ format is used to obtain the attributes of a named autoinstall terminal model, and obtain a read lock on that entry in the AITM table in virtual storage.

Input parameters

TERM_MODEL_NAME
specifies the name of the autoinstall terminal model to be located.
BPS
identifies a buffer into which the attributes of the autoinstall terminal model are to be placed.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER TM_LOCATE_FAILED
EXCEPTION TERM_MODEL_NOT_FOUND

AIIQ format, UNLOCK_TERM_MODEL function

The UNLOCK_TERM_MODEL function of the AIIQ format is used to release a read lock on a previously located entry from the AITM table in virtual storage.

Input parameters

TERM_MODEL_NAME
specifies the name of the autoinstall terminal model to be unlocked.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER TM_UNLOCK_FAILED
EXCEPTION TERM_MODEL_NOT_FOUND

AIIQ format, INQUIRE_TERM_MODEL function

The INQUIRE_TERM_MODEL function of the AIIQ format is used to obtain the attributes of a named autoinstall terminal model. (No read lock is retained.)

Input parameters

TERM_MODEL_NAME
specifies the name of the autoinstall terminal model to be located.
BPS
identifies a buffer into which the attributes of the autoinstall terminal model are to be placed.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
TM_LOCATE_FAILED
TM_UNLOCK_FAILED
EXCEPTION TERM_MODEL_NOT_FOUND

AIIQ format, START_BROWSE function

The START_BROWSE function of the AIIQ format is used to initiate a browse of the AITM table. The browse starts at the beginning of the table.

Input parameters

None.

Output parameters

BROWSE_TOKEN
is a token used to refer to this browse session on subsequent browse requests.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. It has this value:
START_BROWSE_FAILED

AIIQ format, GET_NEXT function

The GET_NEXT function of the AIIQ format is used to obtain the name and attributes of the next autoinstall terminal model in the AITM table for the specified browse session.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.
BPS
identifies a buffer to receive the attributes of the next entry in the AITM table.

Output parameters

TERM_MODEL_NAME
is the name of the next entry in the AITM table.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
TM_GET_NEXT_FAILED
TM_UNLOCK_FAILED
EXCEPTION END_OF_MODELS

AIIQ format, END_BROWSE function

The END_BROWSE function of the AIIQ format is used to terminate a browse of the AITM table.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have either of these values:
OK|KERNERROR

AITM format, ADD_REPL_TERM_MODEL function

The ADD_REPL_TERM_MODEL function of the AITM format is used to add or update an entry in the AITM table in virtual storage, and record the entry on the CICS catalog.

Input parameters

TERM_MODEL_NAME
specifies the name of the autoinstall terminal model to be added or updated.
BPS
specifies the attributes of the named autoinstall terminal model.
SYSTEM_STATUS
specifies the status of the CICS system at the time of the call. It can have any one of these values:
COLD_START|WARM_START|ONLINE
where ONLINE means during execution.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
NOT_INITIALISED
ADD_REPL_FAILED
EXCEPTION TERM_MODEL_IN_USE

AITM format, DELETE_TERM_MODEL function

The DELETE_TERM_MODEL function of the AITM format is used to remove an entry from the AITM table in virtual storage and the CICS catalog.

Input parameters

TERM_MODEL_NAME
specifies the name of the autoinstall terminal model to be added or updated.
SYSTEM_STATUS
specifies the status of the CICS system at the time of the call. It can have any one of these values:
COLD_START|WARM_START|ONLINE
where ONLINE means during execution.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
NOT_INITIALISED
DELETE_FAILED
EXCEPTION
TERM_MODEL_IN_USE
TERM_MODEL_NOT_FOUND
[[ Contents Previous Page | Next Page Index ]]