ExportData GUI reference

The ExportData tool provides a GUI that lets you easily export large sets of files from Connected. You can export the data of up to 10 users at a time and can select which devices, and optionally which files or from which folders, to export for each user.

Before you begin

If you modified the ExportData tool's original folder structure, such as by moving the tool's ExportData.jar file to another location, return a copy to its default location. To work correctly, the GUI requires these items.

Ensure the following items are in their default locations:

  • ExportData.jar file. Located in the ExportDataTool folder.

Run the ExportData tool GUI

Start the GUI and enter the credentials of a Bulk Exporter user.

To start the GUI

  1. Browse to the ExportDataTool folder, and then do one of the following:

    • On a Windows-based device, double-click ExportData.exe.

    • On a Mac-based device, double-click the ExportData application.

    • On an ARM-based macOS device, double-click the ExportData application.

  2. On the sign-in page, specify the following information, and then click Next.

    • In the Choose environment list, click the service associated with your Connected environment.

    • In the Email field, enter the Connected email address of the Bulk Exporter user running the tool.

    • If the local computer uses a proxy server to access the Internet:

      • In the Https proxy host field, specify the host name of the proxy server. For example, proxy1.mycompany.com.

      • In the Port field, specify the port number on which the proxy server listens for connections. If the server listens on its default port (80 for HTTP and 443 for HTTPS), you do not need to specify a value.

  3. In the browser that opens, enter the credentials of the Bulk Exporter user, and then close the browser.

Manage export requests

Create a request to export the files or folders of one or more users based on criteria you specify.

To create a request

  1. Click Create.

  2. Specify the following information:

    • Request Name.

      Unique case-insensitive name, up to 64 characters in length, to associate with this particular run of the tool. The name must be valid for the operating system of the destination.

      The tool creates a folder with the specified request name in which to store exported files. Therefore, specify a name that meets the requirements of folder names on the destination's operating system. The following lists identify the reserved characters and names to avoid on each operating system.

      macOS

      • Reserved characters:

        • /  (forward slash)

      • Reserved names:

        No reserved names

      Windows

      • Reserved characters:

        • *  (asterisk)
        • \  (backslash)
        • :  (colon)
        • "  (double quote)
        • /  (forward slash)
        • >  (right angle bracket)
        • <  (left angle bracket)
        • ?  (question mark)
        • |  (vertical bar or pipe)
        • any control character

      • Reserved names:

        • AUX
        • CON
        • COM[1-9]
        • LPT[1-9]
        • NUL
        • PRN
        • listed names that include a file extension, such as AUX.TXT
        • any name that contains a trailing space or period (.)

      If you specify a name that exists in the tool's internal history, an error occurs. If you specify a name previously used but no longer in the history and the same existing destination as that request, the newly exported files will intermix in the same folders as the older files and overwrite any having the same name.

    • Users (devices to export).

      For each user, up to a maximum of 10, specify the user's email address and select which of their protected devices to export.

      Specify the following:

      • Email address. As you type, the app displays the email addresses of Connected users in your company that match your text. Either click the user you want to select or press Enter to select the highlighted one.

      • Devices to export. After you specify the address, the GUI displays the user's protected devices and makes only those on the same platform available for selection. Select the ones to export, and then click OK. If you click CANCEL, the tool removes the user from the Users list.

      The number of devices the tool exports for each user appears in parentheses after each user's email address. By default, the tool exports all protected devices for each user.

      TIP: To change a user's selected devices after you add them to the request, remove the user from the list, and then add the person again.

    • Destination.

      Location, up to 80 characters in length, in which to store the exported files.

      Destination guidelines:

      • Select a relatively short path.

        The tool prefixes a combination of the destination, user, and device to the original path of files that it exports. To minimize the chance that the resulting path length exceeds the limit of the destination's operating system, specify a short path. If the derived path exceeds the limit, the tool truncates the path.

      • Ensure the path exists and the destination has enough space available to store the exported data.
      • Ensure that your local computer account has write access to the path.

    • Filters.

      Filter mode options for the folders to export.

      There are two filter mode options, Basic and RegEx.

      • Basic.

        There are three optional filter fields in Basic mode.

        • Folder Path. (Optional)

          Folder path with text or wild card characters, up to 255 characters in length.

          Folder path guidelines:

          • Use this option along with file name and file extension options to narrow down the exported data from the devices.

          • Always separate the folder names with a slash (either forward (/) or backward (\) depending on the Operating System).

          • Maximum of 20 folder paths can be mentioned and the maximum length of one folder path should not be greater than 255 characters.

          • ? and * are the only wild card characters allowed.

          The following lists identify the reserved characters and names to avoid on each operating system:

          macOS

          • \ (backslash)

          Windows

          • < (left angle bracket)

          • > (right angle bracket)

          • " (double quote)

          • / (forward slash)

          • | (vertical bar or pipe)

          After you enter a folder path, click Add to add the folder path to the list. Once you click Add, the folder path box is cleared for you to enter the new path. You need to click Add, each time you add a new folder path.

          To view all the folder paths you have entered, click View. The Folder Path dialog is displayed with the list of folder paths you have entered so far. To delete any of the folder paths from the list, click the X mark against the folder path to delete it from the list.

        • File Name. (Optional)

          Name of the file to export.

          File name guidelines:

          • Include the file's extension but not its path. For example, specify report.txt not C:\tmp\report.txt.
          • To export multiple files based on name, specify the names as a comma-separated list.

          • To match a single character in an item's name, enter a question mark (?).

            For example:

            • report-?? matches Report-AB but not report-A

              To match a file name, include the file's extension. For example, report-??.txt matches report-AB.txt and report-?? does not.

            • do? matches dot or doc but not docx

          • To match zero or more characters in a name, enter an asterisk (*).

            For example:

            • report* matches Report and Report1; *report matches MyReport

            • doc* matches doc and docx

          • Do not include the following characters in the name: left brace ({), right brace (}), left bracket ([), right bracket (]), and colon (:)

          • Maximum length of all the file names should not be greater than 512 characters.

          • Maximum length of individual file name should not be greater than 255 characters.

          The following lists identify the reserved characters and names to avoid on each operating system:

          macOS

          • : (colon)

          • / (forward slash)

          • { }(curly brackets)

          • [ ] (square brackets)

          Windows

          • < > (angle brackets)

          • : (colon)

          • / (forward slash)

          • \ (backslash)

          • | (vertical bar or pipe)

          • { }(curly brackets)

          • [ ] (square brackets)

        • File Extension. (Optional)

          Type of files to export, based on file extension.

          File extension guidelines:

          • To export multiple types of files, specify extensions as a comma-separated list.
          • Do not precede extensions with a dot (.). For example, specify txt not .txt.
          • To match files without an extension, specify a dot (.). For example, . matches report or myReport.

          • Maximum length of all the file extensions should not be greater than 512 characters.

          • Maximum length of individual file extension should not be greater than 255 characters.

          The following lists identify the reserved characters and names to avoid on each operating system:

          macOS

          • : (colon)

          • / (forward slash)

          • { }(curly brackets)

          • [ ] (square brackets)

          Windows

          • < > (angle brackets)

          • : (colon)

          • " (double quotes)

          • / (forward slash)

          • \ (backslash)

          • | (vertical bar or pipe)

          • ? (question mark)

          • * (asterisk or star)

          • { }(curly brackets)

          • [ ] (square brackets)

      • RegEx.

        Regular expression, up to 255 characters in length. You must mention both the path and the file name along with the extension in the regular expression.

      To view the filters applied, see View a request's filter details.

  3. Click Submit.

