Skip to content

System Views

The IBM i FileSystem extension provides powerful system views that allow you to monitor and manage various aspects of your IBM i system directly from VS Code. These views provide comprehensive information and interactive actions for jobs, spooled files, subsystems and objects.

All the views can be opened from the FS Quick Start menu in the status bar (see FS Quick Start Menu) or from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).


📊 Display Object Information (DSPOBJ)

A comprehensive view that displays detailed information about any IBM i object, similar to the DSPOBJD command but with an enhanced, multi-tab interface.

IBM i SQL Services Used

TypeSchemaNamePurpose
Table FunctionQSYS2OBJECT_STATISTICSRetrieve comprehensive object statistics and metadata
Table FunctionQSYS2LIBRARY_INFORetrieve the ASP group of libraries
ViewQSYS2OBJECT_LOCK_INFORetrieve all locks on the object
Table FunctionQSYS2OBJECT_PRIVILEGESRetrieve object authorizations and permissions

Features

  • 📊 Information Tab: Complete object metadata including owner, creation date, size, and attributes
  • 🔒 Locks Tab: View all active locks with state, scope, and job information
  • 👥 Authorizations Tab: View user and group authorities with specific permissions
  • 📅 Usage Statistics: Last used timestamp, days used count, save/restore information
  • 🎨 Multi-tab Interface: Organized display with badges showing lock and authorization counts

How to Access

FS Quick Start / Command Palette

Select DSPOBJ in the FS Quick Start menu, or run IBM i FS: Additional Information from the Command Palette:

  1. Enter the library name
  2. Enter the object name
  3. Enter the object type (e.g. *PGM)
  4. View the information in a multi-tab interface

Object Browser

Right-click on any object in the Object Browser and select Additional Information from the context menu, or click the Additional Information icon in the editor toolbar when viewing an object.

Information Displayed

Information Tab:

  • SQL Name and SQL Type
  • Owner and Definer
  • Object Size
  • ASP Group (for libraries)
  • Text Description
  • Creation, Change, and Last Used timestamps
  • Days Used Count
  • Save/Restore information (timestamp, device, volume, sequence)
  • Journal information
  • Authorization List

Locks Tab:

  • Lock State (shared/exclusive)
  • Lock Status
  • Lock Scope
  • Job Name holding the lock

Authorizations Tab:

  • Authorization Name (user/group)
  • Object Authority (*ALL, *CHANGE, *USE, *EXCLUDE)
  • Object Operational, Management, Existence, Alter, Reference permissions
  • Data Read, Add, Update, Delete, Execute permissions

👥 Work with Active Jobs (WRKACTJOB)

Display and manage all active jobs in the system with real-time information and interactive actions.

IBM i SQL Services Used

TypeSchemaNamePurpose
Table FunctionQSYS2ACTIVE_JOB_INFORetrieve all active jobs with detailed information

Features

  • 📊 Real-time Job List: View all active jobs with current status and statistics
  • 🔍 Search Functionality: Filter jobs by name, user, type, status, subsystem, or function
  • 🔄 Auto-refresh: Automatic updates driven by the code-for-ibmi.views.autoRefreshInterval setting, plus a manual refresh button in the toolbar
  • 📋 Comprehensive Information: Subsystem, job name, user, type, function, status, CPU, I/O
  • ⚡ Interactive Actions: Hold, release, end, or debug jobs directly from the view
  • 🎨 Dynamic UI: Action buttons adapt based on job status and type

Available Actions

ActionDescriptionAvailability
DetailsOpen the WRKJOB view for the jobAll jobs except subsystem jobs
DetailsOpen the Subsystem Description (*SBSD) viewSubsystem jobs
HoldHold the job (HLDJOB)Jobs not held
ReleaseRelease the job (RLSJOB)Held jobs
EndEnd the job (ENDJOB)All jobs except subsystem jobs
DebugStart service entry point debuggingAll jobs except subsystem jobs

How to Access

Select WRKACTJOB in the FS Quick Start menu, or run FS Quick Start: Work with Active Jobs from the Command Palette.

Information Displayed

  • Subsystem: Subsystem name (blank for non-subsystem jobs)
  • Job: Full job name (number/user/name)
  • User: Authorization name
  • Type: Job type (BATCH, INTER, SBS, etc.)
  • Function: Current function being performed
  • Status: Job status (ACTIVE, HLD, etc.)
  • Temp. Stg.: Temporary storage used
  • Elapsed CPU %: CPU percentage since last reset
  • Elapsed I/O: Disk I/O count since last reset
  • CPU Time: Total CPU time used
  • Total I/O: Total disk I/O count

