CICS Plugin for the Zowe CLI
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
docs/maintainer maintainer update Oct 5, 2018
jenkins initial commit to the zowe org Oct 4, 2018
scripts Profile options added to commands; updated tests/snapshots; added CLI… Dec 12, 2018
src Enable progress bar Dec 12, 2018
.gitignore Profile options added to commands; updated tests/snapshots; added CLI… Dec 12, 2018
.npmignore initial commit to the zowe org Oct 4, 2018
.npmrc use bintray to install imperative - don't remove .npmrc file during j… Dec 13, 2018
CONTRIBUTING.md fixed broken links in the table. Oct 9, 2018
Jenkinsfile disable system tests Dec 13, 2018
LICENSE
LICENSE_HEADER initial commit to the zowe org Oct 4, 2018
README.md
package-lock.json Bumped pre-release version to 1.1.0-next.201812131943 [ci skip] Dec 13, 2018
package.json Bumped pre-release version to 1.1.0-next.201812131943 [ci skip] Dec 13, 2018
package_template.json initial commit to the zowe org Oct 4, 2018
tsconfig.json initial commit to the zowe org Oct 4, 2018
tslint-tests.json initial commit to the zowe org Oct 4, 2018
tslint.json initial commit to the zowe org Oct 4, 2018

README.md

Zowe CLI Plug-in for IBM® CICS®

The Zowe CLI Plug-in for IBM® CICS® lets you extend Zowe CLI to interact with IBM CICS programs and transactions. The plug-in uses the IBM CICS Management Client Interface (CMCI) API to achieve the interaction with CICS. For more information, see CICS management client interface on the IBM Knowledge Center.

As an application developer, you can use the plug-in to perform various CICS-related tasks, such as the following:

  • Deploy code changes to CICS applications that were developed with COBOL.
  • Deploy changes to CICS regions for testing or delivery.
  • Automate CICS interaction steps in your CI/CD pipeline with Jenkins Automation Server or TravisCI.

Contribution Guidelines

For more information about general development guidelines and CICS plug-in specific information, see the Contribution Guidelines.

Tip: Visit our Sample Plug-in repository and follow the tutorials on the documentation site to start developing your first plug-in!

Prerequisites

Before you install the plug-in, meet the following prerequisites:

Build the Plug-in from Source

Follow these steps:

  1. The first time that you download the Zowe CLI plug-in for CICS from the GitHub repository, issue the following command against the local directory:

    npm install
    

    The command installs the required Zowe CLI Plug-in for CICS dependencies and several development tools. When necessary, you can run the task at any time to update the tools.

  2. To build your code changes, issue the following command:

    npm run build
    

    The first time you build your code changes, you will be prompted for the location of the Imperative CLI Framework package, which is located in the node_modules/@brightside folder in the directory where Zowe CLI was installed.

    Note: When you update package.json to include new dependencies, or when you pull changes that affect package.json, issue the npm update command to download the dependencies.

Install the Zowe CLI Plug-in for CICS

Follow these steps:

  1. Meet the prerequisites.

  2. Install the plug-in:

    zowe plugins install @brightside/cics
    
  3. (Optional) Verify the installation:

    zowe plugins validate @brightside/cics
    

    When you install the plug-in successfully, the following message displays:

    Validation results for plugin 'cics':
    Successfully validated.
    

    Tip: When an unsuccessful message displays, you can troubleshoot the installation by addressing the issues that the message describes. You can also review the information that is contained in the log file that is located in the directory where you installed Zowe CLI.

  4. Create a profile.

Create a User Profile

You can create a cics user profile to avoid typing your connection details on every command. A cics profile contains the host, port, username, and password for the IBM CMCI server of your choice. You can create multiple profiles and switch between them as needed.

Follow these steps:

  1. Create a CICS profile:
    zowe profiles create cics <profile name> <host> <port> <user> <password>
    
    The result of the command displays as a success or failure message. You can use your profile when you issue commands in the cics command group.

Tip: For more information about the syntax, actions, and options, for a profiles create command, open Zowe CLI and issue the following command:

zowe profiles create cics -h

Run Tests

For information about running automated, unit, and system and integration tests using the plug-in, see Zowe CLI Plug-in Testing Guidelines.

Uninstall the Plug-in

Follow these steps:

  1. To uninstall the plug-in from a base application, issue the following command:
    zowe plugins uninstall @brightside/cics
    

After the uninstallation process completes successfully, the product no longer contains the plug-in configuration.