Add Product CRQ Activity (ADDPRDCRQA)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Add Product Change Request Activity (ADDPRDCRQA) command adds an activity to a change request description which performs a product distribution function. The activity can be conditioned so that it runs after one or more other activities have completed (successfully or unsuccessfully). The activity can also be scheduled to run at a future date and time.

Restrictions:

  1. This command is shipped with public *EXCLUDE authority.
  2. You must have *CHANGE authority to the change request description object and *EXECUTE authority to the library.
  3. The product must have been previously packaged for distribution. You can use the Package Product for Distribution (PKGPRDDST) command to package the product.
  4. If a NODL value is specified, the node list can only contain entries that have a value of *SNA for the address type.

Notes:

The following notes provide information on how the command works.

  1. Authorization to the product specified on the activity is not verified until the activity runs.
  2. All conditions must be satisfied before the activity can be performed.
  3. The start times indicate when the activity can be started. Actual start times can be later due to network and system delays.
  4. Action *DLTCLGE only deletes the save file containing the licensed program and deletes the distribution catalog entry that maps this save file. It does not delete the product.
  5. If TGTRLS(*ONLY) is specified, the action parameter must be a value other than *INS.
  6. When it is requested to send the license key of the product, a record with the license key information must exist in the central site license repository by the time this activity runs.
  7. All the existing records in the central site license repository containing the license key information for the specified product is sent to the specified managed system or systems, but only those that match the system serial number are added to the managed system license repository.
Top

Parameters

Keyword Description Choices Notes
CRQD Change request description Qualified object name Required, Positional 1
Qualifier 1: Change request description Name
Qualifier 2: Library Name, *LIBL, *CURLIB
ACTIVITY Activity Name, *GEN, *LAST Optional, Positional 2
ACTION Action *SND, *RTV, *DLTCLGE, *INS, *SNDINS Optional, Positional 3
PRDID Product ID Character value Optional, Positional 4
RLS Release level Character value, *ONLY Optional
OPTION Product option 1-99, *BASE Optional
LODTYPE Product load type *ALL, *CODE, *LNG Optional
LODID Load ID 2900-2999, *ALL, *CODE Optional
TGTRLS Target release *CURRENT, *PRV, V5R2M0, V5R3M0, V5R4M0, *ONLY Optional
NODL Managed systems node list Element list Optional
Element 1: Node list Single values: *NONE
Other values: Qualified object name
Qualifier 1: Node list Name
Qualifier 2: Library Name, *LIBL, *CURLIB
CPNAME Managed system node names Single values: *NONE
Other values (up to 50 repetitions): Element list
Optional
Element 1: Network identifier Communications name, *NETATR
Element 2: Control point Communications name
KEEPCLGE Keep catalog entry *YES, *NO Optional
SNDLICKEY Send license key *YES, *NO Optional
RMTSTRTIME Start time on managed system Element list Optional
Element 1: Time zone *LCLSYS, *MGDSYS
Element 2: Start after Element list
Element 1: Time Time, *CURRENT
Element 2: Date Date, *CURRENT, *NEXT
TEXT Text 'description' Character value, *GEN, *BLANK Optional
COND Activity conditions Single values: *NONE
Other values (up to 5 repetitions): Element list
Optional
Element 1: Activity Generic name, name, *PRV
Element 2: Relational operator *EQ, *GT, *LT, *LE, *NE, *GE
Element 3: End code 0-99, *SUCCESS, *FAIL, *NOTRUN, *ANY
Element 4: Condition mode *ALLNODES, *SAMENODE
STRTIME Activity start time Element list Optional
Element 1: Start after Element list
Element 1: Time Time, *CURRENT
Element 2: Date Date, *CURRENT, *NEXT
Element 2: Start before Element list
Element 1: Time Time, *ANY, *CURRENT
Element 2: Date Date, *ANY, *CURRENT, *NEXT
HOLD Hold activity *NO, *YES Optional
Top

Change request description (CRQD)

Specifies the change request description object name.

The possible library values are:

