Applies to AQTime 8.80, last modified on June 13, 2019

Description

The IntegrationManager object is used to automate AQTime via COM. You can obtain a reference to it, by connecting to AQTime’s COM engine and calling its IntegrationManager property (see Working With AQTime via COM - Overview).

Inheritance Hierarchy

The object implements the following interfaces:

IaqTimeIntegrationSupportManager

IaqSubsystemManager

IDispatch

Members

Below are methods and properties of the IaqTimeIntegrationSupportManager interface:

Members (in alphabetical order) Description
AddModule(AFileName) Method. Adds the specified file to the currently opened project. The AFileName parameter should contain the fully-qualified path to the desired file. If the given file already exists in the project, it is not added. If the file is not found using the specified path, the module is added but marked as unavailable.
AreaManager Property. Returns the IaqCOMAccessAreaManager object that provides access to profiling areas of the currently opened AQTime project.
Attach(ProcessId, SummaryResultsFile, FullResultsFile) Method. Starts profiling by attaching AQTime to the process with the identifier specified by the ProcessId parameter. The SummaryResultsFile and FullResultsFile parameters specify the fully qualified names of .xml files, to which results will be stored:
  • SummaryResultsFile is an .xml file holding brief results that are shown in the Summary panel (to convert it to HTML, you can use XSL files from the <AQTime>\Bin\Extensions\Profilers.Files folder).

  • The FullResultsFile file holds all the profiling results. If you do not need any of these two files, simply pass an empty string as a parameter.

If the profiling is started successfully, the method returns True; else - False. See also description of the Start method below and the Attach to Process topic.

The Attach method returns immediately, it does not wait until profiling is over. So, to wait until the end of profiling, check the ProfilingStarted property in a loop.

Note that attaching to process is available in the  Normal profiling mode only.

BaseManager Property. Provides program interface to the IaqBaseManager object.
ClearResults() Method. Works during profiling. Removes the results that AQTime has collected during the run.
DebugInfoManager Property. Returns the IaqCOMAccessDebugInfoManager object that provides access to debug info storage of the currently opened AQTime project.
EnableProfiling(AEnable) Method. Turns the profiling status on or off according to the value of the AEnable parameter (True or False). If the profiling status is changed successfully, the method returns True; else - False. A calling to this method has the same effect as pressing the  Enable/Disable Profiling button in AQTime.
ExportCurrentResults(SummaryResultsFile, FullResultsFile) Method. Use this method to export results that are currently shown in AQTime. The SummaryResultsFile and FullResultsFile parameters specify the fully qualified names of the files to which the results will be stored:
  • SummaryResultsFile is an .xml file holding brief results that are shown in the Summary panel (to convert it to HTML, you can use XSL files from the <AQTime>\Bin\Extensions\Profilers.Files folder).

  • The FullResultsFile parameter holds all the profiling results. Depending on the extension of the specified file, AQTime saves profiling results in the .html, .xml or .txt format. For instance, if you specify the "D:\Profiling Results\Index.xml" file name as the FullResultsFile parameter, AQTime will save the generated results in the .xml format.

If you do not need any of these two files, simply pass an empty string as a parameter.

Note that the exported results show the fully-qualified paths to the source and module files regardless of the File names with path option’s value.

If the results have been exported successfully, the method returns True, else - False.

