Xerox

Xerox multifunction devices are supported by OptimiDoc through the Extensible Interface Platform (EIP) using Weblet technology. This page describes how the integration works under the hood, lists the supported models, outlines the available features and authentication methods, and documents known limitations and firmware requirements.

Xerox is an embedded-terminal vendor: OptimiDoc installs an EIP application on the device panel, can lock the panel behind authentication, release held jobs, run scan workflows, and account jobs through Xerox's Job Based Accounting (JBA).

Integration Method

OptimiDoc integrates with Xerox devices via EIP (Extensible Interface Platform) Weblets. A Weblet is a small application package installed on the device that provides a custom user interface on the device's touchscreen panel. The OptimiDoc Weblet provides:

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

• A pull-print job list for browsing and releasing held jobs.

• Scan-to-workflow integration for server-defined scan templates.

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

How the Integration Works

1. Installation and browser detection

When you install OptimiDoc onto a Xerox device, OptimiDoc first queries the device for its capabilities. It reads the panel canvas size to determine the screen resolution and detects which EIP browser generation the device supports (first, second, or third generation), then selects the highest generation available so the terminal renders correctly. OptimiDoc then:

• Reconfigures the device's authentication settings and registers the OptimiDoc EIP application for the detected browser.

• Enables the accounting web service on the device (via SNMP) if it is not already on.

• Optionally enables Job Based Accounting if accounting is used, and sets OptimiDoc as the default application if configured.

• When Device Authentication is enabled (and the method is not External Authentication), OptimiDoc enables screen blocking so the panel is locked until the user authenticates.

2. Authentication

OptimiDoc configures the device for off-box authorisation, pointing the device at an OptimiDoc validation web service. The login prompt is served by OptimiDoc, and the user authenticates with a card, PIN, or login/password at the panel. Access rights (copy, print, scan, colour) are enforced per user.

3. Job accounting (JBA, polled)

Xerox accounting uses Job Based Accounting (JBA). OptimiDoc periodically connects to the device's accounting endpoint (/acct/), downloads the accumulated job log, matches each entry against jobs released through OptimiDoc, writes the page/colour counters and cost into the accounting records, and then purges the device log so it does not grow unbounded. The accounting poll runs on a five-minute interval. Jobs performed outside OptimiDoc (walk-up copies, direct prints) are also captured and attributed to the matching user, or to the administrator account if the user cannot be resolved. On VersaLink devices OptimiDoc adjusts the JBA payload line endings automatically.

4. Remote login and logout

Xerox supports remote login/logout — a user can be logged in or forcibly logged out at the device from the OptimiDoc web/mobile app. OptimiDoc calls the device's smart-authentication web service to initiate a login session or force a logout (allowing any in-progress job to finish).

5. Uninstallation

Uninstalling removes the OptimiDoc EIP application, disables JBA accounting, resets the default application, and deregisters the Weblet, returning the device to its previous state.

Login reliability (26.07): The encrypted authentication ticket sent to Xerox panels has been slimmed to fit within the device's HTTP header buffer limits. Previously, very long department names (or other long user fields) could inflate the ticket past the buffer and break login with "Invalid server response" even though the server had authenticated the user successfully. This is now fixed.

Authentication Methods

OptimiDoc supports the following authentication methods for Xerox devices:

Preauthorisation is a separate device option (see below) rather than an authentication method.

Separate Print and Scan Applications

Xerox devices support separate application registration. Instead of a single OptimiDoc application on the device panel, the administrator can register separate Print and Scan applications. This allows users to navigate directly to the desired function from the device's home screen without first entering the OptimiDoc terminal. When separate apps are registered, OptimiDoc's status check verifies both the Print and Scan applications independently.

Default Application

Xerox devices support the Default Application setting. When enabled, the OptimiDoc terminal is automatically launched when the device starts up or when a user session begins.

Preauthorisation

Xerox devices support the Preauthorisation feature. When preauthorisation is enabled, a device can be configured with a pre-assigned user identity. The user is automatically authenticated when they approach the device, without needing to enter credentials or tap a card. This is typically used in environments where a device is dedicated to a specific user or a small workgroup.

EIP Browser Generations

Xerox devices use different generations of the EIP browser engine depending on the device model and firmware version. OptimiDoc detects the supported generation during installation and selects the highest one available:

The Legacy terminal layout is used for 1st generation devices, whilst the Classic and Modern layouts are available for 2nd and 3rd generation devices.

Supported Models

AltaLink Series

VersaLink Series

Supported Features

Prerequisites

Before installing the OptimiDoc Weblet on a Xerox device:

1. Enable EIP services. On the device web interface, navigate to Properties > Connectivity > Setup > Weblet Management and ensure that Weblet installation is allowed.

2. Install a custom EIP Weblet policy (if required). Some devices require the administrator to accept custom Weblets via the security policy settings.

3. Enable HTTPS on the device. EIP Weblets require a secure connection.

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

5. Provide device admin credentials to OptimiDoc for remote Weblet installation.

Known Limitations

• VersaLink B400/C400 series: These smaller desktop models support pull printing and card authentication but do not have scan workflow integration due to panel limitations.

• EIP policy restrictions: Some organisations configure Xerox devices to reject unsigned Weblets. In these environments, the OptimiDoc Weblet must be signed with a trusted certificate or the policy must be relaxed.

• Firmware auto-updates: Automatic firmware updates on Xerox devices may remove installed Weblets. Disable automatic updates or re-deploy the Weblet after firmware changes.

Firmware Update Notes

Xerox periodically releases firmware updates that may affect EIP compatibility. Before updating:

1. Check the OptimiDoc release notes for known firmware compatibility issues.

2. Update a single test device first and verify all OptimiDoc features.

3. After updating, check that the Weblet is still installed and operational.

4. Review the OptimiDoc logs for any communication errors with the updated device.

In Summary

Xerox devices integrate through EIP Weblets over HTTPS. OptimiDoc detects the device's EIP browser generation, installs a terminal, optionally locks the panel with screen blocking, and enforces per-user access rights via off-box authorisation. Jobs are accounted through Xerox Job Based Accounting, which OptimiDoc polls and purges every five minutes, capturing both released and walk-up jobs. Remote login/logout from the OptimiDoc app is supported, and separate Print/Scan applications can be registered for direct home-screen access.

Related articles

• Managing Devices

• Device Communication Failures

• Supported Devices