IBM IMS® Explorer for VS Code

Exploring the User Interface

Welcome Page

A welcome page is shown the first time the IMS Explorer for VS Code extension is launched. It provides quick-start scenarios to help verify that the extension is properly installed and to prepare your first project workspace and configurations.

IMS Explorer Views and Controls

Note: Source and DDL views display a snapshot of the current state that can be edited within the editor. If you edit these files, the views will not automatically refresh another.

IMS Connections Tree View

  • Purpose: Add and manage multiple IMS database and catalog connections.
  • Usage:
    • Add and organize connections.
    • Expand/collapse connection contents to browse DBDs, PSBs, and PCBs.
    • Right‑click an item to view DDL, segments, fields, source, or visualize the structure.

IMS Projects View

  • Purpose: Create and edit IMS projects to execute SQL queries, run IMS commands, and edit DBD fields and database definitions.
  • Usage: Start new projects, add SQL query files, add IMS command files, import DBDs and PSBs from the IMS catalog, edit DDL and source files, and organize project assets.

Source and DDL Views

  • Purpose: View and edit the source code or DDL for DBDs and PSBs.
  • Usage: Right-click a DBD or PSB in the IMS Connections tree view or IMS Projects view and select View Source or View DDL to open an editable snapshot in the editor.
  • Limitation: These views show a snapshot that can be edited but will not auto-refresh when changes are made. Close and reopen to see updates.

Table Views

  • Purpose: Inspect DBDs, PSBs, and PCBs in tabular form.
  • Usage: Quickly click across related definitions to find associated segments and fields. For DBDs and PSBs, select the overflow menu to use Find referenced PSBs or Find referenced DBDs and view results in a nested table.

Visualization Views

  • Purpose: Interactively explore DBD and PSB hierarchical structures.
  • Usage: Visualize database structures with zoom controls, expand segments to view fields, and switch between visualization, source, DDL, and table views.

Output Channels

  • IBM IMS Explorer for VS Code — Client logs
  • IBM IMS Explorer LSP Server — Language server logs
    View them via the Output panel to troubleshoot or monitor activity.

Status Bar Options

  • IMS Workspace — Indicates the workspace location that stores extension artifacts such as ims.connections.json. Can be clicked to choose a location.
  • IMS Connection — Used to verify or switch the active database connection for SQL execution.

Settings Integration

While not indicated on the UI, these extension settings are key to using the IMS Explorer for VS Code extension effectively.

  • Java selection (ims.explorer.connection.property.javaHome) and JVM arguments (ims.explorer.connection.property.jvmArgs).
  • Logging level (ims.explorer.logging.level).
  • IMS Workspace path (ims.explorer.property.ImsWorkspace). Configure under Preferences → Settings.