# Connect Paige to OnBase

Get Paige's finished documents into Hyland OnBase through Document Import Processor (DIP): Paige exports each document with its data to an SFTP folder, a Power Automate flow writes the DIP index file and drops the PDF on the import share, and OnBase's scheduled DIP process files the documents with their keywords set.

Product: paige · Audience: integrator · Time: 2 hours · Last verified: 2026-09-05

Canonical: https://help.ademero.com/paige/integrations/connect-paige-to-onbase

**At the end of this guide, every document Paige finishes is imported into Hyland OnBase by its Document Import Processor on the schedule you set — as a searchable PDF of the right document type, with its keywords (vendor, invoice number, date, amount…) filled from what Paige extracted.**

OnBase (Hyland OnBase, "OnBase by Hyland") doesn't watch folders on its own. Its bulk import tool, **Document Import Processor** (DIP), reads an **import index file** that lists documents to import and the keyword values for each. So the integration has two halves: Paige produces the documents and data, and a small Power Automate flow turns each document's data into an index-file record that DIP understands. Your OnBase administrator defines the DIP format once; after that it's hands-off.

## How it works

1. Paige exports each finished document to an SFTP folder: a PDF, then `.json`, `.xml`, and `.csv` files with the same base name.
2. A Power Automate flow triggers on the `.json`, reads the values, copies the PDF to the DIP import share, and appends one record to the day's index file on that share.
3. OnBase runs the DIP process on a schedule (or an operator runs it from the Client), imports every document in the index file, and sets the keywords.

## Step 1 — Point Paige at your SFTP server

1. In Paige, open **Settings** (the gear at the bottom of the left menu — administrators only), pick the scan job, and choose **Export**.
2. Click the **FTP** card. Enter the **FTP Address**, **Port** `22`, **Username**, **Password**, and in **FTP Folder Path** a folder for this scan job, such as `/paige/invoices`.
3. Click **Test Connection**. **What you should see:** `FTP connection successful!` Connect — `Connected to FTP Server!` and a green **Connected** label.
4. Turn on **Enable Auto Export**. Under **Auto Export Settings**, switch on **Only documents having a document type**, set **Auto Field Entry Complete** to **Yes**, and set **Human Reviewed** to **Reviewed** — DIP imports are hard to undo, so let people check in Paige first. Click **Save**.

Open port 22 on your firewall to Paige's address ranges — [Outbound IP ranges for firewall allow-lists](/paige/document-processing/outbound-ip-ranges-for-firewall-allow-lists).

## Step 2 — Agree the index file layout with your OnBase administrator

DIP supports two index-file styles. Use **Ordered**: every record is one line, values in a fixed order, separated by a delimiter. It's the easier one to produce from a flow and to configure.

Agree these with whoever configures OnBase:

| Item | Suggested value |
| --- | --- |
| Import share | `\\fileserver\OnBaseImport\Paige\Invoices\` — DIP reads from here; the PDFs go in a `files` subfolder |
| Index file | One per day, `paige-invoices-YYYY-MM-DD.txt`, in the share root |
| Record separator | New line |
| Field separator | Pipe `\ | ` (Paige values can contain commas; they never contain pipes) |
| Field delimiter | None |
| Field order | Document Type, File Path, then one keyword per field you want filled — for example `Vendor Invoice\ | \\\\fileserver\\OnBaseImport\\Paige\\Invoices\\files\\INV-20441.pdf\ | Acme Office Supply\ | INV-20441\ | 08/28/2026\ | 1284.50` |

The OnBase administrator creates the DIP process format in **OnBase Configuration** (**Import > Document Import Processor**): sets the **Process Settings** for an ordered format with that separator and delimiter, chooses the document types the process may create, and configures the **Field Order** so each position maps to Document Type, File Path, and the right keyword types. They'll also set the default file format (PDF) and schedule the process. Field order must match the file exactly — one extra or missing column and every record fails validation.

## Step 3 — Build the flow

Create an **Automated cloud flow**. It needs a **File System** connection through an **on-premises data gateway** installed on a machine that can reach the import share.

1. **Trigger — SFTP - SSH: When a file is added or modified.** Connection: **Host server address**, **User name**, **Password**, **Port number** `22`. **Folder:** the scan job's folder. **Include file content** on.

2. **Condition:** *File name* **ends with** `.json`. Steps 3–6 go in **If yes**.

3. **Parse JSON** on the trigger's *File content*, schema generated from a real `.json`.

4. **SFTP - SSH: Get file content using path.** Path: the folder plus the parsed `pdf_file`.

5. **File System: Create file.** **Folder path:** the `files` subfolder of the import share. **File name:** a name built from Paige fields, ending in `.pdf` — `@{body('Parse_JSON')?['fields']?['Invoice Number']}.pdf` — and **File content** from step 4. Strip `\ / : * ? " < > |` from the name with `replace()` calls; a duplicate name would overwrite, so append the export timestamp if that can happen.