💼 Work with Job (WRKJOB)

Display comprehensive information about a specific job with multiple tabs showing job details, statistics, and logs.

IBM i SQL Services Used

TypeSchemaNamePurpose
Table FunctionQSYS2JOB_INFORetrieve comprehensive job information
Table FunctionQSYS2ACTIVE_JOB_INFORetrieve active job status and function
Table FunctionQSYS2ACTIVATION_GROUP_INFORetrieve activation groups
Table FunctionQSYS2STACK_INFORetrieve call stack entries
Table FunctionQSYS2JOB_LOCK_INFORetrieve job locks
Table FunctionQSYS2OPEN_FILESRetrieve open files
Table FunctionQSYS2SPOOLED_FILE_INFORetrieve spooled files
Table FunctionQSYS2JOBLOG_INFORetrieve job log messages

Features

  • 📊 Job Information Tab: Complete job attributes and configuration
  • 📈 Job Statistics Tab: Library list, activation groups, call stack, locks, open files, and spooled files
  • 📝 Job Log Tab: All job log messages with severity and timestamps, with search and pagination
  • 🔄 Auto-refresh: Automatic updates driven by the code-for-ibmi.views.autoRefreshInterval setting; stops when the job reaches OUTQ status
  • ⚡ Interactive Actions: Hold, release, end, or debug jobs; open, download, or delete spools
  • 🎨 Dynamic UI: Action buttons adapt based on job status
  • 💾 State Preservation: Active tab is preserved across refreshes

Available Actions

Job Actions (from the Job Actions toolbar button):

ActionDescriptionAvailability
Hold JobHold the job (HLDJOB)Active jobs (not held)
Release JobRelease the job (RLSJOB)Held jobs
End JobEnd the job (ENDJOB)All jobs not in OUTQ status
Debug JobStart service entry point debuggingActive jobs

Spool Actions:

ActionDescription
OpenOpen spooled file in editor
DownloadDownload spooled file as PDF
DeleteDelete spooled file

How to Access

  • From WRKACTJOB, WRKUSRJOB, a Job Queue or a Subsystem Description: click Details on any job
  • From the FS Quick Start menu: select WRKJOB and enter the job name
  • From the Command Palette: run FS Quick Start: WRKJOB and enter the job name

Information Displayed

Job Info Tab:

  • Job Status and Active Status
  • Function currently being performed
  • Job Type and Subsystem
  • Job Description
  • Submitter Job Name
  • Timestamps (entered, scheduled, active, end)
  • Job Queue and priorities
  • Threading, storage, and wait settings
  • CCSID and format settings
  • Message logging configuration
  • CPU and I/O statistics

Job Statistics Tab:

  • Library List: All libraries with type (SYS/CUR/USR), ASP, and description
  • Activation Groups: Group name and number, state, program library, name and type, in-use indicator
  • Call Stack: Program call stack with position, program, statement, and procedure
  • Locks: All object locks with state, status, scope, and member lock type
  • Open Files: All open files with member, type, option, and I/O counts
  • Spooled Files: All spools with name, status, pages, and interactive actions

Job Log Tab:

  • Message ID and severity
  • Message text (first and second level)
  • From program and message file
  • Timestamp

👤 Work with User Jobs (WRKUSRJOB)

Display and manage the jobs (active and inactive) of a user profile with filtering and actions.

IBM i SQL Services Used

TypeSchemaNamePurpose
Table FunctionQSYS2JOB_INFORetrieve all jobs (active and inactive)
Table FunctionQSYS2ACTIVE_JOB_INFORetrieve active job status

Features

  • 👤 User Prompt: Choose the user profile whose jobs are shown (*CURRENT by default); the user is shown in the tab title
  • 🗂️ Multiple Tabs: Open the view several times, for different users or even the same one
  • 📊 Complete Job List: View all jobs including completed and output queue jobs
  • 🔍 Search Functionality: Filter jobs by name, status, type, completion status, or function
  • 📋 Comprehensive Information: Job status, active status, type, end severity, completion status
  • ⚡ Interactive Actions: View details, hold, release, or end jobs
  • 🎨 Dynamic UI: Action menu adapts based on job status (active/inactive)
  • 🔄 Refresh: Manual refresh button, plus auto-refresh driven by the code-for-ibmi.views.autoRefreshInterval setting

