Debugging Audit Test

You can debug audit tests and embedded dialogs.

Processing Routines

In the status bar the corresponding status will be shown. If the tagging has not been done yet, the script cannot be run. If this is the case, you have to do the tagging first. Click Tagged if a database is assigned directly. An icon will be displayed which you can click to open the Define Tags dialog box. In this dialog box you can do the tagging. The databases of the selected project will be displayed. After confirming the dialog box will be closed and the entry in the Tagged line will be set to Yes. Now you can run the script.

Tagging Type identifies the way of creating associations between audit test input files and IDEA databases. Three values are possible: None, Full and Optional.

None means the direct, non tag-based association. The IDEA database is directly associated with the audit test.

Full means that in order to associate database with the test at least one test tag has to be resolved, even if all test tags are optional.

Optional means that it is not mandatory to resolve any of the test tags.

You can use the following commands for the check:

Commands for checking (Processing Routines)
Command	Description
Close Debugger	Closes the dialog box.
Start debugging	Starts the debugging. The debugger of the program in which the selected routine was created will be opened. If the tagging has not been done yet, the icon is not available.
Enable/Disable IP Protection	This function defines if information and error messages should be displayed encrypted. If you use Enable IP Protection, the messages will be displayed encrypted. Moreover, temporary files will be deleted after the debugging. Select Disable IP Protection to show all messages concerning the unencrypted running of routines. If you use this setting, temporary files will not be deleted after the completion of the debugging.
Start debugging the input parameter's dialog	This icon is enabled if the audit test requires the entry of parameters. Click the icon to start the debugging and check the entry of parameters.
Abort debugging immediately	Cancels the debugging and closes the corresponding dialog box. This icon is only available as long as the debugger is open.
Toggle the task cancellation request	Abort debugging immediately cancels the debugging immediately. Using this command might lead to a corrupt file. In contrast to this command the Toggle the task cancellation request command does not cancel the debugging immediately. Use this command to set Is cancellation requested to "True" or "False". If it is set to "True", the macro will check if the debugging can be completed. With this command you can test if the cancel process works correctly when the user runs a corresponding command, i. e. when he cansels the tagging. This icon is only available as long as the debugger is open.
Start Debugger Settings dialog	Opens the Debugger Settings dialog box where you can define which messages should be displayed during the debugging.
Help	Opens the help for the debugging of a routine.

Step-by-Step

In case the tagging has not been done yet click Tagged and do the tagging in the Define Tags dialog box.
Click Start debugging. The debugger of the program in which the selected routine was created will be opened. Corresponding to the settings in the Debugger Settings dialog box messages concerning the testing of the routine will be displayed.
In the right area information concerning the context of the audit test (SmartContext object) is displayed. Use the icons to sort this information by category or in alphabetical order. For some entries additional information is available. Click the corresponding name. If further information is available, an icon will be displayed. Click the icon to show the information.
The debugging itself is run in the debugger of the program in which you have created the routine. There you can start the actual check. You can find a detailed description of the procedure in the help of the respective debugger.

Embedded Dialogs

In this dialog box you can run the debugging of embedded dialogs. All embedded dialogs that can be run will be displayed. Select the embedded dialog you want to check.

You can use the following commands for the check:

Commands for checking (Embedded Dialogs)
Command	Description
Close Debugger	Closes the dialog box.
Start debugging the embedded dialog	Opens the debugger of the program in which you created the selected roputine.
Start debugging in the existing execution context	This command can be used for two purposes: You can resume the debugging after cancelling. After the debugging you can run another test in the same context (i.e. the dialog box is still open) without having to test the complete application again. This is useful if you want to test a data preparation routine. This way you can test the routine without having to run an import again. Only available for audit tests.
Enable/Disable IP Protection	This function defines if information and error messages should be displayed encrypted. If you use Enable IP Protection, the messages will be displayed encrypted. Moreover, temporary files will be deleted after the debugging. Select Disable IP Protection to show all messages concerning the unencrypted running of routines. If you use this setting, temporary files will not be deleted after the completion of the debugging. Not available for workflows.
Abort debugging immediately	Cancels the debugging and closes the corresponding dialog box. This icon is only available as long as the debugger is open.
Run on:	You can only debug on desktop. Only available for Standard Import Routines.
Toggle the task cancellation request	Abort debugging immediately cancels the debugging immediately. Using this command might lead to a corrupt file. In contrast to this command the Toggle the task cancellation request command does not cancel the debugging immediately. Use this command to set Is cancellation requested to "True" or "False". If it is set to "True", the macro will check if the debugging can be completed. With this command you can test if the cancel process works correctly when the user runs a corresponding command, i. e. when he cansels the tagging. This icon is only available as long as the debugger is open.
Start Debugger Settings dialog	Opens the Debugger Settings dialog box where you can define which messages should be displayed during the debugging.
Help	Opens the help for the debugging of a routine.

Step-by-Step

Select the embedded dialog you want to check.
Click Start debugging in the new execution context to start the debugging. The debugger of the program in which the selected routine was created will be opened.
Start the debugging in the corresponding environment.
If you have set breakpoints, the status will be shown at each breakpoint. Click Continue with debugging the task [Name of the task] to resume the debugging after a pause.
In the right area information concerning the context of the audit test (SmartContext object) is displayed. Use the icons to sort this information by category or in alphabetical order. For some entries additional information is available. Click the corresponding name. If further information is available, an icon will be displayed. Click the icon to show the information.

If you only want to see the dialog without debugging, press the Ctrl Button and click Start debugging the embedded dialog.

The InputOutput Parameters area is only relevant if you use SmartDataExchanger(sDE). In this case you can proof the exchange logic.

In the DataExchangerName field enter the name given in the code.
Click in the InputParameters or OutputParameters field. A Browse button appears. After clicking this button the InputParameter Collection Editor or OutputParameter Collection Editor dialog box is shown.
Click the Add button to enter the properties of an input parameter/output parameter (i.e. an if condition) of the routine you want to debug.
On the right side click the Name field and enter the name.
Click the Type field and select the corresponding type.
Enter a value. The name entered in the Name field is shown in the Member area.
Repeat the steps 3 - 6 if you want to add further members.
Click the OK button.
Start the debugging.