ExportFromID command (Import/Export tool)

Export a project item, as identified by its TestArchitect ID, to a file.

Restriction: The Import/Export tool is not available in the TestArchitect packages for the Linux and macOS operating systems.

Synopsis

java -jar TAImportExportTool.jar --ExportFromID [--server<value>] [--port<value>] --uid<value> 
--pwd<value> --repoName<value> --projectName<value> --ID<value> --destinationFile<value> 
--outputType<value> [--overwrite<true|false>] [--includePictureChecks] [--includePictureChecks<yes|no>]
TAImportExportTool.jar
An executable .jar file used to invoke the Import/Export tool.
The file can be found at TA_INSTALL_DIR\binclient.
--ExportFromID
Invoke the export project items function.
--server<value>
(Optional, default = localhost) Full hostname or IP address of the repository server in which the repository is to reside.
Note: If this argument is not defined, localhost is used as the default.
--port<value>
(Optional, default = 53400) Port number of the repository server.
Note:
  • If this argument is set to 0 or not defined, the default port number 53400 is used.
  • If port number of the source repository server has been changed from its TestArchitect default of 53400, ensure that the correct port number is specified.
--uid<value>
User name with which to log in to repository.
Note: If the user name contains any spaces, enclose it between a pair of double quotation marks.
--pwd<value>
Password for the given user name.
--repoName<value>
Name of the source repository.
Note: If the repository name contains any spaces, enclose it between a pair of double quotation marks.
--projectName<value>
Name of the source TestArchitect project.
Note: If the project name contains any spaces, enclose it between a pair of double quotation marks.
--ID<value>
TestArchitect ID of the item to be exported.
Note: To obtain the ID of the item, find the URL field under the item's Information tab. The ID is placed at the end of the item's URL address, prefixed with a hyphen ( - ). In the following example, the TestArchitect ID is 1z26kdr8h1:

--destinationFile<value>
Location into which the exported file is to be written.
Note:
  • If the specified path does not include a file name, the name is automatically generated.
  • Network paths are also supported.
  • If the path contains any spaces, enclose it between a pair of double quotation marks.
--outputType<value>
Type of file to export to.
Allowable values are:
  • csv: Applicable to the Tests node, test folders, test modules, and test cases.
  • html: Applicable to the Tests node, test folders, test results.
  • zip: Applicable to test modules, data sets, actions, interface entities, test results, test result folders and shared picture checks.
    Note: For a shared picture check, the exported .zip file contains .png files of the baseline variations.
  • txt: Applicable to actions, interface entities, the Tests node, test folders, test modules, test cases, and data sets.
--overwrite<true|false>
(Optional, default = false) Specifies whether the existing file, if any, should be overwritten.
Note: If this parameter is not specified, or its value is empty, its value defaults to false.
--includePictureChecks<yes|no>
(Optional, default = yes) Specifies whether the regular picture checks belonging to the target test module are to be exported.
Note:
  • If this parameter is not specified, or its value is empty, its value defaults to yes.
  • This parameter is only applicable to test modules. For other project items, it is simply ignored.
  • Only .zip files are supported as export targets.

Example: Exporting test modules including regular picture checks

Ensure that you have installed or upgraded your Java Runtime Environment (JRE) to at least version 8, which is necessary to run TAImportExportTool.jar on your Windows machine.
Tip:
  • Refer to JRE 8 Installation for Microsoft Windows for details.
  • As an alternative to explicitly installing JDK 8, you may also use the Java Runtime Environment (JRE) packaged with TestArchitect at TA_INSTALL_DIR\jre\bin. In such a case, note that all invocations of the java command will need to specify its filepath (e.g., C:\Program Files\LogiGear\TestArchitect\jre\bin\java). (This latter step can be circumvented by setting the Windows environment variable JAVA_HOME to TA_INSTALL_DIR\jre\bin.)
Let's say you want to export a given test module, Action Based Testing, with the following information and requirements:
  • Repository server's IP address: 192.168.167.60
  • Repository server's port number: 53400
  • Repository name: SampleRepository
  • User name for account in repository: john
  • Password for the account: doe
  • Project name: Car Rental
  • TestArchitect ID of the test module: 1z26kdr8h1

  • Destination for the exported file: D:\exported items
  • Destination file name: (We'll accept the default, which is automatically generated based on name of the source test module)
  • In the export, include the regular picture checks of the source test module.
  • Type of output: .zip
    Note: Only .zip files are supported as targets when exporting regular picture checks from a test module. If you are not including regular picture checks in your export, .html and .csv files may also serve as the output.
  • Overwrite the existing file.

To run the ExportFromID command, do the following:

  1. Bring up a command window. You can do this from the Windows Start menu by choosing Run, and then entering cmd. The command window opens with a prompt displaying your current directory.
  2. Use the cd command to change your current directory to TA_INSTALL_DIR\binclient\, which is where TAImportExportTool.jar is located. For example, type the following command at the prompt, and then press Enter.
    cd "C:\Program Files\LogiGear\TestArchitect\binclient"
    Now the prompt should change to the new directory, e.g., C:\Program Files\LogiGear\TestArchitect\binclient>
  3. Based on the given scenario, enter the following command, and then press Enter.
    java -jar TAImportExportTool.jar --ExportFromID --server 192.168.167.60 --port 53400 --uid john 
    --pwd doe --repoName SampleRepository --projectName "Car Rental" 
    --ID 1z26kdr8h1 --destinationFile "D:\exported items" --outputType zip 
    --overwrite true --includePictureChecks yes


In the exported .zip file:
  • Each folder corresponds to one regular picture check.
  • Each baseline variation of a regular picture check is stored as a .png file in the appropriate folder.