ZosReleaseArea

The ZosReleaseArea object represents a ChangeMan ZMF release area (ERO). This object can be obtained using either the GetReleaseArea method or the GetReleaseAreas method of ZosRelease.

ZosReleaseArea Properties

ZosReleaseArea exposes the following properties:

Property	Type	R/W	Description
Release	ZosRelease	R	Parent release object.
Name	String	R	Release area name.
Path	String	R	Release area full path name
AreaType	ZosReleaseAreaType	R	Release area type.
Status	ZosReleaseAreaStatus	R	Release area status.
NextArea	String	R	Next release area.
PriorArea	String	R	Prior release area.
Description	String	R	Release area description.
StepNumber	Int16	R	Release area sequence number.
AuditReturnCode	Int32	R	Audit return code.
Approvers	ZosReleaseApprover[]	R	Approvers for the release area.

...

ZosReleaseArea Methods

ZosReleaseArea exposes the following methods:

ApproveCheckIn Method

Approves a release area for check in.

void  ApproveCheckIn(  
    String entity  
    )

ApproveCheckOff Method

Approves a release area for check off.

void  ApproveCheckOff(  
    String entity 
    ) 

Audit Method

Audits a release area. If the job card, contains multiple lines, they should be separated by a newline character.

void Audit(  
        ZosAuditReleaseAreaOptions opt,  
        String jobCard  
        )

Block Method

Blocks the release area.

void Block() 

CheckIn Method

Checks in components from on release area to the next release area. Component names are specified as name and type pairs.

ZosCheckInStatus[]  CheckIn(  
        String appName,  
        ZosNameType[] componentNames,  
        Boolean rep, [optional]  
        Boolean eligOnly [optional] ) 

Demote Method

Demotes a either a full package or selected components from a release area. Component names are specified as name and type pairs.

If the job card, contains multiple lines, they should be separated by a newline character. If user variables are specified, each is a name/value pair. Each name must be one of the following:

UserVariable01 -

UserVariable05 (length 8)

UserVariable05 -

UserVariable10 (length 72)

Overrides

Demote(String, ZosPromotionLevel, String, ZosNameValue[])

void Demote(  
        String appName,  
        ZosPromotionLevel level,   
        String jobCard,  
        ZosNameValue[] uVars [optional]  
        ) 

...

Demote(String, ZosPromotionLevel, ZosNameType[], String, ZosNameValue[])

void Demote(  
        String appName,  
        ZosPromotionLevel level,  
        ZosNameType[] componentNames,  
        String jobCard,  
        ZosNameValue[] uVars [optional] ) 

...

GetLibraries Method

Gets an array containing the release libraries for the application.

ZosReleaseLibrary  GetLibraries(  
        String appName  
        ) 

GetLibrary Method

Gets a release library by name.

ZosReleaseLibrary  GetLibrary(  
        String appName,  
        String libType  
        ) 

GetPromotionLevel Method

Gets a single promotion level given the site name and promotion level number or name.

Overloads

ZosPromotionLevel GetPromotionLevel(String, String, String)

ZosPromotionLevel  GetPromotionLevel(  
        String appName,   
        String siteName,  
        String promotionName  
        ) 

...

ZosPromotionLevel GetPromotionLevel(String, String, Int16)

ZosPromotionLevel  GetPromotionLevel(  
        String appName,  
        String siteName,  
        Int16 promotionLevel  
        )                                        

...

GetPromotionSite Method

Gets a promotion site by name.

ZosPromotionSite  GetPromotionSite(  
        String appName,  
        String siteName  
        ) 

GetPromotionSites Method

Gets an array containing the promotion sites for the application.

ZosPromotionSite  GetPromotionSites(  
    String appName  
    ) 

NotifyCheckIn Method

Notifies approvers to begin the approval process for check in.

void  NotifyCheckIn() 

NotifyCheckOff Method

Notifies approvers to begin the approval process for check off.

void  NotifyCheckOff() 

Promote Method

Promotes a either a full package or selected components from the starting release area. Component names are specified as name and type pairs.