The tool creates the request, and then redisplays the request list. It starts processing the new request as soon as threads are available.

  • Here are several examples of export requests for the fictitious company named AcmeXYZ and the sample values to create them through the ExportData tool's GUI.

    • Export all files for three users.

      The following values create a request to export all files for three specific users to the existing exports folder in the root drive of the local Windows-based computer. Each user has two actives devices from which all data is exported. Fields not applicable to a particular example do not contain any value.

      • Request Name. AllData
      • Users. msmith@acmexyz.com (2)  bjones@acmexyz.com (2)  tcharles@acmexyz.com (2)
      • Destination. C:\exports
      • Filter.
      • Folder path.
      • File Name.
      • File Extension.

    • Export all files from a particular device for a user with three active devices.

      The following values create a request to export all of a user's backup data to the existing exports folder in the root drive of the local Windows-based computer. Although the user has three active devices, only one has been selected for export.

      • Request Name. AllData
      • Users. kstokes@acmexyz.com (3)
      • Destination. C:\exports
      • Filter.
      • Folder path.
      • File Name.
      • File Extension.

    • Export files by file extension for a single user with two active devices.

      The following values create a request to export all PNG and JPG image files for a single user, regardless of device, and store them on a remote drive.

      • Request Name. ImageData
      • Users. bstewart@acmexyz.com (2)
      • Destination. \\svr1.acmexyz.com\exports
      • Filter. Basic
      • Folder path.
      • File Name.
      • File Extension. png,jpg

    • Export files by name for a single user with three active devices.

      The following values create a request to export all files whose name contains "report", regardless of case or file type, from all active devices and store them on a remote drive.

      • Request Name. ReportData
      • Users. mjefferson@acmexyz.com (3)
      • Destination. \\svr1.acmexyz.com\exports
      • Filter. Basic
      • Folder path.
      • File Name. *report*
      • File Extension.

      In another example for the same user, the following values create a request to export all files with the name "Report-2016.txt", regardless of case or device.

      • Request Name. ReportData
      • Users. mjefferson@acmexyz.com (3)
      • Destination. \\svr1.acmexyz.com\exports
      • Filter. Basic
      • Folder path.
      • File Name. Report-2016.txt
      • File Extension.

    • Export all files from three specific folder paths

      The following values create a request to export all files from three specific folder paths for a specific user to the existing exports folder in the root drive of the local Windows-based computer.

      • Request Name. AllData
      • Users. msmith@acmexyz.com (2)
      • Destination. C:\exports
      • Filter. Basic
      • Folder path. C:/documents/emails, C:/documents/applications, C:/documents/forms
      • File Name.
      • File Extension.

    • Export files by file extension from a specific folder path

      The following values create a request to export files by file extension (doc, docx, txt) from a specific folder paths for a specific user to the existing exports folder in the root drive of the local Windows-based computer.

      • Request Name. AllData
      • Users. sholmes@acmexyz.com (1)
      • Destination. C:\exports
      • Filter. Basic
      • Folder path. C:/documents/applications
      • File Name.
      • File Extension. doc, docx, txt

    • Export all files using regular expression

      The following values create a request to export all files using regular expression for a specific users to the existing exports folder in the root drive of the local Windows-based computer.

      • Request Name. AllData
      • Users. jwatson@acmexyz.com (1)
      • Destination. C:\exports
      • Filter. RegEx
      • Regular Expression. ([a-zA-Z]:)?(/[a-zA-Z0-9._-]+)+/emails([a-zA-Z0-9]+])

  • Requests can have one of the following statuses:

    • ACTIVE. The tool is currently processing the request or was processing the request before it stopped without finishing.

      For example, before the request finished, you exited the tool or the computer shut down either inadvertently or on your command.

    • COMPLETE. The tool finished processing the request and exported all files successfully.

    • COMPLETED WITH FAILURES. The tool finished processing but failed to export all files successfully. To try exporting the failed files again, resume the request.

    • ERROR. The tool stopped processing the request because of an error.
    • PEND. The request is ready for processing and starts as soon as the tool assigns it to an available thread.
    • PREP. The tool is creating the request's manifest of files to export.

    To see how many files the tool exported, see View a request's detailed status.

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

  • Exit the ExportData application.

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.