*LIBL
All of the libraries in the user and system portions of the job's library list are searched.
*CURLIB
The current library for the job is used to locate the object.
library-name
Specify that only the library named in this parameter is searched.
change-request-description
Specify the name of the change request description object.
Top

Activity (ACTIVITY)

Specifies the name of the activity to add to the change request description.

*GEN
An activity name is generated. The activity name is of the form QACTxxxxxx where xxxxxx is the first multiple of ten not already being used.
*LAST
The activity is the last to run in the change request. When *LAST is specified for the activity (ACTIVITY) parameter, the condition (COND) parameter and the start time (STRTIME) parameter cannot be specified. Only one activity named *LAST can exist in the change request description.
activity-name
Specify a 10-character activity name.
Top

Action (ACTION)

Specifies the product distribution function that is to be performed.

*SND
Send the product to the specified managed systems.
*RTV
Retrieve the product from the specified managed system.
*DLTCLGE
Delete the catalog entry and its associated save file which contains the product packaged for distribution from the specified managed systems.
*INS
Install the product on the specified managed systems.
*SNDINS
Send and install the specified product on the specified managed systems.
Top

Product ID (PRDID)

Specifies the 7-character identifier of the product for which the action is performed.

The possible product ID value is:

product-ID
Specify the 7-character product ID that is used in the activity.
Top

Release level (RLS)

Specifies which version, release, and modification level of the product is used.

The possible values are:

*ONLY
The release level of the product that is installed on your system.
release-level
Specify the release level in the format VxRxMy, where Vx is the version number, Rx is the release number, and My is the modification number. Valid values for x are the numbers 0 through 9. Valid values for y range from the numbers 0 through 9 and the letters A through Z.
Top

Product option (OPTION)

Specifies which of the optional parts of the product given in the PRDID parameter are used.

The possible values are:

*BASE
Only the base part of the product is used.
product-option-number
Specify the option number for the product load being used. Valid values range from 1 through 99.
Top

Product load type (LODTYPE)

Specifies the product load objects being used.

The possible values are:

*ALL
Code and language objects specified on the LODID parameter are used.
*CODE
The program objects associated with this product load are used.
*LNG
The objects associated with the national language version (NLV) identified on the LODID parameter are used.
Top

Load ID (LODID)

Specifies the load identifier used.

The possible values are:

*ALL
All languages for this product option are saved.
*CODE
The code load is used.
product-load-ID
Specify the load ID of the product when LODTYPE(*LNG) or LODTYPE(*ALL) is used. The load ID must be one of the valid IBM national language versions and be specified in the form 29xx. The value of x can be 0 through 9.
Top

Target release (TGTRLS)

Specifies the release of the operating system on which you intend to use the product.

*ONLY
The release is determined by the release of the existing product. This value is not valid if more than one release exists for the same product.
*CURRENT
The product is to be used on the release of the operating system currently running on your system.
*PRV
The product is to be used on the previous release with modification level 0 of the operating system.
release-level
Specify the release level in the format VxRxMx. The product can be used on a system with the specified release or with any later release of the operating system installed. Valid values depend on the current version, release, and modification level, and can change with each new release.
Top

Managed systems node list (NODL)

Specifies that the node list parameter is the object name that contains a list of systems which are the destinations for the activity. This parameter cannot be specified if the control point (CPNAME) parameter or ACTION(*RTV) is specified.

The possible values are:

*NONE
The systems on which this activity is to be performed are not specified by a node list. Individual control point names must be specified.

The possible library values are:

*LIBL
All of the libraries in the user and system portions of the job's library list are searched for the node list object.
*CURLIB
The current library for the job is used to locate the node list object.
library-name
Specify the name of the library to be searched.
node-list-name
Specify the node list object name containing the list of systems on which the command is to be performed.
Top

Managed system node names (CPNAME)

Specifies the APPN control point names of the managed systems on which this activity is to be performed. Control point names cannot be specified if a node list is specified. If ACTION(*RTV) is used only one control point name can be specified.

*NONE
The systems on which this activity is to be performed are not identified individually. A node list must be specified.