6. **File System: Append file** (or **Create file** if it doesn't exist yet, guarded with a **Get file metadata using path** and a condition). **File path:** the share root plus `paige-invoices-@{formatDateTime(utcNow(),'yyyy-MM-dd')}.txt`. **Content:** one record in the agreed order, ending with a newline:
   
   ```
   @{body('Parse_JSON')?['metadata']?['document_type']}|\\fileserver\OnBaseImport\Paige\Invoices\files\@{body('Parse_JSON')?['fields']?['Invoice Number']}.pdf|@{body('Parse_JSON')?['fields']?['Vendor Name']}|@{body('Parse_JSON')?['fields']?['Invoice Number']}|@{body('Parse_JSON')?['fields']?['Invoice Date']}|@{replace(body('Parse_JSON')?['fields']?['Total'], ',', '')}
   ```
   
   Use the same field names as the Paige document type, in the order the OnBase administrator configured. Keyword types that are dates or currency want values in the format OnBase expects — convert with `formatDateTime()` and `replace()` as in the amount example.

7. **Save.** **What you should see:** the flow checker reports no errors.

## Step 4 — Run DIP

The OnBase administrator schedules the DIP process (for example, nightly, or every 30 minutes) against the share, or an operator runs it from the OnBase Client under **Processing > Import**, choosing the Paige format and the day's index file. Set the format to move or delete processed files so the share doesn't accumulate.

> **IMPORTANT:** DIP processes an index file as a whole. If the flow is appending to today's file while DIP reads it, the last record may be cut off. Schedule DIP for a quiet time, or have the flow write one index file per document (`<Invoice Number>.txt`) and configure DIP to process every index file in the folder — either avoids the race.

## Step 5 — Test it

1. Process one document through the scan job in Paige, review it, and wait for the export.
2. Check the flow's run history: one successful run. On the share: the PDF in `files`, and the day's index file with one record.
3. Run the DIP process (or wait for its schedule). **What you should see:** in the OnBase Client, the document under its document type with the keywords filled. The DIP verification report shows one document imported and no rejections.

## When it doesn't work

| Symptom | Where to look |
| --- | --- |
| DIP rejects the record | Field count doesn't match the format's field order, or a value doesn't fit its keyword type (date or currency format). Compare the record against the format. |
| DIP can't find the file | The File Path in the record isn't the path as seen by the DIP processing workstation; use a UNC path everyone resolves the same way. |
| File System steps fail | The on-premises data gateway is offline, or the gateway's account lacks write rights on the share. |
| The flow never runs | Wrong SFTP folder, or a subfolder. Files over 50 MB are skipped by this trigger. |
| Nothing arrives from Paige | Auto-export criteria aren't met, or the document was processed before you enabled auto export. Export once from the **Documents** page with **Export** and tick **FTP**. |

If the Paige side is the problem, contact Ademero support with the scan job name and the message from **Test Connection**.

## What's next

- [Connect Paige to any app with Zapier, Make, or Power Automate](https://help.ademero.com/paige/integrations/connect-paige-to-any-app-with-zapier-make-or-power-automate)
- [Integrate your own system with the Paige API](https://help.ademero.com/paige/integrations/integrate-your-own-system-with-the-paige-api)