Skip to content

Commit

Permalink
update version and downloads badges
Browse files Browse the repository at this point in the history
Signed-off-by: zFernand0 <[email protected]>
  • Loading branch information
zFernand0 committed Feb 5, 2024
1 parent 6c73cd5 commit 6ce19e0
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions packages/vsce/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Zowe CICS Explorer

[![version](https://vsmarketplacebadge.apphb.com/version-short/zowe.cics-extension-for-zowe.svg)](https://vsmarketplacebadge.apphb.com/version-short/Zowe.cics-extension-for-zowe.svg)
[![downloads](https://vsmarketplacebadge.apphb.com/downloads-short/zowe.cics-extension-for-zowe.svg)](https://vsmarketplacebadge.apphb.com/downloads-short/Zowe.cics-extension-for-zowe.svg)
[![version](https://img.shields.io/visual-studio-marketplace/v/zowe.cics-extension-for-zowe.svg)](https://img.shields.io/visual-studio-marketplace/v/zowe.cics-extension-for-zowe.svg)
[![downloads](https://img.shields.io/visual-studio-marketplace/v/zowe.cics-extension-for-zowe.svg)](https://img.shields.io/visual-studio-marketplace/v/zowe.cics-extension-for-zowe.svg)
[![slack](https://img.shields.io/badge/chat-on%20Slack-blue)](https://openmainframeproject.slack.com/archives/CUVE37Z5F)
[![open issues](https://img.shields.io/github/issues/zowe/vscode-extension-for-cics)](https://github.com/zowe/vscode-extension-for-cics/issues)

Expand Down Expand Up @@ -80,7 +80,7 @@ If you don't have an existing Zowe CICS CLI profile, follow these steps to creat
5. Select the **+** button in the CICS tree and click the newly created profile to load it into view.

<p align="center">
<img src="./docs/images/create-config-profile.gif" alt="Zowe CICS Explorer config profiles" width="700px"/>
<img src="./docs/images/create-config-profile.gif" alt="Zowe CICS Explorer config profiles" width="700px"/>
</p>

Here's an example of a CICS profile entry in the config file:
Expand Down Expand Up @@ -116,7 +116,7 @@ Here's an example of a CICS profile entry in the config file:
Configuring a CICS region to have a connection is a system programmer task and more details can be found in [Setting up CMCI with CICSPlex SM](https://www.ibm.com/docs/en/cics-ts/5.3?topic=explorer-setting-up-cmci-cicsplex-sm) or [Setting up CMCI in a stand-alone CICS region](https://www.ibm.com/docs/en/cics-ts/5.3?topic=suace-setting-up-cmci-in-stand-alone-cics-region). If your CMCI connection is configured to use a self-signed certificate that your PC's trust store doesn't recognize, see [Untrusted TLS certificates](#untrusted-tls-certificates).

<p align="center">
<img src="./docs/images/create-profile.gif" alt="Zowe CICS Explorer profiles" width="700px"/>
<img src="./docs/images/create-profile.gif" alt="Zowe CICS Explorer profiles" width="700px"/>
</p>

To show more than one CICS profiles in the tree, select the **+** button and choose from the list of profiles. Only profiles that not already included in the CICS tree will be shown.
Expand Down Expand Up @@ -149,7 +149,7 @@ To show more than one CICS profile in the tree, select the + button and choose f
4. Refresh the Zowe Explorer for IBM CICS extension by either clicking the button at the top level of the CICS view, or the `Zowe Explorer for IBM CICS: Refresh` command palette option.

<p align="center">
<img src="./docs/images/update-config-profile.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/update-config-profile.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

#### Using Zowe v1 profiles
Expand All @@ -163,15 +163,15 @@ To show more than one CICS profile in the tree, select the + button and choose f
3. Once the details are updated, click the **Update Profile** button to apply the changes to the profile.

<p align="center">
<img src="./docs/images/update-profile.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/update-profile.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

### Hiding Profiles

Open the menu actions for a profile by right-clicking a profile and select `Hide Profile` to hide it from the CICS view. To add the profile back, click the + button and select the profile from the quick pick list.

<p align="center">
<img src="./docs/images/hide-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/hide-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

### Deleting Profiles
Expand All @@ -187,7 +187,7 @@ Open the menu actions for a profile by right-clicking a profile and select `Hide
4. Refresh the Zowe Explorer for IBM CICS extension by either clicking the button at the top level of the CICS view, or the `Zowe Explorer for IBM CICS: Refresh` command palette option.

<p align="center">
<img src="./docs/images/delete-config-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/delete-config-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

#### Using Zowe v1 profiles
Expand All @@ -197,7 +197,7 @@ Open the menu actions for a profile by right-clicking a profile and select `Hide
2. Select **Delete Profile** and click the **Yes** button when prompted to confirm the action of permanently deleting the profile. The functionality deletes the CICS profile from the persistent storage directory `~/.zowe/profiles/cics`.

<p align="center">
<img src="./docs/images/delete-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/delete-profile.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

## CICS Resources
Expand All @@ -213,7 +213,7 @@ The list of resources are pre-filtered to exclude many of the IBM supplied ones
To reset the filter to its initial criteria use the clear filter icon <img src="./docs/images/resource-filter-clear.png" width="16px"/> against the resource type. If you wish to see all resources in a region (including IBM supplied ones) you can use "\*" as a filter.

<p align="center">
<img src="./docs/images/region-filter.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/region-filter.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

**Tip:** To apply multiple filters, separate entries with a comma. You can append any filter with an \*, which indicates wildcard searching.
Expand All @@ -225,7 +225,7 @@ Similar to filtering resources in a region, it is also possible to apply a filte
To reset the filter to its initial criteria use the clear filter icon <img src="./docs/images/resource-filter-clear.png" width="16px"/> against the `Regions` tree. This will open a drop-down menu which gives the option to clear the filter for all the `Regions`, `Programs`, `Local Transactions` or `Local Files` in the plex, and an option to otherwise clear `All` filters within the plex.

<p align="center">
<img src="./docs/images/plex-filter.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/plex-filter.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

**Tip:** To apply multiple filters, separate entries with a comma. You can append any filter with an \*, which indicates wildcard searching.
Expand All @@ -237,31 +237,31 @@ Plexes contain an `All Programs`, `All Local Transactions`, `All Local Files` an
To view resources under these trees, use the search icon <img src="./docs/images/resource-filter.png" width="16px"/> inline with the tree and apply a filter.

<p align="center">
<img src="./docs/images/all-resources.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/all-resources.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

If the applied filter results in over 500 records, either change the filter to narrow down the search, or click the `view X more ...` item to retrieve 'X' more resources.

**Tip:** The default 500 count can be modified via the `Record Count Increment` property in Settings (UI).

<p align="center">
<img src="./docs/images/record-count-increment.png" alt="Zowe CICS Explorer Record Count Increment in Setting UI" width="700px"/>
<img src="./docs/images/record-count-increment.png" alt="Zowe CICS Explorer Record Count Increment in Setting UI" width="700px"/>
</p>

### Show Attributes

Right-click and use the pop-up menu against a program to list the available actions that can be performed. For every resource, including a CICS region, `Show Attributes` opens a viewer listing all attributes and their values. The attributes page has a filter box at the top that lets you search for attributes matching the criteria.

<p align="center">
<img src="./docs/images/show-attributes.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/show-attributes.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

### Enable and Disable

Right-click against a program, local transaction or local file to open up the pop-up menu and click `Disable [CICS resource]` to disable the resource. When a resource is already disabled the first option becomes `Enable [CICS resource]` to allow its enablement state to be toggled. A disabled resource is identified by a `(Disabled)` text next to its name.

<p align="center">
<img src="./docs/images/disable-enable.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
<img src="./docs/images/disable-enable.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

### New Copy and Phase In
Expand All @@ -271,7 +271,7 @@ Use `New Copy` <img src="./docs/images/program-newcopy-action.png" width="16px"/
The `newcopycnt` for a program which is greater than zero is shown next to the program item in the CICS resource tree.

<p align="center">
<img src="./docs/images/new-copy.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/new-copy.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

### Open and Close Local Files
Expand All @@ -281,7 +281,7 @@ Right-click against a closed local file and perform the `Open Local File` menu a
To close a local file, right-click against an open local file and perform the `Close Local File` menu action. This will bring up a prompt on the bottom right corner requesting to choose one of `Wait`, `No Wait` or `Force` for the file busy condition. Once an option has been selected, the local file name will be appended with a `(Closed)` label upon success.

<p align="center">
<img src="./docs/images/open-close.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/open-close.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

### Purge Task
Expand All @@ -291,7 +291,7 @@ Right-click against a task and click the `Purge Task` command. This will open a
Select the appropriate condition to perform the purge.

<p align="center">
<img src="./docs/images/purge-task.gif" alt="Zowe CICS Explorer Purge Task" width="600px"/>
<img src="./docs/images/purge-task.gif" alt="Zowe CICS Explorer Purge Task" width="600px"/>
</p>

### Inquire Functionality
Expand All @@ -301,23 +301,23 @@ Right-click against a Task and perform the `Inquire Transaction` command. This w
The same can be done on a Local Transaction to find the associated Program by executing the `Inquire Program` right-click menu action against a Local Transaction.

<p align="center">
<img src="./docs/images/inquire.gif" alt="Zowe CICS Explorer Inquire functionality" width="600px"/>
<img src="./docs/images/inquire.gif" alt="Zowe CICS Explorer Inquire functionality" width="600px"/>
</p>

### View Datasets under Libraries

Expand libraries of a region to view specific datasets belonging to a library. Right-click on libraries to `Show Attributes` to view library attributes. Similarly, right-click on datasets to `Show Attributes` to view dataset attributes.

<p align="center">
<img src="./docs/images/datasets.gif" alt="Zowe CICS Explorer View Datasets functionality" width="600px"/>
<img src="./docs/images/datasets.gif" alt="Zowe CICS Explorer View Datasets functionality" width="600px"/>
</p>

### View four CICS Web Resources under the Web Folder

Expand the Web folder to view TCPIP Services, URI Maps, Pipelines and Web Services. Each of these resources can be expanded and allows for right-click functionality on the specific resource to execute the `Show Attributes` command. Use the search icon to filter down specific resources by applying a filter.

<p align="center">
<img src="./docs/images/webResources.gif" alt="Zowe CICS Explorer Web resources under the Web folder" width="600px"/>
<img src="./docs/images/webResources.gif" alt="Zowe CICS Explorer Web resources under the Web folder" width="600px"/>
</p>

## Untrusted TLS Certificates
Expand All @@ -327,7 +327,7 @@ If the CMCI connection is using a TLS certificate that your PC doesn't have in i
If you define a profile as only accepting trusted TLS certificates when the Zowe Explorer first connects it will detect the mismatch and allow you to override the setting and proceed. This is done through a pop-up message with a `Yes` button to accept the untrusted certificate authority, which changes the profile's setting.

<p align="center">
<img src="./docs/images/untrusted-cert.gif" alt="Zowe CICS Explorer accepted untrusted certificate" width="600px"/>
<img src="./docs/images/untrusted-cert.gif" alt="Zowe CICS Explorer accepted untrusted certificate" width="600px"/>
</p>

## Usage tips
Expand All @@ -345,7 +345,7 @@ If you define a profile as only accepting trusted TLS certificates when the Zowe
Before filing an issue, check if an error is arising from the Zowe Explorer for IBM CICS extension and not the Zowe Explorer extension by expanding the error message and checking if the `Source` is `Zowe Explorer for IBM CICS (Extension)`.

<p align="center">
<img src="./docs/images/expand-error-cics.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
<img src="./docs/images/expand-error-cics.gif" alt="Zowe CICS Explorer NewCopy Program" width="600px"/>
</p>

Error messages arising from the Zowe Explorer extension will have the `Source` as `Zowe Explorer(Extension)`.
Expand Down

0 comments on commit 6ce19e0

Please sign in to comment.