Reports page
The Reports page of the Workspace window runs reports on the whole workspace. You choose reports and formats, then run them as one batch; each batch saves its files to a new folder in your Documents folder. The same reports run from the Command-line interface.
Opening it
- Select Reports in the workspace window's navigation rail.
- On the page, press F1 to open this manual page.
| # | Name | Description |
|---|---|---|
| 1 | Run reports | Runs the selected reports and saves their files to a new folder in Documents. Its label counts the selection, such as Run 3 reports. See Run reports. |
| 2 | Select all | Selects every format of every report that can run. |
| 3 | Clear | Clears the selection. |
| 4 | Last batch: | The folder of the latest run, shown once you have run a batch. Select the text to copy it. |
| 5 | Open folder | Opens the latest batch folder in File Explorer. |
| 6 | Group check box | Selects or clears every report in the group, such as General, with how many are selected, such as 2 of 4 selected. Select the group's header to collapse or expand it. |
| 7 | Report | The report's name and what it contains. See Available reports. |
| 8 | Format chip | The file format to save, such as XLSX, CSV or TXT. Select it to include the report in the batch. |
| 9 | Unavailable reason | Why a report cannot run now, in place of its description. Its chip is cleared and disabled. See When a report is unavailable. |
Available reports
Each report saves one file, named after the report, such as solution-metrics.xlsx. The text files are
tab-separated: import them into a spreadsheet as delimited text with a tab as the separator.
| Report | File | Contains |
|---|---|---|
| Solution metrics | solution-metrics.xlsx |
Object counts by type for each app, and a list of every object, in three worksheets:
|
| Object dependencies | object-dependencies.csv |
The objects each object depends on, one row per dependency. The first two lines say which workspace the
report describes and when it was made; the columns follow: DependencyType,
SourceObjectType, SourceObjectNamespace, SourceObjectName,
TargetObjectType, TargetObjectNamespace, TargetObjectName.
|
| Unreferenced objects | unreferenced-objects.csv |
Objects that no other object references, in the columns ObjectModule, ObjectType,
ObjectId, ObjectNamespace and ObjectName. An object in the list can
still be in use: extension objects and event subscribers are not referenced by other objects, and a user
or a job can run an object directly.
|
| OnPrem usages | onprem-usages.csv |
Code that uses declarations scoped to OnPrem, one row per use, with where the use is
(Source… columns: module, object, declaration and position) and what it uses
(Target… columns), and IsObjectScope when a whole object is scoped to OnPrem.
Needs a full code graph.
|
| Parse errors | parse-errors.txt |
Files that failed to parse, with each error: the total error count, then for each file its module, its path and the errors. We may ask you for this file when Prism reads your code wrongly. |
Run reports
- Select Reports in the workspace window's navigation rail.
- Select the format chip of each report you want, or Select all.
- Select Run reports. Prism says Working: “Report batch started.” The reports run in the background, so you can go on working.
- Wait for Report batch completed, which lists each file with “Completed successfully” or what went wrong.
- Select Open folder to see the files.
Each run makes a new folder, StaticalPrism-Reports-… in Documents, so earlier batches
are kept. With nothing selected, Run reports says Empty report batch: “Please select
one or more report targets.”
When a report is unavailable
A report that cannot run now shows why in place of its description, and its chip cannot be selected:
| Reason | Fix |
|---|---|
| “Your license doesn't include this report.” | Activate a license key in the Activate license window. |
| “Needs a code graph. Load the workspace into one first.” | Start the code graph on the Code graph page. |
| “Needs a full code graph. Load the workspace into one first.” | Set Graph detail to Full and load the workspace into the code graph again. |
The page checks again whenever the code graph starts or stops, so a report becomes available as soon as it can run.