Reference manual

Objects page

Solution page

The Solution page shows what the open workspace consists of: every module Prism resolved, in dependency order, with its publisher, version, role and origin, and a dashboard with two tabs: Overview, with the workspace's health issues, object counts and Git status, and Configuration, with its AL settings. Select a module to see its details, its dependencies, the modules that use it, its namespaces, its translations and its configuration. Use it to size up a solution and to check that every dependency resolved as you expect.

Opening it

  • Select Solution in the rail of the Workspace window.
  • Right-click an object or a module in the Objects panel and select Go to Module: the page opens with that module selected.

To open every workspace on this page, set Start action to Show solution view on the Settings page.

Prism for AL Solution page with the modules of a workspace, and the dashboard's Overview tab with the object metrics
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
The Solution page with no module selected.
# Name Description
1 Search Filters the modules by publisher, name, version and module id. A version range such as 1.0..2.0 (or 1.0.. or ..2.0) keeps the modules whose version lies in the range; add text to the range to match both.
2 # The module's place in the Topological order of the module dependencies.
3 Publisher The publisher, from the module's manifest.
4 Name The module name. A red symbol after it means one or more of its dependencies did not resolve: hover over it to see whether symbols are missing (download symbols and reload the workspace) or the dependencies were not found in the workspace.
5 Version The module's version.
6 Constraint The version the other modules of the workspace require of it, combined, such as ≥23.0.0.0.
7 Role The kind of module: PLATFORM, SYSTEM (System and System Application), BASE (Base Application), APP (Application), TEST or EXT (an extension). Hover over a chip for its description.
8 Origin Where the module comes from: a workspace folder or a package. See Origin column.
9 Total object count The number of objects in all resolved modules and the number of object types.
10 Object count per object type The number of objects of each type; extension types beside the type they extend.
11 Export solution metrics Saves the solution metrics to an Excel (.xlsx) file, for example to estimate the size of a customer solution.
12 Explore file system Opens the File explorer window on the workspace folders and the packages the workspace uses.
13 Reveal workspace Shows the workspace folder or .code-workspace file in File Explorer.
14 Reveal selected item Scrolls the list to the selected module, when it is out of view. Available while a module is selected.
15 Overview and Configuration The dashboard's tabs: the workspace's health, object metrics and Git status, or its AL settings. See Dashboard.

Further columns to the right of Origin count, per module, the files with errors, the candidate discoveries, the dependencies, the modules that use it and the translation files that target it; hover over a column header for its meaning. The error column is shown only when files have errors; see Parse errors. Select a module to show its tabs on the right, starting with the Module tab: Module, Discovery, Usings, Usages, Namespaces, Translations and Configuration. A tab with nothing to show for the module is dimmed.

Ctrl+C copies the selected module as its publisher, name and version, such as Microsoft › Base Application › 23.0.12034.13456.

Origin column

The Origin column shows a symbol for where Prism found the module. The tooltip of each symbol starts with the text in the second column.

Symbol Tooltip Meaning
Source symbolWorkspace folder, not under GitAn app.json file in a workspace folder.
Source symbol, greenWorkspace folder, tracking a remoteA workspace folder in a Git repository whose branch tracks a remote branch.
Source symbol, caution colorWorkspace folder, branch not tracking a remoteA workspace folder in a Git repository whose branch does not track a remote branch, such as a detached HEAD.
Package symbolPackageAn .app file, in the workspace or in the package cache.
Package symbol, caution color Package, transitive only A package only search depth All loads, as a dependency of a dependency. “AL: Download symbols” in Visual Studio Code does not update it, so it may be outdated.
Package symbol with a minus badge Package, symbols only A package without AL source files: Prism has its symbols but not its code. The module loads and searches as any other. In the caution color, it is also transitive only (Package, transitive only, symbols only).

Below that heading, the tooltip lists what Prism knows about the module:

  • For a workspace folder: Folder, the folder on disk that holds app.json; and, in a Git repository, Repository (the folder the repository is checked out in), Branch (or Detached HEAD at and the commit), Upstream (“None, the branch does not track a remote” when there is none) and Status: the commits ahead and behind and the changed files, or “Up to date, no changes” (“No changes” without an upstream).
  • For a package: File, the .app file; Contents, AL source or Symbols only, no AL source; and Loaded by, The workspace's dependencies or Search depth All only. A transitive-only package adds that “AL: Download symbols” does not update it.

Paths read as on the Recent workspaces list, with the last folder or file name at full strength. The Objects panel and the CodeGraph tab draw the same symbol, with the same tooltip, beside a module.

Dashboard

With no module selected, the right side of the page shows the dashboard of the whole workspace, on two tabs. Each tab shows its title when the row has room, and its icon alone otherwise; hover over a tab for what it holds.

  • Overview (“Diagnostics, object metrics and source control across the solution”), as expanders:
    • Diagnostics (“Workspace health issues”), when there are any. See below.
    • Object metrics (“Objects by type across all resolved modules”): the object counts, legend rows 9 and 10 above.
    • Git, when all modules of the workspace are in one Git repository. See Git.
  • Configuration (“AL settings cascaded from the user and workspace settings files”): the AL settings of the workspace. See Configuration tab.