If the job card, contains multiple lines, they should be separated by a newline character.

If user variables are specified, each is a name/value pair. Each name must be one of the following:

UserVariable01 -

UserVariable05 (length 8)

UserVariable05 -

UserVariable10 (length 72)

Overrides

Promote( String, ZosPromotionLevel, String, ZosNameValue[])

void  Promote(  
        String appName,  
        ZosPromotionLevel level,  
        String jobCard,  
        ZosNameValue[] uVars [optional]  
        ) 

...

Promote(String, ZosPromotionLevel, ZosNameType[], String, ZosNameValue[] )

void  Promote(  
        String appName,  
        ZosPromotionLevel level,  
        ZosNameType[] componentNames,  
        String jobCard,  
        ZosNameValue[] uVars [optional] )

...

Refresh Method

Refreshes the release area information.

void  Refresh() 

RejectCheckIn Method

Reject a release area for check in. The reason is single string, but can contain multiple lines, delimited by newline characters. If a line exceeds 72 characters, the text will automatically be split on word boundaries into multiple lines.

void  RejectCheckIn(  
    String entity,  
    String reason  
    ) 

...

RejectCheckOff Method

Reject a release area for check off. The reason is single string, but can contain multiple lines, delimited by newline characters. If a line exceeds 72 characters, the text will automatically be split on word boundaries into multiple lines.

void  RejectCheckOff(  
        String entity,  
        String reason  
        ) 

ResetApprovals Method

Resets the check-in approvals.

void  ResetApprovals() 

Retrieve Method

Retrieve removes components from a release area. Component names are specified as name and type pairs.

Overloads

Retrieve(String, String)

ZosRetrieveStatus[]  Retrieve(  
        String appName,  
        String package )  

...

Retrieve(String, ZosNameType[])

ZosRetrieveStatus[]  Retrieve(  
        String appName,  
        ZosNameType[] componentNames 
        ) 

...

Retrieve(String, String, ZosNameType[])

ZosRetrieveStatus[]  Retrieve(  
        String appName,  
        String package,  
        ZosNameType[] componentNames 
        )

...

Test Method

Test release area for errors.

package - Package name pattern to include or exclude (optional)

excludePackage - Exclude packages that match the package name pattern.

Overloads

Test()

ZosTestReleaseResult[] Test()

...

Test(String)

ZosTestReleaseResult[]  Test( 
        String package 
        )

...

ZosTestReleaseResult[] Test(String, Boolean)

ZosTestReleaseResult[]  Test(  
        String package,  
        Boolean excludePackage  
        )

...

Unblock Method

Unblocks the release area.

void  Unblock() 

ZosReleaseArea Examples

Examples of using ZosReleaseArea are shown below. ComponentDirectory

C

ZosReleaseArea area;
ZosReleaseLibrary lib = area.GetLibrary(“APPX”, “SRC”);
ZosReleaseLibrary[] libs = area.GetLibraries(“APPX”);
area.Description = “Unit test”;
area.Retrieve(“APPX”, “APPX000123”);

...

C++

ZosReleaseArea^ area;
ZosReleaseLibrary lib = area->GetLibrary(“APPX”, “SRC”);
array<ZosReleaseLibrary^>^ libs = area->GetLibraries(“SRC”);
area->Description = “Unit test”;
area->Retrieve(“APPX”, “APPX000123”);

...

Visual Basic

Dim area as ZosReleaseArea
Dim lib As ZosReleaseLibrary = area.GetLibrary(“APPX”, “SRC”)
Dim libs () As ZosReleaseLibrary = area.GetLibraries(“SRC”)
area.Description = “Unit test”
area.Retrieve(“APPX”, “APPX000123”)

...

Jscript

var area : ZosReleaseArea;
var lib: ZosReleaseLibrary = area.GetLibrary(“APPX”, “SRC”);
var libs : ZosReleaseLibrary [] = area.GetLibraries(“SRC”);
area.Description = “Unit test”;
area.Retrieve(“APPX”, “APPX000123”);

...