Variables and Commands

To set the variables use := (colon + equals sign)

The dollar sign in front of the string variable indicates that one variable can use another variable. In this case the StateImage variable will have the value c:\gateway\GatewayState.AWS

You can space the assignment operator where you want as long as there is at least one space between each part of the statement.

(VariableName),(at least one space),( := ),(at least one space), (variable value)

A variable can be assigned as a mixture of strings and variables. Integer variables can be used in the assignment statement and these will be translated to strings.

This command can be used to set a variable that has been declared, to a value retrieved from an INI file.

The five parameters needed for GET_INI_VARIABLE are:

Variable name with or without a '$' in front of it.

INI file to get variable from.

Section name to get variable from.

Key name to get variable from.

A default value to use if key is not found - defaults to empty string if not specified.

This command can be used to set a variable that has been declared, to a value retrieved from an environment variable.

The three parameters needed for GET_ENV_VARIABLE are:

• Variable name with '$' in front of it.
• Environment variable to read from.
• A default value to use if variable is not found - defaults to empty string if not specified.

Calls another section of the command script. It takes a section name as a parameter. Do not call any of the standard sections Startup, Variables, Process and End.

Run another Analysis Workbench command script. It takes a script file name as a parameter.

Loads an Analysis workbench state image file into Analysis Workbench.

Loads one scan file into Analysis Workbench. It has a single scan file name as a parameter.

Has a single section name as a parameter to load a list of scan file names from. This procedure calls the LOAD_SCAN procedure for each file in the list.

Loads a single directory specified, as a parameter to this command. Optionally, specify the /SUB parameter to load all scan files in the specified directory and all subdirectories of that directory.

Loads a list of directories from a section of the script file. This procedure calls the LOAD_DIRECTORY procedure for each directory in the list. (The /SUB parameter can also be used in the directory list).

Unloads scan file data from Analysis Workbench. Uses a parameter ALL, TAGGED, or UNTAGGED. Assumes ALL if no parameter is specified.

Sets business mode if no scan files have been loaded.

Sets operational mode if no scan files have been loaded.

Instructs Analysis Workbench how to treat duplicate scan files. This overrides and changes the current setting of Analysis Workbench. The settings are available in the File Load Options dialog box called from the scan file load form Options button.

Valid combinations are:

• LOAD_DUP_OPTION NEWEST (load the newest of the duplicate files)
• LOAD_DUP_OPTION ASK (Ask what to do if duplicate files detected)
• LOAD_DUP_OPTION LOAD (load the duplicate file, remove the previously loaded one)
• LOAD_DUP_OPTION IGNORE (Leave the file already loaded, ignore the attempt to load another file with the same name)

Instructs Analysis Workbench how to treat old scan files. This overrides and changes the current setting of Analysis Workbench.

Valid combinations are:

• LOAD_OLD_OPTION LOAD (Load old files even if they are older than the limit).
• LOAD_OLD_OPTION Ask (Ask what to do if old scan files are detected).
• LOAD_OLD_OPTION IGNORE (Ignore files older than the limit).

Require a load configuration file as a parameter, to load an INI file saved by the Analysis Workbench Load Configuration dialog box. This sets up recognition, display filter, asset fields, duplicate and old scan file options and so on.

Allows a list of directories to ignore to be specified, when loading scan files. The list can be set and saved using the Load Filter tab of the Analysis Workbench Load Configuration dialog box.

Clear the current Analysis Workbench query from memory, this is not necessary if you are loading a query from a file.

Load a tag query into Analysis Workbench. Takes a query file as a parameter.

Run the tag query currently loaded into Analysis Workbench. Ensure that you load the correct query file before running the query. Typically you would call the QUERY_RUN procedure immediately after a QUERY_LOAD.

Overrides the tagging option set by the loaded query in Analysis Workbench.

Uses the parameters SET, CLEAR, TOGGLE.

Valid combinations are:

• QUERY_SET_OPTION TAG SET
• QUERY_SET_OPTION TAG CLEAR
• QUERY_SET_OPTION TAG TOGGLE

Overrides the pre-query option set by the loaded query in Analysis Workbench.

Uses the parameters NONE, CLEARALL, SETALL.

Valid combinations are:

• QUERY_SET_OPTION PREQUERY NONE
• QUERY_SET_OPTION PREQUERY CLEARALL
• QUERY_SET_OPTION PREQUERY SETALL

Loads a list of tagged machines from a .tag text file. This file contains the asset numbers of the tagged machines. It takes one argument, the fully qualified name of the tags file to load.

Saves the asset numbers of the machines tagged in a Machines window to a .tag text file. It takes one argument, the fully qualified name of the tags file to save.

Used to tag or untag all items of a particular type.

The syntax of the command is

TAG_ALL (Tag|Untag) (Local|Global) (File|Dir|App|Mach)

Tags files, directories and applications from a script. The syntax is:

TAG_CONTAINS (Tag|Untag)(File|Dir|App) ColumnName Value

Where (x|y) means x or y.

Loads a saved export layout file. This can be configured using any of the exports available from the main Analysis Workbench menu. Simply set up the export as required for exporting the data and save it to the file name used in your script.

Runs the currently loaded export layout file. This will export the data to the files specified in the AWRCL file.

Allows you to change the directory that the files are exported.

Setting BREAK_ON_ERROR ON will stop the script if any errors occur.

Puts up a dialog box for every command when switched on, allowing the script to quit, skip the current command or turn off the single stepping.

Shows a window with currently processing script line added to a list

Clears the Analysis Workbench error log. (this is not recommended unless you are saving the error log to a file each time a script is run).

Writes command lines to the log as they are processed

Writes the specified string to the log file and log window if turned on.

Displays the Analysis Workbench main log window to show errors and messages as the commands in the script are processed.

Saves the log to a file specified as a parameter.

This statement performs the command only if the preceding expression is true.

Used in conjunction with the IF...THEN command.

Allows a command to be repeated a number of times. The command can be a normal one line command or a whole process section.

The syntax is FOR (variable) := Start TO end DO (command)

Start and end can be numbers or variables, end must be greater than start.

FOR TestInt1 := 1 to 10 DO LOG_WRITE HELLO WORLD

FOR $loop := $start TO $end DO RUN_PROCESS HelloWorld

Saves the current Analysis Workbench data to a state image file. Takes two parameters – Filename and Description. The state image description is optional and a default description will be used if one is not specified.

The state image files are compressed and decompressed on the fly.

Shuts down the Analysis Workbench program.

Will not prompt for shutdown

Will display a dialog box prompting for action - optionally you can include a message that will be displayed in the dialog box.

Displays and outputs all date fields in a standard format to aid in exporting data to other applications.