find-analysis-scripts
Finds scripts, data functions, and custom queries in files in the library.
find-analysis-scripts
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
[-p value | --library-parent-path=value]
[-e value | --library-search-expression=value]
[-s <true|false> | --auto-trust-scripts=<true|false>]
[-d <true|false> | --auto-trust-data-functions=<true|false>]
[-q <true|false> | --auto-trust-custom-queries=<true|false>]
[-n | --no-prompt]
[-i | --single-threaded]
[-v | --verbose]
[output directory]
Overview
Use this command to analyze all files (of relevant types) in the library and locate scripts, data functions, and custom queries within these files, so they can be reviewed, updated or trusted.
The output of the command is a (possibly empty) report of all findings, and a (possibly empty) script that can be used for trusting the scripts, data functions, and custom queries in bulk.
As the content of the scripts, data functions, and custom queries is logged in the report, this command is also useful when you want to search all your scripts/functions/queries for some pattern that needs updating.
Options
Option | Optional or Required | Default Value | Description |
---|---|---|---|
|
Optional | none | The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file. |
|
Optional | none | The configuration tool password used to decrypt the database password in the bootstrap.xml file. If the tool password is omitted, the command will prompt the end-user for it on the console. See Bootstrap.xml file for more information. |
|
Optional | none | The path to a library folder with the files that should be analyzed (files in sub-folders will also be included). |
|
Optional | none | A library search expression matching the
files that should be analyzed.
For information about available search parameters, see "Searching the library" in the Spotfire Analyst User Guide. |
|
Optional | false | This flag indicates that any untrusted scripts that are found should be trusted automatically. Use this option with care. The scripts SHOULD BE REVIEWED before being trusted. |
|
Optional | false | This flag indicates that any untrusted data functions that are found should be trusted automatically. Use this option with care. The data functions SHOULD BE REVIEWED before being trusted. |
|
Optional | false | This flag indicates that any untrusted custom queries that are found should be trusted automatically. Use this option with care. The custom queries SHOULD BE REVIEWED before being trusted. |
|
Optional | none | This flag indicates that the tool should proceed without printing a warning about the potentially long execution time and prompting for confirmation to continue. |
|
Optional | none | This flag indicates that the analysis
should be done in a single thread. (This will reduce CPU, memory, and network
usage, but increase execution time.)
Note: If the
tool runs out of memory when executing the command, then specifying this flag
might help.
|
|
Optional | none | This flag indicates that verbose progress output should be given. |
|
Optional | find-analysis-scripts | The directory to which the output of the
tool will be written.
If the directory does not exist it will be created (in the current working directory, if the path is relative). |
Examples
- To run the analysis only
against items that do not exceed a certain size:
config find-analysis-scripts --library-search-expression="content_size:<500MB"
- To run the analysis only
against the items in a particular folder:
config find-analysis-scripts --library-parent-path="/Production/Critical"
- To run the analysis in a
single thread (to reduce memory and CPU consumption):
config find-analysis-scripts --single-threaded
- To automatically trust
any data functions after running the analysis:
config find-analysis-scripts --auto-trust-data-functions