JCL Check

The JCL Check extension provides an interface in VS Code for developers and system administrators to interact with Job Control Language (JCL) on IBM z/OS mainframes.

The extension provides the following benefits:

• Edit JCL in VS Code to enhance developer productivity.
• Use the syntax highlighting, linting, and auto-complete features to write JCL efficiently.
• Ensure that JCL is valid prior to job submission by integrating with JCLCheck on the mainframe.
• Produce JCLCheck reports in markdown format to share with your team.
• Access a library of useful JCL snippets.

Tips:

• Use this extension in conjunction with Zowe Explorer to enable a suite of mainframe functionality in VS Code.
• The syntax highlighting capability is based on the ibm-jcl extension.

Contents

• Software Requirements
• Configuring
• Using

Software Requirements

You can use the JCL syntax highlighting/coloring and snippets generation features provided by the JCL Language support extension. The JCL Language Support extension is installed along with the JCL Check extension.

If you want to use JCLCheck's linting and reporting features, you must meet the following requirements:

• JCLCheck Workload Automation v12.0 is installed and configured on a mainframe system with the latest maintenance applied.
• An instance of JCLCheck Workload Automation v12.0 REST API server is running.
• Zowe CLI and the JCLCheck Plug-in for Zowe CLI is installed on your PC.

Configuring

To connect with a JCLCheck instance on the mainframe, create a jclcheck service profile on your computer using the JCLCheck Plug-in for Zowe CLI.

To create a JCLCheck plug-in profile via config command, gather the following data:

1. The host name of the LPAR on which JCLCheck Web Services is running
2. A username that has authority to access JCLCheck Web Services
3. The password to the account tied to the username

To create a JCLCheck profile through configuration command, issue the following command and provide the above details as prompted:

zowe config init

After you create the profile in the CLI, it will become available for use in VS Code. You can now perform JCLCheck actions in the extension using your default profile.

Advanced configuration

To access extension settings, navigate to File > Preferences > Settings, then select Extensions > JCL configuration.

You can configure the following options:

• JCLCheck features - Enable the linting and reporting features provided by the JCLCheck REST API. Ensure that you meet the software requirements before you use these features. (Default: Off)

• Automatic linting on save - Choose to perform linting manually, or automatically lint for each local save. You must enable the 'JCLCheckfeatures' option to use linting. (Default: On)

• Reports location - Specify the local folder where JCLCheck reports are saved. If you leave the setting blank, the extension prompts you for a location when you generate a report.

• Server tracing - Traces communication between VS Code and the language server. Specify Off, Messages, or Verbose. (Default: Off)

• Syntax highlighting rules - Configure syntax highlighting settings. For example, highlight the continuation column:

  "[jcl]" : { "editor.rulers" : [71, 72, 80]},
  

Using

Review the following use cases to understand how to use the JCL Check extension:

Accessing JCL locally

This extension does not provide the ability for you to download from, upload to, or submit jobs on the mainframe. To access mainframe code on your computer, use a tool such as Zowe CLI or Zowe Explorer.

JCL syntax highlighting

For basic syntax highlighting and symbol resolution, use the shortcut Ctrl/Cmd + Shift + O.

JCL Linting

Perform linting to check your JCL for programmatic or stylistic errors. You can perform linting manually, or enable automatic linting on save.

Note: To use linting, you must meet the software requirements and enable the "JCLCheck features" option. Automatic linting is enabled by default. See Configuring for more information.

Follow these steps:

1. Open the command palette with Ctrl/Cmd + Shift + P

2. Type "Check your JCL".

3. Click the command or press Enter to perform linting.

   JCL problems are highlighted in your code and displayed in the VS Code Problems view.

Producing and sharing JCLCheck reports

Run JCLCheck against your code and produce convenient reports in markdown format.

Note: To use reporting, you must meet the software requirements and enable the "JCLCheck features" option. See Configuring for more information.

Follow these steps:

1. Open the command palette with Ctrl/Cmd + Shift + P
2. Type "Generate JCL report".
3. Click the command or press Enter to generate a report.
4. When prompted for a filename, enter a location where the report should be saved and click OK to continue.

The report opens in VS Code after it is generated. Reports are created in the folder that you specified in the prompt, or that you specify in the extension settings.

Tip: If you want to convert your JCLCheck report from Markdown format into PDF, HTML, PNG, or JPEG, we recommend using the extension Markdown PDF by yzane.

Using JCL snippets

Before you write JCL from scratch, check the snippet library for useful job templates.

Follow these steps:

1. Open the command palette with Ctrl/Cmd + Shift + P
2. Type "Insert Snippet".
3. Click the command or press Enter.
4. Choose the type of snippet you want to insert.
5. Fill in the templated values to complete the JCL statement.

For a quicker way to access the snippets:

1. Begin typing the name of a snippet (e.g. IEFBR14) in the editor.
2. VS Code autocomplete should suggest the snippet.
3. Select the suggested snippet and press Enter.

Creating JCL snippets

You can add your own JCL templates to the snippet library.

Navigate to File > Preferences > User Snippets and select the JCL language.

Refer to Create your own snippets in the VS Code documentation for detailed information about creating the snippet.

For more information about this extension, please visit the documentation on Broadcom TechDocs.

Technical Assistance and Support for JCL Check extension

The JCL Check extension is made available to customers on Visual Studio 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 JCLCheck Workload Automation or Brightside, technical assistance and support is provided to Broadcom customers in accordance with the terms, guidelines, details and parameters located within Broadcom’s “Working with Support” guide located at:

https://techdocs.broadcom.com/us/product-content/admin-content/ca-support-policies.html?intcmp=footernav

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 Broadcom 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 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 software and Broadcom shall not be responsible for these effects or any resulting degradation in performance of the Broadcom software.

Copyright © 2020 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.