Skip to content

IBM i FileSystem

Advanced functionality for viewing and managing objects inside the IBM i QSYS file system

The IBM i FileSystem extension provides advanced functionality for viewing and managing objects inside the IBM i QSYS file system. It extends the base Code for IBM i extension with specialized editors and operations for various IBM i object types.

Install

The extension can be installed from the Marketplace and is also part of the IBM i Development Pack .

Optional: CL Prompter

Some actions use Bob Cozziโ€™s CL Prompter and Formatter for IBM i to prompt the underlying CL command:

  • Required to add or change a message description in a Message File (*MSGF) and to change a Job Description (*JOBD)
  • Optional for Save Files (*SAVF): when installed, save and restore prompt the CL command (SAV/SAVLIB/SAVOBJ, RST/RSTLIB/RSTOBJ) with the save file already filled in, instead of asking for each parameter one by one

Usage

Once connected to your IBM i system using Code for IBM i:

  1. Navigate to the Object Browser
  2. Browse to any supported object type
  3. Click on the object to open it in the custom editor
  4. Object-level actions are available in the editor Action Bar (top right), or through the Object Actions quick pick
  5. Row-level actions (hold/release/end a job, reply to a message, open a spooled file, โ€ฆ) are buttons inside the tables of the object view itself

Supported Object Types

The extension supports 22 different IBM i object types with comprehensive viewing capabilities and interactive actions. Below is a summary table of all supported object types:

Object TypeType CodeActionsDescription
๐Ÿ“ฆ Save Files*SAVFโœ…Store and manage saved objects and libraries
๐Ÿ“จ Data Queues*DTAQโœ…Inter-process communication queues
๐Ÿ“ Data Areas*DTAARAโœ…Shared data storage objects
๐Ÿ–จ๏ธ Output Queues*OUTQโœ…Manage spooled files and printer output
๐Ÿ“‹ Job Queues*JOBQโœ…Manage batch jobs waiting to be processed
๐Ÿ’พ User Spaces*USRSPCโœ…Temporary or permanent data storage
๐Ÿ”‘ User Indexes*USRIDXโœ…Fast keyed access to user-defined entries
๐Ÿ“„ Message Files*MSGFโœ…Predefined application messages
๐Ÿ’ฌ Message Queues*MSGQโœ…Store and manage system/user messages
๐Ÿ”— Binding Directories*BNDDIRโœ…Lists of service programs and modules
๐Ÿ”ง Programs*PGMโŒExecutable program objects
๐Ÿ”ง Service Programs*SRVPGMโŒShared executable code libraries
๐Ÿงฉ Modules*MODULEโŒCompiled ILE objects
โš™๏ธ Commands*CMDโŒIBM i CL command definitions
๐Ÿ“„ Job Descriptions*JOBDโœ…Runtime environment for batch jobs
๐Ÿ““ Journal Receivers*JRNRCVโŒStore journal entries for recovery
๐Ÿ““ Journals*JRNโœ…Record changes for auditing and recovery
๐ŸŒ DDM Files*DDMFโŒAccess files on remote systems
๐Ÿ–ฅ๏ธ Subsystem Descriptions*SBSDโœ…Define independent operating environments
๐ŸŽฏ Classes*CLSโŒRuntime attributes for batch jobs
๐Ÿ“ Files*FILEโœ…Physical/logical files, views, and indexes
๐Ÿ” Query Definitions*QRYDFNโŒQuery/400 definitions, shown as SQL

Legend:

  • โœ… Actions Available - Interactive operations (create, modify, delete, send, clear, etc.)
  • โŒ View Only - Read-only information display

View Object Details and Actions

To view the detailed object content and interact with object-specific actions, click directly on the object in the Object Browser. This will open the custom editor for that object type, where you can:

  • View the complete object content
  • Use the Action Bar (top right) to perform operations
  • Edit and modify the object (when applicable)
  • Access object-specific features and tools

Object Details Editor Object Details Editor - Click on an object to open the custom editor with full content and interactive actions

Generic Actions

Every object opened in the custom editor gets these toolbar actions, whatever its type:

ActionDescription
๐Ÿ”„ Refresh ObjectReload the objectโ€™s data from the system
โšก Object ActionsQuick pick listing every action available for the current object, so they stay reachable when the toolbar is collapsed
๐Ÿ”ง Additional InformationOpen the Display Object Information (DSPOBJ) view for the object

