Square9 Setup Guide

Square9 GlobalSearch Connector

Connect to Square9 GlobalSearch via REST API. Supports databases, archives, field mapping, and search-based extraction.

Overview

Square9 connector uses the GlobalSearch REST API for document extraction and field discovery. Primarily used as a target for migrations.

  • • Database and archive enumeration
  • • Dynamic field dictionary from archive
  • • License token management
  • • Search-based handle providers

Prerequisites

Square9 GlobalSearch with REST API enabled (v5.8+ recommended).
API username/password with archive read/write permissions.
Network access to Square9 server (HTTPS/443).

Configuration

Connection Fields

baseUrl
Square9 REST API base (required)
e.g. https://globalforms.yourcompany.com/GlobalSearch
databaseId
Database ID (required for archives)
From "Get Databases" test.
archiveId
Archive ID (required)
From "Get Archives" test.
username / password
API credentials (required)

Step-by-Step

  1. Create connector: select Square9.
  2. Enter baseUrl and credentials.
  3. Test Connection → lists databases → select one → lists archives.
  4. Enter databaseId and archiveId.
  5. Test again → fetches field dictionary → save.

Connection Testing

Success indicators:

  • License token acquired
  • Databases listed
  • Archive fields returned

Common Issues

License token failed
Check API user has GlobalSearch license assigned.
Invalid archiveId
Use "Get Archives" button after selecting databaseId.