Download and install the ExportData tool

The ExportData tool exports the Connected data of multiple users at the same time through either a GUI or CLI. Connected administrators can download the ExportData tool from the Downloads page of the Connected web application.

Before you begin

Ensure that the location in which you plan to install the tool meets all requirements and prerequisites.

The ExportData tool has the following requirements and prerequisites:

  • Software requirements

    • Operating system. Any macOS or 64-bit Windows operating system

    • Third-party software. The following software:

      • Java

        • For the GUI:

          • 64-bit Java SE Development Kit 8 (JDK 8)
          • Java SE Runtime Environment 8 (bundled with JDK 8)

        • For the CLI:

          • Java SE Runtime Environment 8

      • Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policies enabled

        These policies are enabled by default.

      • For ARM-based macOS device, JDK 8 for arm64 is required.

  • System requirements

    • Credentials. Connected credentials of a user with the Bulk Exporter role

    • Encryption key management. Connected must escrow your company's encryption keys

      If your company manages its own encryption keys using Connected Key Management Server (CMX-KMS) software, you must install the Connected client device certificate after installing the ExportData tool. This certificate enables the tool to establish a secure connection with the Connected server.

    • Disk space. Sufficient storage on the target location to hold the exported data

  • Prerequisites (ExportData GUI only)

    • Set the JAVA_HOME environment variable.

      Set the JAVA_HOME environment variable to the Java SE 8 location on your computer:

      • Windows: C:\Program Files\Java\<JDK-VERSION>
      • macOS: /Library/Java/JavaVirtualMachines/<JDK-VERSION>/Contents/Home

      Where <JDK-VERSION> is the Java SE 8 version you are using.

    • Enable Java Native Interface (JNI) for Java SE 8 (macOS only).

      Download and run the script that enables JNI for Java SE 8 on the computer:

      1. Open the following script in a browser and save it as a file named modify_java.py in a temporary folder:

        https://gist.githubusercontent.com/pudquick/349f063c242239952a2e/raw/5e6ce4e975a1d269e61b7f29f410feff9e02636e/modify_java.py

      2. In Terminal, go to the folder that contains the script, and then enter the following command to run it:

            sudo python modify_java.py

    • Create a symlink to Java SE 8 (macOS only).

      Enter the following commands in Terminal to create a symlink to Java SE 8:

          sudo mkdir /Library/Application\ Support/ExportData/
    cd /Library/Application\ Support/ExportData/
    sudo ln -s /Library/Java/JavaVirtualMachines/<JDK-VERSION>/Contents/Home javaLocation

      Where <JDK-VERSION> is the Java SE 8 version you are using.

To download and install the ExportData tool

  1. In the upper-right corner of the Connected web application, click your name, and then click Downloads.

  2. Under Tools & Utilities on the Downloads page, click one of the following links, depending on the operating system which will run the tool:

    • Download ExportData tool for Windows 64-bit

    • Download ExportData tool for macOS

    • Download ExportData tool for ARM-based macOS

    The application downloads the Windows-based package as a zip file or the macOS-based package as a read-only disk image.

  3. Close the Downloads page.

  4. If you plan to run the tool on a different computer, copy the package to it, and then perform the remaining steps from that computer.

  5. In the folder that contains the package, do the following:

    • For the Windows-based package (ExportDataTool-Win-version.zip), extract its contents.

      The Windows-based package contains an ExportDataTool folder with the following items:

      • ExportData.exe. The tool's graphical user interface.
      • ExportData.jar. The tool's command-line interface.
      • Electron license files. Contains the open-source acknowledgments and license agreements for Electron, the framework on which the tool is built.
      • license.txt. Contains the tool's open-source acknowledgments and license agreements.
      • log4j2.xml. Contains the tool's log message formats. To ensure the tool operates correctly, do not modify the contents of this file except under the guidance of Support.
      • ReadMe.txt. Contains basic information about the tool's command-line interface as well as the tool's open source acknowledgments and license agreements.

    • For the macOS-based package (ExportDataTool-Mac.dmg), do the following:

      1. Double-click the ExportDataTool-Mac.dmg disk image.

        This action mounts a read-only volume named ExportData.

      2. Copy the ExportDataTool folder from the new ExportData volume to a location with write access.

        The tool requires write access to work correctly so you must copy it to another location before using it.

      3. Eject the ExportData volume.

      The macOS-based package contains an ExportDataTool folder with the following items:

      • ExportData.jar. The tool's command-line interface.
      • Electron license files. Contains the open-source acknowledgments and license agreements for Electron, the framework on which the tool is built.
      • license.txt. Contains the tool's open-source acknowledgments and license agreements.
      • log4j2.xml. Contains the tool's log message formats. To ensure the tool operates correctly, do not modify the contents of this file except under the guidance of Support.
      • ReadMe.txt. Contains basic information about the tool's command-line interface as well as the tool's open source acknowledgments and licenses.

      NOTE: If you plan to use the tool's GUI, keep the package's folder structure intact after extraction.

    • For the ARM-based macOS package (ExportDataTool-Arm-Mac.dmg), do the following:

      1. Double-click the ExportDataTool-Arm-Mac.dmg disk image.

        This action mounts a read-only volume named ExportData.

      2. Copy the ExportDataTool folder from the new ExportData volume to a location with write access.

        The tool requires write access to work correctly so you must copy it to another location before using it.

      3. Eject the ExportData volume.

      The ARM-based macOS package contains an ExportDataTool folder with the following items:

      • ExportData.jar. The tool's command-line interface.
      • Electron license files. Contains the open-source acknowledgments and license agreements for Electron, the framework on which the tool is built.
      • license.txt. Contains the tool's open-source acknowledgments and license agreements.
      • log4j2.xml. Contains the tool's log message formats. To ensure the tool operates correctly, do not modify the contents of this file except under the guidance of Support.
      • ReadMe.txt. Contains basic information about the tool's command-line interface as well as the tool's open source acknowledgments and licenses.

  6. If installing the tool in a CMX-KMS environment, copy the Connected client device certificate (cmxDevice.p12) to the ExportData tool's root folder.

    The ExportData tool uses the Connected device client certificate to establish a secure connection with CMX-KMS. Although the certificate is password-protected, you can provide additional security by restricting access to the tool's root folder to only users who will run the tool.

    NOTE: Each instance of the tool requires its own certificate, named cmxDevice.p12. Therefore, if you install the tool in multiple locations, you must install a copy of the certificate in the tool's root folder of each location.

    For more information about CMX-KMS, see the Connected Help Center.

For detailed information about how to use the ExportData tool, see either ExportData CLI or ExportData GUI.