MVS API Call – PACKAGE START

This initiates the execution of a package and returns the package details and complete list of items for the REXX to start processing.

Syntax

WZZRXI("PACKAGE","START",parm1,parm2,parm3,parm4,parm5)

Input Parameters

The following table lists the input parameters for the API call.

Input Parameters - PACKAGE START

Parm	Description
RequestID	This is one of the passed parameters.
PackageID	This is one of the passed parameters.
System Name	This is one of the passed parameters.
Package Stem	The name of a REXX Stem variable that will be populated with the returned Package variable names and values. This is a user supplied name
Item Stem	The name of a REXX Stem variable that will be populated with the returned Item variable names and values. This is a user supplied name

Returned Values

The following table lists the returned values that are stored in REXX Stem variables, and consist of a single set of Package variables and n sets of Item variables, where n is the number of Items in the Package.

Returned Values - PACKAGE START

Return Variables	Description
PkgStem.dreqid	RequestID.
PkgStem.pkgid	PackageID.
PkgStem.systname	System Name.
PkgStem.ctsrvrnm	The name of the ISPW CT Server on the target machine.
PkgStem.dpenv	Deploy Environment.
PkgStem.subenv	Deploy Sub-environment.
PkgStem.dpcat	Deploy Category.
PkgStem.process	Current Deploy Process; value can be: S – Staging I – Implementing A – Activating
PkgStem.procstat	Current Process Status: value should always be E (for executing).
PkgStem.erlydate	Earliest Start Date for the Process.
PkgStem.erlytime	Earliest Start Time for the Process.
PkgStem.strtdate	Actual Start Date for the Process.
PkgStem.strttime	Actual Start Time for the Process.
ItemStem.0	This contains the number of returned items. There is a set of returned values for each Item returned, and they are identified by the suffix “.n” in the stem name.
ItemStem.dreqid.n	RequestID.
ItemStem.pkgid.n	PackageID.
ItemStem.itemid.n	Item Number.
ItemStem.systname.n	System Name.
ItemStem.status.n	Physical Item Status.
ItemStem.applid.n	ISPW ApplicationID.
ItemStem.stream.n	ISPW StreamID.
ItemStem.curlevel.n	ISPW Level at which the component is at.
ItemStem.cmpntype.n	ISPW Component Type.
ItemStem.cmpnclas.n	ISPW Component Type Class.
ItemStem.partname.n	Name of the Item.
ItemStem.parttype.n	ISPW Part Type
ItemStem.partclass.n	ISPW Part Class
ItemStem.dptype.n	Deploy Type
ItemStem.action.n	ISPW action code. Value can be: Blank – normal D – Delete F – Fallback I – Implement. The object does exist in a higher level, and it is necessary to reinstate the runtime environment to what it was previously. To do this, it is necessary to Implement the previous object in the runtime environment. No action is required; the previous object should be restored to the runtime environment.
ItemStem.stortype.n	Storage Type defined for this Item – goes with Storage Name. Value can be: PDS – Partitioned Dataset HFS – Unix File system
ItemStem.storname.n	Name of the Target Dataset defined in Deploy.
ItemStem.storuse.n	Storage Use. Indicates the “permanency” of the component part in the Storage Name. Value can be: R – Runtime T – Temporary P – Permanent
ItemStem.altstype.n	Not currently used.
ItemStem.altsname.n	Not currently used.

The “.n” suffix on the ItemStem variable names represents the instance of that variable in the array. The first item will have variable names of the format:

ItemStem.VariableName.1

Subsequent items will be .2 .3 etc.

The number of Items is returned in ItemStem.0.

Return Codes

The following table lists the possible Return Codes.

Return Codes - PACKAGE START

Value	Description
0	Successful
8	Failure
20	Parameter error

Example

The code shown in the following figure makes a PACKAGE START call and then writes the values out for some of the variables.

PACKAGE START Call