APINSELE

#### Search Results

Search

# APINSELE

This API lets obtain chunks of lists of event names.

APINSELE corresponds to the Select Events function of the menu system. It produces only the names of the events. These names can then be used as input to APINAUTH, APINDSC, APINMEOL, APINMGEV, APINOBLS, or APINTEXT.

APINSELE can be invoked with:

    CALLNAT 'APINSELE' API-PARM API-SELE-PARM

S | obtain a chunk of a list of event names.

The value of API-PARM.API-SUB-FUNC is ignored.

This document covers the following topics:

- Local Data Area UPILSELE

- API Return Codes

## Local Data Area UPILSELE

A definition of API-SELE-PARM is provided in LDA UPILSELE.

Field Name | Format | I/O
--- | --- | ---
API-SELE-PARM | - | -
EVENT | A33 | in
APPLICATION | A33 | in
STATUS-FM-TYPE | A1 | in
STATUS-FM | A33 | in
STATUS-TO-TYPE | A1 | in
STATUS-TO | A33 | in
EXECUTION | A1 | in
JCL-TEXT-NAME | A33 | in
STATE | A1 | in
NATURAL-COUNT-FM | N8 | in
NATURAL-COUNT-TO | N8 | in
ERRMESS-COUNT-FM | N8 | in
ERRMESS-COUNT-TO | N8 | in
PREDICT-COUNT-FM | N8 | in
PREDICT-COUNT-TO | N8 | in
FOREIGN-COUNT-FM | N8 | in
FOREIGN-COUNT-TO | N8 | in
USER-MODI | A9 | in
USER-AUTH | A9 | in
USER-SUBM | A9 | in
USER-HOLD | A9 | in
TIME-MODI-FM | T | in
TIME-MODI-TO | T | in
TIME-SCHE-FM | T | in
TIME-SCHE-TO | T | in
TIME-AUTH-FM | T | in
TIME-AUTH-TO | T | in
TIME-SUBM-FM | T | in
TIME-SUBM-TO | T | in
TIME-COMP-FM | T | in
TIME-COMP-TO | T | in
TIME-BACK-FM | T | in
TIME-BACK-TO | T | in
EV-CNT | N3 | in/out
EV | A32 (1:60) 1* | out
API-PAC-AREA | A145 | in/out

1*: This is the proposed default value. Any value equal or greater 1 can be defined by the user.

When APINSELE is called:

- API-SELE-PARM.EVENT should be blank or carry a range of names of the events to be selected.

- API-SELE-PARM.APPLICATION should be blank or carry a range of names of the applications to which events must belong to be selected.

- API-SELE-PARM.STATUS-FM-TYPE should carry a character designating the type(s) of the origin statuses of the events to be selected. The following characters designate status types:

  A | type of ARCHIVE
  C | type of CONTROL
  D | development
  I | incorporation
  M | maintenance
  P | production
  T | test
  * | any
  space | any

- API-SELE-PARM.STATUS-FM should be blank or carry a range of names of the statuses that may be the origin statuses of the events to be selected.

- API-SELE-PARM.STATUS-TO-TYPE should carry a character designating the type(s) of the destination statuses of the events to be selected.

- API-SELE-PARM.STATUS-TO should be blank or carry a range of names of the statuses that may be the destination statuses of the events to be selected.

- API-SELE-PARM.EXECUTION should carry a character designating the mode of execution of the events to be selected. The following characters designate modes of event execution:

  B | batch
  O | online
  * | any
  space | any

- API-SELE-PARM.JCL-TEXT-NAME should be blank or carry a range of names of the JCL texts used by the events to be selected.

- API-SELE-PARM.STATE should carry a character designating the state(s) of the events to be selected. The following characters designate job states.

  A | authorised
  B | backed out
  C | completed
  P | pending
  S | started
  U | submitted
  V | validated
  * | any
  space | any

- API-SELE-PARM.NATURAL-COUNT-FM should carry a lower bound of the numbers of NATURAL objects that have participated in the migrations defined by the events to be selected.

- API-SELE-PARM.NATURAL-COUNT-TO should carry 0 or an upper bound of the numbers of NATURAL objects that have participated in the migrations defined by the events to be selected. If API-SELE-PARM.NATURAL-COUNT-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.ERRMESS-COUNT-FM should carry a lower bound of the numbers (counts) of error messages that have participated in the migrations defined by the events to be selected.

