OptimiDoc Server Help Center

Epson

Epson WorkForce Enterprise multifunction devices are supported by OptimiDoc through the Epson Open Platform. This page describes how the integration works under the hood, lists the supported models, outlines available features and authentication methods, and documents known limitations and firmware requirements.

Epson is an embedded-terminal vendor: OptimiDoc installs a web terminal on the device panel, can lock the panel behind authentication, release held jobs, and drive the device's native scan engine.


Integration Method

OptimiDoc integrates with Epson devices via the Epson Open Platform framework, which enables third-party applications to provide custom workflows on Epson's enterprise-class devices. The OptimiDoc application provides:

  • A custom login screen for card, PIN, and username/password authentication.

  • A pull-print job list for releasing held print jobs at the device.

  • Scan-to-workflow support using the device's native scan engine.

The application is deployed remotely from the OptimiDoc web interface and communicates with the server over HTTP/HTTPS.


How the Integration Works

1. Installation

When you install OptimiDoc onto an Epson device, OptimiDoc:

  1. Generates and stores the device access code (see below) if one is not already present.

  2. Creates an optimidoc access-control user on the device and grants it the copy, colour print, scan, and print functions.

  3. Configures the device's Open Platform server connection with three OptimiDoc URLs — the login page, the notification callback (/api/epson), and the terminal home page.

  4. Reads the device's screen resolution so the terminal renders correctly.

2. Authentication

Users authenticate at the panel with a card, PIN, or login/password. OptimiDoc also supports remote login and logout — a user can be logged in or out at the device from the OptimiDoc web/mobile app, which calls the device's Open Platform authorisation API.

3. Job accounting (job log, cursor-tracked)

Epson reports completed jobs through a device job log. OptimiDoc keeps a cursor (the last processed sequential job number); when the device sends a notification, OptimiDoc reads the new entries from the log and creates the corresponding accounting records. Print jobs released through OptimiDoc are de-duplicated; copy, scan, and fax jobs performed at the device are recorded as walk-up activity.

Accounting reliability (26.07): On installation, OptimiDoc now walks the paginated job log to find the true highest job number before setting its cursor. Previously it read only the first page (about 150 entries) and could set the cursor to an older page's maximum on devices with a large log — which rewound the counter and caused the next notification to re-process the gap, creating duplicate copy/scan/fax accounting records. The cursor now only ever advances, so re-installing a device no longer produces duplicate accounting (OP-1479).

4. Scan path (native)

Scanning uses the device's native engine: OptimiDoc sends the scan parameters and an FTP destination to the Open Platform, the device scans and delivers the file to the OptimiDoc server over FTP, and the server processes it according to the scan template. For multi-page documents the device prompts the user to confirm when all pages have been scanned.

5. Uninstallation

Uninstalling clears the optimidoc access-control user and the Open Platform server settings, returning the device to its previous state.


Authentication Methods

Epson devices support device-authentication methods only (onlyDevice: true). Single Sign-On, User List, and External Authentication are not available.

Method

Requires Device Auth

Description

PIN

No

User enters a numeric PIN code to authenticate.

Login and Password

No

User enters a username and password.

Card

Yes

User taps a card on the device's card reader.

Card or PIN

Yes

User may authenticate with either a card tap or a PIN code.

Card or Login and Password

Yes

User may authenticate with either a card tap or credentials.

Note: Epson devices do not support Single Sign-On, User List, External Authentication, or the combined Card and PIN / Card and Login and Password methods.


Terminal Layout

Epson devices support the OptimiDoc web terminal. The Legacy layout is not offered for Epson (showLegacyLayout: false); the available layouts are:

Layout

Available

Description

Legacy

No

Not offered for Epson devices.

Classic

Yes

Standard web terminal with optimised navigation.

Classic (Large Display)

Yes

Optimised for devices with large touchscreen panels.

Classic (Small Display)

Yes

Optimised for devices with compact touchscreen panels.

Modern

Yes

The latest terminal design with enhanced visual elements.


Default Application

Epson devices support the Default Application setting (showDefaultApp: true). When enabled, the OptimiDoc terminal is automatically launched when the device starts up or when a user session begins.


Scan Workflow

Epson devices support an expanded scan workflow that leverages the device's native scanning capabilities:

  • Native device scan: OptimiDoc configures the scan destination (FTP) directly on the Epson device's Open Platform, allowing high-speed scanning through the device's native scan engine.

  • Multi-page scan confirmation: When scanning multi-page documents, the device prompts the user to confirm when all pages have been scanned before finalising the scan job.

  • FTP-based delivery: Scanned documents are delivered to the OptimiDoc server via FTP, where they are processed according to the configured scan template and routed to the appropriate destination.


Access Code Security

Epson devices use an access code mechanism to protect communication between the device and the OptimiDoc server. The access code is:

  • Generated automatically during device installation.

  • Derived from the device's IP address using a hash function (8-digit code, left-padded with zeros).

  • Stored in the device configuration and used to authenticate API requests.

  • Unique per device — each device has its own access code based on its IP address.

