OptimiDoc Server Help Center
OptimiDoc Server Help Center
Breadcrumbs

Settings

The Settings section provides centralised configuration for all core OptimiDoc server parameters. Email delivery, inbound FTP scan reception, print policy, branding, card-reader authentication, scan processing and multi-server cluster deployment are all managed here from a single administration screen.

https://optimidoc.atlassian.net/wiki/download/attachments/42631189/settings-overview.png?api=v2

Overview

Settings live in the React administration interface under Settings (route /config), which is the primary admin UI — the root URL redirects to it, and the legacy MVC interface remains available at /old. The page is organised into seven tabs, presented in this order: Mail, FTP, Print, Appearance, Cluster, Scan and Authentication. All of them are served by a single administrator-only API (api/v3/config), so access is restricted to users with the Admin role.

Each tab has its own Save button and settings are persisted the moment you click it. Some changes — cluster addressing, the authentication method, or the shared spooler path — only take full effect after the OptimiDoc service is restarted.

Settings Pages

Page

Description

Mail Configuration

Configure the global SMTP server and OAuth 2.0 authentication (Google or Microsoft) used for all system-generated email — notifications, reports, PIN and password messages, and rule email actions.

FTP Configuration

Point OptimiDoc at an external FTP server and a watched local folder used to receive scans from Konica Minolta and Epson devices. This is an inbound ingestion path, not a scan-to-FTP output destination.

Print Settings

Control print queue behaviour, job retention periods, billing codes (formerly Projects) and quotas, the preview analyser, the shared spooler, and the login normalisation regex.

Appearance and Skin

Customise the interface with four brand colours, upload the four logo/background images, set the number of decimal places for amounts, and define the device login welcome message.

Cluster Configuration

Configure a multi-server deployment: the shared cluster IP/DNS, this node's local DNS name, and the Xerox strict-security workaround.

Scan Settings

Set the maximum number of concurrent OCR tasks and the Scan2OD watched folder used for file-based scan ingestion.

Authentication (Card Reader)

Select the card reader type and build the card-number conversion pipeline, with a wizard that matches your reader's raw and expected output against a library of known conversions.

Key Capabilities

  • Email delivery — one global SMTP identity with Login & Password, Google OAuth or Microsoft OAuth authentication

  • Brand customisation — four theme colours (light, dark, text, menu), four images (logo, inverse logo, login logo, login background), a welcome message and amount decimal places

  • Cluster deployment — multi-server high-availability configuration with a shared address and per-node DNS

  • Authentication flexibility — HP CZ208A, RF Ideas and other readers, with a configurable card-number conversion pipeline

  • Print control — billing-code tracking, quota enforcement, preview analysis, job retention and shared-spooler management

  • Scan processing — OCR task throttling and watched-folder ingestion

Getting Started

  1. Begin with Mail Configuration to ensure the server can send notifications and reports.

  2. Configure Print Settings to match your organisation's print policy requirements.

  3. Set up Authentication (Card Reader) if you use card-based device authentication.

  4. Customise Appearance and Skin to apply your organisation's branding.