Interpreting the find-analysis-scripts results
When running the
find-analysis-scripts CLI command, you can get up to four
different outputs: a report, a configuration script for trusting the scripts,
data functions and custom queries that were found, a configuration script for
untrusting, and a progress file.
The report
The name of the generated report is on the format report_<date in ISO 8601 format>_(<integer>).csv, for example, report_2023-01-20.csv. It contains the following entries:
| Column | Description |
|---|---|
| Report generated at | The date and time when the report was generated. |
| Library file ID | The ID (GUID) of the library item in which the script/data function/custom query ("entity") was found. |
| Library file type | The type of the library item. |
| Library file title | The title of the library item |
| Library file description | The description of the library item (can be empty). |
| Library file path | The path to the library item. |
| Library file created at | The date and time when the library item was created. |
| Library file created by user display name | The display name of the user that created the library item (can be empty if the user is not known). |
| Library file created by user name | The user name of the user that created the library item (can be empty if the user is not known). |
| Library file created by user domain name | The domain name of the user that created the library item (can be empty if the user is not known). |
| Library file last modified at | The date and time when the library item was last modified. |
| Library file modified by user display name | The display name of the user that last modified the library item (can be empty if the user is not known). |
| Library file modified by user name | The user name of the user that last modified the library item (can be empty if the user is not known). |
| Library file modified by user domain name | The domain name of the user that last modified the library item (can be empty if the user is not known). |
| Library file last accessed at | The date and time when the item was last accessed (can be empty if the item has never been accessed). |
| May contain inline scripts | True if the file seems to contain inline scripts, and false otherwise. Note that this detection is a best-effort, and that we can get both false positives and false negatives. |
| Name | The name of the entity (script/data function/custom query). |
| Description | A description of the entity (can be empty). |
| Type | The type of the entity. Can in the current version of the command be one of: Script, Expression Function, Data Function, Custom Query. |
| Function type name | The name of the type of data function (can be empty). This entry is always empty for scripts and custom queries. |
| Function type display name | The display name of the type of data function (can be empty). This entry is always empty for scripts and custom queries. |
| Function type description | A description of the type of data function (can be empty). This entry is always empty for scripts and custom queries. |
| Script language name | The name of the script language (can be empty). This entry is always empty for custom queries and data functions. |
| Script language version | The version of the script language (can be empty). This entry is always empty for custom queries and data functions. |
| Definition | The actual entity (the script, data function or custom query). Can be truncated if it exceeds the maximum field length in Microsoft Excel, 32767 characters (information about truncation will be provided by the command if this happens). Can be empty. |
| Hash (SHA-512) | The calculated SHA-512 hash of the entity. |
| Trusted | True if the entity is trusted, and false otherwise. |
| Source of trust | A possibly empty list of library item ID:s in which the entity is trusted. If an entity is trusted in one library item then it is also trusted in all other library items, for all users that have read access to the library item where it is first trusted. |
| Automatically trusted | True if the entity was automatically
trusted (during this run of the command), and false otherwise. Can only be true
if the flag--auto-trust-scripts,
--auto-trust-data-functions or
--auto-trust-custom-queries was set to
true when running the command.
|
The trust script
A Spotfire Server configuration script for trusting the scripts, data functions and custom queries that were found. It can be empty except for some instructions. It is named in the same way as the report but with trust as the prefix and .script as the suffix (for example, trust_2023-01-20_(1).script).
The untrust script
A Spotfire Server configuration script for untrusting scripts, data
functions and custom queries that were automatically trusted. This script is
only generated if at least one of
--auto-trust-scripts,
--auto-trust-data-functions or
--auto-trust-custom-queries is set to true when
running the
find-analysis-scripts CLI command. It can be empty
except from some instructions. It is named in the same way as the trust script
but with
untrust as the prefix (for example,
untrust_2023-01-20_(1).script).
The progress file
A file (progress.xml) containing the current
progress of the command. The purpose of this file is to be able to continue
where you left off (and for example only scan new or updated files). It is not
intended for consumption by users. It will be ignored by the command if
--resume=false is specified.