Explorer for Endevor extension for VS Code
Explorer for Endevor gives you the ability to Browse and Retrieve CA Endevor® SCM elements using a user-friendly, intuitive interface.
Explorer for Endevor allows you to create customized filters for Endevor Elements enabling you to Browse and Retrieve specific Elements, without knowing the exact path to navigate beforehand.
Prior to installing the Visual Studio Code Extension for Explorer for Endevor, ensure that you meet the following prerequisites:
- Access to Mainframe
- Access to CA Endevor® SCM
- Installed and configured CA Endevor® SCM Web Services.
- Latest maintenance and updates applied.
- Check here for more information.
You must first create a host in Explorer for Endevor to enable it to access the repository you want to explore.
Create a Host
Create a Host in Explorer for Endevor to specify the data source you want to work with. This will allow you to view and explore the selected Endevor repositories.
Follow these steps:
Open the Explorer for Endevor extension in Visual Studio Code.
Click the plus icon or New connection.
You will be prompted to enter an Endevor repository URL in the format 'http(s)://url:port', for example 'http(s)://myhost01:9090' then press 'Enter' to confirm or 'Escape' to cancel.
Select a CA Endevor SCM configuration from the drop-down list.
You have successfully created a new Host connected to a repository, and the Host is listed under Explorer for Endevor in the Visual Studio Code interface.
- Change the name of the connection by clicking the pencil icon next to the connection name. Names must be unique as duplicate names are not permitted.
- Filters can be created in the connection without being logged in, however you will be prompted to enter your credentials before any data is displayed.
Create a Filter
Explorer for Endevor filters can be created in two ways:
Create a filter manually by entering all the required parameters.
Search in Map View, and save a filter from the path followed.
Create a Manual Filter:
Creating a manual filter is a quick way to narrow down your search to only relevant results.
Follow these steps
Establish the exact parameters to search as follows:
Click the plus icon next to Filter on the Explorer for Endevor tab.
A prompt appears for you to enter the required parameters as follows:
If the parameters (with a maximum of two parameters as * wildcards) are correctly entered, the filter will appear under the expanded Filter section in the Explorer for Endevor tab.
Create a Filter in Map View:
Map View allows you to create custom filters, without necessarily knowing the parameters in advance or if you have limited or no prior knowledge of Endevor.
Follow these steps:
Open Map View in Explorer for Endevor for your selected Host
Navigate the view as required, selecting your desired options as you navigate through the different parameters in hierarchical order.
Select an entry at the Type level, and click the plus icon.
The path that you followed appears highlighted at the top of your screen, displaying the following dialog:
"Create a new Endevor filter (Press 'Enter' to confirm or 'Escape' to cancel)"
If the created filter matches your requirements, Press Enter.
The newly created filter is automatically saved and now shows as an option under the Filters View
Browse or Retrieve an Element
The Browse Element action displays the entire contents of the Element, including related metadata. This allows you to determine if you want to retrieve and work with the Element
Follow these steps:
Right-click on the element in either the Map or Filters view.
The options to Browse or Retrieve the Element appear.
Select the Browse Element option.
The Element is displayed in the panel, including related information, as shown below:
Review the displayed information to determine if it is relevant or useful to you.
You have successfully opened an element for inspection. If you wish, you can now Retrieve the Element, with or without Dependencies.
As a modern application developer working with CA Endevor® SCM, you use Explorer for Endevor to browse elements controlled by Endevor. You can then decide if you want to retrieve any Element into your workspace, either alone or with dependencies.
You can use Map View in Explorer for Endevor to explore Endevor locations (Environment, Stage, System, and Subsystem) and save them as filter definitions.
Create customised filters by including different wildcard criteria.
Configuration and Usage Tips
- Delete any filters when no longer required. Filters are saved automatically and so the list can become hard to manage.
- Restrict filters to a maximum of two wildcard entries to avoid heavy resource usage. If you have any requirements or dependencies, add a section describing those and how to install and configure them.
The Type level in Map View allows you to create custom filters. As these filters are derived from the properties of the specified element, they can be used, with wildcards, to identify other elements with similar characteristics.
Explorer for Endevor allows you to create custom filters to help you quickly identify the Elements you want to work with. You can create a filter directly by specifiying each parameter, or by searching Map View, and saving the path as a custom filter.
Once created, you can edit filters to create a bespoke search for Elements with closely matching characteristics elsewhere in the data set.
Created filters are saved by default. The Delete filter action helps to keep your list of created filters manageable.
Once you identify the relevant Element, you can perform the following actions:
Displays the contents of the Element, including metadata, to help you determine if you want to Retrieve it and work with the Element.
Retrieves the Element, with no additional data. The Element is stored locally while you work with it, and you can then apply your changes.
Retrieve Element with Dependencies
Retrieves the Element and all the Endevor managed input components. The Element and components are stored locally in the specified Workspace.
Retrieve Multiple Elements
Retrieves several selected Elements. The Elements are stored locally in the specified Workspace.
For more information, please visit our documentation
Technical Assistance and Support for CA Explorer for Endevor
CA Explorer for Endevor extension is made available to customers on Visual Studio’s Code Marketplace in accordance with the terms and conditions contained in the provided End-User License Agreement (EULA).
If you are on active support for CA Endevor, technical assistance and support is provided to Broadcom’s CA Endevor customers in accordance with the terms, guidelines, details and parameters located within Broadcom’s “Working with Support” guide located at:
This support generally includes:
- Telephone and online access to technical support
- Ability to submit new incidents 24x7x365
- 24x7x365 continuous support for Severity 1 incidents
- 24x7x365 access to CA Support Online
- Interactive remote diagnostic support
Technical support cases must be submitted to Broadcom in accordance with guidance provided in “Working with Support”.
Note: To receive technical assistance and support, you must remain compliant with “Working with Support”, be current on all applicable licensing and maintenance requirements, and maintain an environment in which all computer hardware, operating systems, and third party software associated with the affected Broadcom CA software are on the releases and version levels from the manufacturer that Broadcom designates as compatible with the software. Changes you elect to make to your operating environment could detrimentally affect the performance of Broadcom CA software and Broadcom shall not be responsible for these effects or any resulting degradation in performance of the Broadcom CA software. Severity 1 cases must be opened via telephone and elevations of lower severity incidents to Severity 1 status must be requested via telephone.
Copyright © 2019 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.