List Activities (QFVLSTA) API


  Required Parameter Group:

1 Qualified user space name Input Char(20)
2 Format Input Char(8)
3 Qualified change request description name Input Char(20)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The List Activities (QFVLSTA) API retrieves a list of activities from a qualified change request description.


Authorities and Locks

Change request description authority
*USE

Change request description lock
*SHRRD

User space authority
*CHANGE

User space library authority
*EXECUTE

User space lock
*EXCLRD

Required Parameter Group

Qualified user space name
INPUT; CHAR(20)

The name of the qualified user space that receives the generated list. The first 10 characters contain the user space name, the second 10 characters contain the user space library name.

Special values for the user space library name are:

*CURLIB The current library
*LIBL The library list

Format
INPUT; CHAR(8)

The format of the data to return. The valid values are:

CRDA0100 The activity name is returned. See CRDA0100 Format.
CRDA0200 The activity name, start time, and conditions are returned. See CRDA0200 Format.
CRDA0300 The activity name, type, text, conditions and function parameters are returned. See CRDA0300 Format.

Qualified change request description name
INPUT; CHAR(20)

The name of the qualified change request description from which information will be retrieved. The first 10 characters contain the change request description name and the second 10 characters contain the change request description library name.

Special values for the qualified change request description library name are:

*CURLIB The current library
*LIBL The library list

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Format of the Generated List

The user space is used to retrieve the activity list with the requested information and consists of:

For details about the user area and generic header, see User spaces. For details about the other items, see the following sections. For a detailed description of each field in the information returned, see Field Descriptions.


Input Parameter Section

Offset Type Field
Dec Hex
0 0 CHAR(10) User space name specified
10 A CHAR(10) User space library name specified
20 14 CHAR(8) Format name specified
28 1C CHAR(10) Change request description name specified
38 26 CHAR(10) Change request description library name specified


Header Section

Offset Type Field
Dec Hex
0 0 CHAR(10) User space name used
10 A CHAR(10) User space library name used
20 14 CHAR(10) Change request description name used
30 1E CHAR(10) Change request description library name used


CRDA0100 Format

See Field Descriptions for descriptions of the fields in this format.

Offset Type Field
Dec Hex
0 0 CHAR(10) Activity name


CRDA0200 Format

See Field Descriptions for descriptions of the fields in this format.

Offset Type Field
Dec Hex
0 0 CHAR(10) Activity name
10 A Array of CHAR(32) Conditions array
170 AA CHAR(2) Reserved
172 AC BINARY(4) Number of conditions
176 BO CHAR(40) Start time


CRDA0300 Format

See Field Descriptions for descriptions of the fields in this format.

Offset Type Field
Dec Hex
0 0 CHAR(10) Activity name
10 A CHAR(10) Activity type
20 14 CHAR(50) Activity text description
70 46 CHAR(2) Reserved
72 48 BINARY(4) CCSID of activity text description
76 4C Array of CHAR(32) Conditions array
236 EC BINARY(4) Number of conditions
240 F0 BINARY(31) Function parameters length
271 10F CHAR(*) Function parameters


Field Descriptions

Activity name. The name of the activity stored in the change request description name.

Activity text description. The description of the activity.

Activity type. The name of the activity type stored in the change request description name. This value is defined by the user program. The API does not define the possible values.

Change request description name specified. The name of the change request description specified to the API.

Change request description name used. The name of the change request description used to retrieve the list.

Change request description library name specified. The name of the library where the change request description is stored specified to the API. If the special values *LIBL or *CURLIB are used, the library name resolved is set here.

Change request description library name used. The name of the library used where the change request description is stored.

Conditions array. The list of conditions that must be met before the activity can be run. This is an array of 5 elements. The number of conditions field indicates the actual number of conditions specified for the activity.

The structure of each element is:

activity CHAR(10)

Activity name. Possible values: *PRV, user-specified name, or a generic name (partial name followed by an asterisk (*)).
relation CHAR(3)

The relational operator. Possible values are:

