CARMA STANDARD ACCESS REPOSITORY for Endevor Users

Size: px

Start display at page:

Download "CARMA STANDARD ACCESS REPOSITORY for Endevor Users"

Prosper Norris
6 years ago
Views:

CARMA STANDARD ACCESS REPOSITORY for Endevor Users Author: Version: Version 1.0.6 Dr.

1 CARMA STANDARD ACCESS REPOSITORY for Endevor Users Author: Version: Version Dr. Markus Bon, Carmelo Merino Q Group AG Im Langacker 16 CH-5405 Baden-Dättwil Hypothekarbank Lenzburg Account No.: Clearing Nr.: 8307 VAT-No. : T: 0041 (0) F: 0041 (0) E: Sekretariat@qgrp.com

2 1 Introduction CSAR The Search Dialog Actions Retrieve: checking out elements (CSAR->PDS) Edit Update: checking in Elements (CSAR->PDS) Delete Move Browse Generate SignIn Print Compare Compare with Working-Dataset Show member history Customization Accessibility Features Conclusion Page 2 from 18

1 Introduction The Rational Developer for System z (RDz) has been proved as a powerful tool for supporting host developers within their daily work.

3 1 Introduction The Rational Developer for System 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, autocompletion, outline-views and more to make the work 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 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 parametervalues 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. Page 3 from 18

4 The introduction of CARMA was a big step for integrating arbitrary systems. Nevertheless, there was still some work to do developing the PlugIn and the RAM, and much work was done anew with every implementation. The way to access the SCM-Systems differs from customer to customer, even if the same SCM-system is used, but a basic set of actions is always used. 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. 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), CCID, SYSTEM, SUBSYSTEM, TYPE or STAGE A configurable result view A set of actions to check out elements into a PDS, to check in members back into Endevor, to start the build, and to compare elements with each other as well as with the current work-file With these actions it is possible to provide elements in a way that the user can use the whole Rational Developer for System z 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. Page 4 from 18

CSAR provides a special search dialog which enables the user to fill in his search parameters and perform the search.

5 2 CSAR The following sections give an overview of the CSAR-PlugIn and the provided functionality. 2.1 The Search Dialog Usually, the first action performed by a user who wants to change a piece of code is to search Endevor for the wanted element. CSAR provides a special search dialog which enables the user to fill in his search parameters and perform the search. If for certain fields predefined values are available, a combo-box offers the selectable values. The CSAR-Search is implemented as an Eclipse search (Figure 3) and therefore uses the Eclipse-way to handle the search and to present the results in the search-result view (Figure 4). It is also possible to run the search in background or rerun it again later. Figure 3: CSAR s Search Dialog Figure 4: Search Result View Page 5 from 18

6 2.2 Actions When the right mouse button is pressed over an element of the search s result-list (Figure 5), a context menu appears. Figure 5: Context Menu providing element actions The following actions are provided for accessing the Endevor elements: Retrieve copies an Element from Endevor to a working-dataset-member. This action can also be called with Ctrl+Alt+R. Edit opens the retrieved copy of the element for editing. Update stores a working-dataset-member into Endevor. This action can also be called with Ctrl+Alt+U. Delete deletes a member from Endevor. Move moves a member in Endevor. Browse opens in an editor a copy of the element in the host in browse-modus (editing is not allowed). This action can also be called with Ctrl+Alt+B. Generate initiates the build-process defined for this element within Endevor. This action can also be called with Ctrl+Alt+G. Page 6 from 18

7 SignIn unlocks (deletes the signout) the element. Print Element this option generates a report. There are 5 types of them: Browse, Changes, History, Summary, Master. Compare compares to elements marked in the search result. Compare with Working-Dataset compares an element with the currently checked out member. Show member history shows the versions of this member. Configure this action provides the possibility to configure the search-result-view, e. g. to remove columns or change their order. Page 7 from 18

2.2.1 Retrieve: checking out elements (CSAR->PDS) If Retrieve is chosen from the context menu, the marked element will be retrieved from Endevor and is then accessible as an element in the

8 2.2.1 Retrieve: checking out elements (CSAR->PDS) If Retrieve is chosen from the context menu, the marked element will be retrieved from Endevor and is then accessible as an element in the working-dataset. Before starting the action, a dialog shows the parameters to the user (Figure 6). If everything is ok, he can approve this by pressing ok. Figure 6: Dialog to check out an element Page 8 from 18

2.2.2 Edit The Edit action is only enabled if the element was already retrieved. It opens the retrieved version of the PDS, possibly modified, in an editor. 2.2.3 Update: checking in Elements (CSAR->PDS) Update is used to store a working-dataset-member back to Endevor.

9 2.2.2 Edit The Edit action is only enabled if the element was already retrieved. It opens the retrieved version of the PDS, possibly modified, in an editor Update: checking in Elements (CSAR->PDS) Update is used to store a working-dataset-member back to Endevor. Before starting the action, a dialog shows the parameters taken from the selected element to the user (Figure 7). CCID and stage might be changed. Pressing ok starts the execution of the action. Figure 7: Dialog to check in an element Page 9 from 18