The possible network identifier value is:

*NETATR
The network ID of the local system is used. This is useful when the node being specified is in the same network as the local system.
network-identifier
Specify the APPN network identifier of the managed system on which the activity is to be performed.

The possible control point name value is:

control-point-name
Specify the APPN control point name of the managed system on which the activity is to be performed.
Top

Keep catalog entry (KEEPCLGE)

Specifies if the distribution catalog entry and its associated save file corresponding to the product is kept on the specified systems. This is only valid if ACTION(*INS) or ACTION(*SNDINS) is specified.

The possible values are:

*NO
The catalog entry and associated save file are not kept.
*YES
The catalog entry and associated save file are kept.
Top

Send license key (SNDLICKEY)

Specifies if the license key is to be sent with the product.

*YES
The license key is sent with the product.
*NO
The license key is not sent with the product.
Top

Start time on managed system (RMTSTRTIME)

Specifies the date and time after which the activity can begin running on the managed system. The current date and time values and next date values are determined when the activity begins running on the central site system and are based on the central site date and time.

The possible time zone values are:

*LCLSYS
The remote start time is specified in the time zone of the central site system.
*MGDSYS
The remote start time is specified in the time zone of the managed system.

The possible start after time values are:

*CURRENT
This function can start on the managed system at any time on or after the time this activity is started on the central site system on the date specified in element 2.
start-after-time
Specify the time after which this function can start on the managed system. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start after date values are:

*CURRENT
This function starts on the managed system on any date on or after the activity starts on the central site system.
*NEXT
This function starts on the managed system on any date after the activity starts on the central site.
start-after-date
Specify the date after the functions may start on the managed system. The date must be specified in the job date format.

Notes:

  1. The special values *CURRENT and *NEXT are specified for the date and time if the time zone value *MGDSYS is specified.
  2. This parameter can only be specified if *INS or *SNDINS actions are specified.
Top

Text 'description' (TEXT)

Specifies an activity description.

*GEN
A text description is generated based on the action chosen.
text-description
Specify a 50 character description of the activity.
Top

Activity conditions (COND)

Specifies which conditions must be met before this activity can be performed. Each condition identifies an activity which must run before this activity and the value the end code from that activity must have to allow this activity to run. The default condition is that the previous activity (in alphabetical order) must complete successfully before this activity can be run.

The possible single value is:

*NONE
There are no conditions for this activity.

The possible conditioning activity values are:

*PRV
This activity is conditioned on the previous activity. Activities are ordered alphabetically by activity name. If the activity being added is the first activity, a previous activity does not exist and any condition with *PRV is marked as having been met.
conditioning-activity-name
Specify the name of the activity which must run before this activity.
generic*-activity-name
Specify the generic name of the activities which must run before this activity.

The possible relational operator values are:

This element is the relational operator to use when comparing the end code from the conditioning activity.

*EQ
Equal
*GT
Greater than
*LT
Less than
*NE
Not equal
*GE
Greater than or equal
*LE
Less than or equal

The possible condition code values are:

This element is the value compared to the actual end code of the conditioning activity.

*SUCCESS
The activity ended successfully (0 <= end code <= 9). This end code can only be specified with relational operator *EQ or *NE.
*FAIL
The activity failed (10 <= end code <= 89). This end code can only be specified with relational operator *EQ or *NE.
*NOTRUN
The activity never started (90 <= end code <= 99). This end code can only be specified with relational operator *EQ or *NE.
*ANY
The activity ended with any end code. This end code can only be specified with relational operator *EQ.
end-code
Specify an integer value (0-99) that indicates the result of an activity (success or failure). The end code ranges and descriptions are:
00
Activity completed successfully.
01-09
Activity completed with warning messages.
10-29
Activity did not complete successfully.
30-39
Activity was canceled by a user before it completed.
  • 30 = Activity ended with *CNTRLD option
  • 35 = Activity ended with *IMMED option
  • 39 = Activity ended with *FRCFAIL option
40-49
Activity was not run due to errors detected by the application.
  • 40 = Activity not run for security reasons
