SmartContext Object
SmartContext Object is the main SmartAnalyzer scripting object provided to macro programmers. Almost all SmartAnalyzer commands relevant for scripting can be obtained from this object. This help section only focuses on this object (see the hierarchy of the SmartAnalyzer commands).
| Command | Description |
|---|---|
| AbortImport | Gets/sets a value that instructs the importer to abort the task. Standard Import Routine only. |
| Errors | Gets a reference to the collection of errors. Standard Import Routine only. |
| ExecutionStatus | Sets a value that indicates how the macro has completed (failed, canceled or successful). |
| GetServiceById | Delivers several services. |
| ImportFiles | Gets a reference to the collection of file descriptors of the current Standard Import Routine or extension. Standard Import Routine only. |
| InputFileByAlias | Gets the name of the input/assigned databases with the specified alias. |
| InputFilesContainsAlias | Determines whether the collection of input/assigned databases contains an element with the specified alias. |
| IsCancellationRequested | Determines if the current routine is to be canceled. |
| IsServerImportTask | Gets a value that indicates whether the IDEA databases are located on the server. Standard Import Routine only. |
| IsServerTask | Determines if the current task is running on IDEA Server. |
| Log | Logs an error, a message or a warning. |
| MacroCommands | "Class factory" which provides access to other objects. |
| Messages | Gets a reference to the collection of messages that are to be displayed in the message window. Standard Import Routine only. |
| Parameters | Gets a reference of type object to an accessor for the primary input file's set of parameters. |
| ParametersOnlyMode | Gets a value that indicates whether the Standard Import Routine is being executed only to edit the parameters. |
| ParentWindowHandle | Gets the handle of the parent window. Not available to COM clients. |
| ParentWindowHandle32 | Gets the handle of the parent window. Standard Import Routine only. |
| ParentWindowHandleAsString | Gets the handle of the parent window as a string formatted using the InvariantCulture. Standard Import Routine only. |
| Pre-Macros | IPreIndexXmlImportDataPreparationContext derives from ICirExecutionContext and is an interface to an execution context that is passed on to the pre-macros of Standard Import Routines that import data from index.xml packages. Standard Import Routine only. |
| PrimaryInputFiles | Returns the name of primary database. |
| ProjectName | Delivers the IDEA project name. |
| ServerProjectName | Using this property you can detect whether your IDEA instance is connected to an IDEA Server project. |
| SharedTempUserData | Gets a reference to a dictionary that can be used to store user-definable non-persistent data for the current Standard Import Routine and all its active extensions. |
| SharedUserData | Gets a reference to a dictionary that can be used to store user-definable non-persistent data for the current Standard Import Routine and all its active extensions. |
| Strings | Delivers all resource strings. |
| TaskProgress | Progress report on an audit test run. |
| TempUserData | Gets a reference to a dictionary that can be used to store user-definable non-persistent data of the current Standard Import Routine's or extension's subtasks. |
| TestID | Gets the identifier of the audit test. |
| TestName | Delivers the name of the audit test. |
| TestResultFiles | Registers IDEA databases as results for SmartAnalyzer. |
| TestVersion | Delivers the version number of the audit test. |
| UserData | Gets a reference to a dictionary that can be used to store user-definable (e.g. actual parameters) data for the current Standard Import Routine execution. Standard Import Routine only. |
| UserName | Delivers the Windows user name of the user who has created the task. |