2.2.4 Delete With the Delete action the user can delete a source file direct from Endevor (notice that the source will be deleted not from ZOS, but from the

10 2.2.4 Delete With the Delete action the user can delete a source file direct from Endevor (notice that the source will be deleted not from ZOS, but from the Repository Manager itself) Move The Move action moves the element between stages over a given map. Figure 8: Dialog to move an element Page 10 from 18

11 2.2.6 Browse The Browse action allows the user to look into the code of a source file without having the possibility of editing it Generate This action creates an executable from of the chosen element. Figure 9: Dialog to generate an element Page 11 from 18

12 2.2.8 SignIn This action removes the user signout associated with the chosen element Print The user can print the element s information generating a report. There are 5 possibilities: Browse: prints all the statements in the level of the element. Changes: displays all the inserts and deletes made to the element. History: prints all statement in all levels of the element. Summary: prints one line of summary information for each level. Master: prints Master Control File information for the element. Page 12 from 18

2.2.10 Compare It is possible to compare two elements from the search result.

13 Compare It is possible to compare two elements from the search result. Differences are displayed by using Eclipse's Compare -Editor (Figure 8). Figure 10: Compare-Members-Editor Page 13 from 18

2.2.11 Compare with Working-Dataset This action allows the user to compare the element stored in

Differences are displayed by using Eclipse's Compare -Editor (Figure 9).

14 Compare with Working-Dataset This action allows the user to compare the element stored in Endevor with the current working-dataset-member. Differences are displayed by using Eclipse's Compare -Editor (Figure 9). Figure 11: Compare-User-File-Editor Show member history With this action the user can see the old versions of the selected member. Figure 12: Member History View Page 14 from 18

Usually, the target-working-dataset is derived in some way, e. g. <user>.s.<type>. If this pattern should differ for certain element-types, it is also possible to explicitly assign another dataset.

15 2.3 Customization CSAR may be customized to the customers needs in two ways. First: all information necessary to access the host and handle the destination datasets for checked out elements or temporary datasets can be specified by using the preference page (Figure 9). Usually, the target-working-dataset is derived in some way, e. g. <user>.s.<type>. If this pattern should differ for certain element-types, it is also possible to explicitly assign another dataset. Figure 13: Configuration of CSAR using Preferences Second, it is necessary to provide some information about the customer s system, to specify possible input values for the dialog's combo-boxes. This is done by a XML-dataset (Figure 10) which is located on the host and can be read by the PlugIn, as soon as a connection to the host is established. <?xml version="1.0" encoding="utf-8"?> <CONFIG> <TYPE NAME="COBOL" SUFFIX="COB"> <PROCGROUP>COB1</PROCGROUP> <PROCGROUP>COB2</PROCGROUP> </TYPE> <TYPE NAME="CPY" SUFFIX="CBL"> </TYPE> <TYPE NAME="PLI" SUFFIX="PLI"> <PROCGROUP>PLI1</PROCGROUP> <PROCGROUP>PLI2</PROCGROUP> </TYPE> <TYPE NAME="REXX" SUFFIX="REX"> </TYPE> <ENVIRONMENT NAME = "TI"> <STAGE ENTRY="Y">T</STAGE> <STAGE ENTRY="N">I</STAGE> </ENVIRONMENT> <ENVIRONMENT NAME = "LQ"> <STAGE ENTRY="Y">L</STAGE> <STAGE ENTRY="N">Q</STAGE> </ENVIRONMENT> <ENVIRONMENT NAME = "UP"> <STAGE ENTRY="N">U</STAGE> <STAGE ENTRY="N">P</STAGE> </ENVIRONMENT> <ENVIRONMENT NAME = "KY"> <STAGE ENTRY="Y">K</STAGE> </ENVIRONMENT> <SYSTEM NAME="QSYS1"/> <SUBSYSTEM NAME="QSUBSYS1"/> </CONFIG> Figure 14: XML-based Configuration File Page 15 from 18

16 It is important to notice that CSAR for Endevor is initiated at startup. That s necessary in order to load some of the features of this offering (e.g. the option of an update to Endevor after closing the editor) before the plug-in itself is loaded. The user can disable this option (under Window > Preferences > Workbench > Startup and Shutdown), but we strongly recommend to leave it enabled. Page 16 from 18

17 3 Accessibility Features This is a list of the accessibility features that CSAR for Endevor satisfies. Keyboard equivalents Use color as an enhancement Support system settings for high contrast Inherit system settings for font, color, size Avoid the use of blinking text, objects, or other elements Provide documentation in an accessible format Messages don't time out No audio alerts for Page 17 from 18

18 4 Conclusion The CARMA Standard Access Repository (CSAR) provides an out-of-the-box solution for customers searching for a basic integration of their Endevor system into Rational Developer for System z (RDz). It offers actions for copying elements from Endevor into a PDS, so the full functionality of RDz is accessible to the developers, but also functions to store PDSmembers back to Endevor, hence supporting the software-product's life-cycle. Compareactions offer a convenient way to keep track of changes or find similarities in different elements. Implementation of CSAR is easy, as all necessary components are delivered and only the final call has to be built in into the associated Skeleton-REXX. Therefore, a running installation can be achieved quite fast. Preferences and a host based configuration-file allow the easy customization of CSAR to the customers need. CSAR is the perfect solution for all customers looking for an easy way to integrate their Endevor-system. Q Group AG All rights reserved. Copying (also in parts) only with permission of Q Group. This Document is still subject of change. Page 18 from 18

IBM Rational Developer for System z v7.6. Download Full Version :

IBM Rational Developer for System z v7.6. Download Full Version : IBM 000-051 Rational Developer for System z v7.6 Download Full Version : http://killexams.com/pass4sure/exam-detail/000-051 B. a project that has been defined on a z/os system, and can contain artifacts