Audit Test

An audit test is a routine which performs data analysis commands and creates results which can be added to working papers or can be used for further analyses. An audit test contains the following components: IDEA macro, input dialog (optional), description file (audit objectives and examples) as RTF-file, result description files, tags and properties.

Follow the steps to create an audit test:

Step-by-Step

To create an audit test select New in the File tab. Alternatively, you can click the New icon in the Quick Access Toolbar.
In the New SmartAnalyzer App SDK Project dialog box select Audit Test.
Enter a name for the SmartAnalyzer App SDK Project. The name has to comply with the Windows guidelines for file and folder names.
Select the location of the file to be created by clicking the Browse button.
Click OK. A new document box is opened.
In the General area the name, the author and the version number are shown. You can change them. The name is the content item name in SmartAnalyzer, the maximum length is 128 characters. You do not have to consider any Windows guidelines when entering the name, any character is allowed.
Enter the minimum version of IDEA which supports the audit test in the field Minimum IDEA Version. By default, the lowest version number for which an app definition could be created is shown. If you enter a lower number it will be changed automatically.
Specify a descriptive text for each doc tab included in the project. The dialog box Descriptive Text Files is shown. Template files are available for the following descriptive text files: Audit Objectives, Example, Hints and Result Description. These template files should be used as a guideline for the formatting and structure of the descriptive text. In case you intend to localize your audit tests, using these templates will ensure that the translation process runs smoothly. You can find these template files in the directory .../CaseWareIDEA/SmartAnalyzer App SDK/Templates.
Select a result description for each result file. The dialog box Result Description opens.
Specify whether the audit test shall support IDEA Server by clicking the corresponding option.
Use the Requires Audit Period option to define whether an audit test requires the entry of a period or not. A period column is displayed automatically in the Select and Run module if you select Yes for this property.
You can specify whether an audit test runs in batch mode or not by selecting Yes or No. If a user selects several audit tests, all audit tests having Supports batch execution set to Yes will be run first. After all audit tests which are supporting batch runs are executed Select & Run can start executing audit tests which do not support this feature.
It is recommended to set Supports batch execution to No for those audit tests that contain embedded dialogs, so that their execution can be broken while waiting for user reaction.
Supports Unicode specifies whether the Standard Import Routine is compatible with the IDEA Unicode version or not. Setting this property to Yes means that the Standard Import Routine will always be executed. Selecting No means that a Standard Import Routine will not be displayed in case an IDEA Unicode version is installed. You may choose this setting if a command was used which is not supported by IDEA Unicode (@ASCII, @CHR, @RegExpr, @Soundex and @SoundsLike).
Select the macro to be used as Processing Routine by clicking the Browse button. You can start a macro editor by clicking the icon. If you have not selected a macro yet, the editor which you have defined in the Options dialog box will be opened with the corresponding template chosen in the Options dialog box too. If you have already selected a macro, the code will be displayed in the editor you have defined in the Options dialog box.
Use the Reference only check box, to define whether a processing routine should be copied into a project or only references to it. By default Reference only is not activated.
If you have created a parameters dialog for the audit test, you can include it by clicking the Browse button. By enabling or disabling the Dialog is optional option you can determine whether the dialog is mandatory or not. Click the button Show audit test dialog to view the parameters dialog.
If one or more embedded dialog boxes are needed for the macro, you can select them by clicking the button within the Embedded Dialogs field. A dialog box is opened where you can choose one or more Visual Studio projects.
Select the No Databases required option if the audit test can be run without assigning a database. This maybe the case if you want to create a database that contains date values of a specific period. It might contain, e. g. one field for the year, one for the month and one for the days of the week or holidays. This database can be joined with a transaction database (using the date field) in order to find out if postings were made within a certain period of time (e. g. during holidays).
Assign tags to the audit test (primary database). Click the Browse button to open the dialog box Select Tags. This option is only active if a database has to be assigned.
If an additional database should be assigned, click the Browse button next to the Additional Databases field. The Additional Databases dialog box will be opened. An additional database could be necessary if, for instance, transaction data and master data are kept in different source files.
You can use the App Reference to identify the tree and report values. To do this click in the field and enter the value. If a value is added as a property, the ";" character has to be added after it.
The Audit Test ID is the first part of a result name. It is used to group the results in IDEA. Using an audit test ID you make sure that results and intermediate results were grouped and shown separately.
In the Audit Test Navigator field enter the filter string used for the navigator tree to be connected to the audit test.
In the Compatibility Indicator field you can enter a group of string values used later to enable the merging of app workflows. App workflows can be merged if they have at least one compatible indicator value in common
Using the value in the Content Area field you can connect the audit step to an input file.
Save the audit test.

Working with SmartAnalyzer App SDK Projects you can open a context menu by right-clicking a card-index tab.

The following options are available:

In the context menu for content items you can select the following tasks:

Tasks in content menu for context items
Command	Description
Close	Closes the current content item tab. If the tab is not saved, you will be asked whether you want to save it or not.
Close all	All currently opened content items will be closed. If one of them is not saved yet, you will be asked whether you want to save it or not.
Close all except this	Closes all content item tabs except the one the command was called from. If one of the content item tabs to be closed is not saved yet, you will be asked whether you want to save it or not.
Duplicate content item	This command duplicates an existing content item. A dialog box opens where you can enter a name for the content item. The duplicated content item gets a new unique ID.
Create Labeled Import Routine	This command is only active for Standard Import Routines. The command creates a new content item of type "Labeled Import Routine". In this case the project folder can only be created when saving the properties grid context. Only in this case the name of the new project is known.
Create app based on opened items	This command allows creating a demo app. In contrast to creating testing apps, apps created with this command will be IP protected and will have their own fixed icon and its own fixed app ID. This function is only available as of IDEA version 10.1.
Open folder	Opens the project folder of the currently selected content item in Windows explorer.