Add Activity (QFVADDA) API
Required Parameter Group:
| 1 | Qualified change request description name | Input | Char(20) |
| 2 | Activity name | Input | Char(10) |
| 3 | Activity type | Input | Char(10) |
| 4 | Destination format | Input | Char(10) |
| 5 | Destination | Input | Array of Char(20) |
| 6 | Number of destinations | Input | Binary(4) |
| 7 | Condition list | Input | Array of Char(32) |
| 8 | Number of conditions | Input | Binary(4) |
| 9 | Start time | Input | Char(40) |
| 10 | Hold | Input | Char(10) |
| 11 | Function parameters | Input | Char(*) |
| 12 | Length of function parameters | Input | Binary(4) |
| 13 | Text | Input | Char(50) |
| 14 | Replace | Input | Char(10) |
| 15 | Activity added | Output | Char(10) |
| 16 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Add Activity (QFVADDA) API adds an activity to the specified change request description.
Authorities and Locks
- Change request description authority
- *CHANGE
- Change request description lock
- *EXCLRD
Required Parameter Group
- Qualified change request description name
- INPUT; CHAR(20)
The name and library of the qualified change request description to which an activity is added. The first ten characters contain the name of the change request description. The second ten characters contain the name of the library where the change request description is located.
The following special values can be used for library name:
*CURLIB The current library *LIBL The library list
- Activity name
- INPUT; CHAR(10)
The name of the activity to add to the qualified change request description. The first character must be alphabetic or one of the special symbols $, @, or #. The remaining characters can be alphanumeric (A through Z, a through z, 0 through 9, and special symbols $, #, @, ., or _). The maximum number of activities allowed per change request description is 200.
Special values for the name of the activity are:
*GEN The activity name is generated automatically in the format QACTnnnnnn where nnnnnn is a multiple of 10 from 000010 to 999990. *LAST This activity is the last activity to run for the change request. Only one activity in a change request may be specified with this value. The number of conditions must be 0. The start after time and date of start time parameter must be *CURRENT. The start before time and date of start parameter must be *ANY.
- Activity type
- INPUT; CHAR(10)
The name of the activity type to be added to the change request description. This value is defined by the user program. The API does not define the possible values. The characters that can be used for the activity type name are A through Z, 0 through 9, and *. Only IBM activity types should start with *.
- Destination format
- INPUT; CHAR(10)
Whether the activity runs on the local system, a node list name, or a list of 1 to 50 nodes specified by the user.
Special values for the destination format are:
*LCL The activity runs on the local system. The destination and number of destinations parameters are ignored if they are specified (the local network ID and control point name are assumed). *NODL The activity runs on the systems identified in the node list name. The number of destinations parameter is ignored if it is specified. The node list is not restricted to 50 nodes. *SNALST The activity runs on the systems identified in the list of user-specified SNA nodes.
- Destination
- INPUT; Array of CHAR(20)
The destination of the activity. The format of the destination is based on the destination format parameter.
When the destination format is *SNALST, the destination parameter is an array of the number of destinations elements.
The format for each element is:
Network ID CHAR(8) Control point CHAR(8) Reserved CHAR(4) When the destination format is *NODL, the destination parameter is an array of one element with the following format:
Node list name CHAR(10) Library CHAR(10) When the destination format is *LCL, the destination parameter is ignored.
- Number of destinations
- INPUT; BINARY(4)
The number of elements in the destination array. Valid values range from 1 through 50. The number of destinations parameter is ignored if the destination format parameter is *LCL or *NODL.
- Condition list
- INPUT: Array of CHAR(32)
The list of conditions that must be met before the activity can be run.
The format for each element is:
Activity name CHAR(10) The activity name which can be:
activity name the activity is conditioned on the activity name specified. generic name the activity is conditioned on all the activities that match the generic name (partial activity followed by an asterisk (*)). *PRV the activity is conditioned on the activity that precedes it alphabetically.
Relation CHAR(3) Valid values are *EQ, *NE, *GT, *LT, *GE, and *LE.
Reserved CHAR(3) Code BINARY(31) The end code value to base conditioning on. Possible values are:
0-99 user-specified -1 (*SUCCESS) end code is any value from 0-9. If specified, relation must be *EQ or *NE.
-2 (*FAIL) end code is any value from 10-89. If specified, relation must be *EQ or *NE.
-3 (*NOTRUN) end code is any value from 90-99. If specified, relation must be *EQ or *NE.
-4 (*ANY) end code is any value from 0-99. If specified, relation must be *EQ.
Mode CHAR(10) Possible vales 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. Reserved Null - Number of conditions
- INPUT; BINARY(4)
The number of condition elements. The valid values are 0 through 5. When the number of condition elements is 0, the activity specified is not dependent on any other activities to complete before it can start, and the condition list parameter is ignored.
- Start time
- INPUT; CHAR(40)
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 the change request is submitted. The structure is:
Start after time CHAR(10) The time after which this activity may be started. Special values supported are:
*CURRENT
Start after date CHAR(10) The date after which this activity may be started. Special value supported:
*CURRENT
*NEXT
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 is never started. Special values supported are:
*ANY
*CURRENT
Start before date CHAR(10) The date before which the activity must be started. If the activity cannot be started before this date then it is never started. Special values supported are:
*ANY
*CURRENT
*NEXT
The format for time is hhmmss. The format for date is cyymmdd.
- Hold
- INPUT; CHAR(10)
Whether or not this activity is in Held status when it is submitted.
Valid values are *YES and *NO.
- Function parameters
- INPUT; CHAR(*)
The structure containing the specific function parameters. The format is known only by the program calling this API and the exit program that is called to display, change, print, or run this activity.
- Length of function parameters
- INPUT; BINARY(4)
The total length in bytes of the function parameters parameter. Valid values range from 1 through 12288 (12k).
- Text
- INPUT; CHAR(50)
The description of the activity.
- Replace
- INPUT; CHAR(10)
Whether an activity that already exists is replaced. If the activity name is found, it is replaced on this parameter.
*YES The activity that already exists in the change request description is replaced. *NO The activity that already exists in the change request description is not replaced.
- Activity added
- OUTPUT; CHAR(10)
The name of the activity added to the change request description. This is useful when *GEN is specified for the activity name. This parameter is ignored if the activity already exists.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF2150 E | Object information function failed. |
| CPF2151 E | Operation failed for &2 in &1 type *&3. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3793 E | Machine storage limit reached. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9681 E | Activity &1 already exists. |
| CPF9682 E | Element &3 of destination array not valid. |
| CPF9683 E | Number of conditions &1 not valid. |
| CPF9684 E | Start after time &1 not valid. |
| CPF9685 E | Start before time &1 not valid. |
| CPF9686 E | Destination format value &1 not valid. |
| CPF9687 E | Number of destinations &1 not valid. |
| CPF9688 E | Element &3 of condition list array not valid. |
| CPF9689 E | Hold value &1 not valid. |
| CPF968A E | Activity name &1 not valid. |
| CPF968B E | Activity type &1 not valid. |
| CPF968C E | Replace value &1 not valid. |
| CPF968D E | Function parameters length &1 not valid. |
| CPF968E E | Condition list or start time cannot be specified. |
| CPF9691 E | Start after date &1 not valid. |
| CPF9692 E | Start before date &1 not valid. |
| CPF9696 E | Generated activity name limit exceeded. |
| CPF9697 E | Activity cannot be conditioned on itself. |
| CPF9698 E | Maximum size of CRQD &1 exceeded. |
| CPF9699 E | Start time not valid. |
| CPF969E E | Internal processing error occurred. |
| CPF969F E | Activity &1 already exists in condition list. |
| CPF96A2 E | CRQD library name &1 not valid. |
| CPF96A4 E | Activity not added, limit exceeded. |
| 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. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R1
[ Back to top | Network Management APIs | APIs by category ]