Install and Configure File XChange

Owned by Brian Banet
Last updated: Mar 29, 2024 by Square 9 Support
5 min read

To use File XChange for files, you must install it on your machine as a local administrator. Once installed, you must have at least one File XChange drive configured. It is a good idea to make sure that you have sufficient hard drive space for your File XChange drives. (The amount of space needed will depend upon how many and how large the documents in the drives are.)


Install File XChange

  1. To install install the File XChange extension, click the File XChange Install toggle switch.
    Once extraction is completed, the File XChange Manager will open so that you can configure your File XChange drives before using them for the first time.

  2. To uninstall, click the Install toggle switch again.

    Extensions Manager with File XChange indicated.

Configure File XChange Settings

After installation, the File XChange Manager will appear so that you can configure your File XChange-mounted drives. Because at least one drive must be configured for File XChange files before you can start File XChange, a default drive is created automatically the first time that File XChange is opened. Once it (or another drive that you create) is configured and saved in the File XChange Manager, you can run File XChange.

Access the File XChange Manager

When a File XChange drive is running, the Square 9 File XChange icon will appear in your Windows system tray. Right-click on the icon for quick access to the File XChange drive and the File XChange Manager, as well as useful drive information. Double-click on the icon to open the File XChange Drive.

Icon

( ) 

If File XChange is not running, you can still access the the File XChange Manager through the Extensions Manager interface. Open the Extensions Manager in your browser in one of two ways:

  • From GlobalSearch, click the Extensions icon in the top-right side of the GlobalSearch toolbar to open the Extensions Manager on another tab in your browser.

Icon

()


  • From your Windows desktop, double-click the Extensions () icon in your Windows system tray.

Icon

()

In the vertical Extensions menu, select File XChange. Click the More Options () icon and from there, click Settings.

File XChange Settings

Configure Drives in the File XChange Manager

To configure File XChange drives, in the File XChange Manager Drive Management group:

  1. Select the drive letter of a currently saved File XChange drive, in the Drives drop-down list.

  2. To open Windows Explorer® to the location where the File XChange drive is installed, click Show Location.

  3. Optionally, click the Add (+) button in Drives list to add another drive. Click the Delete (-) button to delete a drive (after checking for any files in the drive).

  4. To start the currently selected drive, click Start.
    If it is not already running, you may start up the drive for immediate use. When start-up is complete, the File XChange icon will appear in your system tray and the drive will be visible in Windows Explorer.

  5. To stop the File XChange drive, click Stop.
    Before stopping the drive make sure that all the documents in it have been closed. If a document is open when you stop the drive, it is likely that the application the opened document is in will error and you will be unable to save any further changes to the document.

  6. In the Drive Information group, enter the following:

    1. Enter the Square 9 API URL used to connect to your GlobalSearch server in the API URL text box. (For example, http://mydocumentserver/square9api.)

    2. Enter the domain name of your machine in the Domain text box. If your install is not a domain install, then put in the name of your application server. (Your IT department should be able to advise you on this setting.)

    3. Enter your GlobalSearch credentials in the Username and Password text boxes.

    4. Select the GlobalSearch database that the File XChange drive will connect to from the Database drop-down list.

    5. To test the connection with your entered authentication information, click Test Connection. The status of the connection is indicated by the color of the Power icon and its corresponding tooltip.

Icon

()

  1. A valid combination of URL, Domain, Username, and Password is required to select a database. Indications are as follows:

      • Grey – Indicates that the credentials are not yet set. Enter all of the drive information and then click Test Connection.

      • Yellow – Indicates that the credentials are in the process of being tested.

      • Red – Indicates that the credentials are tested and invalid. Before you can start the drive, enter valid credentials, then click Test Connection again.

      • Green – Indicates that the credentials are tested and valid. Select a database and start the drive.
  1. Enter the letter to be used to represent the File XChange drive in Windows Explorer in the Drive Letter text box.
    A drive letter will be automatically set when the File XChange drive is created, but can be changed at any time. This drive letter must follow Windows conventions like when naming other drives; using a capital letter A through Z. The letter cannot be used for another drive.

  2. Enter the drive cache path either by entering the path in the Drive Cache Path text box or clicking the Browse (folder) button and browse to the drive location.
    The File XChange drive requires a folder on your machine for the temporary files that are being used in File XChange. This folder should be newly created just for File XChange use.

    Possible Data Loss

    By default, File XChange attempts to clear this cache every time the drive restarts. Using the cache folder for any other application besides File XChange will result in a loss of files.

  3. For most cases, you will not have to enter or delete any Regex patterns in the File Blacklist box. Only in particular instances should you need to consult your IT department to adjust this setting.

  4. If you wish to be alerted when files are upload to the drive, enable Show File Upload Alerts. (This is enabled by default.)

  5. To immediately refresh when a file is imported into a GlobalSearch Archive, enable Auto Refresh on File Import. (This is off by default.)

  6. To save your drive settings, in the Deployment group, click Export Settings.This will create a DriveSettings.config file as a ZIP package.

  7. Click Update Drive to save settings for the current drive and update the File Exchange drive reference in your start-up folder, which is created for each File XChange drive. If you close the dialog box without clicking Update Drive, your settings changes will be lost.

File XChange Manager


Access Settings in the File XChange Tray Menu

When a File XChange drive is running, the File XChange icon will appear in your Windows system tray. This provides useful drive information, as well as quick access to the File XChange drive and the File XChange Manager.


  1. To access the File XChange tray menu, start Extensions and then right-click the Square 9 File XChange icon in the Windows system tray and choose from the following options:

Icon

( )


  • Square 9 File XChange – Click to go to the File XChange drive.

  • Version – Displays the currently running version of File XChange.

  • Drive Letter – Displays the letter identifying the File XChange drive.

  • Settings – Click to open the File XChange Manager.

  • Logout – Click to log out and return your user license token.

  • Exit – Click to stop the drive.

  1. To go to the File XChange drive, double-click on the Square 9 File XChange tray icon.

 File XChange Context Menu