*EQ, *NE, *GT, *LT, *GE, *LE.
reserved An ignored field.
code BIN(31)

The end code value to base conditioning on. The following values are supported:

0-99 User can specify anything in this range.
-1 (*SUCCESS) The end code is any value from 0-9.

If specified, relation must be *EQ or *NE.
-2 (*FAIL) The end code is any value from 10-89.

If specified, relation must be *EQ or *NE.
-3 (*NOTRUN) The end code is any value from 90-99.

If specified, relation must *EQ or *NE.
-4 (*ANY) The end code is any value from 0-99.

If specified, relation must be *EQ.
mode CHAR(10)

Condition mode. Possible values are:

*ALLNODES All nodes of the conditioning activity must meet the completion criteria before this condition is considered met.
*SAMENODE Nodes of the conditioned activity need only wait for the same node of the conditioning activity to meet the completion criteria before this condition is considered met.

CCSID of activity text. The CCSID of the activity text description.

Format name specified. The format name specified to the API.

Function parameters. The parameters defined by the calling application when the activity was added.

Function parameters length. The length of the function parameters returned.

Number of conditions. The number of conditions specified for the activity. Valid values range from 0 through 5. This field is used to determine how many elements of the condition array contain valid data.

Reserved. An ignored field.

Start time. The date and time window during which this activity can be started. The current date and time values and next date values are determined when change request is submitted. The structure is:

start after time CHAR(10)

The time after which this activity may be started. Special value supported is:

*CURRENT This activity may start any time on or after the time at which the change request was submitted.
start after date CHAR(10)

The date after which this activity may be started. Special values supported are:

*CURRENT This activity may start on any date on or after the date on which the change request was submitted.
*NEXT This activity may start on any date after the date on which the change request was submitted.
start before time CHAR(10)

The time before which the activity must be started. If the activity cannot be started before this time then it will never be started. Special values supported are:

*ANY The activity may start any time on or after the start time.
*CURRENT The activity must start before the time the change request was submitted on the date specified on the start before date field.
start before date CHAR(10)

The date before which the activity must be started. If the activity cannot be started by this date then it will never be started. Special values supported are:

*ANY The activity may start at any date on or after the start date.
*CURRENT The activity must start on the date the change request was submitted.
*NEXT The activity must start by the day after the date the change request was submitted.

The format of time is HHMMSS and the format of date is CYYMMDD.

User space library name specified. The user space library name specified to the API.

User space library name used. The names of the actual user space library used to report data. If the special values *LIBL or *CURLIB are used, the library name resolved is set here.

User space name specified. The user space name specified to the API.

User space name used. The actual user space name used to report data.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3793 E Machine storage limit reached.
CPF3C21 E Format name &1 is not valid.
CPF3C90 E Literal value cannot be changed.
CPF3CAA E List is too large for user space &1.
CPF3CF1 E Error code parameter not valid.
CPF8100 E All CPF81xx messages could be returned. xx is from 01 to FF.
CPF969E E Internal processing error occurred.
CPF96A1 E User space library name &1 not valid.
CPF96A2 E CRQD library name &1 not valid.
CPF9801 E Object &2 in library &3 not found.
CPF9802 E Not authorized to object &2 in &3.
CPF9803 E Cannot allocate object &2 in library &3.
CPF9804 E Object &2 in library &3 damaged.
CPF9807 E One or more libraries in library list deleted.
CPF9808 E Cannot allocate one or more libraries on library list.
CPF9810 E Library &1 not found.
CPF9811 E Program &1 in library &2 not found.
CPF9812 E File &1 in library &2 not found.
CPF9814 E Device &1 not found.
CPF9820 E Not authorized to use library &1.
CPF9821 E Not authorized to program &1 in library &2.
CPF9822 E Not authorized to file &1 in library &2.
CPF9825 E Not authorized to device &1.
CPF9830 E Cannot assign library &1.
CPF9831 E Cannot assign device &1.
CPF9838 E User profile storage limit exceeded.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R2

[ Back to top | Network Management APIs | APIs by category ]