90-99
Activity was not run because conditions or schedules were not met.
  • 95 = Scheduled start time expired
  • 99 = Conditions cannot be met

The possible condition mode values are:

This element indicates which systems the conditioning activity must have completed on before this activity can be performed.

*ALLNODES
The conditioning activity specified must complete on all nodes before this activity runs.
*SAMENODE
When the conditioning activity specified completes for a given node, the activity specified on the ACTIVITY parameter may run for that same node even though the conditioning activity specified may not have completed for all other nodes. In the case where this activity lists a node not in the conditioning activity, this activity may run for that node; the condition is ignored.
Top

Activity start time (STRTIME)

Specifies the date and time when this activity can be started on the central site system. The current date and time values and next date values are determined when the change request is submitted.

The possible start after time values are:

*CURRENT
This activity can start any time on or after the time when the change request is submitted.
start-after-time
Specify the time when this activity can start. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator such as a colon (:). With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start after date values are:

*CURRENT
This activity can start on or after the date on which the change request is submitted.
*NEXT
The activity can start on any date after the date the change request is submitted.
start-after-date
Specify the date after this activity can start. The date must be specified in the job date format.

The possible start before time values are:

This element is ignored if the start before date is *ANY.

*ANY
The activity can start at any time on or before the start before date.
*CURRENT
The activity must start before the time at which the change request was submitted on the date specified on the start before date element. This value cannot be specified if the start before date is *CURRENT.
start-before-time
Specify the time before the activity must start. If the activity cannot be started before this time, it never starts. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. The time can be specified with or without a time separator such as a colon (:). Seconds are optional. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).

The possible start before date values are:

*ANY
The activity can start at any time after the start after time and the start after date.
*CURRENT
The activity must start on the date the change request is submitted.
*NEXT
The activity must start by the day after the date the change request is submitted.
start-before-date
Specify the date before the activity must start. If the activity cannot be started by this date, it never starts. The date must be specified in the job date format.
Top

Hold activity (HOLD)

Specifies that the activity be held when the change request is submitted.

*NO
The activity is not held. It runs when all conditions and the start time are met.
*YES
The activity is held for all nodes when the change request is submitted. It must be released by you before it runs.
Top

Examples

Example 1: Adding an Activity to Retrieve

ADDPRDCRQA   CRQD(MYLIB/CR1)  ACTIVITY(ACT01)  ACTION(*RTV)
             PRDID(1ACCOUN)  RLS(V5R2M0)  OPTION(*BASE)
             LODTYPE(*ALL)  LODID(*ALL)
             CPNAME((*NETATR SYS1))

Add an activity to retrieve the base option for the 1ACCOUN product, release V5R2M0, for both the code and the language parts from the iSeries server SYS1.

Example 2: Adding an Activity to Send and Install

ADDPRDCRQA   CRQD(MYLIB/CR2)  ACTIVITY(ACT01)  ACTION(*SNDINS)
             PRDID(1CHECKS)  RLS(V5R2M0)  OPTION(0010)
             LODTYPE(*ALL)  LODID(*ALL)
             CPNAME((*NETATR SYS2))  SNDLICKEY(*YES)

This command adds an activity to send and install option 10 of the 1CHECKS product, release V5R2M0, for both the code and the language parts from the iSeries server SYS2. The license key for this product is also sent and is added to the managed system license repository.

Example 3: Adding an Activity to Install Language Objects

ADDPRDCRQA   CRQD(MYLIB/CR3)  ACTIVITY(ACT02)  ACTION(*SND)
             PRDID(1ACCOUN)  RLS(V5R2M0)  OPTION(*BASE)
             LODTYPE(*ALL)  LODID(2924)
             NODL(NETLIB/ACCTSYS)  STRTIME((23:00:00 9/30/02))

This command adds an activity to send the language objects for the English version and the code objects of the base option of the 1ACCOUN product, to all the systems in the node list (NODL) ACCTSYS network at 11 p.m. on 30 September 2002. The license key for this product is also sent and is added to the managed system license repository.

Top

Error messages

None

Top