Prism for AL Solution page Diagnostics expander with 2 unresolved modules, a note on runtime packages, and 1 compilation unit error
The Diagnostics expander.
# Row Description
1 Unresolved modules The number of dependencies Prism could not resolve. Select the link for the Modules tab. When the workspace also has runtime packages, a note explains that Prism cannot read them, as they are encrypted.
2 Compilation unit errors The number of files with errors. Select the link for the Compilation units tab.

These rows appear only when the workspace has such problems:

  • Graph translation syntax errors, Graph translation name resolution errors: Internal Prism for AL errors while building the code graph. Select the link for the CodeGraph tab.
  • Nested project advisories: app.json files found inside workspace folders. Prism leaves these nested projects out of the workspace. Each is listed with its severity, its path, which you can select to show it in File Explorer, and a description.
  • Missing package directories: Folders that an al.packageCachePath setting names but that do not exist. Prism read no packages from them, so the dependencies expected there are unresolved, or come from the package cache when Search Package Cache is on.
  • Modules not updated by “AL: Download symbols”: The modules that search depth All loaded as dependencies of dependencies. “AL: Download symbols” in Visual Studio Code downloads only direct dependencies, the dependencies from app.json's application and platform, and propagated dependencies, so nothing updates these modules and they may be outdated.

Module tab

The Module tab shows the selected module's details: mostly from its manifest, but also from Prism's module resolution, its object metrics and its settings files.

Prism for AL Solution page with a module selected and its Module tab
1 2 3 4 5 6 7
The Module tab of a selected module.
# Name Description
1 Discovery Where Prism found the module that it uses: the path, which you can select to open, and, for a package, which al.packageCachePath setting led to it. To see the other versions Prism considered, use the Discovery tab.
2 Core, Environment, Code and Miscellaneous The module data from app.json for a workspace folder, or from NavxManifest.xml for a package (.app file). A Publisher, Name or Version that app.json takes from a variable in Directory.App.Props.json is shown as a link: point at it to see how the value was put together, and select it to open a Provenance window that traces the value to the variables and files it comes from.
3 Object metrics The number of objects of each type in the module.
4 Module graph Shows the Module graph page with the module highlighted.
5 Collapse Collapses all expanders.
6 Expand Expands all expanders.
7 Close module view Closes the module's tabs and shows the dashboard again, with no module selected.

Below Object metrics, more expanders appear for some modules only, so the screenshot does not show them:

  • Launch Settings, when the module folder has a .vscode\launch.json file. See Launch Settings.
  • Git, when the workspace spans more than one Git repository, for the module's own repository. See Git.

The module's AL settings, and what its app.json inherits from Directory.App.Props.json, are on its Configuration tab, the last of the module's tabs. See Configuration tab.

Launch Settings

Launch Settings (“Visual Studio Code launch configurations”) shows the configurations in the module's .vscode\launch.json, the ones Visual Studio Code uses to publish and debug the app. Prism watches the file and shows a change within a second. It is collapsed until you expand it.

Prism for AL Launch Settings expander with the launch.json path, Show all settings and the Microsoft cloud sandbox configuration with its properties
1 2 3 4
The Launch Settings expander.
# Name Description
1 File The path of launch.json. Select it to open the file in the program Windows associates with it. If the file cannot be read, a red banner gives the reason, such as “Invalid JSON”.
2 Show all settings Off by default. On: each configuration also lists the properties Prism does not show by default, dimmed and in italics.
3 Configuration A launch configuration, by its name.
4 Properties The configuration's properties that are set, of type, request, environmentType, environmentName, server, serverInstance, port, authentication, startupObject (type and id), breakOnError, launchBrowser, enableLongRunningSqlStatements and enableSqlInformationDebugger.

Git

Git (“Version control metadata”) shows the state of a Git repository as a timeline, newest at the top. It shows on the dashboard when all modules are in one repository, and on each module's tab when the workspace spans several repositories. It is expanded by default.

