dfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdf
ghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmrtyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvb
nmqwertyuiopasdfghjklzxcvbnmqwwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnmqwertyuiopasdfghjklzxcvbnm
x
x
CARMA STANDARD ACCESS REPOSITORY FOR CHANGEMAN
USERGUIDE
Author: Dr. Markus Bon, Thorsten Richter, Michael Vetterolf Version: 1.3 Q Group AG Bahnhofstrasse 13 CH-5507 Mellingen
Hypothekarbank Lenzburg Account No.: 146 875 311 Clearing Nr.: 83 07 VAT-No. : 57 31 30
T: 0041 (0)56 483 41 91 F: 0041 (0)56 493 08 80 E: [email protected] www.Qgrp.com
CSAR for Changeman Userguide Page 2 of 29
1 Introduction .................................................................................................................................................................. 3 2 System Requirements .................................................................................................................................................. 5 2.1 Host ............................................................................................................................................................................... 5 2.2 Workstation .................................................................................................................................................................... 5 3 CSAR for Changeman .................................................................................................................................................. 6 3.1 Development Lifecycle ................................................................................................................................................... 6 3.2 Configuration .................................................................................................................................................................. 7 3.2.1 Configuration PDS ......................................................................................................................................................... 8 3.3 Search Packages ........................................................................................................................................................... 9 3.4 Package List ................................................................................................................................................................ 10 3.4.1 Show Components ....................................................................................................................................................... 11 3.4.2 Show Components with Dependencies ........................................................................................................................ 11 3.4.3 Add Component ........................................................................................................................................................... 11 3.4.4 Audit............................................................................................................................................................................. 12 3.4.5 Promote ....................................................................................................................................................................... 12 3.4.5.1 Full Promote ................................................................................................................................................................. 12 3.4.5.2 Selective Promote ........................................................................................................................................................ 13 3.4.6 Demote ........................................................................................................................................................................ 14 3.4.6.1 Full Demote .................................................................................................................................................................. 14 3.4.6.2 Selective Demote ......................................................................................................................................................... 14 3.4.7 Browse Compressed Listing ......................................................................................................................................... 15 3.4.8 Browse Audit Report .................................................................................................................................................... 16 3.4.9 Freeze .......................................................................................................................................................................... 17 3.4.9.1 Full Freeze ................................................................................................................................................................... 17 3.4.9.2 Selective Freeze .......................................................................................................................................................... 17 3.4.10 Revert .......................................................................................................................................................................... 18 3.4.10.1 Revert .......................................................................................................................................................................... 18 3.4.10.2 Selective Unfreeze ....................................................................................................................................................... 18 3.4.11 Approval ....................................................................................................................................................................... 18 3.4.11.1 Approve ....................................................................................................................................................................... 19 3.4.11.2 Checkoff ....................................................................................................................................................................... 19 3.4.11.3 Approval Decision Pending .......................................................................................................................................... 19 3.4.11.4 Reject ........................................................................................................................................................................... 19 3.4.11.5 Under Review .............................................................................................................................................................. 20 3.4.11.6 Final Approval for Linked Packages ............................................................................................................................. 20 3.4.12 Create Package ........................................................................................................................................................... 20 3.4.13 Configure Table ............................................................................................................................................................ 22 3.5 Component List ............................................................................................................................................................ 23 3.5.1 Browse ......................................................................................................................................................................... 24 3.5.2 View ............................................................................................................................................................................. 24 3.5.3 Edit .............................................................................................................................................................................. 24 3.5.4 Personal Checkout ....................................................................................................................................................... 25 3.5.5 Personal Checkin ......................................................................................................................................................... 25 3.5.6 Undo Personal Checkout.............................................................................................................................................. 25 3.5.7 Build ............................................................................................................................................................................. 25 3.5.8 Browse Compressed Listing ......................................................................................................................................... 26 3.5.9 Browse Audit Report .................................................................................................................................................... 26 3.5.10 Compare ...................................................................................................................................................................... 27 3.5.11 Compare… ................................................................................................................................................................... 27 3.5.11.1 Checked-Out Version with Package Version ................................................................................................................ 27 3.5.11.2 Package Version with Baseline .................................................................................................................................... 27 3.5.11.3 Checked-Out Version with Baseline ............................................................................................................................. 27 3.5.12 Add Component ........................................................................................................................................................... 27 3.5.13 Delete .......................................................................................................................................................................... 27 3.5.14 Configure Table ............................................................................................................................................................ 28 4 Remarks ...................................................................................................................................................................... 29 4.1 Known Problems .......................................................................................................................................................... 29 4.2 Licenses & Trademarks ................................................................................................................................................ 29
CSAR for Changeman Userguide Page 3 of 29
1 Introduction
The Rational Developer for Series z (RDz) has been proved as a powerful tool for supporting host
developers within their daily work. They can easily access datasets located on the host and have
with LPEX a powerful editor to modify sources, including features like syntax-highlighting, auto
completion, outline-views and more to make things easier. Hence, the quality of code increases
while less time is spent. Also the number of compiles to get error-free code decreases.
The life-cycle of software products is managed by using software-configuration-management-
Systems (SCM-Systems), which support versioning of source-code as well as building software-
releases based on a certain versions and maturity levels. Therefore, before editing a piece of code
the source has to be transferred (“checked out”) to an area accessible for RDz. In most cases this
will be a PDS (Figure 1). After work is done, the source is stored back to the SCM-system and is
automatically labeled with a new version number (“check in”).
Figure 1: A PDS used as temporary container for sources
Besides SCM-Systems provided by IBM like ClearCase or SCLM, which are already integrated into
RDz by appropriate PlugIns, many customers use SCM-systems provided by other vendors. These
systems almost never provide an adequate integration into Eclipse / RDz. Therefore, another way of
communication between RDz and the SCM-system had to be established. This is exactly, what
CARMA (Common Access Repository Manager) was invented for. CARMA provides a
communication layer which can be used to call actions and receive the result. The actual execution
is coded in a customer-provided piece of code, the so called Repository Access Manager (RAM). As
long as the implemented action takes care of handling the parameters and return values according
to CARMA's interface-definition, there are no restrictions how to implement the functionality.
Therefore, it is possible to call the provided SCM-systems-APIs directly as well as to use REXXs
handling the actual call. The latter is a good choice if existing REXXs should be reused. The
resulting call-hierarchies are shown in Figure 2.
On client side CARMA provides a standard PlugIn for selecting actions, entering parameter-values
and receiving the results. Furthermore a well-designed JAVA-model is available, which makes the
development of own PlugIns possible. Hence, a more user-friendly way of interaction and a
seamless integration into the RDz-workbench can be achieved.
The introduction of CARMA was a big step for integrating arbitrary systems. Nevertheless,
developing the PlugIn and the RAM was still some work to do, and many works was done anew with
every implementation done. The way to access the SCM-systems differ from customer to customer,
even if the same SCM-system is used, but a basic set of actions is always the same. The idea of
CSAR (CARMA Standard Access Repository) is to provide this basic functionality and all the
associated CARMA-components including the RAM and a configurable PlugIn. CSAR for
Changeman is tailored for using CSAR with SERENA's Changeman.
CSAR for Changeman Userguide Page 4 of 29
Figure 2: Accessing SCM-Systems from RDz
The supported functionality of CSAR contains:
A Search-Dialog providing the usual search-criteria like element-name (with wildcards),
APPLICATION, PACKAGE, RELEASE, STATUS, USER, WORKREQUEST, DEPARTMENT or
DATE
A configurable result view
A set of actions to check out elements into a PDS, to check in members back into the SCM-
system, to start the build and to compare elements with each other as well as with the current
work-file
With these set of actions it is possible to provide elements in a way that the user can use the whole
RDz-functionality to do his changes and also respect the element's life-cycle
The RAM is preconfigured, compiled and fully functional. All the customer has to do is to fill in his
personal code into the delivered REXXs, which then are called by the RAM for the associated action.
Communication is handled by using a predefined set of ISPF-variables which are accessible within
the REXX.
CSAR for Changeman Userguide Page 5 of 29
2 System Requirements
2.1 Host
Before installing the CSAR for Changeman – components, you’ ll have to install and configure RDz
according to the Host Configuration guide (hostconfig.pdf). Especially, the CARMA components
have to be adapted as described in the guide’s Chapter 3. Common Access Repository Manager
(CARMA).
You can verify that CARMA is running fine by opening the CARMA-Repository view, create a
CARMA-connection and try to connect and refresh the PDS RAM, which is shipped as example with
the installation media.
Figure 3: Verifying the CARMA-Installation
2.2 Workstation
The CSAR-Extension requires RDZ-Client 7.6 installed on the workstation. For the installation itself,
Installation-Manager Version 1.3.2 or higher is required.
CSAR for Changeman Userguide Page 6 of 29
3 CSAR for Changeman
The following sections describe the usage of the PlugIn itself. Please refer to the installation guide
for a detailed description of the installation process.
3.1 Development Lifecycle
The development lifecycle is the typical approach for developing software with Changeman as
Software Configuration Management. Figure 4 shows every single step of the development lifecycle
that is supported by the PlugIn and will be explained later in the corresponding section.
Figure 4: Development Lifecycle
CSAR for Changeman Userguide Page 7 of 29
3.2 Configuration
The PlugIn offers a configuration that can be found in the main menu by clicking on “Window” and
selecting “Preferences”. On the left hand side you will find the CSAR preference item that will show
you all settings after selecting it (Figure 5). Here you can configure which CARMA should be used,
the RAM, the instance, the configuration PDS, the job-feedback, your standard job card, the trace
level for the host and the log level for CARMA
The configuration PDS can be an arbitrary PDS on your host, e. g. RDZ.CSAR.CONFIG. We
recommend avoiding the qualifier “data”, because RDz’s client defines an automatic mapping of
these datasets to a binary format. The actual member contains XML and has to be named
“CONFIG”. This XML file describes the available applications, component- types etc. The underlying
schema will be explained in the following subsection.
The action-feedback checkbox allows deactivation of dialogs that are shown after all actions without
jobs. Actions with jobs can be separately controlled with the following setting.
The job-feedback checkbox allows deactivation of polling for all jobs, e.g. the build job. You won’t get
any dialogs showing whether a job succeeded or failed. Note that deactivation also causes that the
job status files won’t be deleted anymore by the PlugIn.
Host trace level and CARMA log level can be used for problem fixing issues. The host trace level is
used for debugging issues of the host components and can take a value between 0 (none) and 2
(detailed). Table 1 shows the effect associated with the chosen level.
Host Trace Level Effect
0 Switched off
1 All displays from the RAM and all says from REXX are shown
2 Like 1, but with additional REXX-trace
Table 1: Specification of the Host Trace Level
The CARMA log level refers to the logs provided by IBM for the CARMA-interface itself. Possible
values are from -1 (none) to 3 (very verbose). For detailed information refer to the Host
Configuration guide provided by IBM.
Figure 5: PlugIn configuration
CSAR for Changeman Userguide Page 8 of 29
3.2.1 Configuration PDS
The configuration PDS is an XML file within a member of a PDS. The PDS can be configured in the
preference page (see previous section) but the member has to be named “CONFIG”. The XML
schema for the configuration PDS is given below:
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <xsd:element name="CONFIG">
<xsd:complexType> <xsd:choice minOccurs="0" maxOccurs="unbounded"> <xsd:element ref="COMMENT"/> <xsd:element minOccurs="1" maxOccurs="unbounded" ref="ORGANIZATION"/> <xsd:element minOccurs="1" maxOccurs="unbounded" ref="PACKAGE"/> <xsd:element minOccurs="1" maxOccurs="unbounded" ref="COMPONENT"/> <xsd:element minOccurs="1" maxOccurs="unbounded" ref="PROMOTE"/>
</xsd:choice> </xsd:complexType> </xsd:element> <xsd:element name="COMMENT" type="xsd:string"/> <xsd:element name="ORGANIZATION">
<xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="DEPARTMENT"/>
</xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="DEPARTMENT">
<xsd:complexType> <xsd:attribute name="NAME" type="xsd:string"/>
</xsd:complexType> </xsd:element> <xsd:element name="PACKAGE">
<xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="STATUS"/>
</xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="STATUS">
<xsd:complexType> <xsd:attribute name="NAME" type="xsd:string"/> <xsd:attribute name="ABBREVIATION" type="xsd:string"/>
</xsd:complexType> </xsd:element> <xsd:element name="COMPONENT">
<xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="STATUS"/> <xsd:element maxOccurs="unbounded" ref="LANGUAGE"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="LANGUAGE"> <xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="COMPONENT_TYPE"/> </xsd:sequence> <xsd:attribute name="NAME" type="xsd:string"/>
</xsd:complexType> </xsd:element> <xsd:element name="COMPONENT_TYPE">
<xsd:complexType> <xsd:sequence> <xsd:element minOccurs="0" ref="BUILDPROC"/>
</xsd:sequence> <xsd:attribute name="PROMOTE" type="xsd:string"/> <xsd:attribute name="BROWSE" type="xsd:string"/> <xsd:attribute name="NAME" type="xsd:string"/> <xsd:attribute name="BUILD" type="xsd:string"/>
</xsd:complexType> </xsd:element> <xsd:element name="BUILDPROC">
<xsd:complexType> <xsd:attribute name="NAME" type="xsd:string"/>
</xsd:complexType> </xsd:element> <xsd:element name="PROMOTE">
<xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="SITE"/>
</xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="SITE">
<xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" ref="NICKNAME"/>
</xsd:sequence> <xsd:attribute name="NAME" type="xsd:string"/> </xsd:complexType> </xsd:element> <xsd:element name="NICKNAME"> <xsd:complexType> <xsd:attribute name="LEVEL" type="xsd:string"/> <xsd:attribute name="NAME" type="xsd:string"/>
</xsd:complexType> </xsd:element>
</xsd:schema>
CSAR for Changeman Userguide Page 9 of 29
The root node of the XML file is named “CONFIG” and it has several sub nodes: “ORGANIZATION”,
“PACKAGE”, “COMPONENT” and “PROMOTE”.
The “ORGANIZATION” node has child nodes of the type “DEPARTMENT” that describes your
departments within your organization. The name for a department is given as the attribute “NAME”.
The “PACKAGE” node has child nodes of the type “STATUS” that describes the possible statuses of
a package. Every “STATUS” node must have a name given as the attribute “NAME” and an
abbreviation given as the attribute “ABBREVIATION”.
The “COMPONENT” node also has child nodes of the type “STATUS” but additionally nodes of the
type “LANGUAGE” with further details about the component types. The “STATUS” node of a
component has got only the “NAME” attribute and no need of an “ABBREVIATION” node. The
“LANGUAGE” node has got the attribute “NAME” for the name of the language and sub nodes
“COMPONENT_TYPE” describing the types of the Changeman component. Each node for the
component type contains the attributes “NAME”, “PROMOTE”, “BUILD” and “BROWSE”. The
“NAME” attribute is the actual name of the component type and each of the other attributes can take
the values “T” or “F” meaning true or false. They describe the properties how the component of this
specific type can be used: Is a component of this type promotable, buildable and/or browsable?
Besides these attributes a component type can also have “BUILDPROC” sub nodes with the
attribute “NAME” that contains the name of the build procedure that can be used by this component
type.
Last but not least there is the node “PROMOTE” that contains all information for promotion and
demotion. It can hold a “SITE” node for every promotion site that can be used during development.
Its name is set by the attribute “NAME. Changeman uses nicknames for the sites that can be
configured by “NICKNAME” nodes as child nodes. Every nickname is configured by “NAME” for its
name and “LEVEL” for the level of the nickname.
3.3 Search Packages
The package search is triggered within the standard RDz search mechanism. You can find “Search”
in the main menu and after clicking the “Search…” menu item or with the shortcut Ctrl+H the
following window will show up (see Figure 6).
Figure 6: The search window
You can enter search parameters for application, package, release, status, user, work request,
department and date to find the corresponding package. After clicking “Search” at the bottom of the
window the window will be closed and the search will be performed in a background thread.
After finishing the search, RDz will show the standard search result view of RDz that contains the
found Changeman packages. The next section will describe this package list in detail.
CSAR for Changeman Userguide Page 10 of 29
3.4 Package List
This view is the standard RDz search result view and shows a table with the found Changeman
packages. The view will be shown after performing a package search.
A right click on a package within the table reveals a context menu with further options related to the
package (see Figure 7). All functions are described in the following subsections.
Figure 7: Package list
Every package has its own status icon at the beginning of the table row. Table 2 below describes the
possible icons.
Status Icon Description
Package is in baseline.
Package is in development.
Package is frozen.
Table 2: Package status icons
After clicking on a package in the table, the standard properties view of RDz gets updated with
properties of the package. You can see all details about a package here. Figure 8 shows a
screenshot of the package properties view with an example package.
Figure 8: Package properties view
CSAR for Changeman Userguide Page 11 of 29
3.4.1 Show Components
The show components functionality will give you a list of all components within the current package
that are necessary for development. These components are meant to be changed by developers.
Figure 32 shows an example of the component list and section 3.5 discusses the list and its
functionality in more detail.
3.4.2 Show Components with Dependencies
Show components with dependencies will also give you a list of all components like described in
3.4.1 but will also list the whole content of the package that is not meant to be changed. So these
elements can neither be checked out nor edited. All other components can still be treated like in the
default component list.
3.4.3 Add Component
This functionality will show you a dialog (see Figure 9) when selected. The component can be
copied from baseline or from a z/OS dataset as well.
Figure 9: Add component dialog
If you choose to copy the component from a z/OS dataset, you will be asked for the name and the
type of the component. If you choose to copy it from baseline, you will be able to browse the
baseline by pressing “Browse”. A dialog (see Figure 10) will show you the baseline where you can
select the desired component. “Finish” brings you back to the last dialog where you can see the
name and the type of the selected component in the baseline fields.
After clicking “Finish” the component will be added to the package.
CSAR for Changeman Userguide Page 12 of 29
Figure 10: Baseline list
3.4.4 Audit
Audit will start a job to audit a package and provide an audit-listing with the options specified in the
input-dialog (see Figure 11). The job is executed on the host; a notification-message will inform you
when the job has finished.
Figure 11: Audit package dialog
3.4.5 Promote
Promote is only a parent item for “Full Promote” and “Selective Promote”. The next sections describe
the actual promote functionalities.
3.4.5.1 Full Promote
Full promote executes a complete promotion of a package. A dialog (see Figure 12) allows you to
define the parameters of the promotion. You can define the site, the nickname and accordingly the
level as well as the release, the release area and whether it should overlay target components and
suppress batch messages. By clicking “finish”, a job will be started in background and informs you
about its termination.
CSAR for Changeman Userguide Page 13 of 29
Figure 12: Full promote dialog
3.4.5.2 Selective Promote
Selective promote allows you to promote only single components of a package. The first window
(see Figure 13) allows you to define the parameters of the promotion. You can define the site, the
nickname and accordingly the level as well as the release, the release area and whether it should
overlay target components and suppress batch messages.
Figure 13: First page of selective promote
By clicking “next”, the PlugIn retrieves a list of all promotable components and shows them in
another dialog (see Figure 14). At least one component must be checked to finish promote by
clicking “finish”.
CSAR for Changeman Userguide Page 14 of 29
Figure 14: Second page of selective promote
3.4.6 Demote
Demote is only a parent item for “Full Demote” and “Selective Demote”.
3.4.6.1 Full Demote
Full demote executes a complete demotion of a package. A window (see Figure 15) allows you to
define the parameters of the demotion. You can define the site, the nickname and accordingly the
level as well as the release, the release area and whether it should suppress batch messages. By
clicking finish, a job will be started in background and informs you about its termination.
Figure 15: Full demote dialog
3.4.6.2 Selective Demote
Selective demote allows you to demote only single components of a package. The first window (see
Figure 16) allows you to define the parameters of the demotion. You can define the site, the
nickname and accordingly the level as well as the release, the release area and whether it should
suppress batch messages.
CSAR for Changeman Userguide Page 15 of 29
Figure 16: First page of selective demote
By clicking “next”, the PlugIn retrieves a list of all demo table components and shows them in a
dialog (see Figure 17). At least one component must be checked to finish demote by clicking “finish”.
Figure 17: Second page of selective demote
3.4.7 Browse Compressed Listing
The listings of the builds are saved compressed within Changeman. You can access these listings
by executing “Browse Compressed Listing”. The first page of the dialog allows you to define the
application; a component name and a time span (see Figure 18).
CSAR for Changeman Userguide Page 16 of 29
Figure 18: First page of browse compressed listing
By clicking “next”, the PlugIn retrieves a list of associated listings (see Figure 19). After selecting the
appropriate listing, choose “Finish”. The dialog will close; the listing will be retrieved and opened in
an editor.
Figure 19: Second page of browse compressed listing
3.4.8 Browse Audit Report
The reports of the audits are stored within Changeman. You can access these reports by executing
“Browse Audit Report”. The first page of the dialog allows you to define the application; a component
name and a time span (see Figure 20).
CSAR for Changeman Userguide Page 17 of 29
Figure 20: First page of browse audit report
By clicking “next”, the PlugIn retrieves a list of possible reports (see Figure 21). After selecting the
report to retrieve, choose “Finish”. The dialog will close; the report will be retrieved and shown in an
editor.
Figure 21: Second page of browse audit report
3.4.9 Freeze
Freeze is only a parent item for “Full Freeze” and “Selective Freeze”.
3.4.9.1 Full Freeze
Full Freeze will cause a freeze of the package in Changeman. If the freeze was successful the icon
will change to the freeze status icon (see Table 2) and you are not allowed to change the package
anymore.
3.4.9.2 Selective Freeze
The selective freeze will cause a freeze of selected components. A dialog (see Figure 22) will be
shown where you can mark the required components. After selecting at least one component you
can complete the freeze by clicking “Finish”.
CSAR for Changeman Userguide Page 18 of 29
Figure 22: Selective Freeze
3.4.10 Revert
Revert is only a parent item for full “Revert” and “Selective Unfreeze”.
3.4.10.1 Revert
A revert is only available for frozen packages. It will remove the freeze from the package and make
the package available for changes again. If the revert was successful, the icon will change to the
status icon associated before the freeze (see Table 2).
3.4.10.2 Selective Unfreeze
The selective unfreeze will cause an unfreeze of several components. A dialog (see Figure 23) will
be shown with the list of available components. After selecting at least one component you can
complete unfreeze by clicking “Finish”.
Figure 23: Selective Unfreeze
3.4.11 Approval
The approval function allows you to execute several approval actions. The actions are described
below.
CSAR for Changeman Userguide Page 19 of 29
3.4.11.1 Approve
The “approve” action opens a dialog (see Figure 24). The approval entity name is mandatory for
finishing the action by clicking the finish button.
Figure 24: Approve Package Action
3.4.11.2 Checkoff
The “checkoff” action needs the same input as the reject action (see section 3.4.11.4).
3.4.11.3 Approval Decision Pending
The “approval decision pending” action needs the same input as the approve action (see section
3.4.11.1).
3.4.11.4 Reject
The “reject” action opens a dialog (see Figure 25) and has two mandatory fields: approval entity
name and reject reasons. Both fields need to be filled for finishing the action by clicking the finish
button.
Figure 25: Reject Package Action
CSAR for Changeman Userguide Page 20 of 29
3.4.11.5 Under Review
The “under review” action needs the same input as the approve action (see section 3.4.11.1).
3.4.11.6 Final Approval for Linked Packages
The “final approval for linked packages” action needs the same input as the approve action (see
section 3.4.11.1).
3.4.12 Create Package
You have to select this action to create a Changeman package. A wizard with several pages will
guide you through the creation process.
The first page (see Figure 26) offers the different create methods: “Short Method”, “Copy Forward”
and “Long Method”. Available parameters are the package title, the application, the requester’s
name, the requester’s phone, the work request ID and the department. The PlugIn currently supports
only the “Simple” package level. The package type can be one of the following values “Planned
Permanent”, “Planned Temporary”, “Unplanned Permanent” and “Unplanned Temporary”. The
unplanned reason code field will only be available if you select an unplanned package type. The
temporary change duration field will only be available if you select a temporary package type. The
fields for the application and number model will only be available if you choose the copy forward
create method.
After filling out all required fields, a click on “Next” takes you to the next page.
Figure 26: First page of create package
If you select complex or super package you will get another page where you can configure
participating packages and affected applications (see Figure 27). Next to the lists you can see “Add”-
Buttons that let you add participating packages or affected applications. Clicking on one of these
buttons reveals an input dialog that let you enter the name of the package or application.
To delete a package or an application from the list, simply select one item and click on “Delete”.
You need to define at least one participating package and one affected application to proceed to the
next page.
CSAR for Changeman Userguide Page 21 of 29
Figure 27: Data for complex and super packages
The second page (see Figure 28) has only one multiline text field for entering the package
description. The description is limited to 5 lines with 72 characters each line. Enter a description and
click “Next” to reach the next page.
Figure 28: Second page of create package
The third page (see Figure 29) allows the selection of the contingency and the scheduler. The
installation-instructions will be only available if you select “Other” from the contingency group. You
can provide 10 lines with 72 characters each line. The “Next” button takes you to the last page of the
wizard.
CSAR for Changeman Userguide Page 22 of 29
Figure 29: Third page of create package
The fourth page (see Figure 30) provides fields for specifying site information. You have the
possibility to insert 5 sites with date, time span, primary contact name, primary contact phone,
backup contact name and backup contact phone. The date has to be formatted as YYYYMMDD.
“Finish” sends all data to the mainframe and the package will be created.
Figure 30: Fourth page of create package
3.4.13 Configure Table
This option allows you to customize the package list table. You are able to hide columns or change
their order. The dialog (see Figure 31) provides two lists: “Available Columns” and “Selected
Columns”.
“Available Columns”: These columns are available for the table but will not be shown in the current
configuration. If you want to see these columns in the package list, you’ll have to move them to
“Selected Columns” by selecting them and clicking on the “>” button.
CSAR for Changeman Userguide Page 23 of 29
“Selected Columns”: These columns will be shown in the package list. If you don’t want to see these
columns in the package list anymore, then just move them to “Available Columns” by selecting them
and clicking on the “<” button.
You can change the order of the selected columns by selecting the desired column and move it up
with the “Up” button or down with the “Down” button. The “OK”-Button will save your choice. Note
that you can always return to the default settings with the “Default”-Button.
Figure 31: Configure package list table
3.5 Component List
The component list will be shown after selecting “Show Components” or “Show Components with
Dependencies”. It is an additional view that opens up automatically. The screenshot shown in Figure
32 is an example of such a component list. By right clicking on a component, a context menu will
show up with actions available for your selection. The actions are described in detail in the following
subsections.
Figure 32: Component list
Every component has its own status icon at the beginning of the line. Table 3 below describes the
possible icons.
CSAR for Changeman Userguide Page 24 of 29
Status Icon Description
Locked by another developer.
You are not allowed to checkout and edit this component.
The component is free.
You are allowed to checkout and edit this component.
The component is checked out by you and locked for other developers.
You are allowed to edit the component and check it in afterwards. Other developers
can’t check it out and edit.
Table 3: Component status icons
After selecting a component in the table, the standard properties view of RDz is updated with the
component’s current property-values. Here you can see the details about a component as well as
additional information. Figure 1 shows a screenshot of the component properties view with an
example component.
Figure 33: Component properties view
3.5.1 Browse
By using the browse functionality, the component will be retrieved from Changeman and opened in
the editor of RDz. The browse mode for a component is only for reading purposes as writing is not
allowed therefore the editor will be in a read-only state. The component won’t be locked in
Changeman, so other users are allowed to check out and edit it.
3.5.2 View
The view action is similar to the browse action but the editor is not in read-only mode. You can edit
the file but your changes won’t be saved.
3.5.3 Edit
The edit functionality will be only available if the component is already checked out by you. Normally
you would use it after checking out a component and closing the editor accidentally or on purpose. It
will retrieve the component from a personal copy on the host and open it automatically in the RDz
editor where you edit and save it.
CSAR for Changeman Userguide Page 25 of 29
3.5.4 Personal Checkout
If you want to edit a component you’ll have to check it out first. You can only use personal checkout
if the component is not locked by another user. Personal checkout will retrieve the component from
Changeman and create a personal copy for you on the host and opens it automatically within the
RDz editor. The personal copy leverages you to suspend your work and continue it some other time
or on another client machine since the personal copy is stored on the host. Use the edit functionality
if you want to continue your work and the component has already been checked out by you.
3.5.5 Personal Checkin
After finishing your changes to a Changeman component you have to submit your changes by the
personal checkin. This functionality is only available if you have already checked out this component.
Personal checkin will transfer the changed component to Changeman and delete your personal
copy. The locks on the component will be removed as well so other users have the possibility to
check it out and edit it again.
3.5.6 Undo Personal Checkout
Undo personal checkout can only be selected after you checked out a component. You should use it
if you want to delete your personal copy of the component and remove the locks for this component
in Changeman. Note that all changes you have done so far since your check out will be deleted as
well.
3.5.7 Build
The build functionality will first show you a dialog where you can enter options and parameters for
building the component. The dialog is grouped into two sections: “Compile & Link Options” (see
Figure 34) and “Job Statements” (see Figure 35) that can be reached by the tabs at the top. The
values will be sent to the host after clicking “OK” and a job will be started. You will get a notification
when the job is finished. If you check “Show listing after build” the PlugIn will open the build listing in
the editor of RDz when build is finished.
Figure 34: Build options
CSAR for Changeman Userguide Page 26 of 29
Figure 35: Job statements for build
3.5.8 Browse Compressed Listing
The listings of the builds are saved compressed within Changeman. You can access these listings
by executing “Browse Compressed Listing”. A dialog (see Figure 36) allows you to define a time
span and offers the list disposition option.
Figure 36: Browse compressed listing from component list
After filling in all values you can choose “Finish”. The dialog will close, the listing will be retrieved and
an editor will be opened with the desired listing.
3.5.9 Browse Audit Report
The reports of the audits are saved within Changeman. You can access these reports by executing
“Browse Audit Report”. A dialog (see Figure 37) allows you to define a time span and offers the list
disposition option.
CSAR for Changeman Userguide Page 27 of 29
Figure 37: Browse audit report from component list
After inserting all values you can choose “Finish”. The dialog will close, the report will be retrieved
and an editor will be opened with the desired report.
3.5.10 Compare
The compare functionality is only available if two components are selected at the same time (use
Ctrl to select the second component). It will compare the selected components and show you both
components at the same time in the editor with all differences between them.
3.5.11 Compare…
“Compare…” is only a parent item for the following compare functions.
3.5.11.1 Checked-Out Version with Package Version
The compare with package version is only available if you checked out a component in a personal
copy and only this component is selected. The compare editor will show you the differences between
your personal copy and the component within the package. So you can see the changes you have
done so far since you checkout of the component.
3.5.11.2 Package Version with Baseline
By executing this compare action, the compare editor will show you the differences between the
current component in the package and the component in baseline. So you can see the changes that
are checked-in in contrast to the baseline version of the component.
3.5.11.3 Checked-Out Version with Baseline
This compare action compares your personal copy with the corresponding component in baseline.
The compare editor will be opened so you can see your changes in contrast to the baseline version.
3.5.12 Add Component
This functionality is exactly the same as described in section 3.4.3.
3.5.13 Delete
Delete can only be selected if the component is not locked by another user. It will delete the
component from the package and thus all changes that have been committed.
CSAR for Changeman Userguide Page 28 of 29
3.5.14 Configure Table
This option allows you to customize the component list table. It’s possible to hide columns or to
change their order. The dialog (see Figure 38) has two lists: “Available Columns” and “Selected
Columns”.
“Available Columns”: These columns are available for the table but will not be shown in the current
configuration. If you want to see these columns in the component list, you will have to move them to
“Selected Columns” by selecting them and clicking on the “>” button.
“Selected Columns”: These columns will be shown in the component list. If you don’t want to see
these columns anymore, you’ll have to move them to “Available Columns” by selecting them and
clicking on the “<” button.
You can change the order of the selected columns by selecting the desired and column and move it
up with the “Up” button or down with the “Down” button. The “OK”-Button will save your choice. Note
that you can return to the default settings with the “Default”-Button.
Figure 38: Configure component list table
CSAR for Changeman Userguide Page 29 of 29
4 Remarks
4.1 Known Problems
4.2 Licenses & Trademarks