Skip to content
EPM Workbench EPM Workbench Docs

API Reference

The EPM Groovy API is large, and the official documentation lives in a browser tab away from your code. EPM Workbench ships the same reference inside VS Code, in the Docs tab of the EPM Details panel, so looking up Cube, DataGrid, or a member of Operation does not mean leaving the editor.

Opening the reference

Section titled “Opening the reference”

There are three ways in:

  • Run EPM Workbench: Open API Reference from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
  • Right-click a symbol in a Groovy rule and choose Show in API Docs. If the symbol names a class, interface, or enum, the reference opens that page directly. If it names a method or does not resolve, it opens a search for that token, so a near miss still lands on the likely matches.
  • Click the Docs tab in the EPM Details panel. The tab bar appears when a rule is the current context, or whenever Docs is already the selected tab.

Browsing

Section titled “Browsing”

The reference opens on a home view headed EPM API Reference, with the package and type counts beneath it. Below that:

  • Packages, one chip per package with the number of types in it. Clicking a package filters the lists below it; clicking it again clears the filter.
  • Classes, and once a package is selected, Interfaces and Enums as well. Each row is the type name, its package, and the first line of its description.

Clicking a type opens its class page: the declaration, the description, and a Method Summary listing every method as one line of return type, name, and parameters, with a short description underneath.

Clicking a method opens its detail page, which carries the full signature, the prose, and any Example call from Groovy blocks, syntax-highlighted and each with its own copy button. Class names and method names have a copy button too, next to the heading.

Type names inside a signature are links. If a method returns a Cube, clicking Cube opens the Cube page. Home and Back sit above every class and method page, and Back follows the path you actually took rather than walking up a hierarchy.

Section titled “Search”

The search box at the top right matches across the whole catalog and groups the results into Classes, Interfaces, Enums, Methods, Fields, and Enum Values. It searches names, signatures, packages, return types, parameter names and types, and the documentation text, with exact and prefix matches ranked first. Multiple words all have to match.

Offline and updates

Section titled “Offline and updates”

A full catalog is bundled with the extension, so the reference works with no network connection at all.

The epmWorkbench.apiReference.autoUpdate setting, on by default, checks once a day for a newer catalog and caches it if there is one. The update check is anonymous and carries no install identity. If it is blocked or fails, nothing changes: the bundled catalog keeps being used, and it tries again a day later, not on every startup. Turn the setting off to stay on the bundled catalog permanently. See Settings.