Prism for AL Git expander with uncommitted changes, the HEAD commit with its branch and recent commits
1 2 3 4
The Git expander.
# Name Description
1 Uncommitted changes Shown when the working tree has changes: the number of added (+), updated (~) and deleted (-) files, and the commits ahead of and behind the remote branch.
2 HEAD The commit checked out, in bold, with a chip naming the branch.
3 Commit One of the ten most recent commits: its subject, with an issue reference such as (#3789) kept in view, the author and how long ago. The author and time are left out where they repeat the row above. Hover over a row for the subject, the full SHA, the author and the exact time.
4 Copy commit SHA to clipboard Appears on the row under the pointer. Copies the commit's SHA.

While Prism reads the history, three placeholder rows hold its place. When there is no history to show, the expander shows the branch name, the short SHA of HEAD with a copy button, and its commit message.

Discovery tab

The Discovery tab lists every Package file and workspace folder that Prism for AL considered for the module while loading, and shows which one it chose.

Prism for AL Discovery tab of a module with its candidate packages
1 2 3
The Discovery tab.
# Name Description
1 Go Select the link symbol, or double-click the row, to show the Discovery page with the module selected.
2 Used Marks the candidate that module resolution chose.
3 Path The path of the .app file or workspace folder.

Usings tab

The Usings tab lists the modules the selected module depends on, one row per dependency.

Prism for AL Usings tab of a module with its dependencies
1 2 3 4 5 6 7
The Usings tab.
# Name Description
1 Go Select the link symbol, or double-click the row, to select the dependency in the module list.
2 Publisher The publisher of the dependency.
3 Name The name of the dependency.
4 Version The version of the dependency that Prism resolved.
5 Constraint The version the selected module requires of the dependency.
6 Status Empty when the dependency resolved. Anything here is a module resolution error; hover over it for the details.
7 Kind Where the dependency comes from:
  • Platform: the platform property in app.json.
  • Application: the application property in app.json.
  • Propagated: a dependency passed on by another dependency, typically the one in the application property.
  • Empty: an ordinary dependency from the dependencies property in app.json.

Usages tab

The Usages tab lists the modules that depend on the selected module, one row per module.

Prism for AL Usages tab of a module with the modules that depend on it
1 2 3 4
The Usages tab.
# Name Description
1 Go Select the link symbol, or double-click the row, to select the depending module in the module list.
2 Publisher The publisher of the depending module.
3 Name The name of the depending module.
4 Version The version of the depending module.

Namespaces tab

The Namespaces tab lists the namespaces declared in the selected module's files, one row per namespace.

Prism for AL Namespaces tab of a module with its namespaces
The Namespaces tab.
# Name Description
1 Go Select the link symbol, or double-click the row, to show the namespace on the Namespaces page.
2 Namespace The full namespace name.

Translations tab

The Translations tab lists the XLIFF files that translate something in the selected module, one row per combination of file, source language and target language.

Prism for AL Translations tab of a module with its XLIFF files
1 2 3 4 5 6
The Translations tab.
# Name Description
1 Go Select the symbol, or double-click the row, to show the translation file in File Explorer. Works for XLIFF files in a workspace folder, not for those inside .app files.
2 External Marks a translation file that belongs to another module.
3 Origin The module that contains the XLIFF file: Internal for the selected module, otherwise the name of the owning module.
4 Source The source language of the translation.
5 Target The target language of the translation.
6 File The name of the XLIFF file.

Configuration tab

The dashboard and each module have a Configuration tab, the last of their tabs. It shows the AL settings Prism reads, layer by layer: your Visual Studio Code user settings, the workspace settings and, for a module, the module's own settings.

  • On the dashboard, the Configuration tab (“AL settings cascaded from the user and workspace settings files”) shows the user and workspace layers.
  • On a module, the Configuration tab (“What app.json inherits from Directory.App.Props.json, and the AL settings cascaded from the user, workspace and module settings files”) adds the module layer and, when there is a Directory.App.Props.json file, what the module's app.json inherits from it. A package module has no settings files: its tab is dimmed and says “A package module has no settings files”.

AL Settings

Only settings that a file sets are listed. The list fills the tab and scrolls on its own, however many settings the files hold.

Prism for AL AL settings on the solution's Configuration tab, with a setting set on both the user and the workspace layer
1 2 3 4 5
AL settings set on both the user and the workspace layer.
# Name Description
1 Search Keeps the settings whose name, or value on any layer, contains the text. On a module's tab, the same box filters the Directory.App.Props.json view.
2 Group A heading over a group of related settings.
3 Setting The setting's name, such as al.packageCachePath, with a row below for each layer that sets it: user, workspace and module.
4 Overriding layer A check mark after a layer's name marks the value in effect, which overrides the layers above it, such as “This workspace value overrides the user value”. The overridden values are dimmed.
5 Value A list is shown as chips: over eight items, the first five and Show N more (then Show fewer). An object is shown as a table. A value nested too deep ends in “N more not shown here; the full value is in the settings file”.

For al.packageCachePath, an active row shows the value Prism loaded when it opened the workspace; a change to it takes effect when you reload the workspace.

Directory App Props

When the module folder or a folder above it has a Directory.App.Props.json file, the module's Configuration tab has a switch beside its search box: AL settings or Directory.App.Props.json (“Variables and properties this module's app.json inherits”). The second view shows the file nearest to the module folder, whose variables and properties the module's app.json inherits.

Prism for AL Directory.App.Props.json view of a module's Configuration tab, with the open, reveal and copy buttons, the variables app_version and company, and the properties Brief and Publisher
1 2 3
The variables and properties a module inherits from Directory.App.Props.json.
# Name Description
1 File Opens the file; the tooltip of the open button shows its path. Beside it, Reveal in File Explorer shows the file in File Explorer, and Copy path copies its path. If the file cannot be read, a red banner gives the reason.
2 Variables The file's variables, by name, with their values.
3 Properties The app.json properties the file sets, with their values.

The tab's search box, beside the switch, keeps the variables and properties whose name or value contains the text.

An unhandled error has occurred. Reload 🗙