CasewareDocs

GetAtExecutor

Instantiates Audit Test Executor component. This component provides interface to audit test execution functionality.

Compatibility

Available as of IDEA version 12.0

Syntax

GetAtExecutor(testId As String, tableName As String) As Object

Parameters

testId

String representation of Id of audit test

tableName

Name of IDEA table. The name is considered as relative to IDEA current project.

Return Value

Returns new instance of Audit Test Executor component.

Remarks

Audit Test Executor component operates based on association between specified audit test and IDEA table (execution record). Therefore, some of component’s properties/methods assume the execution record exists; if it is not the case, an exception gets thrown.

Audit Test Executor component implements the following members:

Commands/Methods
Method Description
Id Returns the ID of audit test.
Tables Returns a collection of names of IDEA database associated with the current audit test.
Parameters Returns a collection of execution parameters assigned to execution record.
SetParameters Assigns the execution parameters to execution record.
ImportParameters Loads execution parameters from a parameters file and assigns them to execution record.
CanExecute Returns the code indicating whether audit test can be executed and if not, why.
Execute Executes an audit test.
GenerateReport Generates a report based on results of previous execution.
QueuedTimeout Gets/sets timeout of queuing the audit test during execution.
StartTimeout Gets/sets timeout of starting the audit test execution.
CompleteTimeout Gets/sets timeout of completing the audit test execution.
ShowProgress Specifies whether the progress indicator window has to be displayed during audit test execution and generating the report.

Example

Sub Main()
Dim ac As Object
Dim atExecutor As Object
Set ac = CreateObject("SmartAnalyzer.AutomationClient")
atId = "f4d65220-77f1-5969-8943-59c7bd448460"
tblName = "Sample-Weblog"
Set atExecutor = SA.GetAtExecutor(atId, tblName)
. . .
End Sub