Using the Topaz Connect eclipse plugin

CA Endevor is an integrated set of management tools used to automate, control, and monitor the mainframe software development lifecycle. The Topaz Connect Eclipse Plugin is a graphical user interface that you can use to perform most of CA Endevor functions from your Eclipse IDE framework.
This section contains a description of each change control task you can do using the Eclipse Plugin.

Define CA Endevor element filter (list elements)

Select the Topaz Connect menu item, then select the Endevor Elements:


You can set any/all of the fields to specific values, or you can use wildcard (*).

To populate the pull-down list and any item filters, use the associated filter button.

• Use the Environment Filter button to populate the pull-down list of CA Endevor environments.
• Use the Stage Filter button to populate the pull-down list of CA Endevor stages associated to the selected environment. The Stage Filter button is only activated when the environment field is populated.
• Use the System Filter button to populate the pull-down list of CA Endevor systems associated to the selected environment. The System Filter button is only activated when the environment field is populated.
• Use the Subsystem Filter button to populate the pull-down list of CA Endevor subsystems associated to the selected environment and system. The Subsystem Filter button is only activated when the environment and system fields are populated.
• Use the Type Filter button to populate the pull-down list of CA Endevor types associated to the selected environment, stage, and system. The Type Filter button is only activated when the environment, system, and stage fields are populated.
• Element filter field could be a fully qualified element name or partially qualified using the '*' wildcard. The "Where Text Equal" field limits the list to elements that contain one or more specified 1- to 70-character text strings.
• Search Map option tells CA Endevor to search for elements along the map.
• Return First Found option tells CA Endevor to provide only the first occurrence of a specific element along the application life cycle.
• Foreground/Batch option allows the request to be performed in foreground within the Eclipse framework or with a batch job running on the mainframe. In this case, a valid Job Name must be specified.

Once finished, the Plugin will issue a request to CA Endevor on the mainframe through Topaz Connect. You can follow the progression of the request by looking at the bottom-right of your screen.
The results will be displayed in a separate window as shown below. We are calling the result a CA Endevor Element tree list. You can generate as many CA Endevor Element tree lists as you like.

CA Endevor element tree list actions

You can right-click on any of the listed elements to show the list of actions you can perform for the given element:

Element checkout for browse

When you checkout an element for browse, the element will appear in your Endevor Explorer panel. To open it, right-click the element and select open Element and the element will open in a new window. If the CHECKOUTtoFILE is activated at your site, the CA Endevor element will be retrieved within the CHECKOUT FILE PREFIX data set from your checkout options. The file created within your CA Endevor Explorer panel will have the following record:
Element &element is checked out to file &dataset

• CCID: Change Control Identifier to be attached to the checkout action.
• Comment: Comment to be attached to the checkout action.
• New Subsystem is not active.
• Replace: If the member currently exists in the PDS or within the CA Endevor Explorer workspace, you must set the Replace check box otherwise the checkout action will fail.
• Expand: Activate this check box if you want the INCLUDE statements to be expanded.
• Search Map option tells CA Endevor to search for elements along the map.
• Override Sign-out is not active
• To z/OS File: the data set name entered in this field should be in single quotes. If not in single quotes, the type of the element to be checked out will be appended to the data set name.
• To USS Path: use this field to check out the element to a USS directory.

Element checkout for update

To update an element, you need to check out the element for Update (right- click on the element name)

When you check out an element for Update, the element will appear in your CA Endevor Explorer panel. To edit the element, right-click the element and select open Element and the element will open in a new window where you will be able to change the element directly in Eclipse. If the CHECKOUTtoFILE is activated at your site, the CA Endevor element will be retrieved within the CHECKOUT FILE PREFIX data set from your checkout options. The file created within your CA Endevor Explorer panel will have the following record:
Element &element is checked out to file &dataset

• CCID: Change Control Identifier to be attached to the checkout action.
• Comment: Comment to be attached to the checkout action.
• New Subsystem: If you want to have a different subsystem name within the application element file.
• Replace: If the member currently exists in the PDS or within the CA Endevor Explorer workspace, you must select the Replace check box otherwise the checkout action will fail.
• Expand: Activate this check box if you want the INCLUDE statements to be expanded.
• Search Map option tells CA Endevor to search for elements along the map.
• Override Sign-out if you need this option to be activated.
• To z/OS File: the data set name entered in this field should be in single quotes. If not in single quotes, the type of the element to be checked out will be appended to the data set name. 
• To USS Path: use this field to check out the element to a USS directory.

When done, right-click in the Editor Window and SAVE your work.

Then, you will need to check in your element, so the changes will be saved inside your CA Endevor solution on the mainframe.

