APINLNKS

#### Search Results

Search

# APINLNKS

This API lets obtain a chunk of a list of PAC application - status links.

APINLNKS can be invoked with:

    CALLNAT 'APINLNKS' API-PARM API-LNKS-PARM

To obtain a chunk set API-PARM.API-MAIN-FUNC at 'S'. API-PARM.API-SUB-FUNC is not used by APINLNKS.

This document covers the following topics:

- Local Data Area UPILLNKS

- API Return Codes

## Local Data Area UPILLNKS

A definition of API-LNKS-PARM is provided in LDA UPILLNKS.

Field Name | Format | Description
--- | --- | ---
API-LNKS-PARM |  |
ORDER | A1 | in
APPLICATION | A33 | in
APPLICATION-TYPE | A16 | in
STATUS | A33 | in
STATUS-TYPE | A16 | in
FILE-TRANS-TABLE | A33 | in
STEP-APPL-CNT-FM | N3 | in
STEP-APPL-CNT-TO | N3 | in
STEP-APPL | A33 (1:8) | in
PRD-CASE-LIB | L | in
NEIGHBOUR-APPL | A33 | in
LIBRARY | A9 | in
FUSER-DBNR-COND-K | A1 | in
FUSER-DBNR-COND-M | A5 | in
FUSER-DBNR-COND-L | N5 | in
FUSER-DBNR-COND-U | N5 | in
FUSER-FNR-COND-K | A1 | in
FUSER-FNR-COND-M | A5 | in
FUSER-FNR-COND-L | N5 | in
FUSER-FNR-COND-U | N5 | in
FDIC-DBNR-COND-K | A1 | in
FDIC-DBNR-COND-M | A5 | in
FDIC-DBNR-COND-L | N5 | in
FDIC-DBNR-COND-U | N5 | in
FDIC-FNR-COND-K | A1 | in
FDIC-FNR-COND-M | A5 | in
FDIC-FNR-COND-L | N5 | in
FDIC-FNR-COND-U | N5 | in
FPAA-DBNR-COND-K | A1 | in
FPAA-DBNR-COND-M | A5 | in
FPAA-DBNR-COND-L | N5 | in
FPAA-DBNR-COND-U | N5 | in
FPAA-FNR-COND-K | A1 | in
FPAA-FNR-COND-M | A5 | in
FPAA-FNR-COND-L | N5 | in
FPAA-FNR-COND-U | N5 | in
XREF | A1 | in
ESY-NODE-K | A1 | in
ESY-NODE-M | A3 | in
ESY-NODE-L | N5 | in
ESY-NODE-U | N5 | in
OP-SYSTEM | A9 | in
FOREIGN-PDS-CNT-FM | N3 | in
FOREIGN-PDS-CNT-TO | N3 | in
FOREIGN-TYPE2 | A4 (1:8) | in
FOREIGN-PDS | A55 (1:8) | in
FOREIGN-VOL | A7 (1:8) | in
FOREIGN-TYPE3 | A1 (1:8) | in
ADD-TIME-FM | T | in
ADD-TIME-TO | T | in
ADD-BY | A9 | in
ADD-TID | A9 | in
MOD-TIME-FM | T | in
MOD-TIME-TO | T | in
MOD-BY | A9 | in
MOD-TID | A9 | in
LINE-CNT | N3 | out
LINE-TOT | N10 | in/out
LINE | A250 (1:60) | out
LINE-STRC | (1:60) |
LINE-APPL | A32 |
LINE-STAT | A32 |
LINE-REST | A186 |
API-PAC-AREA | A128 | in/out

Whenever APINLNKS is called [API-LNKS-PARM.ORDER] must be

A | if the links are to be ordered lexicographically by keys wherein application names precede status names,
S | if the links are to be ordered lexicographically by keys wherein status names precede application names.

API-LNKS-PARM.APPLICATION may carry a specification of a range that the application names of the links to be selected must fit into.

API-LNKS-PARM.APPLICATION-TYPE may carry a sequence of one character PAC application type codes. The codes are:

D | for type PREDICT,
N | for type NATURAL,
P | for application PREDICT-CASE.

The field should be left blank if links of applications of various types are to participate in the selection.

API-LNKS-PARM.STATUS may carry a spacification of a range that the status names of the links to be selected must fit into.

API-LNKS-PARM.STATUS-TYPE may carry a sequence of one-character PAC status type codes. The codes are:

A | for ARCHIVE,
D | for development,
I | for incorporation,
M | for maintenance,
N | for neighbour,
P | for production,
R | for retirement,
T | for test.

API-LNKS-PARM.FILE-TRANS-TABLE may carry a range of names specifying the FTTs whose assignment to a link make it eligible for the selection.

An interval for the number of step applications assigned to the eligible links may be specified in API-LNKS-PARM.STEP-APPL-CNT-FM and API-LNKS-PARM.STEP-APPL-CNT-TO. [API-LNKS-PARM.STEP-APPL-CNT-TO] = 0 does not impose a bound on the numbers of step applications.

API-LNKS-PARM.STEP-APPL may carry up to eight ranges of names specifying the PAC applications whose assignment to a link as a step application make the link eligible for the selection. A link is considered eligible on this count if the name of at least one of the step applications it has been assigned fits at least one of the ranges specified. If API-LNKS-PARM.STEP-APPL is completely blank, then no restrictions are imposed on the step application assignments to the links being selected. If API-LNKS-PARM.STEP-APPL has blank elements but is not completely blank, then the blank elements do not affect the eligibility of the links being selected.

