ControlSuite Help
Welcome to Kofax ControlSuite
Install and Configure ControlSuite
ControlSuite overview
Equitrac overview
AutoStore overview
Output Manager overview
Business Connect overview
Preparing to install ControlSuite
Security Framework Service and Datacenters
Understanding Security Framework Datacenters
Configure Security Framework servers
Reset the Security Framework Service password
Backup and restore the Security Framework Service node
Configuring the backup
Restoring a backup to a new machine
Remove a node from the Security Framework Service
Delete a live node manually
Delete a dead node manually
Clean up dead node Service Registrations
Decommission a live node automatically
Remove a node in Configuration Assistant
Security client configuration utility
Single Server Deployment
Single server deployment guidelines
Performance impacts
Installing ControlSuite
ControlSuite installation overview
Install ControlSuite in a production environment
Install ControlSuite in a demo environment
Equitrac installation overview
Install Equitrac in a production environment
Install Equitrac in a demo environment
Add Equitrac server components to an existing Equitrac environment
Upgrade Equitrac
Equitrac print submission high availability for DRE
Print submission high availability
High availability for DRE options
Hyper-V cluster
Create a highly available VM on a Hyper-V cluster
Network load balancer
Client and server network printing protocols
Client workstation traffic flow
DRE considerations
Layer 4 load balancing
Add the IP address variable
Add environment variable
Load balancing IPP print queues
Load balancing SMB print queues
Load balancing LPD print queues
Equitrac print release high availability
Print release HA configuration workflow
Network load balancer
Load balancing for print release
Configure a virtual service
Create a DNS record
Add a loopback adapter
Add the IP address variable
Configure weak host model commands
Print release high availability server deployment
Install DCE in an high availability setup
Configure certificate pinning
Monitor DCE health in a cluster
AutoStore installation overview
Install AutoStore in a production environment
Install AutoStore in a demo environment
Output Manager installation overview
Install Output Manager in a production environment
Install Output Manager in a demo environment
Install the Output Manager Web Console
Install the Output Manager Web Kiosk
Output Manager in a high availability environment
Install Output Manager for high availability
Install the Output Manager Web Console for high availability
Install the Output Manager Web Kiosk for high availability
SAP NetWeaver integration
Establish communication between SAP and Output Manager
Remote Function Call mode
Create the Remote Function Call connection
Create the Real Output Management System
Create the Logical Output Management System
Command line mode
Create the Real Output Management System
Create the Logical Output Management System
Configure operating system commands
Switch tasking modes
Create output devices
Register Output Manager
Configure Output Manager
Upgrade an Output Manager database on a remote SQL instance
Business Connect installation
Device Registration Service overview
Device Registration Service installation overview
Upgrading Device Registration Service
Upgrading Device Registration Service for a remote database
Database Upgrade Tool
Configure DRS
Using DRS Authentication Key
Configure AutoStore to work with a remote DRS server for Konica Minolta devices
How to start Device Registration Service
Migrating device configurations
Device Web Service installation overview
Advanced manual install
Install ControlSuite on multiple nodes
Create an offline installation package
ControlSuite component high availability support
Upgrading ControlSuite
Planning an upgrade
Prepare for an upgrade
Upgrade legacy version
Upgrade previous versions
Upgrade issues
Multi-server phased upgrade
ControlSuite versioning
Register ControlSuite in Azure Active Directory
Register a single-page application redirect URL in Azure AD
Register the Universal Print application manually in Azure AD
Silent installation and configuration
Run Install Assistant in silent mode
Run Configuration Assistant in silent mode
Configure Azure SQL for Equitrac in silent mode
Configure Universal Print in silent mode
Configuring ControlSuite
Modify databases
Configure Output Manager for high availability
Configure Output Manager with SAP in a high availability environment
Configure Microsoft 365 for Output Manager
Create a Microsoft 365 application
Configure the Microsoft 365 application for ControlSuite
Licensing ControlSuite
Licensing AutoStore
Uninstall ControlSuite
Remove Configuration Data
System Requirements
Equitrac Requirements
AutoStore Requirements
Output Manager Requirements
Business Connect Requirements
Device Registration Service (DRS) Requirements
Device Web Server (DWS) Requirements
License Server Requirements
Communication Ports
ControlSuite core communication ports
Equitrac communication ports
AutoStore communication ports
Output Manager communication ports
DRS and Client communication ports
Business Connect communication ports
AutoStore
AutoStore overview
Introduction
What is AutoStore?
AutoStore server architecture
Required components
AutoStore object model
Configurations
Components
Tasks
Workflows
AutoStore Applications and Tools
AutoStore Process Designer
License Manager
Status Monitor
Service Manager
AutoCapture
WebCapture
Help
Runtime Replacement Tags (RRTs)
RRT Syntax
How RRTs work
Using RRTs
Windows RRT
Encrypted Field RRTs
AutoStore Process Designer
Welcome to AutoStore Process Designer
Using AutoStore Process Designer
Start AutoStore Process Designer
Working with configurations
Create a new configuration
Use a template to create a new configuration
Open an existing configuration file
Save a configuration file
Close a configuration file
Working with tasks
Add a task to a configuration
Add tasks from a template
Edit tasks in a configuration
Edit task properties
Delete a task from a configuration
Working with components in a task
Select a component
Add a component to a task
Edit component properties
Remove a component from a task
Working with configuration templates
Create a configuration template
Save selected tasks to a template file
Create a configuration from a template
Add tasks from a template to a configuration
Verify or change the AutoStore template directory
Running processes in AutoStore Process Designer
Run the currently open configuration
Stop running a configuration
Restart the running configuration
Change the default configuration run by AutoStore
Monitor, isolate, or disable a component that is creating issues
Isolate or disable a task that is creating issues
AutoStore Process Designer user interface
APD Options dialog box
Task Properties dialog box
Isolated Component Properties dialog box
Isolated Task Properties dialog box
Ribbon
File menu
Home tab
View tab
Capture Components
AutoCapture
Welcome to AutoCapture Server component
Getting started
Feature highlights
Licensing AutoCapture Server
Using the AutoCapture Server component
Installing AutoCapture client
Configuring Autocapture Server
Menu tab
Adding a Group, Menu, Form, or Action
Group
Menu
Form
Backend Browser dialog box
Boolean Properties dialog box
Button
Date/Time Properties dialog box
DB Lookup dialog box
General SQL syntax
Label Properties dialog box
Number Properties dialog box
String Properties dialog box
String List Properties dialog box
String Multiline Properties dialog box
OpenScan SnapIt
Regular Expression
AutoCapture XML Schema
AutoCapture Default XSLT Style Sheet (AC.xslt)
Action
Use a backend browse field
Editing a Group, Menu, Form, or Action
Remove a Group, Menu, Form, or Action
Preferences tab
AutoCapture Component RRTs
VBScript interface
AutoCapture Server events
Form_OnLoad event
Form_OnValidate event
Field_OnChange event
Field_OnValidate event
Button_OnClick event
AutoCapture Server objects
Form object
GetFieldValue method
SetFieldValue method
StatusMsg method
ErrorMsg method
WarningMsg method
TraceMsg method
Fields object
BooleanField object
DateField object
LabelField object
ListField object
AddListItem method
NumberField object
StringField object
Restrictions and limitations
Troubleshooting tips
Batch Importer
Welcome to the Batch Importer component
Getting started
Feature highlights
Using Batch Importer
Configuring Batch Importer
Workspace tab
Field Setting tab
Component Settings tab
Component RRTs
Troubleshooting tips
Restrictions and limitations
POP3 Email
Welcome to the POP3 eMail component
Getting started
Feature highlights
Use the POP3 eMail component
Use Modern Authentication / OAuth2 and Token Vault
Configuring the POP3 eMail component
General tab
Component Setting tab
POP3 eMail component RRTs
Configuring Modern Authentication / OAuth2
Register a Microsoft 365 application for Token Vault
Set the permissions of the Microsoft 365 application
Register a Microsoft 365 authorization provider
Authorize the Authorization Provider
Configure the component
End user authorization
Troubleshooting tips
Verify the connection to a POP3 mail server
Restrictions and limitations
FTP Poll
Welcome to the FTP Poll component
Getting started
Feature highlights
Using the FTP Poll component
Configuring the FTP Poll component
Main component window
Add/Edit FTP Site dialog box
General tab
FTP tab
Folder Path dialog box
Files tab
Schedule tab
Components tab
Advanced tab
FTP Poll component RRTs
Restrictions and limitations
Troubleshooting tips
IMAP Capture
Welcome to IMAP Capture
Getting started
Feature highlights
Use the IMAP Capture component
Use Modern Authentication / OAuth2 and Token Vault
Configuring the IMAP Capture component
IMAP Capture main configuration window
IMAP Account Settings dialog box
Email Class Configuration dialog box
General tab
Custom Query
Components tab
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Microsoft 365 application
Set the permissions of the Microsoft 365 application
Register a Microsoft 365 authorization provider
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and limitations
Troubleshooting tips
Interactive Capture
Welcome to the Interactive Capture component
Getting started
Feature highlights
Web user interface
Use the Interactive Capture component
Use the dynamic form
Configuring the Interactive Capture component
Interactive Capture dialog box
Menus tab
Forms
General tab
Fields tab
Backend Browser field
Button field
Check Box field
Date field
Label field
List field
Lookup List field
General SQL syntax
Numeric field
Popup Input field
Popup Message field
Signature field
Text field
Tree field
Add/Edit Tree Item dialog box
Extended Field Properties
Components tab
Send To Email Fields tab
Send to Folder Fields tab
Send to SharePoint tab
Menu Properties dialog box
Save Form as Template dialog box
Create Form from Template dialog box
Use a backend browse field
Preferences tab
Extended Field Property Manager
Authentication tab
Authentication Fields dialog box
LDAP Lookup Settings dialog box
Mobile Server tab
Script Editor
Custom Styling in Interactive Capture
Interaction through WCF endpoint
Licensing the Interactive Capture component
Interactive Capture component RRTs
Restrictions and limitations
Troubleshooting tips
Knowledge Package Loader Capture
Welcome to Knowledge Package Loader Capture component
Getting started
Feature highlights
Using Knowledge Package Loader Capture
Configuring Knowledge Package Loader Capture
General tab
Components tab
Knowledge Package Loader Capture component RRTs
Troubleshooting tips
Restrictions and limitations
Multi-Poll
Welcome to the Multi-Poll component
Getting started
Feature highlights
Using the Multi-Poll component
Configuration walkthrough
Configuring the Multi-Poll component
Description of the search engine
Folders tab
Configurations tab
RRTs' Format tab
Custom date-time format strings
Misc tab
Multi-Poll component RRTs
Restrictions and limitations
MFD Capture
Welcome to MFD Capture
Getting started
Settings
Groups tab
Group Settings dialog box
Menu properties dialog box
Forms
Basic form settings
General tab (Form Settings dialog box)
Scan settings
Fields tab (Form Settings dialog box)
Components tab (Form Settings dialog box)
Email form
Folder form
SharePoint form
Field types
Button field options
Checkbox field options
Date field options
Date formats
Label field options
Lookup List field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Form template dialog boxes
Preferences tab
Authentication tab
LDAP Lookup Settings dialog box
Authentication Prompts dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
Ricoh SOP
Welcome to Ricoh SOP
Supported devices
Using the Ricoh SOP component
Managing groups
Adding and editing groups
Menus in a group
Adding and editing forms in a group
Configure Ricoh SOP preferences
Configuring authentication
Ricoh SOP settings
Groups tab
Group Settings dialog box
Menu Properties dialog box
Forms
Basic form
General tab (Form Settings)
Scanning Settings
Fields tab (Form Settings)
Components tab (Form Settings)
Email form
Folder form
SharePoint form
Field types
Button field options
Checkbox field options
Date field options
Date formats
Label field options
List field options
Lookup List field options
General SQL syntax
Numeric field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Form template dialog boxes
Preferences tab
Authentication tab
LDAP Lookup Settings dialog box
Authentication Prompts dialog box
Ricoh SOP component RRTs
RightFax Capture
Welcome to RightFax Capture
Getting started
Feature highlights
Use RightFax Capture
Configuring RightFax Capture
General tab
Received Faxes tab
Sent Faxes tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
SFTP Poll
Welcome to the SFTP Poll component
Getting started
Feature highlights
Using the SFTP Poll component
Configuring the SFTP Poll component
Main window
Add/Edit SFTP Site dialog box
General tab
SFTP tab
Files tab
Schedule tab
Components tab
Advanced tab
SFTP Poll component RRTs
Restrictions and limitations
Troubleshooting tips
Sharp MFP (OSA)
Welcome to the Sharp MFP (OSA) component
Feature highlights
Use the Sharp MFP component
Configuring the Sharp MFP Capture component
Groups tab
Group Settings dialog box
Adding and editing forms in a group
Basic Form Settings dialog box
Send to Email form
Folder Form Settings
Using form templates
Create a form template
Create a form from a template
Field types
Checkbox field
List field
Text field
Tree field
Preferences tab
Authentication tab
Sharp MFP (OSA) component RRTs
Device setup and configuration
Configuring the device to connect to a Sharp OSA web application
Scanning a document from the device
Restrictions and limitations
Troubleshooting tips
SMTP Capture
Welcome to SMTP capture component
Getting started
Feature highlights
Using SMTP capture component
Configuring the SMTP capture component
SMTP Subjects tab
Subject Configurations dialog box
Examples of expression matching
SMTP Gateway tab
Security tab
Preferences tab
Certification Configuration dialog box
SMTP Capture component RRTs
Troubleshooting tips
Restrictions and limitations
Workflow Job Submission
Welcome to Workflow Job Submission
Getting started
Feature highlights
Using Workflow Job Submission
Configuring the Workflow Job Submission component
Workflows tab
Workflow Definition dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
Web Capture
Welcome to the Web Capture component
Getting started
Feature highlights
Web user interface
Use the Web Capture component
Use the dynamic form
Configuring the Web Capture component
Web Capture dialog box
Menus tab
Forms
General tab
Fields tab
Backend Browser field
Button field
Check Box field
Date field
Label field
List field
Lookup List field
General SQL syntax
Numeric field
Popup Input field
Popup Message field
Signature field
Text field
Tree field
Add/Edit Tree Item dialog box
Extended Field Properties
Components tab
Send To Email Fields tab
Send to Folder Fields tab
Send to SharePoint tab
Menu Properties dialog box
Save Form as Template dialog box
Create Form from Template dialog box
Use a backend browse field
Preferences tab
Extended Field Property Manager
Authentication tab
Authentication Fields dialog box
LDAP Lookup Settings dialog box
Mobile Server tab
Script Editor
Custom Styling in Web Capture
Interaction through WCF endpoint
Licensing the Web Capture component
Web Capture component RRTs
Restrictions and limitations
Troubleshooting tips
Unified Client
Welcome to Unified Client
Supported devices
Scripting overview
Scripting samples
CSV samples
LDAP samples
SQL samples
Configuring authentication
Custom Scripting authentication
Optional
LDAP Lookup Settings dialog box
Integration with MFP authentication
Managing groups
Adding and editing groups
Unified Client settings
Groups tab
Group Settings dialog box
Menu Properties dialog box
Forms
Basic form
General tab (Form Settings)
Configuring the Scanning Settings
Brother Scanning Settings
Scanning Settings
Canon Scanning Settings
Scanning Settings
HP Scanning Settings
Scanning settings
Konica Minolta Scanning Settings
Scanning settings in AutoStore
Lexmark Scanning Settings
Scanning settings
Ricoh SOP Scanning Settings
Scanning Settings
Samsung UX Scanning Settings
Scanning Settings
Toshiba Scanning Settings
Scanning Settings
Xerox scanning settings
Scanning settings
Scanning settings constraints
Fields tab (Form Settings)
Components tab (Form Settings)
Email form
Folder form
SharePoint form
Field types
Button field options
Checkbox field options
Date field options
Date formats
Label field options
List field options
Lookup List field options
General SQL syntax
Numeric field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Form template dialog boxes
Restrictions
Preferences tab
Authentication tab
LDAP Lookup Settings dialog box
Authentication Prompts dialog box
User Attribute Retrieval from Azure Active Directory dialog box
Unified Client component RRTs
Unified Client communication ports
Universal Capture
Welcome to Universal Capture Component
Getting started
Configuring the Universal Capture component
General tab
RRT manager tab
How to add a new Document Class
Components tab
Universal Capture Component RRTs
Authentication methods
Restrictions and limitations
Troubleshooting tips
Process Components
Barcode
Welcome to the Barcode component
Getting started
Feature highlights
Use the Barcode component
Configuring the Barcode component
General tab
Setup Zoned Barcodes dialog box
Scripts List dialog box
Script Properties dialog box
Script Editor
Script Variable dialog box
Script examples
Splitting example #1
Splitting example #2
Splitting example #3
Field Values tab
Barcode Location dialog box
Advanced tab
PDF color and compression
PDF rasterization quality
Additional options of document splitting
Enhance barcodes detection
Despeckle filter
OCR resolution filter
Fill gaps less than filter
Dilate black pixels filter
Dilate white pixels filter
Detect Best Settings dialog box
Detected Preprocessing Options dialog box
Component RRTs
Global set RRTs
Named set RRTs
Barcode script RRTs
Restrictions and limitations
Troubleshooting tips
Bates Stamp
Welcome to Bates Stamp
Getting started
Feature Highlights
Using Bates Stamp
Configuring Bates Stamp
General Tab
Bates Stamp Server Administration Dialog Box
Stamps Tab
Stamp Properties
Stamp Elements
Stamp Element Properties
Text Macros
Preview Stamp
Request Properties
Stamp Groups Tab
Stamp Group Properties Dialog Box
Group Stamps Dialog Box
Users Tab
User Properties Dialog Box
User Groups Dialog Box
Stamp Tab
Font Tab
Position Tab
Select Zone Dialog Box
Preview
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Binder
Welcome to Binder Component
Getting started
Feature Highlights
Using Binder
Configuring the Binder component
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Command Line Execution
Welcome to Command Line Execution
Getting started
Feature Highlights
Using Command Line Execution
Configuring Command Line Execution
General tab
Document tab
Authentication tab
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Data Filter
Welcome to Data Filter
Getting started
Feature highlights
Using Data Filter
Configuring Data Filter
Filter dialog boxes
Clean Up
Concatenate
Contains
Ends With
Equals To
Evaluate Expression
Format Date
Format Time
Lookup in DB
General tab
Data Source dialog box
Select Data Source dialog box
Select Table dialog box
Output Columns tab
Select Column dialog box
Conditions Tab
Condition Dialog Box
Select Column dialog box
Result tab
Select Column dialog box
Make Lower Case
Make Upper Case
Match Regular Expression
Test Regular Expression dialog box
Parse CSV
Replace
Test Regular Expression dialog box
Split
Starts With
Trim
Validate
Component RRTs
Restrictions and limitations
Troubleshooting tips
Directory Services
Welcome to Directory Services component
Getting started
Feature highlights
Using Directory Services
Directory Services basic concepts
Configuring Directory Services
Connection tab
Select User From Directory dialog box
Search Requests tab
Requests
Add/Edit Request dialog box
Alternate Logon dialog box
Attributes
Attributes List dialog box
Add New Attribute/Edit Attribute Properties dialog box
LDAP search filters
Build Simple Filter dialog box
Add/Edit Filter Item dialog box
Select Attribute Name and Value dialog box
LDAP filters formal definition
Search Scope Properties dialog box
Test Results dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
Document Transformation
Welcome to the Document Transformation component
Getting started
Feature highlights
Use the Document Transformation component
Configuring the Document Transformation process component
General tab
Watermark
User Stamping
Basic Transformation
Component RRTs
Restrictions and limitations
Troubleshooting tips
Document Writer
Welcome to the Document Writer component
Getting started
Feature highlights
Use the Document Writer component
Configuring the Document Writer component
Component RRTs
Restrictions and limitations
Troubleshooting tips
File Options
Welcome to the File Options component
Getting started
Feature highlights
Using the File Options component
Configuring the File Options component
File Options tabs
File Options component RRTs
Restrictions and limitations
Troubleshooting tips
Form Overlay
Welcome to Form Overlay
Getting started
Feature Highlights
Using Form Overlay
Configuring Form Overlay
General tab
Field Properties dialog box
General tab
Field tab
Font tab
Position tab
Advanced tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
HL7 Messenger
Welcome to HL7 Messenger
Getting started on HL7
HL7 Feature highlights
Using HL7 Messenger
Configuring HL7
General tab
Message Editor tab
HL7 Component RRTs
Welcome to CDA Builder
Getting started on CDA Builder
CDA Builder Feature highlights
Using CDA Builder
Configuring CDA Builder
CDA Builder configuration UI
XML Element Editor
CDA Builder component RRTs
Restrictions and limitations
Troubleshooting tips
Knowledge Package Builder
Welcome to Knowledge Package Builder
Getting started
Feature highlights
Using Knowledge Package Builder
Licensing Knowledge Package Builder
Configuring Knowledge Package Builder
General tab
Field Values tab
Knowledge Package Builder component RRTs
Troubleshooting tips
Restrictions and limitations
Knowledge Package Loader Process
Welcome to Knowledge Package Loader Process component
Getting started
Feature highlights
Using Knowledge Package Loader Process
Configuring Knowledge Package Loader
Knowledge Package Loader options
Knowledge Package Loader component RRTs
Troubleshooting tips
Restrictions and limitations
Notification options
Welcome to Notification component
Getting started
Feature highlights
Using the Notification component
Configuring the Notification component
Notification Options Configuration dialog box
On Success/Failure Notification dialog box
Notification component RRTs
Troubleshooting tips
Office to PDF Converter
Welcome to Office to PDF Converter
Getting started
Feature highlights
Using Office to PDF Converter
Configuring OfficeConverter
General tab
Extension tab
Settings tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
OmniPage Barcode
Welcome to OmniPage Barcode
Getting started
Component features
Using the OmniPage Barcode component
Reference
General tab
Setup Zoned Barcodes dialog box
Script List dialog box
Split example
Field Values tab
Barcode Location dialog box
Advanced tab
Barcode migration
Component RRTs
Restrictions and limitations
Troubleshooting tips
OP Binder
Welcome to OPBinder Component
Getting started
Feature Highlights
Using Binder
Configuring the OPBinder component
OPBinder Dialog Box
Advanced Tab
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
OP Image Processing
Welcome to the OP Image Processing
Getting started
OP Image Processing Configuration
Component RRTs
Restrictions and limitations
Troubleshooting tips
OPOCR
Welcome to the OP OCR component
Getting started
Feature highlights
Using the OP OCR component
Recognizing text in scanned documents
Recognizing text in faxes
Configuring OCR
General tab
Languages dialog box
Select Language dialog box
Format Settings dialog box
RTF/DOCX tab
RTF/DOCX Fields dialog box
PDF tab
PDF Encryption dialog box
PDF Fields dialog box
PDF Advanced Settings dialog box
PDF/A tab
PDF/A Fields dialog box
PDF/A Advanced Settings dialog box
PDF (Keep original) tab
HTML tab
HTML Fields dialog box
TXT tab
CSV tab
XLS/XLSX tab
XLS/XLSX Fields dialog box
PPTX tab
PPTX Fields dialog box
Setup Zoned OCR dialog box
Pages tab
Validation tab
Location tab
Test tab
Advanced tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Outlook MSG Loader
Welcome to Outlook MSG Loader
Getting started
Feature highlights
Using the Outlook Message Loader component
Configuring Outlook MSG Loader
Outlook MSG Loader dialog box
Outlook MSG Loader component RRTs
Troubleshooting tips
Restrictions and limitations
Professional Image Management
Welcome to the Professional Image Management component
Getting started
Feature highlights
Using the Image Management component
Configuring the Professional Image Management component
Image Processing tab
Split tab
Component RRTs
Troubleshooting tips
Restrictions and limitations
Redaction
Welcome to Redaction
Getting started
Feature Highlights
Using Redaction
Configuring Redaction
General Settings
Edit Redaction Profile
General Settings
Redaction Zones
Setup Redaction Zones
Pages tab
Location tab
Setup Dynamic Redaction Zones
Pages tab
Dictionary tab
Test Regular Expression
Regular Expression Syntax
Offset tab
Padding tab
Advanced Settings
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Virtual Image Processing
Welcome to the Virtual Image Processing component
Getting started
Feature highlights
Use Virtual Image Processing
Configuring the Virtual Image Processing component
Main dialog box
Edit Profile dialog box
Advanced Settings dialog box
PDF tab
XPS tab
Vector tab
Filters Configuration dialog boxes
Adaptive Thresholding
Color Dropping filter
Color Extraction filter
Color Resolution filter
Deskew filter
Despeckle filter
Dilation filter
Dot Remove filter
Flip filter
Invert filter
Inverted Text filter
Line Remove filter
Resize filter
Reverse filter
Rotate filter
Sharpen filter
Stretch intensity filter
Thresholding filter
Output Format dialog box
Advanced JPEG 2000 Options dialog box
Virtual Image Processing component RRTs
Restrictions and limitations
Troubleshooting tips
Workflow Tracker
Welcome to Workflow Tracker component
Getting started
Feature highlights
Using this component
Configuring the Workflow Tracker component
Workflow Tracker dialog box
Expression dialog box
Data Source dialog box
Workflow Tracker component RRTs
Restrictions and limitations
Troubleshooting tips
XML Importer
Welcome to the XML Importer component
Getting started
Feature highlights
Using the XML Importer component
Send invoice information
Transform an XML file
Get Information about a File from XML
Configuring the XML Importer component
Fields tab
Add New/Edit Field dialog box
Files tab
Add/Edit File dialog box
XPath Designer
XML Importer component RRTs
Restrictions and limitations
Troubleshooting tips
Route Components
Alchemy
Welcome to the Alchemy component
Getting started
Feature highlights
Using the OpenText Document Server, Alchemy component
Configuring Alchemy
General tab
Document tab
Select a folder
Fields tab
Add/Modify a Property dialog box
Alchemy component RRTs
Restrictions and limitations
Troubleshooting tips
Alfresco
Welcome to the Alfresco component
Getting started
Features highlights
Use the Alfresco component
Configuring the Alfresco component
General tab
Document tab
Attributes tab
Aspects tab
Aspect Settings dialog box
Property dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
ApplicationXtender
Welcome to the ApplicationXtender component
Getting started
Feature highlights
Using the component
Licensing the component
Configuring the component
General tab
Attributes tab
Queue tab
Field Values tab
Component RRTs
Troubleshooting tips
Restrictions and limitations
Autonomy WorkSite
Welcome to Autonomy WorkSite
Getting started
Feature Highlights
Using Autonomy WorkSite
Configuring Autonomy Worksite
General tab
Destination tab
Folder Properties dialog box
Document tab
Document Properties dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
Box
Welcome to Box
Getting started
Feature Highlights
Using the Box Component
Configuring Box
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Box application
Register a Box Authorization Provider
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and Limitations
Troubleshooting Tips
d.velop d.3
Welcome to d.3
Getting started
Feature Highlights
Using d.3 component
Configuring d.3
General Tab
Document Tab
Fields Tab
Add/Edit Field dialog box
List of Values dialog box
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Datacap 8.1
Welcome to Datacap 8.1
Getting started
Feature highlights
Using Datacap 8.1
Configuring Datacap 8.1
Main window
Component RRTs
Restrictions and limitations
Troubleshooting tips
Datacap 9.0
Welcome to Datacap 9.0
Getting started
Feature highlights
Using Datacap 9.0
Configuring Datacap 9.0
Main window
Component RRTs
Restrictions and limitations
Troubleshooting tips
Documentum (6.x)
Welcome to the Documentum (6.x) component
Getting started
Feature Highlights
Using the Documentum (6.x) Component
Configuring the Documentum (6.x) component
General tab
Document tab
Select Permission Set dialog box
New Permission Set dialog box
Permission Set Properties dialog box
Set Access Permissions dialog box
Attributes tab
Add/Edit Attribute dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
DocuShare
Welcome to DocuShare
Getting started
Feature Highlights
Using DocuShare
Route documents from MFD
Routing documents from local folders
Configuring DocuShare
General tab
Document tab
Enter Description dialog box
Select Routing Slip dialog box
Select Collection dialog box
Properties tab
Add/Modify Property dialog box
Advanced tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
DocuWare
Welcome to the DocuWare component
Getting started
Feature highlights
Use the DocuWare component
Configuring the DocuWare component
General tab
Document tab
Fields tab
Add/Edit field
Component RRTs
Restrictions and limitations
Troubleshooting tips
Dropbox
Welcome to Send to Dropbox
Getting started
Feature highlights
Using Dropbox
Configuring Dropbox
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Dropbox App for Token Vault
Register a Dropbox Authorization Provider in Token Vault
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and limitations
Troubleshooting tips
ELO
Welcome to ELO
Getting started
Feature Highlights
Using ELO
Configuring ELO
General tab
Basic tab
Add/Edit Field
Options tab
Edit Access Rights
Version tab
Workflow tab
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
FileNet P8
Welcome to FileNet P8
Getting started
Feature highlights
Using FileNet P8
Configuring FileNet P8
General tab
Select Object Store dialog box
New Folder Options dialog box
Select User dialog box
Document tab
More options
Content Elements tab
Add/Edit Content Element dialog box
Annotation tab
Relationship tab
Add/Edit Relationship dialog box
Subscriptions tab
Add/Edit Subscription dialog box
Add/Edit Event dialog box
Setup MIME Type dialog box
Add/Edit Extension to MIME Association dialog box
Document Class tab
Add/Edit Property dialog box
Edit Binary Data dialog box
Edit Boolean dialog box
Edit Date/Time dialog box
Edit Float Point dialog box
Edit Identifier dialog box
Edit Integer dialog box
Edit Multiline String dialog box
Edit List / Edit Enumeration dialog box
Edit Object Reference dialog box
Select Target Document dialog box
Add/Edit Item dialog box
Select Class dialog box
Select Field of Class dialog box
Inline representation
Security tab
Selection dialog box
Add/Edit Access Permissions dialog box
Access Flags dialog box
Access Rights
Advanced tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Glossary
Google Docs
Welcome to Google Docs
Getting started
Feature highlights
Use the Google Docs component
Configuring Google Docs
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Google Project for Token Vault
Register a Google Authorization Provider in Token Vault
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and limitations
Troubleshooting tips
Micro Focus Content Manager
Welcome to the Micro Focus Content Manager component
Getting started
Feature highlights
Using Micro Focus Content Manager
Configuring Micro Focus Content Manager Web Service
Starting the Service as HP Trim User User
Configuring Micro Focus Content Manager
General tab
Document tab
Select Container dialog box
Find Record dialog box
Search for Locations dialog box
Advanced Record Properties dialog box
Attributes tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Hummingbird/Open Text eDOCS
Welcome to the Hummingbird/Open Text eDOCS component
Getting started
Feature highlights
Use Hummingbird/Open Text eDOCS
Configuring Hummingbird/Open Text eDOCS
General tab
Document tab
Fields tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
IBM CM
Welcome to IBM Content Manager
Getting started
Feature highlights
Use IBM Content Manager
Configuring IBM CM
General tab
Document tab
Select Folder dialog box
Select File Type dialog box
Select Item Type dialog box
Select Process dialog box
Attribute Values tab
Add/Modify Attribute dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
IBM CM OnDemand
Welcome to IBM CM OnDemand
Getting started
Feature highlights
Use IBM CM OnDemand
Configuring IBM Content Manager OnDemand
Component RRTs
Restrictions and limitations
Troubleshooting tips
iManage Work
Welcome to iManage Work
Getting started
Feature Highlights
Using iManage Work
Configuring iManage Work
General tab
Destination tab
Folder Properties dialog box
Document tab
Document Properties dialog box
Component RRTs
Configuring Modern Authentication / OAuth2
Register an iManage Work application for Token Vault
Register an iManage Work Authorization Provider in Token Vault
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and limitations
Troubleshooting tips
IXOS
Welcome to the IXOS component
Using the IXOS component
Configuring the IXOS component
IXAT TR File Builder tab
Command File Builder tab
EXT_DIR tab
Kofax TotalAgility
Welcome to Kofax TotalAgility eConnector and route component
Getting started
Feature highlights
How to use Kofax TotalAgility route component
Configuring the KTA component
TotalAgility Server tab
Process tab
Document tab
eConnector Tab
Kofax TotalAgility component RRTs
Restrictions and limitations
Troubleshooting tips
Laserfiche
Welcome to Laserfiche component
Getting started
Feature highlights
Use the Laserfiche component
Configuring Laserfiche
General tab
Document tab
Fields tab
Choose Fields dialog box
Multiple Field dialog box
Text tab
Laserfiche component RRTs
Restrictions and limitations
Troubleshooting tips
Microsoft Office 365 Mail Send
Welcome to the Microsoft Office 365 Mail Send component
Getting started
Feature highlights
Use the Office 365 Mail Send component
Configure Office 365 Mail Send
Account settings tab
Proxy settings tab
Mail settings tab
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Microsoft 365 application
Set the permissions of the Microsoft 365 application
Register a Microsoft 365 authorization provider
Authorize the Authorization Provider
Configure the component
End user authorization
Configure Application access mode
Configure Application access mode in AutoStore Process Designer
Restrictions and limitations
Troubleshooting tips
Multi Router
MultiRouter
Multi-Router component
Configuring the Multi-Router component
NetDocuments
Welcome to NetDocuments component
Getting started
Configuring NetDocuments
General tab
Navigation tab
Document tab
Configuring Modern Authentication / OAuth2
Register an application for Token Vault
Register a NetDocuments Authorization Provider in Token Vault
Authorize the Authorization Provider
Configure the component
End user authorization
NetDocuments Component RRTs
Restrictions and limitations
Troubleshooting tips
Nuance PowerShare
Welcome to Nuance PowerShare
Getting started
Feature highlights
Using PowerShare
Configuring PowerShare
Connection tab
Upload Form tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
OneDrive
Welcome to OneDrive
Getting started
Feature highlights
Use OneDrive
Use Modern Authentication / OAuth2 and Token Vault
Configuring OneDrive
OneDrive component options
OneDrive Settings tab
Proxy Settings tab
Component RRTs
Configuring Modern Authentication / OAuth2
Register a Microsoft 365 application
Set the permissions of the Microsoft 365 application
Register a Microsoft 365 authorization provider
Authorize the Authorization Provider
Configure the component
End user authorization
Configure Application access mode
Configure Application access mode in AutoStore Process Designer
Restrictions and limitations
Troubleshooting tips
OpenText Livelink/Content Server
Welcome to OpenText Livelink/Content Server
Getting started
Feature highlights
Using OpenText Livelink/Content Server
Configuring OpenText Livelink/Content Server
General tab
Connection Type dialog box
Document tab
System tab
Add/Modify Attribute dialog box
Create new attributes on OpenText Livelink/CS Server
Categories tab
Add/Modify Attribute dialog box
Workflows tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
OpenText RightFax
Welcome to OpenText RightFax Component
Getting started
Configuring OpenText RightFax Component
Server tab
Cover Sheet tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Print Job Submission
Welcome to Print Job Submission
Getting started
Feature highlights
Using Print Job Submission
Configuring the Print Job Submission component
General tab
Print Settings tab
Properties tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
ProLaw
Welcome to the ProLaw component
Getting started
Feature highlights
Use the ProLaw component
Configuring the ProLaw component
Connection parameters tab
Export to Matter tab
Create new Transaction tab
Export to Transaction tab
ProLaw component RRTs
Restrictions and limitations
Troubleshooting tips
RightFax Route
Welcome to the RightFax eConnector and Route component
Getting started
Feature highlights
Use RightFax eConnector and Route
Configuring the RightFax eConnector and Route component
Server tab
Cover Sheet tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Send to Database
Welcome to Send to Database component
Getting started
Feature highlights
Using Send to Database component
Configuring the Send to Database component
General tab
Field Values tab
Send to Database component RRTs
Troubleshooting tips
Restrictions and limitations
Send to Database (Bulk)
Send to Database Batch component
General tab
Field mapping
Send to Folder
Welcome to Send to Folder component
Getting started
Feature highlights
Using the Send to Folder component
Configuring the Send to Folder component
Main configuration window
Configurations dialog box
General tab
Security tab
Impersonation tab
Summary tab
Send to Folder component RRTs
Troubleshooting tips
Restrictions and limitations
Send to FTP
Welcome to Send to FTP component
Getting started
Feature highlights
Use the Send to FTP component
Configuring the Send to FTP component
Send to FTP dialog box
FTP Site Settings dialog box
Advanced Settings dialog box
Folder path
Send to FTP component RRTs
Restrictions and limitations
Troubleshooting tips
Send to HTTP
Welcome to the Send to HTTP component
Getting started
Feature highlights
Use Send to HTTP
Configuring the Sent to HTTP component
Send to HTTP dialog box
Web Browser dialog box
Field Properties dialog box
Regular expression syntax
Send to HTTP component RRTs
Restrictions and limitations
Troubleshooting tips
Send to Mail Recipient
Welcome to the Send to Mail Recipient component
Getting started
Feature highlights
Use Send to Mail Recipient
Configuring the Send to Mail Recipient component
General tab
SMTP Server Configuration dialog box
Microsoft Exchange CDO-MAPI Server Configuration dialog box
Microsoft Exchange Web Server Configuration dialog box
Message tab
Component RRTs
Restrictions and limitations
Troubleshooting tips
Send to PC
Welcome to the Send to PC component
Getting started
Feature Highlights
Using Send to PC component
Configuring the Send to PC component
Send to PC dialog box
Advanced dialog box
Client Configuration dialog box
Send to PC component RRTs
Troubleshooting tips
Restrictions and limitations
Send to SFTP
Welcome to the Send to SFTP component
Getting started
Feature highlights
Using the Send to SFTP component
Configuring Send to SFTP
Proxy Settings dialog box
Add/Edit Site Configuration dialog box
Advanced Settings dialog box
Proxy Settings tab
Flow Control Settings tab
Run Test dialog box
Send to SFTP component RRTs
Restrictions and limitations
Troubleshooting tips
SharePoint
Welcome to the SharePoint component
Getting started
Feature highlights
Using the SharePoint component
Send documents into SharePoint
Send emails into SharePoint 2013
Use Modern Authentication / OAuth2 and Token Vault
Configuring the SharePoint component
General tab
Cookie provider assembly
Document tab
List Item tab
Define Search Keys dialog box
Add/Edit Search Key dialog box
Add/Edit Field dialog box
Define Permissions dialog box
Add/Edit Permission dialog box
SharePoint component RRTs
Configuring Modern Authentication / OAuth2
Register an Office 365 application
Set the permissions of the Microsoft 365 application
Register a Microsoft 365 authorization provider in Token Vault
Authorize the Authorization Provider
Configure the component
End user authorization
Restrictions and limitations
External Data field restrictions
Troubleshooting tips
Grant access to a SQL Server database
VB/J Script
Welcome to the VB/J Script component
Getting started
Feature highlights
Using the VB/J Script component
Configuring the VB/J Script component
General tab
Fields tab
VB/J Script component RRTs
Troubleshooting tips
Restrictions and limitations
Sample scripts
WebDAV
Welcome to the WebDAV component
Getting started
Feature highlights
Use the WebDAV component
Configuring the WebDAV component
General tab
WebDAV Folder dialog box
Properties tab
Add/Edit Property Field dialog box
WebDAV component RRTs
Restrictions and limitations
Troubleshooting tips
Windream
Welcome to Windream
Getting started
Feature Highlights
Using Windream
Starting process as a Windream domain user
Configuring Windream
General Tab
How to add a new alias to the server list
Destination Tab
Index Table Tab
Windream Indices dialog box
Component RRTs
Restrictions and Limitations
Troubleshooting Tips
Worldox
Welcome to the WORLDOX component
Getting started
Feature highlights
Use the WORLDOX component
Configuring Worldox
General tab
Select Profile Group dialog box
Document Profile tab
Edit Field Value dialog box
Add Field Value dialog box
Select Field Value dialog box
Document Relations tab
Network Drives tab
Add New Network Drive Mapping dialog box
Edit Network Drive Mapping dialog box
Select Network Drives dialog box
WORLDOX component RRTs
Restrictions and limitations
Troubleshooting tips
XML Generator
Welcome to the XML Generator component
Getting started
Feature highlights
Using the XML Generator component
Map data
Map a set of data of the same kind
Map tabular data
Configuring the XML Generator component
XML template
Edit Attribute dialog box
Multiply Node Block dialog box
Edit Node Value dialog box
Component RRTs
Restrictions and limitations
Troubleshooting tips
AutoStore Applications and Clients
AutoCapture Client
Welcome to the AutoCapture Client component
Installing the AutoCapture Client
Install AutoCapture client by using AutoCaptureClientPack.exe
Using the AutoCapture Client application
Starting AutoCapture Client
Capture documents with AutoCapture Client
Capturing Microsoft Office documents or messages
Using AutoCapture Explorer client
Configure AutoCapture Explorer client
Explorer Client Settings
Capture files in Windows Explorer
Configure AutoCapture client settings
Configure AutoCapture client settings
Connection Settings
Preferences settings
Log Settings
Customize AutoCapture client
Customize toolbars
Customize commands
Customize keyboard shortcuts
Customize window options
Bates Stamp Server Administrator
Welcome to Bates Stamp Server Administrator
Getting started
Feature highlights
Using Bates Stamp Server Administrator
Configuring
Login
Stamps
Stamp properties
Stamp elements
Stamp element properties
Text macros
Preview stamp
Request properties
Stamp groups
Stamp group properties
Group stamps
Users
User properties
User groups
Restrictions and limitations
Troubleshooting tips
Bates Stamp Server Supervisor
Welcome to Bates Stamp Server Supervisor
Getting started
Feature highlights
Using Bates Stamp Server Supervisor
Configuring
BSS Supervisor main window
Administrators
Administrator properties
Restrictions and limitations
License Manager
License Manager overview
License Manager window
Creating a license report
Checking server version
Send To PC Client
Send to PC Client Configuration dialog box
Send to PC dialog box
Advanced dialog box
Troubleshooting tips
Status Monitor
Welcome to the Status Monitor application
Introduction
Home tab
View tab
Customize dialog box
Appendices
Conditional fields
Using Conditional Field
Operators
Expression syntax
Expression evaluation
Date and time formats
Backend browsing
Equitrac
Introduction
What is Equitrac?
Equitrac features
Core server components
Core Accounting Server
Document Routing Engine
Device Control Engine
Scan Processing Engine
Device Monitoring Engine
Supporting components
Workstation Client
Direct IP Printing (DRC)
Print Assistant
Application-level access permissions
Configure application-level permissions
Windows-level access permissions
Additional documentation
Web System Manager Overview
System Dashboard overview
System Dashboard - Licenses
System Dashboard - Accounts
System Dashboard - Devices
System Dashboard - Accounting
Web Client
Web Client login options
User Dashboard
Working with User Dashboard
How to use User Dashboard
View and delete queued print jobs
View custom reports
Set the default billing code
Manage user PINs in User Dashboard
Transfer funds in User Dashboard
Web Deposit
Installation and Configuration
Installation overview
Requirements
Prerequisites
Configuration overview
Set up the database
Set up the global settings
Use Web Deposit
Uninstall Web Deposit
Web Deposit solution for Ogone
Configuring Web Deposit for Ogone
Requirements
Prerequisites
Configure Ogone
Use Ogone with Web Deposit
Transaction log of Ogone payments
Web Deposit solution for PayPal
Configuring Web Deposit for PayPal
Requirements
Prerequisites
Configure PayPal
Use PayPal with Web Deposit
Transaction log of PayPal payments
Scan Client
Working with the Scan Client
How to use the scan filters
How to sort the scan list
Additional functions
Troubleshooting
Logging
Journaling
Configure admin-only mode
Create and Manage Accounts
Accounts overview
User accounts
Departments
Billing codes
Create new accounts
Work with departments
Enable department charging
Create and edit departments
Work with user accounts
Create user accounts
Add and edit users individually
Create users automatically
Assign delegates to users
Assign users to departments
Assign billing codes to users or departments
Set a default billing code for users
Add users from a flat file import
Import users with Active Directory Services
Qualify accounts by domain
Configure Active Directory synchronization
Add Active Directory Servers
Configure Active Directory servers
Active Directory LDS support
Configure LDAP synchronization
Add LDAP servers
Configure LDAP servers
LDAP field mapping to CAS
Import LDAP user accounts
Configure Azure Active Directory synchronization
Manage user accounts
Control function access
Color quotas
Color quotas for print and copy requests
Setting color quotas for users
Resetting color quotas for users
Locking accounts
Removing accounts
Delete single or multiple accounts
Delete a set of accounts based on shared properties
Perform account transactions
Search filters
User authentication
External user authentication
Data privacy management
Select notification methods
Escape codes, print notification details and error conditions
Charge to departments
Account charging and limits
Escrow
Enable escrow
Reset escrow
View an escrow report
Delete objects in synchronized directories
Configure unlimited printing
Handle unidentified documents
Associate swipe cards with Equitrac accounts
Configure the mail server for email notifications
Implement PINs
User-controlled PIN management
Control transaction tracking
Work with self-service accounts
Configure the guest user feature
Configuring the account monitor popup
Billing Codes
Enable system-wide billing code access
Configure billing code popup behavior
Create billing codes
Edit billing codes
Manage billing codes
Enable billing codes
Remove billing codes from a user or department
Synchronize billing codes
Create the billing code text file
Schedule the billing code synchronized task
Use client billing on a workstation
Manage Devices
Device types
Device status tracking
Edit and remove devices
Import devices
Import several devices at one time
Physical devices
Manually add and configure a physical device
Physical device output settings
Physical device price list settings
Physical device advanced settings
Physical device eCopy integration
Mapping a Universal Print Device
Embedded devices
Supported manufacturer embedded device types
Configuration options
Add and configure embedded devices
Embedded device pricing
Embedded device advanced settings
Setting Upgrade mode
Print queues
Managed Queues
Configuring a Managed Queue
I-Queues
I-Queue Direct printing
I-Queue printing
Create an I-Queue
Create an I-Queue printer
Set up the I-Queue printer share
External print queues
VPSX PersonalQ print queues
Configure a VPSX print queue
Import LRS transactions
VPSX PersonalQ workflow
InfoPrint Manager print queues
Configure an InfoPrint Manager print queue
InfoPrint release workflow
SEAL print queues
SEAL release workflow
Universal Print virtual queues
Print Job Submission
Workstation devices
Configure a workstation device
Configure eCopy ShareScan
eCopy prerequisites
Configuration prerequisites
Set up a print separator page
Separator page escape codes
Device Monitoring with DME
DME workflow
SNMP communication requirements
Configure SNMP communication
Select devices for DME to monitor
Generate device status reports
Routing based on device status
Control Terminals
Card reader hardware overview
Connecting the card reader
LED status messages
Ethernet card reader troubleshooting
Configure Ethernet card readers
Associate the card reader with another printer
Manage Ethernet card readers
Recover an inaccessible card reader
Update the card reader firmware
Reset the card reader factory defaults
Recover an inaccessible card reader
Working with HID cards
HID decoding
Supported HID card types
MicroProx Tag
ISOProx II
DuoProx II
Smart DuoProx II
ProxKey II
ProxCard II
Advanced Printing Configuration
Enable secure printing
Secure printing configuration
Administer the secure print queue
Manage device pull groups
Choose devices to group
Printer pull group workflow
Set Up Print-to-Me
Configure Print-to-Me
Print-to-Me printing across multiple accounting servers
Release prints to first available DRE
Printer driver management
Printer Driver Repository
Printer driver mapping
Upload printer driver package
Equitrac Printer Driver Uploader tool
Set custom printing preferences
Configure Send To printing
Send To Printing configuration workflow
Client popup behavior
Recipients
Release keys
Print costs
Job settings
Desktop printing
User workflow for desktop printing
Desktop printing configuration workflow
How to exclude applications
Re-enable an excluded application
Edit an excluded application
Exclude printer ports
Price lists overview
Price list types
Price list workflow
Cost calculation and currency
Create Basic Print/Copy price lists
Advanced Print/Copy price lists
Page detail costs
Create Advanced Print/Copy price lists
Set print surcharges
Sample Advanced job cost calculation
Create Large-Format price lists
Fax price lists
Create fax price lists
Scan price lists
Create scan price lists
Departmental pricing
Create and apply departmental price lists
Default price lists
Primary vs. dual pricing
Configure dual pricing
Assign price lists
Apply price lists
Reprice jobs on release
Routing rules
Rules overview
Rule sets
Create a rule set
Apply a rule set
Create print rules
Print attributes
Print rule type and actions
Create a print rule
Adjust the rule ranking
Interactive print rules
Copy rules
Create copy rules
Work with routing groups
Manage routing groups
Create desktop print rules
Default desktop print rules
Scheduled tasks
Define a schedule recurrence
Schedule a report task
Schedule a billing code task
Schedule an arbitrary command
Schedule a color quota task
Schedule an account balance task
Schedule a purge transactions task
Run a missed task
Suspend, resume or remove a scheduled task
Suspend a task
Resume a task
Remove a task
Create and run reports
System Dashboard reports
Configure a Savings report
Schedule reports to run automatically
Run consolidated reports
Configure multiple CAS servers
Run Subsidiary reports only
Manage scan and user workflows
Configure workflows
Configure workflow containers
Configure scan processing and delivery
Configure SMTP mail server for SPE
Scan load balancing
Configure scan load balancing
Configure SPE nodes
Configure scan destinations
Enable Scan-to-Me
Scan Client
Work with the scan client
How to use scan filters
Sort the scan list
Additional functions
User Dashboard
Enable account balance transfers for User Dashboard
Enable PIN management for User Dashboard
Enable default billing code for User Dashboard
Display color quota in User Dashboard
Equitrac Utilities
Import utilities
Import Campus Card account information
How to import domain qualified users
Directory synchronization access permissions
Purge database transactions
Modify user accounts from a flat file
EQCmd actions
add
assign
modify
addormodify
delete
remove
query
adjust
adjust ... <amount>
adjust ... set <amount>
adjust ... atleast <amount>
adjust department
lock and unlock
color quota
EQCmd batch file process
CSV File Format
CSV File Sample
Map LPR user IDs
Install EQXLPD
Modify the configuration file
Start the EQXLPD service
Obtain Debug Logs
Print Queue Viewer
Run Print Queue Viewer on a workstation
Diagnostics
Save and clear log files
Glossary
Output Manager
Getting started
Welcome to Kofax Output Manager
ControlSuite overview
Output Manager implementation
Output Manager concepts
Output Manager user interfaces
Instances of Output Manager
Output Manager services
Output Manager applications
Destinations application
Sources application
Documents application
Library application
Reports application
Devices application
Administration application
Learning about the Output Manager Console
Open the Output Manager Console
Using the LocalSystem user account with SQL Server 2016 or later
Customizing the grid views
Sort by columns
Group by columns
Filter on values
Configure columns for grid views
Use grid layouts
Configure Output Manager Console security
Configure columns
Using Output Manager in a Citrix environment
Users
Managing users
Adding users and groups to Output Manager
Group membership
Add an Output Manager user
Add an Output Manager group
Add an LDAP user or group
Add a Windows user or group
Add an Azure user or group
Importing users and groups to Output Manager
Import user data from a file (no groups)
Import Active Directory users or groups
Import LDAP users or groups
Import Azure users or groups
Import users or groups with a recurring task
Add a department
Map groups to departments
Configure users
Configure departments
Modify a user, group, or department
Remove a user, group, or department
Assign a print delegate
Managing Output Manager security roles
Add users or groups
Remove users or groups
Modify security permissions
Devices
Learning about the Devices application
Managing devices
Open a device
Move a device
Rename a device
View the device output history
View the SNMP alert history
Initiate an SNMP update for a device
Configure access control
Manage device groups
Add devices
Import new devices
Modify devices
Create destinations
Search for devices
Managing devices through SNMP
SNMP versions and communication security
Configure SNMP services
Organize detected SNMP devices
Detecting devices using SNMP
Override global SNMPv3 gettings
Ethernet Card Reader
Hardware overview
Connect the Ethernet Card Reader
Add the Ethernet Card Reader
Update the Ethernet Card Reader firmware or configuration
LED status messages
Ethernet Card Reader troubleshooting
Reset the Ethernet Card Reader
Use maintenance mode to recover an inaccessible Ethernet Card Reader
RF IDeas Ethernet 241 Card Reader
Prerequisites
Install the RF IDeas Ethernet 241 Card Reader
Configure Output Manager with the RF IDeas Ethernet 241 Card Reader
Queues and Universal Postscript Driver
Converting Windows queues
Convert Windows queues
Convert Windows queues (advanced mode)
Restore Windows queues
Output Manager Universal PostScript Driver
Use the Output Manager Universal PostScript Driver
Security
Output Manager security
Document ownership
Security roles
Add or remove users and groups in roles
Add or remove role permissions
Configuring permissions
Configure console permissions
Configure object permissions
Security enforcement
File store encryption
Encrypt a file store
Decrypt a file store
File store encryption troubleshooting
Sources
Learning about the Sources application
Manage source groups
Add sources
Add an AutoStore source
Add a ControlSuite source
Add an Email source
Microsoft 365 Configuration for Email Source
Add an Epic source
Add an Epic Web Service source
Add an FTP source
Add an IPP source
Add an LPD source
Add a Microsoft Universal Print source
Add a Mobile Server source
Add a NetWeaver source
Add a Network Folder source
Add an Output Manager source
Add a Socket Connection source
Add a TCP/IP NJE source
Add a WCF API source
Add a Web Upload source
Add a WebSphere MQ source
Add a Windows Queue source
Modify sources
Remove sources
Import sources
Search for sources
Configure security for sources
Managing sources
Enable a source
Disable a source
Open a source
Move a source
Rename a source
Copy a source
View all messages for a source
Configuring document property profiles
Configure document profiles during source configuration
Configure a document properties profile
Order document property profiles
Destinations
Learning about the Destinations application
Manage destination groups
Add destinations
Modify destinations
Remove destinations
Import destinations
Redirect destinations
Search for destinations
Configure security for destinations
Routing documents
Send documents to AutoStore
Send documents to a ControlSuite destination
Send documents to an email address
Microsoft 365 Configuration for Outbound Email
Send documents to a fiery device
Send documents to an FTP server
Send documents to an IPDS printer
Send documents to an IPP printer
Send documents to JDF/JMF
Send documents to an LPR server
Send documents to a Microsoft Universal Print Platform
Send documents to a network folder
Send documents to another Output Manager instance
Send documents to a socket server
Send documents to a WebSphere MQ
Send documents to a Windows Queue
Configure the Document Library
Send documents to a destination group
Managing destinations
Enable a destination
Disable a destination
View SNMP alerts
Open a destination
Move a destination
Rename a destination
Copy a destination
View destination output history
View all messages for a destination
Documents
Learning about the Documents application
Learning about the Library application
Managing documents
Change the document state
View documents
Manually route documents to a destination
Edit document properties
Assign documents to a folder
Delete documents
Reprint documents
Restore documents
Schedule output
Assign a failover profile
Assign a library filing profile
Assign a notification profile
Assign an output process to a document
Assign a retain period
Run an ad hoc rule on documents
Run an ad hoc action on documents
Manage document packages
View a document history
Working with documents
Manage document folders
Configure security for documents
Create document queries
Search for documents
Configure global document properties
Output processes and actions
Output process actions
Open and close the Process Designer
Create an output process
Configure actions
Open an output process
Rename an output process
Delete an output process
Print an output process
Search for an output process
Zoom in or out of the Process Editor
Cost Tracking and Management
Print rules profiles
Create a print rules profile
Create user print rules
Create a desktop client profile
Assigning costs to billing accounts
Allowances
Configure balance settings
Import billing accounts
Managing Windows Queues
Assign a quota profile
Create a quota profile
Rules and Tasks
Rules
Business rules
Set up business rules
Create business rules
Manage business rules
Create business rule actions
AdHoc rules
Manage Ad Hoc rules
Create Ad Hoc rules
Create Ad Hoc actions
Alert rules
Create alert rules
Manage alert rules
Error handling rules
Failover rules
Using Output Manager functions
Configure the @dateTimeToString function
Configure the @lookupCsv function
Configure the @parse function
Configure the @schedule function
Configure the @stringToDateTime function
Configure the @counter function
Using the Data Conversion Utility
DCO descriptions
DCO parameters
Scheduling tasks
Create a schedule
Run an Ad Hoc rule
Create and save or email a report
Update output history with page counts
Import users and groups
Synchronize Active Directories
Synchronize LDAP
Reports
Learning about the Reports application
Working with reports
Manage report folders
Create reports
Modify reports
Remove reports
Move reports
Rename reports
Copy reports
Export reports
Import reports
Search for reports
Configure security for reports
Send report data to a remote database
Using the Report Preview window
View reports
Print reports
Scale reports
Change the zoom level
Change watermark and background settings
Search for text in a report
Export reports
Email reports
The Report Designer
Learning about the Report Designer
Report settings
Report bands
Report controls
Using the Report Designer
Save reports
Manually update report output
Change element layout in a report
Add or modify static information in a report
Delete report elements
Use Mail Merge in report elements
Display values from a database
Change value formatting of report elements
Change fonts and colors of report elements
Change or apply data sorting to a report
Change or apply data filtering to a report
Change or apply data grouping to a report
Add totals for a report
Create or modify watermarks for a report
Add page numbers and system information to a report
Add calculated fields to a report
Add parameters to a report
Styles and conditional formatting in reports
Use odd and even styles
Store and restore style sheets
Conditionally change the appearance of a control
Conditionally hide bands
Conditionally change label text
Navigation in reports
Add bookmarks
Create hyperlinks
Add a cross-reference
Miscellaneous topics in reports
Show the current row index
Count the number of records in a report or group
Cancel printing when a report does not contain any records
Limit the number of records per page
Resources
Add resources
Modify resources
Remove resources
Import resources
Export resources
Configure Resources
Configure the CpMillUnitLibrary resource
Configure a CpMillProfile resource
Configure a banner resource
Configure a PrinterControlFile resource
Configure an FCB resource
Configure a CsvDocProp resource
Configure a binary resource
Configure a text resource
Configure an Ini resource
Server and database administration
The Message Console
Using the Message Console
Capture trace data
View messages for destinations, sources, or documents
Show or hide the message panel
Clear messages from the Message Console
Copy messages to Microsoft Excel
Export or import messages
Pause and resume automatic refresh
Set general preferences
System Health utility
Managing services through Microsoft Windows
Configure services to log on using the Local System account
Configure services to log on using a user account
Managing product components
View product components
Monitor services from the Output Manager Console
Authorize servers
SSL certificates
Backing up and restoring the Output Manager database
Schedule periodic backups
Restore a backup
Back up from a command prompt
Configure NetWeaver integration
Notifications
User Interface Reference
@DateTimeToString dialog box
@LookupCsv dialog box
@Parse dialog box
@StringToDateTime dialog box
Add Columns dialog box
Add Destination (from Devices) dialog box
Add Destination dialog box
Add Source dialog box
Ad Hoc Rule dialog box
Ad Hoc Rules Manager dialog box
Adjust Message Priority dialog box
Adjust User Custom Properties dialog box
Advanced Costing Profile dialog box
Alert Rule dialog box
Alert Rules Manager dialog box
Allowances Profile dialog box
Assign Access Control dialog box
Bitmap Output tab
Browse LDAP Server dialog box
Burst Document - Line Mode dialog box
Extract Text tab
Burst Conditions tab
Set Document Properties tab
Burst Document - Page Mode dialog box
Extract Text tab
Burst Conditions tab
Set Document Properties tab
Business Rule dialog box
Business Rules Manager dialog box
Configuration tab
Configure Columns utility
Configure Device dialog box
Configure Document Properties utility
Configure IP Ranges dialog box
Configure Kiosk dialog box
Configure Method Call dialog box
Configure Transform dialog box
Configuring administrative options
Connect to Output Manager Server dialog box
Create Package dialog box
Create Resource or Edit Resource dialog box
Custom DBM Activation dialog box
Deactivate DBM Components dialog box
Department dialog box
Departments tab
Windows Groups to Departments Mapping dialog box
Desktop Client Installation dialog box
Desktop Client Profile dialog box
Destination Capabilities dialog box
Destination Configuration dialog box
AutoStore settings tab (Destination Configuration)
ControlSuite settings tab (Destination Configuration)
Email settings tab (Destination Configuration)
Error Handling tab (Destination Configuration)
Fiery device settings tab (Destination Configuration)
Folder settings tab (Destination Configuration)
FTP settings tab (Destination Configuration)
IPDS settings tab (Destination Configuration)
IPP settings tab (Destination Configuration)
JDF/JMF settings tab (Destination Configuration)
LPR settings tab (Destination Configuration)
Microsoft Universal Print settings (Destination Configuration)
More settings tab (Destination Configuration)
OM settings tab (Destination Configuration)
SharePoint device settings tab (Destination Configuration)
Socket settings tab (Destination Configuration)
WebSphere MQ settings tab (Destination)
Windows queue settings tab (Destination Configuration)
Destination Configuration (bulk settings) dialog box
Email settings tab (Destination Bulk Configuration)
Error Handling tab (Bulk Configuration)
Fiery Device settings tab (Bulk Configuration)
Folder settings tab (Destination Bulk Configuration)
FTP settings tab (Destination Bulk Configuration)
General tab (Destination Bulk Configuration)
IPP settings tab (Destination Bulk Configuration)
JDF/JMF settings tab (Destination Bulk Configuration)
LPR settings tab (Destination Bulk Configuration)
More settings tab (Destination Bulk Configuration)
OM Settings tab (Destination Bulk Configuration)
Socket settings tab (Destination Bulk Configuration)
WebSphere MQ settings tab (Destination Bulk Configuration)
Windows Queue settings tab (Destination Bulk Configuration)
Destination/Device Output and SNMP Alert History window
Detect Readers dialog box
Device Configuration dialog box
SNMP tab (Device Configuration)
Device Details tab (Device Configuration)
Kiosk tab (Device Configuration)
Job Status tab (Device Configuration)
Device Profile dialog box
Device wizard
Display Client Pop-up dialog box
Document Library Profile dialog box
Document Owner Mapping tab
Document Properties dialog box
Document Properties Profile dialog box
Document Property Mappings tab
Edit LDAP User dialog box
Edit Windows User dialog box
Error Handling Profile dialog box
Exception Fields dialog box
Export Reports dialog box
Failover Profile dialog box
File Store dialog box
Filter Profiles tab
Font Face Configuration dialog box
Fonts tab
General tab (Transform Package)
Global Group Routing Map dialog box
Group Routing Configuration dialog box
Groups tab
Headers from Data tab
Import Reports dialog box
Ini Resource dialog box
Input Options tab
Job Parsing tab
Job Ticket tab
Job Status Manager dialog box
Job Status Mapping Profile dialog box
LDAP Group dialog box
LDAP Server dialog box
LDAP User dialog box
Learning about the Audit Console
Library Settings tab
License Information tab
Adjust Output Manager Instance Feature Allocation dialog box
Mail Server Search dialog box
Manage Billing Accounts Utility
Billing List dialog box
Manage CsvDocProp Resources dialog box
Manage Product Components Utility
Manage Profiles dialog box
Manage Resources dialog box
Manage Devices Utility
Manage Windows Queue Quota Profiles dialog box
Manage Windows Queues Utility
Server tab
Workstation tab
Merge Package dialog box
MFP Kiosk Preferences Profile dialog box
Modify Document dialog box
Configuration tab
Document Properties tab (Modify Document)
Native Headers tab
New Device dialog box
Notification Profile dialog box
Document notifications
Document - Notification Editor dialog box
Document In Specific State For Elapsed Time - Notification Editor dialog box
Document waiting to complete or unrouted - Notification Editor dialog box
System notifications
Database Usage Monitor - Notification Editor dialog box
File Store Usage Monitor - Notification Editor dialog box
License Status - Notification Editor dialog box
Login Failure Count Exceeded - Notification Editor dialog box
Message Posted to Message Log - Notification Editor dialog box
Modified Events - Notification Editor dialog box
Service is Down - Notification Editor dialog box
Source Error - Notification Editor dialog box
State Change - Notification Editor dialog box
OM Group dialog box
OM User dialog box
Opening Windows utilities
Organizational Units Container Specification dialog box
Outbound Email Profile dialog box
Output Options tab
Package Boundary Fields dialog box
Package Manager dialog box
Page Layout tab
PDF Output tab
Power Rule dialog box
Preview window
Printer Family Profile dialog box
Process Designer Utility
Remove From Document dialog box
Rename Process dialog box
Resource Manager dialog box
Banner Resource dialog box
Binary Resource dialog box
Configure Filter Profile dialog box
Configure Unit Library dialog box
CsvDocProp Resource dialog box
FCB Resource dialog box
PrinterControlFile Resource dialog box
Resources tab
Role Manager dialog box
Route to Destination (Advanced) dialog box
Run Command dialog box
Schedule dialog box
Schedule Manager dialog box
Schedule tab (New/Edit Schedule dialog box)
Tasks tab (New/Edit Schedule dialog box)
New/Edit Task (Active Directory Synchronization) dialog box
New/Edit Task (Create Report) dialog box
New/Edit Task (Import Users and Groups) dialog box
New/Edit Task (LDAP Synchronization) dialog box
New/Edit Task (Output History to Equitrac Import) dialog box
New/Edit Task (Perform Rule) dialog box
New/Edit Task (Push Reporting Data to Database) dialog box
New/Edit Task (Update Output History with Page Counts) dialog box
Security Configuration dialog box
User or Group Permissions
Select Detection Options dialog box
Select devices dialog box
Select Organizational Units dialog box
Select Redirected Destination dialog box
Select User Accounts/Groups to Import dialog box
Select User dialog box
Send Email dialog box
Set Document Owner - Advanced dialog box
Set Document Owner - Guest dialog box
Set Failover Profile dialog box
Set Filter Profile dialog box
Set General Preferences Utility
General tab (Set General Preferences Utility)
Destination tab (Set General Preference Utility)
Security tab (Set General Preference Utility)
Actions saved in auditing information
Reporting tab (Set General Preference Utility)
Kiosks tab (Set General Preference Utility)
Clients tab (Set General Preference Utility)
Set Library Filing Profile dialog box
Set Notification Profile dialog box
Set Output Process dialog box
Set Priority in Group dialog box
SNMP Server Configuration dialog box
Source Properties Profile dialog box
Source Configuration dialog box
AutoStore settings tab (Source Configuration)
ControlSuite settings tab (Source Configuration)
Document properties tab (Source Configuration)
Email settings tab (Source Configuration)
Epic settings tab (Source Configuration)
Epic Web Service settings tab (Source Configuration)
Filters tab
Regular expressions
FTP settings tab (Source Configuration)
Folder settings tab
IPP settings tab (Source Configuration)
LPD settings tab (Source Configuration)
LPD Queue Settings tab
Microsoft Universal Print settings (Source Configuration)
More settings tab (Source Configuration)
Output settings tab (Source Configuration)
Socket settings tab (Sources)
TCP/IP NJE settings tab (Source Configuration)
Web Upload settings tab (Source Configuration)
WebSphere MQ settings tab (Source)
Windows queue settings tab (Source Configuration)
Source Configuration (bulk settings) dialog box
Document Properties tab (Source Bulk Configuration)
Email settings tab (Source Bulk Configuration)
Epic Settings tab (Source Bulk Configuration)
Filters tab (Source Bulk Configuration)
Regular expressions
Folder Settings tab (Source Bulk Configuration)
FTP Settings tab (Source Bulk Configuration)
General tab (Source Bulk Configuration)
IPP settings tab (Source Bulk Configuration)
LPD Settings tab (Source Bulk Configuration)
More Settings tab (Source Bulk Configuration)
Output Settings tab (Source Bulk Configuration)
Socket settings tab (Source Bulk Configuration)
Web Upload Settings tab (Source Bulk Configuration)
WebSphere MQ settings tab (Source Bulk Configuration)
Windows Queue Settings tab (Source Bulk Configuration)
Specify LDAP Server Connection dialog box
Specify SQL User dialog box
Text Extraction Variable Definition dialog box
Text Resource dialog box
Transform Adept dialog box
Transform Office Files dialog box
Transform Package dialog box
Transform Record Mode (Advanced) dialog box
Transform Record Mode (Basic) dialog box
Universal PS Driver Wizard
Create a Microsoft Windows print queue
Add multiple Microsoft Windows print queues
Import queues from a file
Unzip Document dialog box
User Information Stamping dialog box
User and Group Selection dialog box
User Print Rules Profile dialog box
User Print Rule dialog box
User Print Rules Manager dialog box
Users tab
Viewer Configuration dialog box
Watermarking dialog box
Windows Queue Quota Profile dialog box
Windows Queue Quota Rule dialog box
Windows Queue Print Rules Manager dialog box
Windows Users and Groups dialog box
Zip Package dialog box
Business Connect
Overview
Introduction
Business Connect Features
Product Compatibility
System Requirements
Prerequisites
Mobile Device Management Integration
Server Configuration
Business Connect Server Configuration
Layout Configuration
Configuring Font Settings
Configuring Logos
Configuring Background
Configuring Activity
Client Support Setup
Feature Access Configuration
Configure SharePoint Sites (Optional)
Geo-Location Management
Adding a New Location
Adding a Floorplan
Editing or Deleting Location Information
MFD and Printer Management
User and Device Management
Managing Users
Managing Devices
Localization and Multi-Language Support in Business Connect
Business Connect Server Logs
Troubleshooting
Mobile Device Management Integration
Configure the Mobile Server URL in AirWatch Console
Verify the Mobile Server URL on the Device
Configure the Mobile Server URL in MobileIron
Force Device Check-In
Verify the Mobile Server URL on the Device
Configure the Mobile Server URL in BlackBerry UEM
Verify the Mobile Server URL on the Device
Configure the Mobile Server URL in Intune
iOS Policy Configuration
Verify the Mobile Server URL on the iOS Device
iOS Mobile App Configuration
Configuring Business Connect Manually
Database Configuration
Configure a database on an SQL server database
Configure an embedded SQL Server Compact database
Workflow Engine Configuration
About ControlSuite™ Enrollment
Printing Services Configuration
Web Server Configuration
Support Service Configuration
Connect Web Server to Support Service on local machine
Connect Web server to the Support Service on a remote machine
Support Service Configuration in Standalone Mode
Connect Web Server to standalone Support Service
Security Configuration
Launching Admin Tool
Configuring Web Capture for Business Connect Server
Configure Web Capture Communication Port in AutoStore
Configuring SSL for Business Connect
Configure SSL for the Business Connect Client
Add Site Bindings in IIS
Create Business Connect website in IIS
Specify the Server Address on the Business Connect Client
Configuring SSL for Web Capture
Configure the Business Connect Server
Add the Certificate to the AutoStore Server
Configure SSL for Web Capture in AutoStore
Configuring SSL for Support Service
Configuring SSL for Support Service in Stand-Alone Mode
Integrations
Send documents from capture to print management
AutoStore to ControlSuite print management via Process
Create a new task
Add components
Create a new workflow
General settings
Print Settings
Properties
Route the print job
AutoStore to ControlSuite print management via Route
Configure Server Manager in AutoStore
Create a new task
Add components
Create a new workflow
General settings
Print Settings
Properties
Send documents from capture to mobile
Configure Server Manager in AutoStore
Create a new workflow
General settings
Print Settings
Properties
Send documents from mobile to other ControlSuite components
Configure Server Manager in AutoStore
Configure Business Connect Server Configuration Manager - Printing Services tab
Configure Business Connect Server Configuration Manager - Web Server tab
Create a new task
Add components
Create a new workflow
Transforming the document
General settings
Print Settings
Properties
Route the print job
Send documents from print management and mobile to capture
Create a new rule set
Create a rule to add a watermark
Create a rule to add a stamp
Create a rule to send to AutoStore
Add the Equitrac rule to the Equitrac source
Send documents from print management to output management
Create a new rule set
Create a rule to add a watermark
Create a rule to add a stamp
Create a new rule to send to Output Manager
Add the Equitrac rule to the Equitrac source
Send documents from output management to capture
Create an AutoStore task to route a document to a folder
Configure the AutoStore workflow
Create an Output Manager destination
Delete existing sources
Create a new source
Send documents from output management to print management
Release Output Manager documents at Equitrac endpoints
Create an Output Manager destination
Delete existing sources
Create a new source
Send documents from the output management to mobile
Create an AutoStore task to route to Business Connect
Configure the Print Job Submission eConnector component
Create an Output Manager destination
Delete existing sources
Create a new source
Device Registration Service
Using the DRS
Open the DRS web client
Working with Applications
Add an Application profile
Edit Application profile settings
Working with Devices
Add a new Device profile
Edit a Device
Changing languages on Device
Change language on eBN Device
Change language on eBX Device
Filter Device and group information
Import Device information
Export Device information
Device status
Working with Device Groups
Add a Device group
Add an existing Device to a Device group
Add a new Device profile to a Device group
Working with client packages
Files list (Unified Client installation packages)
Remove a package file from DRS
Rename a package file in DRS
Performing Actions on Devices
Perform Device Actions
View Action history
Manage the DRS service on the server
Troubleshooting the DRS
Service verification
Device Web Server
Overview
View the DWS Web administration page
Purge DWS logs
Generate a CA Certificate using an IP address
Regenerate certificates
DWS failover
DWS failover scenarios
ControlSuite Clients
Unified Clients Overview
Brother Unified Client
Deployment steps
Requirements
Supported languages
Preparing for deployment
Verify that your device is supported
Verify prerequisites
Download installer package
Installing the Unified Client for Brother
Installing ControlSuite
Use DRS to configure and deploy the Unified Client
Manual Device Configuration
Generating CA Certificate using IP Address
Uninstalling Client using DRS
Setting up a Brother device
Ensure that BSI is enabled on the device
Ensure that application entry menus and CA certificate entry are available
Configure the Brother device in case Mass Deployment Tool is not in use
Install CA Certificate in case Mass Deployment Tool is not in use
Set up screen displayed on the Brother device after login
Recommendations for Brother device settings
Using the Unified Client for Brother
Features
Creating a capture workflow
Configure Send to Folder
Creating a print workflow
Use Print-to-Me
Configure Equitrac for use with the Unified Client for Brother
CAS offline operation through DCE caching
Typical user workflows
Log in to the Unified Client for Brother
Login with Equitrac and AutoStore
Login with Equitrac only
Login with AutoStore only
Register your card
Card readers
Card reader setup
Function Access Control
Enter Billing Codes
Print-to-Me
Release All
Release Key
Scan a document
Field Types
Checkbox field
Date field
Label field
List field
Lookup list field
Numeric field
Text field
Tree field
Scan Settings
Logout
Reference
Application properties
Device properties
Actions reference
Unified Client failover
Troubleshooting
Error messages
Canon Unified Client
System requirements
Third-party application dependencies
Deploying Unified Client for Canon
Deploying Unified Client for Canon with AutoStore - process outline
Deploying Unified Client for Canon with Equitrac - process outline
Deploying Unified Client for Canon with AutoStore and Equitrac - process outline
Deploying Unified Client for Canon with Output Manager - process outline
Deploying Unified Client for Canon with AutoStore and Output Manager - process outline
Supported languages
Switch language on the device
Preparing for deployment
Verify that your device is supported
Verify prerequisites
Installing the Unified Client for Canon
AutoStore server installation and configuration
Equitrac server installation and configuration
Output Manager server installation and configuration
Setting up a Canon device
Configure the Canon MFP language and date/time settings
Enable SSL for remote UI
Install Canon application for AutoStore only
Install Canon application for Equitrac or both AutoStore and Equitrac
Install Canon application for both AutoStore and Output Manager
Set the home screen for the guest user
Configure the TLS certificates
Recommendations for Canon device settings
Check the Canon platform version
Use DRS to configure and deploy the Unified Client
Quick setup Device Registration Service instructions for AutoStore
Quick setup Device Registration Service instructions for Equitrac
Quick setup Device Registration Service instructions for AutoStore and Equitrac
Quick setup Device Registration Service instructions for Output Manager
Quick setup Device Registration Service instructions for AutoStore and Output Manager
Install certificates in a ControlSuite NLB environment
Using the Unified Client for Canon
Set up your first AutoStore capture workflow
License AutoStore
Configure scan to folder
Scanning with the Unified Client for Canon
Basic scan overview
Scan Settings
Scan form overview
Text field
Numeric input field
Simple List field
Extendable/Multiselect/Database lookup fields
Date field
Tree field
Button field
Checkbox field
Label field
Complex scan overview
Scan limitations and constraints
Set up your first print job in Equitrac
License Equitrac
Configure Print-to-Me
Use Print-to-Me
Set up your first print job in Output Manager
License Output Manager
Configure Output Manager
Add a device
Set print preferences
Kofax Unified Client for Canon device settings
Application properties
Device properties
Files Tab
Actions reference
Return codes
Add a device
Import device information
Canon Unified Client Launcher Screen
Authentication and identification
Offline behavior
Server reconfiguration behavior
Hardkey behavior
System timeout
Main Menu button
Appendix: Additional configuration instructions
Security
Changing the TLS settings
Canon Auto Reset Timer
Configuring AA Common Access Card authentication solution
CAC Authentication and Equitrac MEAP Authentication solution
Canon Licensing
Moving App Logo to the First Page of Canon Device
Renaming Embedded Application on Home Screen
Selecting user display style
Appendix: Additional AutoStore instructions
Configuring authentication
LDAP Lookup Settings dialog box
Integration with MFP authentication
Adding and editing groups
Basic form
Scanning Settings
Email form
Folder form
SharePoint form
Authentication tab
Authentication Prompts dialog box
Custom Scripting authentication
Configuring the Scanning Settings
Scripting Overview
Unified Client component RRTs
Unified Client communication ports
Troubleshooting
Numeric field issue (on the server side)
User is removed from the current workflow
Device administrator cannot log in and cannot reach Settings > Registration
Documents sent from Kofax Business Connect cannot be printed
Canon device DRS configuration fails
Default Canon device administrator password fails
KBC authentication is not working when "Require PIN with card swipe" is enabled in OM settings
Epson Unified Client
Deployment steps
Prepare for deployment
Verify that your device is supported
Verify prerequisites
Download installer packages
Set up a scan watch folder
Installing the Unified Client for Epson
Install Equitrac
Install the Equitrac server
Enable Page Counters
Installing ControlSuite
Device Registration Service
Use DRS to configure and deploy the unified client
Device Web Server
Deployment scenarios
Managing the Device Web Server
Install the DWS with eCopy ShareScan
Install DWS after moving to an eCopy ShareScan only environment
Move to an eCopy ShareScan and Equitrac environment
Setting up the Epson MFP
Configure the Epson MFP
Update card reader settings to support Kofax Business Connect
Configuring the Unified Client for Epson
Setting up your first print workflow
Configure Print-to-Me
I-Queue printing
Use Print-to-Me
Reference
Application properties
Move from one DWS to another
Devices properties
Actions reference
Return codes
Appendix
Additional documentation
Troubleshooting
HP Unified Client
Features
Authorization
Deployment steps
Requirements
Preparing for deployment
Verify prerequisites
Equitrac configuration
Configure authentication prompts
Output Manager configuration
Set print preferences
AutoStore configuration
Scanning settings
Authentication configuration
Configure CAC for authentication
Card reader configuration
Configuring card self-registration
DWS configuration
Dual stack limitations
Deploying the Unified Client for HP
Installing ControlSuite
Update DWS certificates
Use DRS to configure and deploy the unified client
Setting up the HP device
Ensure that previous Kofax applications are cleared
Creating a print workflow
Configure Print-to-Me
Creating a capture workflow
Configure the Send to Folder workflow
Using the Unified Client for HP
Typical user workflows
Log in to the Unified Client for HP
Card self-registration
Launcher screen
Release All
Release Key
Billing codes
Enter billing codes
Log out
Printing
Print-to-Me
Use Print-to-Me
Print Jobs Details
Print Settings
Print with Business Connect
Scanning
Scan a document
Scan settings
Job tracking
Data collected in tracking
Reference
Unified Client for HP actions reference
Unified Client for HP application properties
Unified Client for HP device properties
Unified Client failover
Troubleshooting
Error messages
Konica Minolta Unified Client
Product features
Campus card support
Delegate printing support
Runtime Replacement Tag (RRT) support
Failover support
System requirements
Supported devices
Prepare for deployment of Unified Client for Konica Minolta
Equitrac configuration
Configuring authentication prompts
Output Manager configuration
Set print preferences
Configure device for access control
AutoStore configuration
Scanning settings in AutoStore
Dynamic form support
Migrate workflows
Workflow configuration
Walk-up copy workflows and billing codes
Authentication configuration
Credential caching
DWS configuration
DWS configuration for TLS
Certificate management
DWS certificate management
Server certificate management
Device certificate management
Certificate acceptance
Dual stack limitations
Device configuration
SSL
Enable and configure SSL
TCP socket setting
Page size release
Web browser
WebDAV client
Auto reset
Printing support
Hide slide menu tab
Card reader configuration
Considerations for setting up a card reader
Configuring card reader authentication
Configuring card self-registration
Deploy Unified Client for Konica Minolta
Overview of the deployment process
DRS setup and device registration
Change configuration
Unregister Unified Client for Konica Minolta from the device
Create a first workflow in AutoStore
Using Unified Client for Konica Minolta
Getting started with the Unified Client for Konica Minolta
Logging on
Card self-registration
Public access
Billing codes
Launcher screen
Release key
Device Home button
Screen elements
Logging off
Printing features
Print job management
Print-to-Me screen
Print Jobs Details screen
Print Settings screen
Printing with Kofax Business Connect
Scanning features
Scan documents
Scan form fields
Job tracking
Data collected in tracking
Reference
Unified Client for Konica Minolta application properties
Unified Client for Konica Minolta device properties
Unified Client for Konica Minolta actions reference
Debugging tips
DWS debug logs
Device debug logs
Troubleshooting the Unified Client for Konica Minolta
Error messages
Lexmark Unified Client
Features
System requirements
Prepare to deploy the Unified Client for Lexmark
Equitrac configuration
Configure authentication prompts
Configure the Quick Shortcut buttons
DCE pinning
Output Manager configuration
Add a device
Set print preferences
AutoStore configuration
Scanning settings
Workflow configuration
Walk-up copy workflows and billing codes
Authentication configuration
Configure CAC for authentication
Card reader configuration
Configuring card self-registration
Device configuration
Enable HTTPS
Create a local device administrator
Deploy the Unified Client for Lexmark
Use DRS to configure and deploy the unified client
Using the Unified Client for Lexmark
Getting started
Log onto the Unified Client for Lexmark
Card self-registration
Change the language on the device
Launcher screen
Home button
Screen elements
Release All
Release Key
Billing codes
Log out
Printing
Print-to-Me
Print Jobs Details
Print Settings
Print with Business Connect
Scanning
Create an AutoStore workflow
Scan settings
Scan a document
Job tracking
Data collected in tracking
Reference
Unified Client for Lexmark actions reference
Unified Client for Lexmark application properties
Unified Client for Lexmark device properties
Debugging tips
Download debugging logs
Troubleshooting
Error messages
Ricoh Unified Clients
Ricoh SOP for AutoStore
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy the Unified Client for Ricoh Smart Operation Panel
Install and configure the AutoStore server
Install ControlSuite for AutoStore
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Use DRS to configure and deploy the unified client
Upgrade from Ricoh SOP 1.2.0 to 1.3.0
Uninstall the client using DRS
DRS authorization
Using the Unified Client for Ricoh Smart Operation Panel
Elements of Unified Client for Ricoh Smart Operation Panel user interface
Launcher screen
Set up your first AutoStore Capture workflow
Configure Scan to Folder
Reference
Unified Client for Ricoh actions reference
Return codes
Action status codes
Unified Client for Ricoh application properties
Unified Client for Ricoh device properties
Device status
Files tab
Application types
Add a device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Device configuration for AuthOff
Configuring the Common Access Card authentication solution
Configure SP Mode Settings
Change the TLS settings
DRS Authorization Key
Restart the device
Ricoh SOP for AutoStore and Equitrac
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy the Unified Client for Ricoh Smart Operation Panel
Install and configure the AutoStore server
Install Equitrac
Install the Equitrac server
Enable login for CAS offline mode through DCE caching
Install ControlSuite for AutoStore and Equitrac
Device Registration Service
Use DRS to configure and deploy the unified client
Upgrade from Ricoh SOP 1.2.0 to 1.3.0
Uninstall the client using DRS
DRS authorization
Set up a Ricoh MFP device
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Configuring Equitrac to use with Unified Client for Ricoh Smart Operation Panel
Configure Equitrac
Installation and configuration
Server-side configuration scenario
Additional documentation for Equitrac 5.7
Equitrac card readers
Card reader setup
USB Keyboards
Using the Unified Client for Ricoh Smart Operation Panel
Elements of the Unified Client for Ricoh Smart Operation Panel user interface
Launcher screen
Typical user workflows
Logging into Unified Client for Ricoh Smart Operation Panel
Azure AD authentication with card registration
If you have difficulty logging in
Enter billing codes
Print-to-Me
Scanning
Terminology
Prepare to scan
Delivery formats
Search using LDAP Email
Logout
Set up your first AutoStore Capture workflow
Configure Scan to Folder
Set up your first print workflow
Use Print-to-Me
Reference
Unified Client for Ricoh actions reference
Return codes
Action status codes
Unified Client for Ricoh application properties
Unified Client for Ricoh device properties
Device status
Files Tab
Application types
Add a new Device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Job tracking
Enable home key settings
Enable the billing code prompt
Disable print from USB
Configuring the Common Access Card authentication solution
Configure SP mode settings
Change the TLS settings
Set the paper type
System configuration settings
DCE pinning
DRS Authorization Key
Restart the device
Ricoh SOP for AutoStore and Output Manager
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy the Unified Client for Ricoh Smart Operation Panel
Install and configure the AutoStore server
Install and configure Output Manager
Install ControlSuite for AutoStore and Output Manager
Device Registration Service
Use DRS to configure and deploy the unified client
Upgrade from Ricoh SOP 1.2.0 to 1.3.0
Uninstall the client using DRS
DRS authorization
Set up a Ricoh MFP device
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Using the Unified Client for Ricoh Smart Operation Panel
Elements of the Unified Client for Ricoh Smart Operation Panel user interface
Launcher screen
Typical user workflows
Typical usage
Output Manager login
Login settings
User name and password entry
Card swipe
Manual ID entry
Azure AD authentication with card registration
Screen layout
View print jobs
Logout
Set up your first AutoStore Capture workflow
Configure Scan to Folder
Set up your first print workflow
Add sources
Add destinations
Manually route documents to a destination
Reference
Unified Client for Ricoh actions reference
Return codes
Action status codes
Unified Client for Ricoh application properties
Unified Client for Ricoh device properties
Device status
Files tab
Application types
Add a new device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Job tracking
Enable home key settings
Disable print from USB
Configuring the Common Access Card authentication solution
Configure SP Mode Settings
Change the TLS settings
Set the paper type
DRS Authorization Key
Restart the device
Ricoh SOP for Output Manager
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy the Unified Client for Ricoh Smart Operation Panel
Install and configure Output Manager
Install ControlSuite for Output Manager
Device Registration Service
Use DRS to configure and deploy the unified client
Upgrade from Ricoh SOP 1.2.0 to 1.3.0
Uninstall the client using DRS
DRS authorization
Set up a Ricoh MFP device
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Using the Unified Client for Ricoh Smart Operation Panel
Elements of the Unified Client for Ricoh Smart Operation Panel user interface
Launcher screen
Typical user workflows
Typical usage
Output Manager login
Login settings
User name and password entry
Card swipe
Manual ID entry
Azure AD authentication with card registration
Screen layout
View print jobs
Logout
Set up your first print workflow
Add sources
Add destinations
Manually route documents to a destination
Reference
Unified Client for Ricoh actions reference
Return codes
Action status codes
Unified Client for Ricoh application properties
Unified Client for Ricoh device properties
Device status
Files tab
Application types
Add a new Device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Job tracking
Enable home key settings
Disable print from USB
Configuring the Common Access Card authentication solution
Configure SP Mode Settings
Change the TLS settings
Set the paper type
DRS Authorization Key
Restart the device
Ricoh PCC for Equitrac
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy Ricoh PCC
Install Equitrac
Install the Equitrac server
Enable login for CAS offline mode through DCE caching
Install ControlSuite for Equitrac
Set up the Equitrac Embedded for Ricoh PCC SFP or MFP
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Device Registration Service
Use DRS to configure and deploy the unified client
Upgrade from Ricoh PCC 5.2.0 to 5.3.0
Uninstall the client using DRS
DRS authorization
Configuring Equitrac to use with Ricoh PCC
Configure Equitrac
Installation and configuration
Server-side configuration scenario
Additional documentation for Equitrac 5.7
Equitrac card readers
Card reader setup
USB keyboards
Using Ricoh PCC
Elements of the Ricoh PCC user interface
Launcher screen
Typical user workflows
Logging in
Azure AD authentication with card registration
If you have difficulty logging in
Enter billing codes
Print-to-Me
Scanning
Terminology
Prepare to scan
Delivery formats
Search using LDAP Email
Logout
Set up your first print workflow
Use Print-to-Me
Reference
Actions reference
Error codes
Return codes
Action status codes
Application properties
Device properties
Device status
Files tab
Application types
Add a new Device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Job tracking
Enable home key settings
Enable the billing code prompt
Disable print from USB
Configuring the Common Access Card authentication solution
Configure SP Mode settings
Change the TLS settings
Set the paper type
System configuration settings
DCE pinning
DRS Authorization Key
Restart the device
Supporting a mixed fleet environment
Ricoh PCC for AutoStore and Equitrac
Deployment steps
Prepare for deployment
Requirements
Verify prerequisites
Download installer packages
Deploy Ricoh PCC
Install and configure the AutoStore server
Install AutoStore
Install Equitrac
Install the Equitrac server
Enable login for CAS offline mode through DCE caching
Install ControlSuite for Equitrac and AutoStore
Device Registration Service
Use DRS to configure and deploy the unified client
Upgrade from Ricoh PCC 5.2.0 to 5.3.0
Uninstall the client using DRS
DRS authorization
Set up a Ricoh PCC MFP
Configuring a Ricoh device in a unified client environment
Install and configure the TLS certificates
Ensure that previous applications are cleared
Configuring Equitrac to use with Ricoh PCC
Configure Equitrac
Installation and configuration
Server-side configuration scenario
Equitrac card readers
Card reader setup
USB keyboards
Using Ricoh PCC
Elements of the Ricoh PCC user interface
Launcher screen
Typical user workflows
Logging in
Azure AD authentication with card registration
If you have difficulty logging in
Enter billing codes
Print-to-Me
Scanning
Terminology
Prepare to scan
Delivery formats
Search using LDAP Email
Logout
Set up your first AutoStore Capture workflow
Configure Scan to Folder
Set up your first print workflow
Use Print-to-Me
Reference
Actions reference
Return codes
Action status codes
Application properties
Device properties
Device status
Files tab
Application types
Add a new device profile
Import device information
Appendix: Additional configuration instructions
Troubleshooting
Download logs
Job tracking
Enable home key settings
Enable the billing code prompt
Disable print from USB
Configuring the Common Access Card authentication solution
Configure SP Mode settings
Change the TLS settings
Set the paper type
System configuration settings
DCE pinning
DRS Authorization Key
Restart the device
Supporting a mixed fleet environment
Samsung Smart UX Unified Client
Checklist: Unified Client for Samsung Smart UX implementation
Requirements
Configuring Kofax Unified Client for Samsung Smart UX
Configure AutoStore
AutoStore features
AutoStore server-side configuration
Additional documentation for AutoStore
AutoStore Smart UX component licensing
Configure Equitrac
Equitrac features
Installation and configuration
Before you install
Equitrac server-side configuration
Additional documentation for Equitrac
Equitrac card readers
Card reader setup
USB keyboards
Server Side Configuration
Licensing Unified Client for Samsung Smart UX
If the license is invalid
If the serial number is denied
Add a printer on a TCP/IP printer port
Server-side configuration
Configuring Unified Client for Samsung Smart UX embedded devices
Automatically creating embedded devices
Manually configuring embedded devices
Licensing the device
Enabling the Guest user
Guest user setup
Configuring workflows
Tracking jobs originating at the device
Setting timeouts
Configuring card self-registration
Enabling secure printing
Secure printing on the physical device
Enable secure printing on the embedded device
Configure Print-to-Me
Configure Capture and Send
Scan-to-Me
Configure the Mail Server
Enforce color quotas
Enable the billing code prompt
Operation through DCE caching
Configure account and session display
Configuring available MFP functions
Elements of Unified Client for Samsung Smart UX user interface
Samsung Smart UX workflow and workflow container settings for the device
Multi-language support
Using Kofax Unified Client for Samsung Smart UX
Typical user workflows
Logging into Unified Client for Samsung Smart UX
If you have difficulty logging in
Enter billing codes
Using Print-to-Me
Scanning
Terminology
Prepare to scan
Using LDAP Email Search
Reference
Application properties
Device properties
Device status
Files tab
Actions reference
Return codes
Action status codes
Quick start
Quick setup process for AutoStore
Quick setup process for Equitrac
Quick setup process for AutoStore and Equitrac
Toshiba Unified Client
AutoStore solution overview
Basic workflow
Preparing for deployment
Verify that your device is supported
Verify prerequisites
Download installer packages
Installing the Unified Client for Toshiba
Install the AutoStore server
License AutoStore
Installing ControlSuite
Install DWS standalone
Set up the Toshiba MFP
Configure the Toshiba MFP in a Kofax Unified Client environment
Install SSL/TLS root certificate
Import or create the Device Certificate on the Toshiba device
Ensure SSL/TLS is enabled for ODCA on the Toshiba device
Clear previous applications
Install DRS and upload the client package
Configuring the Unified Client for Toshiba
Set up your first capture workflow
Configure Send to Folder
Equitrac solution overview
Basic workflow
Preparing for deployment
Verify that your device is supported
Verify prerequisites
Download installer packages
Installing the Unified Client for Toshiba
Installing Equitrac
Install the Equitrac server
Install the Equitrac hotfixes
Installing ControlSuite
Set up the Toshiba MFP
Configure the Toshiba MFP in a Kofax Unified Client environment
Install SSL/TLS root certificate
Import or create the Device Certificate on the Toshiba device
Ensure SSL/TLS is enabled for ODCA on the Toshiba device
Clear previous applications
Install DRS and upload the client package
Configuring the Unified Client for Toshiba
Set up your first print workflow
Configure Print-to-Me
I-Queue printing
Use Print-to-Me
AutoStore and Equitrac solution overview
Basic workflow
Preparing for deployment
Verify that your device is supported
Verify prerequisites
Download installer packages
Installing the Unified Client for Toshiba
Install the AutoStore server
License AutoStore
Installing Equitrac
Install the Equitrac server
Install the Equitrac hotfixes
Installing ControlSuite
Set up the Toshiba MFP
Configure the Toshiba MFP in a Kofax Unified Client environment
Install SSL/TLS root certificate
Import or create the Device Certificate on the Toshiba device
Ensure SSL/TLS is enabled for ODCA on the Toshiba device
Clear previous applications
Install DRS and upload the client package
Configuring the Unified Client for Toshiba
Set up your first capture workflow
Configure Send to Folder
Set up your first print workflow
Configure Print-to-Me
I-Queue printing
Use Print-to-Me
Device Web Server
Deployment scenarios
Managing the Device Web Server
Install the DWS with AutoStore
Install the DWS after moving to an AutoStore only environment
Move to an AutoStore and Equitrac environment
Reference
Device properties
Actions reference
Application properties
Xerox Unified Client
System requirements
Prepare for deployment of Unified Client for Xerox
Equitrac configuration
Configuring authentication prompts
Output Manager configuration
Set print preferences
AutoStore configuration
Scanning settings in AutoStore
Scan settings constraints
Dynamic form support
Migrate workflows
Workflow configuration
Centralized and decentralized workflows
Walk-up copy workflows and billing codes
Authentication configuration
Xerox component RRTs
Credential caching
Timeout configuration
DWS configuration
Failover support
DWS configuration for TLS
Certificate management
DWS certificate management
Server certificate management
Device certificate management
Export the root self-signed certificate from DWS
Device configuration
AltaLink configuration
PrimeLink configuration
VersaLink properties
Dual stack limitations
Card reader configuration
Card reader licensing
Adding card reader support
Adding Smart Card Support
Configuring card reader authentication
Configuring card self-registration
Deploy Unified Client for Xerox
Overview of the deployment process
DRS setup and device registration
Unregister Unified Client for Xerox from the device
Set language of client
Create a first workflow
Using Unified Client for Xerox
Getting started with the Unified Client for Xerox
Logging on
Card self-registration
Billing codes
Launcher screen
Release key
Device Home button
Screen elements
Logging off
Printing features
Print job management
Print-to-Me screen
Print Jobs Details screen
Print Settings screen
Printing with Kofax Business Connect
Reconcile print transactions
Scanning features
Scan documents
Scan form fields
Scan Settings screen
Job tracking
Data collected in tracking
Reference
Unified Client for Xerox application properties
Unified Client for Xerox device properties
Unified Client for Xerox Actions reference
Debugging tips
DWS debug logs
Device debug logs
Troubleshooting the Unified Client for Xerox
Error messages
Combined Clients Overview
Konica Minolta Combined Client
Implementation checklist
Requirements
ControlSuite deployment
Install ControlSuite for AutoStore
Install ControlSuite for Equitrac
Install ControlSuite for Output Manager
Install ControlSuite for Equitrac and AutoStore
Install ControlSuite for AutoStore and Output Manager
Prepare the MFP to run the Kofax Combined Client for Konica Minolta
Configure Konica Minolta OpenAPI
Configure MFP Auto Reset Settings
Configure MFP for print release
Configuring a device to use the authentication application
Configure a device to use SSL for Web Services (OpenAPI)
Configure WebDAV to use SSL
Configure TCP Socket Setting to use SSL/TLS
Enable Web Browser
Check Authentication
Certificate validation
Configuring the Kofax Combined Client for Konica Minolta
Configure Equitrac
Server side configuration
Configuring secure printing
Configuring an embedded device
Configuring Authentication Prompts
Configure printer driver
Configure device print tracking
Configure user authentication
Configure print authentication at the MFP
Configuring card self-registration
Configuring billing codes
Configuring a default billing code
Enforcing color quotas
Receiving print error messages
Equitrac only deployment configuration
Copy Stop
Configure Output Manager
Output Manager authentication
Card reader authentication with Output Manager
Output Manager touchscreen authentication
How to configure client web server
Configure Output Manager devices
Configure device for accounting
Configure device for access control
Configure device for print preferences
Configure login methods
Configure billing accounts
Configure copy quota for users
Configure a destination
Accounting
Output Manager only deployment
Configure AutoStore
AutoStore authentication
AutoStore only deployment
Using the Kofax Combined Client for Konica Minolta
Combined Client for Konica Minolta login
Output Manager login
AutoStore login
Equitrac login
Switch between capture and print
Manage print jobs
Configure print settings
View Print Manager job information
Start an AutoStore workflow
Reference
Application settings
Device settings
Actions reference
Return codes
Restrictions and Limitations
Troubleshooting
Ricoh Combined Client
Checklist: Combined Client for Ricoh Implementation
Requirements
Configuring the Kofax Combined Client for Ricoh
Configure Output Manager
Configure the SSL port
Configure Output Manager devices
Configure device for accounting
Configure device for access control
Configure device for print preferences
Configure sign-in methods
Configure billing accounts
Configure copy quotas
Accounting
Enable quota management
Configure AutoStore
Configure Equitrac
Server side configuration
Configure Secure Printing
Configure an embedded device
Configure authentication prompts
Configure card self-registration
Configure billing codes for Combined Client for Ricoh devices
Configure a default billing code
Enforce color quotas
Receiving print error messages
Configure Combined Client for Ricoh device properties
Upload the Ricoh Combined Client Xlets to the server
Install the Combined Client for Ricoh
Modify the Ricoh Xlet
Install the SSO Xlet
Configure authentication on a device
Configure a device for external authentication
Turn off internal authentication
Turn on Enhanced External Charge Unit Management
Configure user access to device functions
Activate access control for internal authentication
Configure a device for internal authentication
Configure LDAP and user authentication at a device
Configure LDAP and user authentication
Internal authentication and Address Book
Configure authentication settings in Output Manager
Configure SNMPv3 settings
Single sign-on integration
Single sign-on integration
Single sign-on under internal authentication
Single sign-on under AAA
Single sign-on under CAP
Using the Kofax Combined Client for Ricoh
Combined Client for Ricoh login
Output Manager login
Login settings
User name and password entry
Card swipe
Manual ID entry
AutoStore login
Equitrac login
Screen layout
Configuration on the device
Print settings
Job information
Billing accounts
View Print jobs
View Job information
Logout
Reference
Combined Client for Ricoh application properties
Combined Client for Ricoh Device properties
Files tab
Ricoh authentication modes
Combined Client for Ricoh Action properties
Combined Client for Ricoh actions reference
Import guidelines
Combined Client for Ricoh return codes
Restrictions and limitations
Troubleshooting the Kofax Combined Client for Ricoh
Xerox EIP Connect
Device Setup and Configuration Prerequisites
Supported devices
Using the Xerox EIP Connect component
Configuring the Xerox EIP Connect Capture component
Configure Preferences settings
Enabling authentication for the component
Restrict access using Xerox Secure Access
Managing groups
Add a group
Edit a group
Remove a group
Enabling group level authentication
Adding a menu
Restrict access to a menu
Adding and editing forms
Adding a form
Edit a form
Restrict access to a form
Enable a dynamic form
Add fields to a form
Save a form as a template
Create a form from a template
Xerox EIP Connect settings
Groups tab
Group Settings dialog box
Menu Properties dialog box
Forms
Basic form
Checkbox field options
Date field options
Date
List field options
Lookup List field options
General SQL syntax
Numeric field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Send to DocuShare form
Send to Email form
Send to Folder form
Send to SharePoint form
Save Form as Template dialog box
Preferences tab
Advanced Server Settings dialog box
New Self Signed Certificate dialog box
Authentication tab
Authentication Prompts dialog box
LDAP Lookup Settings dialog box
Device Registration tab
Component RRTs
Troubleshooting tips
Restrictions and limitations
AutoStore Clients Overview
Fuji Xerox AIP
Overview
Prerequisites: Device setup and configuration
Supported devices
Using the Fuji Xerox AIP component
Configuring the Fuji Xerox AIP capture component
Configure Preferences settings
Register devices
Enable authentication for the component
Restrict access using the Fuji Xerox Authentication Agent
Managing groups
Add a group
Edit a group
Remove a group
Enable group-level authentication
Add a menu
Restrict access to a menu
Adding and Editing Forms
Add a form
Edit a form
Restrict access to a form
Enable a dynamic form
Add fields to a form
Save a form as a template
Create a form from a template
Configuring the component
Groups tab
Group Settings dialog box
Menu Properties dialog box
Forms
Basic form
Checkbox field options
Date field options
Date formats
List field options
Lookup List field options
General SQL syntax
Numeric field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Send to DocuShare form options
Send to Email form
Send to Folder form options
Send to SharePoint form options
Save Form as Template dialog box
Preferences tab
Advanced Server Settings dialog box
New Self Signed Certificate dialog box
Authentication tab
Authentication Prompts dialog box
LDAP Lookup Settings dialog box
Device Registration tab
Add/Edit Device Group dialog box
Add/Edit Device dialog box
Fuji Xerox AIP component RRTs
Restrictions and limitations
Troubleshooting Tips
Fujifilm AIP
Overview
Prerequisites: Device setup and configuration
Supported devices
Using the Fujifilm AIP component
Configuring the Fujifilm AIP capture component
Configure Preferences settings
Register devices
Enable authentication for the component
Restrict access using the Fujifilm Authentication Agent
Managing groups
Add a group
Edit a group
Remove a group
Enable group-level authentication
Add a menu
Restrict access to a menu
Adding and Editing Forms
Add a form
Edit a form
Restrict access to a form
Enable a dynamic form
Add fields to a form
Save a form as a template
Create a form from a template
Configuring the component
Groups tab
Group Settings dialog box
Menu Properties dialog box
Forms
Basic form
Checkbox field options
Date field options
Date formats
List field options
Lookup List field options
General SQL syntax
Numeric field options
Text field options
Tree field options
Add/Edit Tree Item dialog box
Send to DocuShare form options
Send to Email form
Send to Folder form options
Send to SharePoint form options
Save Form as Template dialog box
Preferences tab
Advanced Server Settings dialog box
New Self Signed Certificate dialog box
Authentication tab
Authentication Prompts dialog box
LDAP Lookup Settings dialog box
Device Registration tab
Add/Edit Device Group dialog box
Add/Edit Device dialog box
Fujifilm AIP component RRTs
Restrictions and limitations
Troubleshooting Tips
HP OXPd
Overview
Supported devices
Firmware requirements
Using the HP OXPd component
Use the HP OXPd component
Hosting the component in IIS
Configuring roles and features
Verifying the ASP.NET 4.0 configuration
Configuring access to the application pool identity
Creating the IIS web application
Enabling authentication
Validating the IIS web application
Disabling the component web server
Configuring the component for IIS
Enabling HP OXPd 1.6 on Oz devices
Configuring the HP OXPd component
General tab
Group options
Application options
Menu options
Form options
Label Field Options
List Field Options
Numeric Field Options
Text Field Options
Shared form options
Preferences tab
Device Manager options
Configure language settings for an HP OXPd device
Manage certificates
RRT Format tab
Authentication tab
Using SSL with Active Directory Application Mode
Obtaining a Certificate on a Windows 2003 Server
Using the Certificate with the ADAM Service
Verifying that SSL is Working with ADAM
HP OXPd component RRTs
Deploying top-level buttons to MFP devices
Deploy top-level buttons with Device Manager
Deploy top-level buttons with HP Web Jetadmin
Troubleshooting tips
Kyocera MFP (HyPAS)
Overview
Using the Kyocera MFP (HyPAS) component
Kyocera MFP (HyPAS) Component configuration
Groups tab
Groups
Menus
Forms
Basic form
PDF Encryption Settings dialog box
Send to Folder form
Email form
Send to SharePoint form
Form templates
Field types
Checkbox field options
Date/time field options
List field options
Numeric field options
Text field options
Tree field options
Preferences tab
Authentication tab
LDAP Lookup Settings dialog box
Kyocera MFP (HyPAS) component RRTs
Setting the component log level
Device setup and configuration
Install the KYOcapture MFP application
License the KYOcapture application
Configure the KYOcapture application for the first time
Change a configuration
Scan a document from a device
Supported devices
Lexmark MFP
Overview
Getting started
Supported devices
Device Deployment Utility tool
Installing and configuring the Lexmark Client software
Install the Lexmark client software
Configure the Lexmark client to use the AutoStore server
Determine the host name or IP address of the AutoStore server
Assign a solution ID to the AutoStore client (eSF 1.2-eSF 4.0)
Configure authentication on the Lexmark MFP (eSF 2.0-eSF 4.0)
Configure authorization on the Lexmark MFP (eSF 6.0, 7.0, and 9.0)
Test the AutoStore client with the Lexmark MFP device
Export settings configuration files
AutoStore settings for the Lexmark MFP
General tab
Group Settings dialog box
Menu Settings dialog box
Form Settings dialog box
General tab
Fields tab
Text Field Properties dialog box
Integer Field Properties dialog box
Numeric Field Properties dialog box
List Field Property dialog box
Tree Field Properties dialog box
Components tab
Appearance tab
Form List dialog box
Preferences tab
RRT's Format tab
Custom date-time format strings
Authentication (eSF 2.0, 3.0, 4.0, 6.0, 7.0, and 9.0) tab
Obtain an SSL certificate
LDAP Lookup Settings dialog box
Lexmark MFP component RRTs
Equitrac Clients Overview
Canon MEAP Embedded Client
Supported MFPs
USB Availability
Installation Overview
Pre-installation
Additional Documentation
Prerequisites
Pre-Installation Workflow
Planning the Deployment
Licensing the Embedded Application
Downloading the Embedded Application
Embedded Application Installation
Machine status during installation
Installing the Embedded Application
Verifying the Installation
Uninstalling an Existing Installation
Server-Side Configuration
Configuring the Embedded Device
Configure Embedded Device Settings
Configuring Authentication Prompts
Configuring Card Self-Registration
Configuring Follow-You Printing
Enabling Release Keys
User Workflows
Using the Card Reader
Logging in with a Magnetic Stripe Card
Logging in with a Proximity Card
Logging with Campus Card
Card Reader Status Messages
Registering Swipe Cards
Using the MFP Device
Using Follow-You Printing
Setting Print Options
Setting Temporary Default Print Options
Using Multi-Server Follow-You Printing
Accessing the Device Functions
Administrator Reference Material
Canon System Manager
Offline Mode and the Administrator
Administrator Tracking and Validation
Normal Users and Departmental Management
Transactions, Power Failure and Offline
Behavioral Changes
Configure the Equitrac Application
Log Files
Obtaining Equitrac Embedded Installer Log Files
Obtaining Device Application Logs from the Server
Obtaining Device Application Logs from the Device
Troubleshooting
Glossary
Fuji Xerox ECSP Embedded Client
About user authentication
Xerox ECSP Features
Installation and configuration requirements
Server and MFP requirements
System requirements
Supported MFPs
Magstripe device reader
Proximity cards
List of terms
MFP configuration
ApeosPort multifunction devices
Lock the device services
Configure MFP properties
Server-side configuration
Configure secure printing
Configure authentication prompts
Set Fuji Xerox API authentication prompts
Enable release keys
Configure card self-registration
Configure billing code popup behavior
Configure a default billing code
Configure embedded devices
Configure eCopy embedded client
Configure workflows
Print tracking configuration
Track printing through printer ports
Track printing using Fuji Xerox Network Accounting
Disable Equitrac print tracking
Track color copies and prints using Xerox tiered billing
Enforce color quotas
Enable escrow for print and copy
Print error messages
Reconcile print transactions
Configure SNMP communication
Add a customized logo
Equitrac USB Card Reader plugin
Install Equitrac USB Card Reader plugin
Configure Equitrac USB Card Reader plugin
User workflows
Authenticate with a magnetic stripe card
Authenticate with a proximity card
Card Reader status messages
Set up EPA card readers
Set up USB card readers
Logging in to a user session
Equitrac Server authentication
Selecting functions
Using Follow-You Printing
Scanning
ControlSuite HelpControlSuite Help