Resume a request that completed with failures or that did not complete because it stopped or was interrupted. For example, you exited the tool or the computer on which it was running shut down unexpectedly.

If you resume a request that completed with failures, the tool tries to export only files that previously failed. If you resume a request that did not finish, the tool continues processing the request at the point where it left off. For example, suppose a request contains two users. The first user's export completed with failures and you stopped the tool while it was exporting the second user's data. When you resume the request, the tool exports only the failed files for the first user and continues the second user's export at the point it left off.

To resume a request

  • Select the request, and then click RESUME.

NOTE: Requests that stop before completion retain the status of their last state: PREP or ACTIVE. Although a request in progress also might have one of these statuses, the RESUME button is available only for those that have stopped or were interrupted.

Cancel a request so the tool stops processing it and deletes its information from the tool's display and internal history. You can cancel any request that has not completed successfully. Files that the tool exported before you cancel the request remain available in the specified destination.

To cancel a request

  1. Select the request, and then click CANCEL.
  2. To confirm the cancellation, click CONFIRM.

Remove all successfully completed requests from the tool's display and internal history but retain each request's exported files in the destination. If you no longer need the exported files associated with completed requests, you must manually delete them. You can clear requests only while no requests are active.

To clear all completed requests

  1. To delete exported files associated with a specific completed request, do the following:

    1. Select the request, and then click OPEN.
    2. Manually delete the destination folder that opens.

    Repeat this step for each completed request whose files you want to delete.

  2. Click CLEAR ALL.

  3. To confirm the clear action, click CONFIRM.

Open the location to which files were exported for a particular request. 

To access exported files

  • Select the request, and then click OPEN.

View the following detailed status information for the request:

  • User. Connected user whose data the tool exports. The tool reports a separate status for each user in a request.
  • Data Exported. Amount the user’s data exported out of the total amount to export.
  • Files Exported. Number of the user’s files exported out of the total number to export.
  • Progress. Percent of the user's export that is complete, based on the amounts listed in the Data Exported field.
  • Status. Current status of the export process.

    • ACTIVE. The tool is currently processing the request or was processing the request before it stopped without finishing.

      For example, before the request finished, you exited the tool or the computer shut down either inadvertently or on your command.

    • COMPLETE. The tool finished processing the request and exported all files successfully.

    • COMPLETED WITH FAILURES. The tool finished processing but failed to export all files successfully. To try exporting the failed files again, resume the request.

    • ERROR. The tool stopped processing the request because of an error.
    • PEND. The request is ready for processing and starts as soon as the tool assigns it to an available thread.
    • PREP. The tool is creating the request's manifest of files to export.

To view detailed request status

  1. Select the request, and then click VIEW.

  2. To see the devices selected for a particular user, click the row for that user.

View the following filter details for the request:

  • Request name. Name of the request.

  • Filter mode. Filter mode selected for the request.

    The following details are displayed based on the Filter mode selected:

    For Basic

    • Filter path. Folder path(s) specified in the request.

    • File name. Name of the file(s) mentioned in the request.

    • File extension. Type(s) of the file mentioned in the request.

    For RegEx

    • Regular expression. Regular expression specified in the request.

To view filter details

  1. Click View filters for a request.

    The Filters applied dialog is displayed with information on the filters applied for the request.

TIP: The GUI does not automatically update status information. To see the latest status of each request, click REFRESH.