If [API-LNKS-PARM.PRD-CASE-LIB] = TRUE, then only links with non-blank PREDICT CASE Library field are returned.

API-LNKS-PARM.NEIGHBOUR-APPL may carry a range of names specifying the PAC applications whose assignment to a link as a neighbour application make the link eligible for the selection. Only links whose statuses are neighbour statuses will occur in a list compiled to specifications with non-blank API-LNKS-PARM.NEIGHBOUR-APPL. If API-LNKS-PARM.NEIGHBOUR-APPL is blank, then no restrictions are imposed on account of this parameter on the links being selected.

API-LNKS-PARM.LIBRARY may carry a range of library names whose occurrence in a link make it eligible for for the selection.

The twenty-four '...-COND-...' fields may carry the specifications of conditions imposed on the data base and file numbers of some of the three files possibly referred to in the links being selected.

A condition is imposed on such a number if the corresponding ...COND-K field carries 'B' (between), 'G' (greater or equal), 'L' (less or equal), 'M' (mask only), 'O' (strictly outside). In any of these cases the number must fit the mask specified in the corresponding ...COND-M field, decimal digits and '.', which will match any digit in the number, being the characters acceptable in a mask. If [...COND-K] = 'M', then the mask is the only condition imposed on the number. In the other cases the number must additionally fit into or, with 'O', outside the specified interval. The lower bound should be specified in ...COND-L and the upper bound in ...COND-U. Thus [...COND-K] = 'L' makes [...COND-U] relevant, and [...COND-K] = 'G' makes [...COND-L] relevant.

API-LNKS-PARM.XREF may carry a character which has to occur in the link's Maintain Xref field for the link to be eligible for the selection. The (possibly) meaningful values of the field are:

L | for local,
N | for none,
R | for remote.

The four ESY-NODE-... fields may carry the specification of conditions imposed on the foreign node numbers referred to in the links being selected. The method of condition specification is the same as with the ...-COND-... fields; only the node numbers have at most three, not five, digits.

API-LNKS-PARM.OP-SYSTEM may carry a range of operating system names which the foreign node referred to in a link must fit for the link to be eligible for the selection.

An interval for the number of foreign locations assigned to the eligible links may be specified in API-LNKS-PARM.FOREIGN-PDS-CNT-FM and API-LNKS-PARM.FOREIGN-PDS-CNT-TO. [API-LNKS-PARM.FOREIGN-PDS-CNT-TO] = 0 does not impose a bound on the numbers of foreign locations.

The (API-LNKS-PARM.FOREIGN-TYPE2,API-LNKS-PARM.FOREIGN-PDS, API-LNKS-PARM.FOREIGN-VOL,API-LNKS-PARM.FOREIGN-TYPE3) quartets may carry up to eight sets of conditions specifying the foreign locations whose assignment to a link make the link eligible for the selection. A link is considered eligible on this count if for each non-blank condition quartet there is at least one foreign location assigned to the link and fitting the quartet. FOREIGN-TYPE2 and FOREIGN-TYPE3 can take single values or remain blank and inactive. FOREIGN-PDS and FOREIGN-VOL can take range specifications.

An interval for the creation times of the links to be selected may be specified in API-LNKS-PARM.ADD-TIME-FM and API-LNKS-PARM.ADD-TIME-TO. Values achieved by resetting do not impose bounds on the times of the links being selected.

API-LNKS-PARM.ADD-BY may carry a range of names specifying the ids of the users who must have added the links to be selected.

API-LNKS-PARM.ADD-TID may carry a range of names specifying the ids of the terminals from which the links to be selected must have been added.

An interval for the latest modification times of the links to be selected may be specified in API-LNKS-PARM.MOD-TIME-FM and API-LNKS-PARM.MOD-TIME-TO. Values achieved by resetting do not impose bounds on the times of the links being selected.

API-LNKS-PARM.MOD-BY may carry a range of names specifying the ids of the users who must have last modified the links to be selected.

API-LNKS-PARM.MOD-TID may carry a range of names specifying the ids of the terminals from which the links to be selected must have been last modified.

[API-LNKS-PARM.LINE-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the number of lines (the size of the chunk) to be returned. In particular, no lines will be returned, if LINE-CNT EQ 0. APINLNKS returns in API-LNKS-PARM.LINE-CNT the number of lines of the returned chunk. It may be less than the adjusted original value, if the end of the list has been reached.

Normally, API-LNKS-PARM.LINE-TOT should be reset when the first chunk of a list is wanted and left untouched until the processing of the list is finished. It will then after each call carry the total of list entries already returned.

API-LNKS-PARM.LINE will carry the returned chunk.

Normally, API-LNKS-PARM.API-PAC-AREA should be reset when the first chunk of a list is wanted. API-LNKS-PARM.API-PAC-AREA should be left untouched for a next call to obtain an immediately following chunk of the list.

## API Return Codes

APINLNKS returns the following [API-PARM.API-MSG-NO]:

0000 | if a non-final chunk of a list is being returned.
0070 | if no entities satisfying the selection criteria have been found.
1011 | if the specified [API-PARM.API-MAIN-FUNC] is meaningless.
7407 | if the specified [API-LNKS-PARM.ORDER] is meaningless.
9999 | if at least one entity satisfying the selection criteria has been found and a final chunk of a list is being returned.

Other values of API-PARM.API-MSG-NO may be received in more unusual situations.

### On this page

- Local Data Area UPILLNKS
- API Return Codes