Available Actions

ActionDescriptionAvailability
DetailsOpen WRKJOB view for detailed job informationAll jobs
HoldHold the job (HLDJOB)Active jobs (not held)
ReleaseRelease the job (RLSJOB)Active held jobs
EndEnd the job (ENDJOB)Active jobs

How to Access

Select WRKUSRJOB in the FS Quick Start menu, or run FS Quick Start: Work with User Jobs from the Command Palette, then enter the user profile (or leave *CURRENT).

Information Displayed

  • Job: Full job name (number/user/name)
  • Job Status: Overall job status (ACTIVE, OUTQ, etc.)
  • Active Status: Active job status (HLD, RUN, etc.) - only for active jobs
  • Type: Job type (BATCH, INTER, etc.)
  • End Severity: Job end severity level
  • Completion: Completion status (NORMAL, ABNORMAL, etc.)
  • Function: Current function being performed (for active jobs)

🖨️ Work with Spooled Files (WRKSPLF)

Display and manage the spooled files of a user profile with pagination, search, and interactive actions.

IBM i SQL Services Used

TypeSchemaNamePurpose
Table FunctionQSYS2SPOOLED_FILE_INFORetrieve all spooled files with details
FunctionSYSTOOLSGENERATE_PDFGenerate PDF from spooled file

Features

  • 👤 User Prompt: Choose the user profile whose spooled files are shown (*CURRENT by default); the user is shown in the tab title
  • 🗂️ Multiple Tabs: Open the view several times, for different users or even the same one
  • 🔍 Search Functionality: Filter spools by name, user, data, status, or job
  • 📄 Pagination: Navigate through large spool lists, with the page size set by code-for-ibmi.tables.itemsPerPage
  • 📋 Comprehensive Information: Name, user data, status, job, pages, size, timestamp
  • ⚡ Interactive Actions: Open, download as PDF, or delete spooled files
  • 🔄 Refresh: Manual refresh button, plus auto-refresh driven by the code-for-ibmi.views.autoRefreshInterval setting

Available Actions

ActionDescription
OpenOpen spooled file in VS Code editor
DownloadDownload spooled file as PDF to local system
DeleteDelete spooled file from the system

How to Access

Select WRKSPLF in the FS Quick Start menu, or run FS Quick Start: Work with Spooled Files from the Command Palette, then enter the user profile (or leave *CURRENT).

Information Displayed

  • Name: Spooled file name
  • Data: User data associated with the spool
  • Status: Spool status (READY, HELD, PRINTING, etc.)
  • User: User who created the spool
  • Job: Job name that created the spool (number/user/name)
  • Number: Spooled file number
  • Timestamp: Creation date and time
  • Pages: Total number of pages
  • Size (KB): Spool file size in kilobytes

Pagination Controls

  • Items per page: code-for-ibmi.tables.itemsPerPage setting (default 50)
  • Page navigation: First, previous, next, last page buttons
  • Total count: Display total number of spools matching search criteria

🏢 Work with Subsystems (WRKSBS)

Display all the subsystems currently active on the system, with the number of jobs each one is running, and drill into a subsystem or end it.

IBM i SQL Services Used

TypeSchemaNamePurpose
ViewQSYS2SUBSYSTEM_INFORetrieve active subsystems (filtered on STATUS = 'ACTIVE')

Features

  • 📊 Active Subsystem List: All active subsystems, sorted by name
  • 👥 Job Counts: Current and maximum active jobs of each subsystem
  • ⚡ Interactive Actions: Open the subsystem description or end the subsystem
  • 🔄 Refresh: Manual refresh button, plus auto-refresh driven by the code-for-ibmi.views.autoRefreshInterval setting

Available Actions

ActionDescription
DetailsOpen the Subsystem Description (*SBSD) view, with memory pools, autostart/workstation/job queue/routing/prestart entries and the list of active jobs
EndEnd the subsystem (ENDSBS), asking whether to use *IMMED or *CNTRLD; the list is refetched automatically afterwards

How to Access

Select WRKSBS in the FS Quick Start menu, or run FS Quick Start: Work with Subsystems from the Command Palette.

Information Displayed

  • Subsystem Description Library: Library containing the subsystem description
  • Subsystem Description: Subsystem name
  • Maximum Active Jobs: Maximum number of active jobs allowed (*NOMAX when unlimited)
  • Current Active Jobs: Number of jobs currently active in the subsystem
  • Text Description: Subsystem text description