diff --git a/packages/vsce/README.md b/packages/vsce/README.md index cf97b923..26082726 100644 --- a/packages/vsce/README.md +++ b/packages/vsce/README.md @@ -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) @@ -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.
- +
Here's an example of a CICS profile entry in the config file: @@ -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).- +
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. @@ -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.- +
#### Using Zowe v1 profiles @@ -163,7 +163,7 @@ 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.- +
### Hiding Profiles @@ -171,7 +171,7 @@ To show more than one CICS profile in the tree, select the + button and choose f 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.- +
### Deleting Profiles @@ -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.- +
#### Using Zowe v1 profiles @@ -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`.- +
## CICS Resources @@ -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 against the resource type. If you wish to see all resources in a region (including IBM supplied ones) you can use "\*" as a filter.- +
**Tip:** To apply multiple filters, separate entries with a comma. You can append any filter with an \*, which indicates wildcard searching. @@ -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 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.- +
**Tip:** To apply multiple filters, separate entries with a comma. You can append any filter with an \*, which indicates wildcard searching. @@ -237,7 +237,7 @@ Plexes contain an `All Programs`, `All Local Transactions`, `All Local Files` an To view resources under these trees, use the search icon inline with the tree and apply a filter.- +
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. @@ -245,7 +245,7 @@ If the applied filter results in over 500 records, either change the filter to n **Tip:** The default 500 count can be modified via the `Record Count Increment` property in Settings (UI).- +
### Show Attributes @@ -253,7 +253,7 @@ If the applied filter results in over 500 records, either change the filter to n 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.- +
### Enable and Disable @@ -261,7 +261,7 @@ Right-click and use the pop-up menu against a program to list the available acti 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.- +
### New Copy and Phase In @@ -271,7 +271,7 @@ Use `New Copy` - + ### Open and Close Local Files @@ -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.- +
### Purge Task @@ -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.- +
### Inquire Functionality @@ -301,7 +301,7 @@ 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.- +
### View Datasets under Libraries @@ -309,7 +309,7 @@ The same can be done on a Local Transaction to find the associated Program by ex 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.- +
### View four CICS Web Resources under the Web Folder @@ -317,7 +317,7 @@ Expand libraries of a region to view specific datasets belonging to a library. R 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.- +
## Untrusted TLS Certificates @@ -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.- +
## Usage tips @@ -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)`.- +
Error messages arising from the Zowe Explorer extension will have the `Source` as `Zowe Explorer(Extension)`.