• Entry Environment: If you want the ADD to be done against a different environment than the one from the application element file.
• CCID: Change Control Identifier to be attached to the check in action.
• Comment: Comment to be attached to the check in action.
• New Version: Lets you to assign a different version number. Simply enter the number (1-99 inclusive, leading zeros optional) that you want to use.
• Processor Group: The associated processor group will be displayed. You can select a new one if desired.
• Update if present to perform an UPDATE action instead of ADD.
• Override Sign-out if you need this option to be activated.
• Bypass Generate if you want to bypass the generate processor after the source management of the ADD action.
• From z/OS File: the data set name entered in this field should be in single quotes. If not in single quotes, the type of the element to be checked in will be appended to the data set name.
• From USS Path: use this field to specify the USS path to the directory that the element should be checked in from.

Browse element

Browse a CA Endevor element without checking it out to your local file directory. This will only allow you to view the element.

Quick-edit

The Quick-Edit function allows you to perform the check-out, edit, and check-in within the same function. The editor being invoked is managed by the file extension configuration.

Element list listing

If the CA Endevor implementation is saving the output of the generate processors within CA Endevor output managed data sets, the related listing can be accessed using the Topaz Connect Plugin. You can browse these by using the ELEMENT LIST LISTING option.

When the listing is retrieved, right-click the element in the Endevor Reports panel and select "open Element" to open it in a new window.

Element list summary

To obtain the list summary activities related to a specific CA Endevor element, right-click the corresponding element within the CA Endevor Element tree list.

When completed, this request will display all the different levels for the given element with the date/time/user of the changes.

For each level, you can perform different action such as Display Element Changes, Checkout element for browse/update and display the listing.

Element list components

To obtain the of input and output components involved within the translation of an element within the CA Endevor GENERATE processor.

Display element master

This action will allow you to browse the master information from the CA Endevor MCF.

Display element changes

This action will allow you to browse the changes that were made to the element. This will show the differences between the current version and the previous version.

When the changes are retrieved, right-click the element and select open Element to open it in a new window.

Generate element

This action will request a generate action to execute the associated generate processor.

• CCID: Change Control Identifier to be attached to the generate action.
• Comment: Comment to be attached to the generate action.
• Current Proc. Group: The associated processor group will be displayed. You can select a new one if desired.
• Copy Back option tells CA Endevor to first copies the current level of the element back to the FROM stage specified into the Environment and Stage filters, then generates the element. CA Endevor searches for the element first in the current environment, then in other stages along the map.
• No Source option, when the target location has a sourced Element, the element is generated in place. When the target location has a sourceless element, the element is generated at the target location using the source of the first occurrence of the element found up the map. When the element does not exist at the target location, the element is generated at the target location using the source of the first occurrence of the element found up the map. The source is not fetched to the target. NOSOURCE cannot be used with COPYBACK. It is not necessary to specify the SEARCH option with NOSOURCE, because NOSOURCE implies SEARCH.
• Search Map option is only valid with the COPYBACK option.
• Override Signout if the element has been signed out to a person other than yourself, you must code this option in order to perform this action.
• Foreground/Batch options allows to perform the request in foreground within Eclipse framework or with a batch job running on the mainframe. In this case, a valid Job Name must be specified.

Move element

This action will request a move action to execute the associated move processor.

• CCID: Change Control Identifier to be attached to the generate action.
• Comment: Comment to be attached to the generate action.
• Synchronize option compensates for differences between the base level of a source element and the current level of a target element.
• With History option preserves source element change history.
• Bypass Elm. Delete option tells CA Endevor to retain the element in the source stage after successfully completing the move.
• Signin option tells CA Endevor to sign in all elements at the target stage after successfully completing the move.
• Retain Signout option tells CA Endevor to retain the source location signouts for all elements at the target location.
• Jump option tells CA Endevor to move elements across environments even if the element exists at an intermediate stage that is not on the map.
• Signout To option tells CA Endevor to sign all elements out to the specified user ID at the target stage.
• Foreground/Batch options allows to perform the request in foreground within Eclipse framework or with a batch job running on the mainframe. In this case, a valid Job Name must be specified.

Signin element

The SIGNIN statement removes a user sign-out associated with an element. It also enables you to sign out or reassign an element to another user.

• Override Signout if the element has been signed out to a person other than you, then you must code this option in order to perform this action.
• Search Map tells CA Endevor to look for the element to be signed in along with the map, if it is not in the current environment.
• Signout To enables you to sign out or reassign an element at either stage to another user. If you have an element signed out to your user ID, you can use this option to reassign that element to the other user.

Delete element

• CCID: Change Control Identifier to be attached to the delete action.
• Comment: Comment to be attached to the delete action.
• Delete Component Only is applicable for CA Endevor ACM users only. Indicates whether you want to delete both the element component list and the element, or the element component list only.
• Override Signout if the element has been signed out to a person other than you, then you must code this option in order to perform this action.
• Foreground/Batch options allows to perform the request in foreground within Eclipse framework or with a batch job running on the mainframe. In this case, a valid Job Name must be specified.

This section further explains the following topics: