Runtime information for the ExportData CLI

This topic provides runtime information for the ExportData tool's command-line interface (CLI).

Before using the ExportData CLI for the first time, review the following list to familiarize yourself with how several key areas of it function:

  • Encryption. The tool does not encrypt or compress exported files and handles currently encrypted files as follows:

    • EFS encryption. Files retain EFS encryption if exported to another NTFS device that also uses EFS encryption.

      CAUTION: If exporting files to an NTFS device that uses EFS encryption, the exported files are encrypted under the Windows user account running the tool.

    • Full-disk encryption. Files retain their system-level encryption if exported to a device that also uses full-disk encryption.
    • Third-party application-level encryption. Files retain their encryption and are not accessible after export unless decrypted with the same third-party application and encryption key or password that encrypted them.

  • Credentials. The CLI prompts for credentials by default.

    By default, the tool prompts for the credentials. However, you can use the CLI's preservelogin option to bypass this prompt the next time that the tool runs. Here is how the option works:

    The first time you that specify --preservelogin, the tool prompts for credentials and verifies them. It then securely stores the resulting OAuth tokens in a properties file, named dataExport.properties, located in the home directory of the local user account that ran the tool. The next time that the tool runs, it uses the stored tokens to bypass the prompt if you have not have edited, moved, or deleted the properties file. In addition, if you specified the preservelogin option for this run, the tool continues to store the tokens so that it can bypass the prompt the next time, too. Otherwise, the tool deletes the properties file after it runs and prompts for credentials in the subsequent run.

    NOTE: The dataExport.properties file contains security credentials. To ensure that you do not compromise the security of your system, do not edit this file or share it with others.

  • Multi-instance support. The tool supports multiple instances when installed in different locations.

    You can install the ExportData tool in different locations and run a single instance of each one in parallel. However, to ensure optimal system performance, OpenText recommends that you keep the number of simultaneous instances running to a minimum.

    Multiple instances are semi-independent of each other. They maintain separate request histories and log files but share the same exportData.properties file and therefore the same OAuth token. As a result, if one instance changes or deletes the token, it affects all other instances.

    To perform an action on a particular request, such as to cancel or resume it, you must do so using the instance that ran the request. When running multiple instances of the tool, you can export files to a common destination, such as C:\Export, because the tool exports data to request-specific folders.

    NOTE: If you attempt to run multiple instances of the tool from the same installation, the tool processes only one command at a time.

  • Request interruption. The CLI lets you stop a request that is running in a console window.

    You can stop a request in its current state so that you can resume it at a later time. Stopping a request is different than canceling it because you cannot resume a canceled request.

    To stop a request, in the console window where the request is running, press Ctrl+C. To later resume the request, run the tool with the resume option in any console window.

    NOTE: If you stop a request, its status does not change. Therefore, if you stop a request while it is currently preparing to export files or actively exporting them, its status remains either PREP or ACTIVE, respectively. Using the CLI's list option does not identify requests as stopped. Keep this in mind so that you note the names of any requests that you stop if you plan to resume them in the future.

  • Auxiliary file creation. The CLI creates files for internal use in the location that you run the tool.

    The tool creates files containing information that help it process and track requests. It stores these files in the folder where you run the tool, which is not necessarily the folder to which you extracted it. To ensure that the tool functions correctly, do not move, rename, or delete these files.

  • Logging. For information about the type and location of the status and error messages that the CLI logs, see Troubleshoot ExportData tool errors.