Parameters that you can Use with the Area of Interest Cleaner Utility

This topic provides information about the parameters and options (command line arguments) that you can use when you run the Area of Interest Cleaner utility from a Command Prompt window.

Parameter Name Description and Comments
-n node

Use to specify the node name or address of the server on which the database resides.

You can omit this parameter if you run the utility on a client-server PC that uses the default settings, in which case the utility will default to localhost.

-p port

Use to specify the port number of the server on which the database resides.

You can omit this parameter if you run the utility on a client-server PC on which the server uses the default port of 5481.

-u user

Use to specify the name of a Geo SCADA Expert user account that has the relevant security permissions to access the database and delete unused Areas of Interest.

If you omit this parameter, you will be prompted to enter the username interactively when you run the utility.

-a password

Although we do not recommend it, you can include this parameter and specify the password of the Geo SCADA Expert user account mentioned above.

For improved security, we recommend that you omit this parameter, so that you are prompted to enter the password interactively when you run the utility. When entered interactively, the password appears as a row of asterisks (*).

-d delay

Use to specify a short delay to enable the server to process requests from other sources - such as telemetry drivers - in between server requests from the Area of Interest Cleaner utility.

By default, the utility inserts a 1-millisecond delay in between server requests even if this parameter is omitted; this is to help prevent the utility from locking the database.

With a large or complicated Area of Interest structure (such as one that includes 500 or more Areas of Interest), a 1-millisecond delay might prove insufficient. With such an Area of Interest structure, we recommend that you include this parameter and specify a larger delay, to help prevent the cleanup routine from adversely impacting the database while it runs. A delay of 2 to 10 milliseconds should suffice.

(With an insufficient delay, the server's ability to process requests from other sources will be affected while the utility runs. During this time, users might notice that the server is unresponsive.)

-r reverse

Use to perform the deletions in reverse. This parameter is useful if the Areas of Interest in your database have a hierarchical structure, with many branches and levels, and you want the deletion routine to have as little an impact on the running of the live system as possible.

When you include the -r option, the utility performs the deletion routine in reverse. As such, it deletes the unused Areas of Interest in reverse alphanumeric order. It also deletes the unused Areas of Interest in reverse hierarchical order, starting with the lowest level Areas of Interest, followed by the next lowest-level Areas of Interest. This option has less impact on the live system than it would if the routine deleted higher-level unused Areas of Interest first, but will take longer to complete. By running in reverse on a system with multiple hierarchical levels of Areas of Interest, the utility is likely to perform more individual deletion activities than it would when not run in reverse.

If you omit the -r option, the utility will delete unused Areas of Interest in alphanumeric order, from highest to lowest hierarchical level. In doing so, the utility will delete unused lower-level Areas of Interest as part of the deletion process associated with the higher-level unused Areas of Interest. With a hierarchical Area of Interest database, this can result in the utility performing fewer separate deletion activities than it might do so when run in reverse. However, this will also impact more on system performance.

The 'Total Deletion Attempts' value in the summary that is output on completion of a deletion routine is likely to show fewer separate deletion activities when the -r option is omitted from the request to run the Area of Interest Cleaner utility than when the -r option is included.

-l list

Use to output a list of those unused Areas of Interest that the utility has deleted.

If you omit this option, the utility still provides a summary that indicates the number of unused Areas of Interest that it has deleted (but does not provide the names of those deleted unused Areas of Interest).

-v verbose

Use for the utility to provide an on-going listing of the activities that it is undertaking as it runs through the requested deletion routine. The inclusion of this option does increase the time taken by the utility, but provides comprehensive 'live' feedback.

If you omit this option, the utility still provides a progress indicator that regularly updates to indicate the current percentage complete while the routine runs. On completion of the routine, the utility also still provides a summary indicating the number of unused Areas of Interest that it has deleted.

-w wait Use for the utility to prompt for a key press on completion. This is useful if you are using a batch file to execute several commands and want to be notified when the cleanup routine has completed, before continuing to run further commands.
-? help Use to display this list of parameters and options associated with the Area of Interest Cleaner utility.

As an alternative to using the one-letter parameters shown above, you can include the long form of a parameter by prefixing the entry shown in the 'Name' column with a double hyphen (--).

 

You might include the short form of these parameters in a command:

aoicleaner -d 2 -r -l

Or you might opt to use the long form of the same parameters:

aoicleaner --delay 2 --reverse --list

Both of the above will trigger the Area of Interest Cleaner utility to:

  • Insert a 2 millisecond delay in between sending server requests (so enabling the server to continue to process requests from other sources while the deletion routine runs)
  • Run in reverse direction (so deleting lower-level unused Areas of Interest first, but impacting less on system performance)
  • Produce a list on completion, indicating the names of the unused Areas of Interest that have been deleted.

Disclaimer

Geo SCADA Expert 2022