Custom Preparation Routine

With this routine you create a Custom Prepatation Routine for analyzing data in IDEA. This automates the preparation process. The import of the data into IDEA must be done beforehand.

Create a Custom Preparation Routine, part 1

Create a Custom Preparation Routine, part 2

Follow the steps to create a Custom Prepatation Routine:

Step-by-Step

1. To create a Custom Prepatation Routine select New in the File tab. Alternatively, you can click the New icon in the Quick Access Toolbar.
2. In the New SmartAnalyzer App SDK Project dialog box select Custom Preparation Routine.
3. Enter a name for the Custom Prepatation Routine. The name has to comply with the Windows guidelines for file and folder names.
4. Select the location of the file to be created by clicking the Browse button.
5. Click OK. A new document box is opened.
6. 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.

7. 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 to 12.2.

8. In the Description File field select a file containing information about the preparation routine. This description will be shown to the user when selecting the preparation routine. If you do not select any description, a default description will be displayed. You can find a template file in the directory .../Caseware IDEA/SmartAnalyzer App SDK/Templates.
9. In the Belongs to Import Group(s) field you can enter one or several groups in which this Custom Prepatation Routine will be listed. You can do this in the Group Names dialog box. When starting the preparation using this Custom Prepatation Routine the names will be displayed in the Data Source/ERP System area. Additionally, you have to specify a group name.
10. The Ask for Batch Import File field is not used for creating a data preparation and is therefore disabled.
11. Supports Unicode specifies whether the Custom Prepatation Routine is compatible with the IDEA Unicode version or not. Setting this property to Yes means that the Custom Prepatation Routine will always be executed. Selecting No means that a Custom Prepatation 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).
12. The fields in the Localization area only serve as information. Source Language indicates the language, in which the routine is created, Target Languages shows the languages into which the routine can be translated.

13. In the Files to be Identified field define the file(s) to be prepared. The files themselves will be created in the Files to be Identified dialog box.

14. You can split the preparation into two macros. The macro selected in the Preliminary Routine field will be run first. You could use a macro like this, for example, to check the files to be prepared. This routine can be an IDEAScript macro or a C# project. There are two ways to select a macro. Click the browse button. In the Select Routine dialog box you can select the macro. The name of the selected macro is displayed in the corresponding field. There is also the option to not only select a macro but to open it immediately in an editor. To use this option, click 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.

15. In the Preparation Routine field select the main routine for the data preparation. This routine can be an IDEAScript macro or a C# project. There are two ways to select a macro. Click the browse button. In the Select Routine dialog box you can select the macro. The name of the selected macro is displayed in the corresponding field. There is also the option to not only select a macro but to open it immediately in an editor. To use this option, click 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.

16. 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.

17. In the Properties area you can set a property. This property can be used to assign the Custom Prepatation Routine to a workflow. If a new value is added the current list separator selected for your computer have to be added after it.

    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.

    The Compatibility Indicator property is not used for theCustom Prepatation Routine.

    Using the value in the Content Area field you can connect the audit step to an input file.