The access code is managed automatically by OptimiDoc and does not require manual configuration.


Supported Models

WorkForce Enterprise Series

Model

Minimum Firmware

Notes

WorkForce Enterprise WF-C20590

Latest firmware recommended

Full pull print support

WorkForce Enterprise WF-C20750

Latest firmware recommended

Full pull print support

WorkForce Enterprise WF-C21000

Latest firmware recommended

Full pull print, scan support

WorkForce Enterprise AM-C4000

Latest firmware recommended

Full pull print, scan support

WorkForce Enterprise AM-C5000

Latest firmware recommended

Full pull print, scan support

WorkForce Enterprise AM-C6000

Latest firmware recommended

Full pull print, scan support

RIPS (Replaceable Ink Pack System) Series

Model

Minimum Firmware

Notes

WorkForce Pro WF-C879R

Latest firmware recommended

Pull print via IPP; no embedded agent

WorkForce Pro WF-C878R

Latest firmware recommended

Pull print via IPP; no embedded agent


Supported Features

Feature

Status

Notes

Pull print (release at device)

Supported

Card, PIN, or username/password authentication on Enterprise models

Scan to workflow

Supported

Native device scanning via FTP with multi-page confirmation

Copy/print accounting

Supported

Job-log based, with cursor tracking to avoid duplicates

Card authentication

Supported

USB card readers on Enterprise models

PIN authentication

Supported

Configurable PIN length

Device monitoring (SNMP)

Supported

Ink levels, paper trays, page counts

Agent remote installation

Supported

On Enterprise models with Open Platform

Remote login/logout

Supported

Log in or force logout from the OptimiDoc web/mobile app

IPP pull print

Supported

For models without embedded agent support

Default application

Supported

Auto-launch OptimiDoc terminal


Prerequisites

Before installing the OptimiDoc application on an Epson device:

  1. Verify Open Platform support. Only WorkForce Enterprise models support the Epson Open Platform for embedded applications. RIPS models use IPP-based pull printing instead.

  2. Enable Open Platform on the device. Navigate to the device web interface > Admin Settings > Open Platform and enable the platform.

  3. Enable HTTPS on the device for secure communication.

  4. Configure SNMP for device monitoring. Set up SNMPv2c with the community string matching the OptimiDoc configuration.

  5. Note the device administrator credentials for remote application deployment.


IPP Pull Print for Non-Enterprise Models

Epson RIPS models (WF-C879R, WF-C878R) and other Epson devices that do not support the Open Platform can still participate in pull printing using the IPP (Internet Printing Protocol) method:

  1. Configure an IPP pull-print queue in OptimiDoc (see IPP Pull Printer Setup).

  2. Users print to the IPP queue from their workstation.

  3. Jobs are held on the OptimiDoc server.

  4. Users release jobs from the OptimiDoc web interface or a nearby device with an embedded agent.

This method does not provide device-panel authentication or scan workflow integration but still delivers secure pull printing.


Known Limitations

  • Legacy layout not available: The Legacy terminal layout is not offered for Epson devices. Use Classic, Classic Large Display, Classic Small Display, or Modern instead.

  • No SSO or External Auth: Epson devices only support device-authentication methods. Single Sign-On, User List, and External Authentication are not available.

  • Scan workflow availability: Scan-to-workflow is only available on the newest WorkForce Enterprise models (AM-C series and WF-C21000). Older models do not support server-initiated scan workflows through the Open Platform.

  • Open Platform maturity: Epson's Open Platform is newer than competing vendor platforms (Konica Minolta OpenAPI, Xerox EIP, HP OXPd). Some advanced features may not yet be available.

  • Card reader compatibility: Epson Enterprise devices support USB HID card readers. Verify compatibility with the specific reader model before deployment.

  • Copy accounting detail: Copy accounting on Epson devices may provide less granular data (e.g. no paper size breakdown) compared to other vendors.


Firmware Update Notes

Epson firmware updates for Enterprise devices may affect Open Platform compatibility:

  1. Always check the OptimiDoc release notes for Epson firmware compatibility information.

  2. Test firmware updates on a single device before rolling out to the fleet.

  3. After updating, verify the OptimiDoc application is still installed and all features work correctly.

  4. If the application is removed during a firmware update, redeploy it from the OptimiDoc web interface.


In Summary

Epson devices integrate through the Epson Open Platform, secured with a per-device access code. OptimiDoc installs a web terminal (Legacy layout excluded), locks the panel with device-authentication methods, drives the device's native scan engine over FTP, and accounts jobs from the device job log using a cursor that never rewinds — so re-installing a device no longer risks duplicate accounting. Remote login/logout from the OptimiDoc app is supported. Models without Open Platform can still be used for IPP pull printing.


Related articles