- API-SELE-PARM.ERRMESS-COUNT-TO should carry 0 or an upper bound of the numbers (counts) of error messages that have participated in the migrations defined by the events to be selected.

  If API-SELE-PARM.ERRMESS-COUNT-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.PREDICT-COUNT-FM should carry a lower bound of the numbers of PREDICT objects or DDMs that have participated in the migrations defined by the events to be selected.

- API-SELE-PARM.PREDICT-COUNT-TO should carry 0 or an upper bound of the numbers of PREDICT objects or DDMs that have participated in the migrations defined by the events to be selected.

  If API-SELE-PARM.PREDICT-COUNT-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.FOREIGN-COUNT-FM should carry a lower bound of the numbers of foreign objects that have participated in the migrations defined by the events to be selected.

- API-SELE-PARM.FOREIGN-COUNT-TO should carry 0 or an upper bound of the numbers of foreign objects that have participated in the migrations defined by the events to be selected. If API-SELE-PARM.FOREIGN-COUNT-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.USER-MODI should be blank or carry a range of ids of the users who have last modified the events to be selected.

- API-SELE-PARM.USER-AUTH should be blank or carry a range of ids of the users who have last authorised the events to be selected.

- API-SELE-PARM.USER-SUBM should be blank or carry a range of ids of the users who have last submitted the events to be selected.

- API-SELE-PARM.USER-HOLD should be blank or carry a range of ids of the users by whom the events to be selected remain locked.

- API-SELE-PARM.TIME-MODI-FM should carry a lower bound of the modification times of the events to be selected.

- API-SELE-PARM.TIME-MODI-TO should carry an upper bound of the modification times of the events to be selected or 0.

  If API-SELE-PARM.TIME-MODI-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.TIME-SCHE-FM should carry a lower bound of the schedule times of the events to be selected.

- API-SELE-PARM.TIME-SCHE-TO should carry an upper bound of the schedule times of the events to be selected or 0. If API-SELE-PARM.TIME-SCHE-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.TIME-AUTH-FM should carry a lower bound of the authorisation times of the events to be selected.

- API-SELE-PARM.TIME-AUTH-TO should carry an upper bound of the authorisation times of the events to be selected or 0.

  If API-SELE-PARM.TIME-AUTH-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.TIME-SUBM-FM should carry a lower bound of the submission times of the events to be selected.

- API-SELE-PARM.TIME-SUBM-TO should carry an upper bound of the submission times of the events to be selected or 0.

  If API-SELE-PARM.TIME-SUBM-TO = 0 then the selection of events is not restricted on the account of this parameter.

- API-SELE-PARM.TIME-COMP-FM should carry a lower bound of the completion times of the events to be selected.

- API-SELE-PARM.TIME-COMP-TO should carry an upper bound of the completion times of the events to be selected or 0. If API-SELE-PARM.TIME-COMP-TO = 0 then the selection of events is not restricted on the account of this parameter.

- [API-SELE-PARM.EV-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the maximum number of event names to be returned; no event names will be returned, if API-SELE-PARM.EV-CNT = 0.

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

APINSELE returns in API-SELE-PARM.EV-CNT the number of event names in the returned chunk; it may be less than the adjusted original value, if the end of the event name list has been reached.

If no job satisfying the selection criteria is found or a non-positive [API-SELE-PARM.EV-CNT] has been specified then APINSELE returns 0 in API-SELE-PARM.EV-CNT.

If APINSELE returns a non-zero [API-SELE-PARM.EV-CNT] then it returns the chunk of the list of the names of the events satisfying the selection criteria in API-SELE-PARM.NUMBER(1:[API-SELE-PARM.EV-CNT]).

## API Return Codes

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

0000 | if at least one event satisfying the selection criteria has been found and a non-final chunk of a list of the names of the events satisfying the selection criteria is being returned,
1011 | if [API-PARM.API-MAIN-FUNC] other than 'S' has been specified,
7251 | if events satisfying the selection criteria have been sought but none has been found,
9999 | if at least one event satisfying the selection criteria has been found and a final chunk of a list of the names of the events satisfying the selection criteria is being returned.

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

### On this page

- Local Data Area UPILSELE
- API Return Codes