System Views

The extension also provides powerful system views for monitoring and managing your IBM i system:

  • ๐Ÿ“Š Display Object Information (DSPOBJ) - Comprehensive object details with locks and authorizations
  • ๐Ÿ‘ฅ Work with Active Jobs (WRKACTJOB) - Monitor and manage all active jobs
  • ๐Ÿ’ผ Work with Job (WRKJOB) - Detailed job information with statistics and logs
  • ๐Ÿ‘ค Work with User Jobs (WRKUSRJOB) - View the jobs of a user profile, including completed ones
  • ๐Ÿ–จ๏ธ Work with Spooled Files (WRKSPLF) - Manage the spooled files of a user profile with pagination
  • ๐Ÿข Work with Subsystems (WRKSBS) - List active subsystems, drill into them or end them

FS Quick Start Menu

Click on FS Quick Start in the status bar (bottom left) to access these commands:

CommandDescription
๐Ÿ“ฅ DSPMSGDisplay the current userโ€™s message queue
๐Ÿ’ฌ DSPMSG QSYSOPRDisplay System Operator messages
๐Ÿ“‹ DSPOBJOpen the Display Object Information view, prompting for library, name and type
๐Ÿ” DSPOBJ DetailedPrompt for library, object name and object type, then open that object without navigating the Object Browser
๐Ÿ“„ WRKSPLFWork with Spooled Files
๐Ÿ’ผ WRKJOBWork with Job
๐Ÿ”„ WRKACTJOBWork with Active Jobs
๐Ÿ‘ฅ WRKUSRJOBWork with User Jobs
๐Ÿข WRKSBSWork with Subsystems

Customizing the menu

The menu is fully customizable through the vscode-ibmi-fs.quickStartMenu setting. Click the โš™๏ธ Customize FS Quick Start Menuโ€ฆ entry at the bottom of the menu (or run FS Quick Start: Configure FS Quick Start Menu from the Command Palette) to open a guided wizard that lets you:

  • โž• Add an entry pointing to any built-in or contributed VS Code command (with optional arguments)
  • โœ๏ธ Edit an existing entryโ€™s label, description, icon or command
  • ๐Ÿ—‘๏ธ Remove one or more entries
  • โฌ†๏ธโฌ‡๏ธ Move entries up or down to reorder the menu
  • โ™ป๏ธ Reset the menu back to the built-in defaults

Once customized, your menu completely replaces the built-in defaults; use Reset to go back to them.


Settings

Besides vscode-ibmi-fs.quickStartMenu, the extension follows two settings of the base Code for IBM i extension:

SettingDefaultDescription
code-for-ibmi.views.autoRefreshInterval30Auto-refresh interval, in seconds, of the views that refresh themselves (WRKACTJOB, WRKJOB, WRKUSRJOB, WRKSPLF, WRKSBS and the data queue, job queue, output queue, message queue and subsystem description editors). Set it to 0 to disable auto-refresh
code-for-ibmi.tables.itemsPerPage50Number of rows per page in paginated tables (minimum 30)

Localization

This extension supports multiple languages through VSCodeโ€™s built-in localization framework. The display language of VS Code is detected automatically, and more than 1600 strings are translated, including UI messages, tab titles, table column headers and IBM i database column names.

Supported Languages

  • ๐Ÿ‡ฌ๐Ÿ‡ง English (default)
  • ๐Ÿ‡ฎ๐Ÿ‡น Italian
  • ๐Ÿ‡ซ๐Ÿ‡ท French
  • ๐Ÿ‡ฉ๐Ÿ‡ช German
  • ๐Ÿ‡ช๐Ÿ‡ธ Spanish
  • ๐Ÿ‡ฏ๐Ÿ‡ต Japanese
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korean
  • ๐Ÿ‡ง๐Ÿ‡ท ๐Ÿ‡ต๐Ÿ‡น Brazilian Portuguese
  • ๐Ÿ‡จ๐Ÿ‡ณ Simplified and Traditional Chinese

To contribute a new language, add a l10n/bundle.l10n.<locale>.json file to the GitHub repository , copying the structure of l10n/bundle.l10n.en.json and translating the values while keeping the keys unchanged.