GetRunMode(Index) Method. Returns the IaqTimeIntegrationRunMode object specified by the index. The aqTimeIntegrationRunMode object describes the corresponding profiling mode and retrieves and sets the profiling parameters at runtime. The possible indexes are: 0 - Service mode; 1 - COM Server mode; 2 - IIS mode; 3 - ASP.NET mode; 4 - Normal mode.
NewProjectFromModule(AExecutableFileName) Method. Creates a new AQTime project for the specified executable. The AExecutableFileName parameter specifies the full name of the desired executable file. If the project is created successfully, the method returns True; else - False.
OpenConfiguration(AConfigFileName) Method. Imports project settings form the specified .acnfg file to a project. The AConfigFileName parameter specifies the full name of the needed project configuration file. If the file is opened successfully, the method returns True; otherwise, it returns False.
OpenProject(AProjectFileName) Method. Opens an .aqt project in AQTime. The AProjectFileName parameter specifies the full name of the needed project file. If the project is opened successfully, the method returns True; otherwise, it returns False.
ProfilerCategory(Index) Property. Returns the category name of a profiler by the profiler's index in the AQTime’s profiler collection. The index of the first profiler in the collection is 0. The total number of profilers in the collection is specified by the ProfilersCount property.
ProfilerName(Index) Property. Returns the name of a profiler by the profiler's index in the AQTime’s profiler collection. The index of the first profiler in the collection is 0. The total number of profilers in the collection is specified by the ProfilersCount property.
ProfilersCount Property. Returns the total number of available profilers in AQTime.
ProfilingStarted Property. Returns True, if AQTime is running a profiler. Otherwise, it returns False.
RemoveModule(AFileName) Method. Removes the specified file from the currently opened project. The AFileName parameter denotes the fully-qualified path to the file to be removed.
ResultReady Property. Returns True if AQTime contains result sets to be displayed or exported. Otherwise, it returns False. The property is automatically set to False after the profiling starts, and it remains False until the results are generated. The results can be generated during the profiler run by the Get Results menu item or by an action, or at the end of the run by AQTime.
Results Property. Returns a reference to the IagAQtimeResults object that provides access to profiling results.
RunModeCount() Method. Returns the number of currently available profiling modes.
SelectProfiler(AProfilerName) Method. Changes the current profiler to the profiler specified by the AProfilerName parameter. This parameter should specify the profiler name as it is shown in the Profilers box in AQTime. If the profiler is selected successfully, the method returns True; otherwise, it returns False.

Note that the profiling is started in the currently selected profiling mode. The profiling mode is stored in your AQTime project.

SelectRunMode(RunModeName) Method. Selects the profiling mode with the specified name. The acceptable mode names are: "Service", "COM Server", "IIS", "ASP.NET" and "Normal".
SetActiveOutput(ActiveOutputType, Active, OutParameter) Method. Enables or disables the output of the Event View content to a text or XML file or to an NT event log. Calling this method is analogous to changing the settings of the Display events in group of Event View Panel Options from the user interface.

The method parameters are:

  • ActiveOutputType - Denotes the output format type. The acceptable typs are: aotTxt (0), aotXML (1) and aotNTLog (2).
  • Active - Boolean. Starts (true) or stops (false) logging events and messages in the specified format.
  • OutParameter - String. Specifies either the fully qualified name of the output files (.txt or .xml), or the event source name to be displayed in the NT event log.
Start(SummaryResultsFile, FullResultsFile) Method. Starts the profiling by running the currently selected profiler in AQTime. The SummaryResultsFile and FullResultsFile parameters specify the fully qualified names of the files to which the results will be stored:
  • SummaryResultsFile is an .xml file holding brief results that are shown in the Summary panel (to convert it to HTML, you can use XSL files from the <AQTime>\Bin\Extensions\Profilers.Files folder).

  • The FullResultsFile parameter holds all the profiling results. Depending on the extension of the specified file, AQTime saves profiling results in the .html, .xml or .txt format. For instance, if you specify the "D:\Profiling Results\Index.xml" file name as the FullResultsFile parameter, AQTime will save the generated results in the .xml format.

    Note that the saved results show the fully-qualified paths to the source and module files regardless of the File names with path option’s value.

If you do not need any of these two files, simply pass an empty string as a parameter.

If the profiling is started successfully, the method returns True; otherwise - False. See also the description of the Attach method.

Note: the Start method returns immediately, it does not wait until the profiling is over. So, to wait until the end of the profiling, check the ProfilingStarted property in a loop. See an example in the Working With AQTime via COM - Overview topic.

TakeSnapshot(Timeout, SnapshotName) Method. Use this method to generate profiling results. If results are generated successfully, the method returns True; otherwise - False.
The Timeout parameter specifies the number of milliseconds AQTime waits for until the results are generated. If results are not generated within the specified timeout, the method returns False.
The SnapshotName parameter is optional. It specifies the name, which AQTime assigns to the result set. If you skip this parameter, AQTime will assign a name generated by default.
Calling the TakeSnapshot method has the same effect as clicking the  Get Results button in AQTime. See also the description of the ExportCurrentResults method.
TerminateProfiling() Method. Terminates the application under test without generating profiling results. A call to this method has the same effect as clicking the  Terminate button in AQTime.

Example

For an example of using the IaqTimeIntegrationSupportManager object, see Working With AQTime via COM - Overview.

See Also

COM Type Reference
Working With AQTime via COM - Overview
Working With AQTime via COM

Highlight search results