Configuring Workbench Debug

This topic describes how to create the Workbench Debug configuration.

Before you begin

• Install Workbench Explorer if you want to use the Workbench Debugger.
• Create the connection profile to connect with HCI before you begin debugging.
• Install Workbench Debugger on your mainframe.
• Set up the workspace in VS code.

To create a Workbench Debug configuration for a Workspace

1. In the left navigation panel of the VS code, click Run and Debug (). Alternatively, press Ctrl+Shift+D.
2. On the Run and Debug panel, click create a launch.json file. 
   
   
   
   
3. Select Workbench Batch from the list displayed.  
   
   
   
   This creates a launch.json file under the .vscode folder.
   
   
   
   
4. Open the launch.json file from the workspace .vscode directory, and click Add Configuration. This creates a new launch configuration. 

5. The following property fields are displayed. These fields are mandatory fields. Enter the values in the required fields.

   {
      "type": "workbench-batch",
      "request": "launch",
      "name": "Batch Launch",
      "hciConnectionName": "",
      "jclDatasetMember": "",
      "jobName": "",
      "steps": [
          {
              "step": "",
              "program": "",
              "DB2": false,
              "IMS": false  
          }
       ]
   }

   • type and request: Identifies this configuration as a launch configuration for Workbench. Do not modify these these fields.
   • name: Specifies the name of the launch configuration as it should appear in the VS Code Run and Debug dropdown.
   • hciConnectionName: Specifies the name of the HCI connection profile that defines the connection to the mainframe where the job is to be debugged.
   • jclDatasetMember: Specifies the data set name or member containing the JCL to run the program. For a PDS member, specify this as HLQ.ABC.DEF(MEMBER). For a sequential data set, specify simply as HLQ.ABC.DEF.
   • jobName: Specifies the job name for the batch program.
   • steps: Array of job steps to debug.

   • step: Specifies the name of the step within the JCL to be debugged.
   • program: Specifies the name of the program to be debugged.
   • DB2: Set as true or false, depending on whether Db2 is used.
   • IMS: Set as true or false, depending on whether IMS is used.
     
     You can add the following optional properties to include all possible options. To include any of the following options, start typing the option names, and when it is visible on the screen select them.
   • ddios: Specifies an optional comma-separated list of DDIO data sets to be searched for program source code.  For example: ["HLQ.ABC.DEF","HLQ.GHI.JKL"]
   • loadlibs: Specifies an optional comma-separated list of load libraries to be searched for load modules. For example: ["HLQ.ABC.DEF","HLQ.GHI.JKL"]

   • log: Displays the log at the end of each debug session. 

     • dsn: Enter the log data set options for your session.
     • spaceUnit: Enter the data set allocation. The space unit is TRK/CYL.
     • primary: Enter the primary value. The default value is 5.
     • secondary: Enter the secondary value. The default value is 5.
     • unit: Enter the unit name.
     • volume: Enter the volume.
     • dataClass: Enter the data class.
     • stgClass: Enter the storage class.
     • printToSysoutClass: Print output data set to SYSOUT. The output class is A-Z, 0-9.

     Following is the example with the optional fields added.

     {
        "type": "workbench-batch",
        "request": "launch",
        "name": "Batch Launch",
        "hciConnectionName": "",
        "jclDatasetMember": "",
        "jobName": "",
        "steps": [
            {
                "step": "",
                "program": "",
                "DB2": false,
                "IMS": false  
            }
         ],
        "ddios": [],
        "loadlibs": [],
        "log": {
            "dsn": "",
            "spaceUnit": "TRK",
            "primary": "5",
            "secondry": "5",
            "unit": "",
            "volume": "",
            "dataClass": "",
            "stgClass": "",
            "printSysoutClass": ""
        }
     }  
6. Save the launch.json file.