OnBase Setup Guide

Hyland OnBase Connector

Connect to Hyland OnBase ECM via SQL Server database. Extract documents by document type, groups, or Unity API queries.

Overview

The OnBase connector accesses OnBase repositories through direct SQL queries against the OnBase SQL Server database. Supports document type-based extraction, keyword associations, and Unity API custom queries (requires agent with Unity capability).

  • • Full document type and group support
  • • Keyword metadata extraction
  • • Incremental sync via handle ranges and dates
  • • Unity API delegation for custom queries

Prerequisites

AetherFlow Agent with sqlserver capability installed on a machine with network access to OnBase SQL Server.
OnBase SQL Server database access (typically DB_NAME database).
SQL Server read credentials (user/password or Windows auth via agent).

Configuration

Connection Fields

server
SQL Server hostname/IP (required)
e.g. onbase-sql.yourdomain.com or 192.168.1.100
database
OnBase database name (required)
Usually DB_NAME or custom.
user / password
SQL credentials (required for SQL auth)
Windows auth via agent context.
instanceName
Named instance (optional)
e.g. SQLEXPRESS
connectTimeout
Connection timeout (ms) (optional, default 15000)

Step-by-Step

  1. Install AetherFlow agent with sqlserver capability on a VM/server with DB access.
  2. Connect agent to your AetherFlow tenant.
  3. Create connector: select OnBase → enter SQL connection details.
  4. Test Connection → verifies SQL access and lists document type groups.
  5. Save connector profile for reuse in flows.

Connection Testing

Success indicators:

  • SQL connection established
  • Document type groups listed
  • Sample document types returned

Common Issues

Login failed for user
Verify SQL credentials. Test with sqlcmd from agent machine.
Cannot connect to server
Check firewall, agent network access, SQL Browser service (named instances).
No document types found
Verify database name. Run SELECT * FROM documenttype manually.