Technical Insight

Reducing Clutter in Arbutus Analyzer

Arbutus Analyzer provides a multitude of ways to organize your work efficiently and reduce clutter. These can apply to files, scripts, logs, and folders.

Intermediate/Temporary Files and Objects

Complex and sophisticated scripts can generate many intermediate files that are not necessary for future use. Using a temporary object prefix will tag such files for automatic deletion when a script completes. This setting is in Tools >> Options >> Interface.

The user can enter a prefix for temporary objects here. In a script, the user can name temporary objects with this prefix. These objects will be automatically deleted when the project is closed. Alternatively, the user can set the prefix and delete the objects using Arbutus procedure syntax:
Setting the prefix:
-SET TEMP 'tmp_'
-Deleting all temporary objects:


Hiding Objects

Procedures may create files that are necessary but distracting. To hide them from view, append an underscore (_) to the file name. Hidden objects, including procedures, can be seen by checking the "Show hidden overview items" checkbox in in Tools >> Options >> Interface.

Uncheck the setting to hide the objects again.

Image 1 (2)


Image 2 (2)


Folders, Subfolders and Logs

Create folders by right-clicking on the root or a folder and selecting New >> Folder. These are subject to Windows naming conventions. Objects from other folders can be drag-and-dropped into the new folder. Any folder that is created in an Arbutus project is also created in the project's Windows folder. This symmetry makes for efficient data file searches.

Use the SET FOLDER command in procedures to name folders or to make a specific folder the active folder. Folder names can incorporate a date-time stamp to document the execution date. For example, a variable can be initialized in a procedure to capture the execution date as text:

The results folder can then be created:
SET FOLDER TO \AC_Payable_Result_%v_ExecDate%

They can be useful for separating source data from results, and for segregating procedures in an easy to find area. The same process can be used to create a log for the procedure's execution:
SET LOG TO AC_Payables_%v_ExecDate%

This is a useful way of segregating the audit trail for this test.

Shared Folders

Everyone has data files or procedures that they re-use in many situations. For example, a scripted data integrity test analytic would be useful in almost every project. Similarly, a master file of postal code data would be of value when conducting validation tests.

Rather than making multiple copies of each object, the user can designate a Windows folder as a shared folder. Key objects can then be stored in this folder. This shared folder will appear in the Overview in all projects, and its objects will be available in various Arbutus lists. By maintaining only one object that is always current, this can ensure consistency.

To designate a shared folder, go to Share >> Add Personal Share…. Name the shared folder, then use the Browse capability to select the target Windows folder.

Image 3.2

This folder will now appear in the Overview. Its icon is a variation on the standard Arbutus folder icon. Any sub-folders in the shared folder will also be visible and accessible. Tables in these folders can be opened in all of the user's Arbutus projects, and procedures stored here can be executed.

Image 4-1




Arbutus Analyzer allows you to create scripts within scripts. These nested procedures can be called from the main section of the script to enable user inputs with input validation or to repeat a series of commands.

In the graphic below, there are 16 sub-procedures nested in the script. This reduces the number of objects in the Overview and facilitates the management of the script by allowing you to edit or transfer just one script rather than 17 different scripts.

Here's a simple example of one sub-procedure in a script. The multiple commands in the sub-procedure "Payments_Splitting" will be executed only if the file's statistics trigger the running of the sub-procedure.

Image 6.1






Sub-procedures can be triggered unconditionally or conditionally, with IF <conditions> and WHILE <conditions>. For details on how to create sub-procedures, please see the Online Help: Automating Analyzer >> Procedure Labels.
For details on how to create sub-procedures, see the Online Help: Automating Analyzer >> Procedure Labels.
Image 5

Hiding Fields

In addition to hiding project objects, Analyzer also allows the hiding of fields. When a field is hidden, it will not appear in command dialogs that include field lists. The only location where it will appear is in the table layout.

The scenarios for using this feature include:

  • Maintaining utility fields where such a field may be necessary for calculations but does not need to be otherwise referenced.

  • Hiding fields in large, imported tables such as SAP tables. Rather than specifying fields to import, the user can download the entire file. Hidden fields can thus always be available for use in the future should the need arise.

To hide a field, go to Edit >> Table Layout. Right-click on the field and select "Hide"

image 7


To hide a field, go to Edit >> Table Layout. Right-click on the field and select "Hide"


image 7



Arbutus Technical Insights

Explore more of our Technical Resources

Technical Insights Main

Request Trial 

Fill in your details and get started with a free trial on us

Try Arbutus