TestArchitect Tutorial Part 3: Extending TestArchitect Lesson #11: Creating Excel reports using TAUtilities

 TAUtilities API reference

TAUtilities API reference

How to access the API specifications of the TAUtilities library.

You have several options for accessing the API reference of the TAUtilities library:

• Option #1:

  1. Start TestArchitect Client, if it is not running.

  2. Select menu Help > TAUtilities API.

• Option #2:

  1. Go to the following location TA_INSTALL_DIR\tahelp\TAUtilities doc.

  2. Open the file the index.html.

• Option #3: Access TAUtilities online.

In all cases, your default browser displays the main API reference of the TAUtilities library. For a further explanation of the organization of this document, click the Help link at the top of the page.

• For API methods that contain the Boolean isRecursive parameter, the allowable values vary between different technologies as follows:

  Technology	Allowable Boolean values
  Java	false: Gets project items at the top level only.
  	true: Gets project items recursively at all levels.
  Microsoft Component Object Model (COM)	0: Gets project items at the top level only. Notes:  If an invalid value is specified, the value of 0 is used by default.
  	1: Gets project items recursively at all levels.

• Related methods include:

  • Project interface:
    • getTestModules()
    • getTestFolders()
    • getActions()
    • getActionFolders()
    • getDatasets()
    • getDatasetFolders()
    • getTestSuites()
    • getTestSuiteFolders()
    • getResults()
    • getResultFolders()
  • TestFolder interface:
    • getTestModules()
    • getTestFolders()
  • ActionFolder interface:
    • getActions()
    • getActionFolders()
  • DatasetFolder interface:
    • getDatasets()
    • getDatasetFolders()
  • TestSuiteFolder interface:
    • getTestSuites()
    • getTestSuiteFolders()
  • ResultFolder interface:
    • getResults()
    • getResultFolders()