ControlSuite Web Help
Install and Configure ControlSuite
ControlSuite overview
Equitrac overview
AutoStore overview
Output Manager overview
Business Connect overview
Preparing to install ControlSuite
Install Roles and Features
Installing ControlSuite
ControlSuite installation overview
Equitrac installation overview
AutoStore installation overview
Output Manager installation overview
Business Connect installation
Device Registration Service overview
Device Web Service installation overview
Advanced manual install
Install ControlSuite on multiple nodes
Create an offline installation package
Configuring ControlSuite
Modify databases
Configure Output Manager for high availability
Configure Output Manager with SAP in a high availability environment
Licensing ControlSuite
Licensing AutoStore
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
Delete a dead node
Uninstall ControlSuite
Clean up IIS Bindings
Remove certificates
Remove folders and files
Remove registry entries
System Requirements
ControlSuite System Requirements
Equitrac Requirements
AutoStore Requirements
Output Manager Requirements
DRS Requirements
Communication Ports
Equitrac Communication Port Reference
AutoStore Communication Port Reference
Output Manager Communication Port Reference
DRS Communication Port Reference
Capture - AutoStore
AutoStore Overview
Introduction
What is AutoStore?
AutoStore server architecture
AutoStore object model
AutoStore Applications and Tools
Runtime Replacement Tags (RRTs)
Welcome to AutoStore Process Designer
Using AutoStore Process Designer
Start AutoStore Process Designer
Working with configurations
Working with tasks
Working with components in a task
Working with configuration templates
Running processes in AutoStore Process Designer
AutoStore Process Designer user interface
APD Options dialog box
Task Properties dialog box
Isolated Component Properties dialog box
Isolated Task Properties dialog box
Ribbon
Capture Components
Overview
AutoCapture Server
Batch Importer
POP3 Email
FTP Poll
Fuji Xerox AIP
HP MFP/Digital Sender OXPd
HP OXPd
IMAP Capture
Knowledge Package Loader Capture
Konica Minolta iOption
Kyocera MFP (HyPAS)
Lexmark MFP
Multi-Poll
MFD Capture
Ricoh ESA
Ricoh SOP
RightFax Capture
Samsung
Samsung SmartUX
SFTP Poll
SMTP Capture
Toshiba Unified Client
ControlSuite PJ Submission Workflow
Web Capture
Xerox EIP Connect
Unified Client
Universal Capture
Process Components
Overview
ApplicationXtender Component
Autonomy WorkSite
Barcode
Bates Stamp
Binder
Box
Command Line Execution
d.3
Datacap
Datacap9
Data Filter
Directory Services
DocTransformProcess
Document Writer
Documentum (6.x)
DocuShare
DocuWare
ELO
FileNet
FileNet P8
File Options
Form Overlay
Google Docs
HL7
HP TRIM
Hummingbird/Open Text eDOCS
IBM CM
IBM CM OnDemand
Knowledge Package Builder
Knowledge Package Loader - Process
Kofax TotalAgility eConnector
Laserfiche
Notification component
Office Converter
OneDrive
OmniPage Barcode
OP Binder
OpenText Livelink/Content Server
OPOCR
Outlook MSG Loader
PowerShare
Professional Image Management
ProLaw
Redaction
RightFax Route
Send to Database
Send to Dropbox
Send to Folder
Send to FTP
Send to HTTP Help
Send to Mail Recipient
Send to SFTP
SharePoint
ControlSuite Print Job Submission
VB/J Script
VIP
Workflow Tracker
XML Importer
WebDAV
Windream
Worldox
XML Generator
Route Components
Overview
ApplicationXtender Component
Autonomy WorkSite
Box
Datacap
Datacap9
Documentum (6.x)
DocuShare
DocuWare
ELO
FileNet
FileNet P8
Google Docs
HP TRIM
Hummingbird/Open Text eDOCS
IBM CM
IBM CM OnDemand
IXOS
Kofax TotalAgility
Laserfiche
Multi Router
OneDrive
OpenText Livelink/Content Server
PowerShare
ProLaw
RightFax Route
Send to Database
Send to Database (Bulk)
Send to Dropbox
Send to Folder
Send to FTP
Send to HTTP Help
Send to Mail Recipient
Send to PC
Send to SFTP
SharePoint
ControlSuite Print Job Submission
VB/J Script
WebDAV
Windream
Worldox
XML Generator
Sunset Pack
Sunset Pack
Alchemy
Alfresco
Content Management Queue
Encryption/Decryption
Fortis
FortisBlue
Konica Minolta MFP
LAN Fax
Lotus Notes Domino
Send to Printer
Sharp MFP (OSA)
Xerox
Applications and Clients
Welcome to the AutoCapture Client component
Installing the AutoCapture Client
Using the AutoCapture Client application
Capturing Microsoft Office documents or messages
Using AutoCapture Explorer client
Configure AutoCapture client settings
Customize AutoCapture client
Welcome to Bates Stamp Server Administrator
Getting started
Configuring
Restrictions and limitations
Troubleshooting tips
Welcome to Bates Stamp Server Supervisor
Getting started
Configuring
Restrictions and limitations
License Manager overview
License Manager window
Creating a license report
Checking server version
Send to PC Client Configuration dialog box
Troubleshooting tips
Welcome to the Status Monitor application
Introduction
Appendices
Appendices
Date and time formats
Field Expressions
Using Conditional Field
AutoStore ControlSuite Service settings
Print Management - Equitrac
Introduction
What is Equitrac?
Core Server Components
Supporting Components
Application-level Access Permissions
Windows-level Access Permissions
Additional Documentation
System Dashboard Overview
System Dashboard - Licenses
System Dashboard - Accounts
System Dashboard - Devices
System Dashboard - Accounting
Create and Manage Accounts
Accounts Overview
Create New Accounts
Work with Departments
Work with User Accounts
Configure Active Directory Synchronization
Configure LDAP Synchronization
Manage User Accounts
Search Filters
User Authentication
External User Authentication
Select Notification Methods
Charge to Departments
Account Charging and Limits
Escrow
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
Control Transaction Tracking
Work with Self-service Accounts
Configure the Guest User Feature
Configuring the Account Monitor Popup
Working with Billing Codes
Enabling System-Wide Billing Code Access
Configuring Billing Code Popup Behavior
Creating Billing Codes
Enabling User or Department Billing Codes
Removing Billing Codes from a User or Department
Synchronizing Billing Codes
Using Client Billing on a Workstation
Managing Devices
Device Types
Device Status Tracking
Editing and Removing Devices
Importing Devices
Physical Devices
Embedded Devices
VPSX Devices
InfoPrint Manager Devices
Configuring Print Queues
Managed Queues
I-Queues
Print Job Submission
Workstation Devices
Configuring eCopy ShareScan
Setting up a Print Separator Page
Device Monitoring with DME
DME Workflow
SNMP Communication Requirements
Configuring SNMP Communication
Selecting Devices for DME to Monitor
Generating Device Status Reports
Routing Based on Device Status
Control Terminals
Card Reader Hardware Overview
Configuring Ethernet Card Readers
Associating the Card Reader with Another Printer
Managing Ethernet Card Readers
Recovering an Inaccessible Card Reader
HID Cards
HID Decoding
Supported HID Card Types
Advanced Printing Configuration
Enabling Secure Printing
Managing Device Pull Groups
Setting Up Follow-You Printing
Releasing Prints to First Available DRE
Printer Driver Management
Configuring Send To Printing
Desktop Printing
Configuring Price Lists
Overview of Price List Types
Price List Workflow
Cost Calculation and Currency
Creating Basic Print/Copy Price Lists
Advanced Print/Copy Price Lists
Creating Large-Format Price Lists
Fax Price Lists
Scan Price Lists
Departmental Pricing
Default Price Lists
Primary vs. Dual Pricing
Assigning Price Lists
Applying Price Lists
Repricing Jobs on Release
Routing Rules
Rules Overview
Creating Print Rules
Interactive Print Rules
Copy Rules
Working with Routing Groups
Creating Desktop Print Rules
Scheduling Tasks
Defining a Schedule Recurrence
Scheduling a Report Task
Scheduling a Billing Code Task
Schedule an Arbitrary Command
Scheduling a Color Quota Task
Scheduling an Account Balance Task
Scheduling a Purge Transactions Task
Running a Missed Task
Suspending, Resuming, or Removing a Scheduled Task
Creating and Running Reports
System Dashboard Reports
Configuring a Savings Report
Scheduling Reports to Run Automatically
Running Consolidated Reports
Manage Scan and User Workflows
Configuring Workflows
Configuring Workflow Containers
Configuring Scan Processing and Delivery
Configuring SMTP Mail Server for SPE
Load Balancing
Configuring Load Balancing
Configuring SPE Nodes
Configuring Scan Destinations
Enabling Scan-to-Me
Scan Client
Working with the Scan Client
Using the Scan Filters
Sorting the Scan List
Additional Functions
User Dashboard
Enabling Account Balance Transfers
Enabling PIN Management
Setting Default Billing Code
Displaying Color Quota
Using Equitrac Utilities
Import Utilities
Import Campus Card Account Information
Directory Synchronization Access Permissions
Purge Database Transactions
Modifying User Accounts from a Flat File
Map LPR User IDs
Print Queue Viewer
Running Print Queue Viewer on a Workstation
Diagnostics
Glossary
Output Management - Output Manager
Getting Started
Welcome to Kofax Output Manager
ControlSuite overview
Getting started
Concepts
User interfaces
Instances of Output Manager
Services
Output Manager applications
Learning about the Output Manager Console
Customizing the grid views
Configure security console
Configure columns
Using Output Manager in a Citrix environment
Users
Managing users
Managing Output Manager security roles
Devices
Learning about the Devices application
Managing devices
Manage device groups
Add devices
Modify devices
Create destinations
Search for devices
Managing devices through SNMP
Ethernet Card Reader
RF IDeas Ethernet 241 Card Reader
Queues and Universal Postscript Driver
Converting Windows queues
Output Manager Universal PostScript Driver
Security
Output Manager security
File store encryption
Sources
Learning about the Sources application
Manage Source groups
Add sources
Modify Sources
Remove Sources
Import Sources
Search for Sources
Configure security for Sources
Managing sources
Configuring 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
Managing destinations
Documents
Learning about the Documents application
Learning about the Library application
Managing documents
Working with documents
Configure global document properties
Output Processes and Actions
Output processes
Cost Tracking and Management
Print rules profiles
Create a desktop client profile
Assigning costs to billing accounts
Allowances
Configure balance settings
Import billing accounts
Managing Windows Queues
Rules and Tasks
Rules
Scheduling tasks
Reports
Learning about the Reports application
Working with reports
Using the Report Preview window
The Report Designer
Resources
Managing resources
Server and Database Administration
The Message Console
Using the Message Console
Set general preferences
System Health utility
Managing services through Microsoft Windows
Managing product components
SSL certificates
Backing up and restoring the Output Manager database
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
Burst Document - Page Mode dialog box
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
Desktop Client Installation dialog box
Desktop Client Profile dialog box
Destination Capabilities dialog box
Destination Configuration dialog box
Destination Configuration (bulk settings) dialog box
Destination/Device Output and SNMP Alert History window
Detect Readers dialog box
Device Configuration dialog box
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
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 Utility
Mail Server Search dialog box
Manage Billing Accounts Utility
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
Merge Package dialog box
MFP Kiosk Preferences Profile dialog box
Modify Document dialog box
Native Headers tab
New Device dialog box
Notification Profile 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
Resources tab
Role Manager dialog box
Route to Destination (Advanced) dialog box
Run Command dialog box
Schedule dialog box
Schedule Manager dialog box
Security Configuration dialog box
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
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
Source Configuration (bulk settings) dialog box
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
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
Mobile - Business Connect
Overview
Introduction
Business Connect Features
Product Compatibility
System Requirements
Prerequisites
Mobile Device Management Integration
Server Configuration
Business Connect Server Configuration
Layout Configuration
Client Support Setup
Feature Access Configuration
Geo-Location Management
MFD and Printer Management
User and Device Management
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
Configure the Mobile Server URL in MobileIron
Configure the Mobile Server URL in BlackBerry UEM
Configure the Mobile Server URL in Intune
Configuring Business Connect Manually
Database Configuration
Workflow Engine Configuration
About ControlSuite™ Enrollment
Printing Services Configuration
Web Server Configuration
Support Service Configuration
Support Service Configuration in Standalone Mode
Security Configuration
Launching Admin Tool
Configuring Web Capture for Business Connect Server
Configuring SSL for Business Connect
Integrations
From Capture to Print Management
From Capture to Print Management - Overview
Via AutoStore Process
Via AutoStore Route
From Capture to Mobile
AutoStore to ControlSuite mobile
Configure Server Manager in AutoStore
Create a new workflow
General settings
Print Settings
Properties
From Mobile to other ControlSuite Components
From Mobile to other ControlSuite Components - Overview
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
From Print Management to Capture and Mobile
Send documents from print management and mobile to capture
From Print Management to Output Management
Send documents from print management to output management
From Output Management to Capture
Send documents from output management to capture
From Output Management to Print Management
Send documents from output management to print management
From Output Management to Mobile
Send documents from the output management to mobile
Device Registration Service
Device Registration Service User Guide
Using the Device Registration Service
Troubleshooting Device Registration Service
Device Web Server
Device Web Server overview
View the DWS Web administration page
DWS failover
Epson
Overview
Managing the Device Web Server
Toshiba
Overview
Managing the Device Web Server
ControlSuite Clients
Kofax Combined Client for Konica Minolta
Overview
Implementation checklist
Requirements
ControlSuite deployment
Prepare the MFP to run the Kofax
Combined Client for Konica Minolta
Configuring the Kofax
Combined Client for Konica Minolta
Using the Kofax
Combined Client for Konica Minolta
Reference
Restrictions and Limitations
Troubleshooting
Kofax Combined Client for Ricoh
Overview
Checklist: Implementation
Requirements
Configuring the Kofax Combined Client for Ricoh
Using the Kofax Combined Client for Ricoh
Reference
Restrictions and limitations
Troubleshooting the Kofax Combined Client for Ricoh
Kofax Unified Client for Brother
Overview
Preparing for deployment
Installing the Unified Client for Brother
Using the Unified Client for Brother
Device Settings
Unified Client failover
Troubleshooting
Kofax Unified Client for Canon
Overview
Preparing for deployment
Installing the
Unified Client for Canon
Using the
Unified Client for Canon
Kofax
Unified Client for Canon
device settings
Appendix: Additional configuration Instructions
Appendix: Additional AutoStore Instructions
Troubleshooting
Kofax Unified Client for Epson
Overview
Preparing for deployment
Installing the Unified Client for Epson
Setting up the Epson MFP
Configuring the Unified Client for Epson
Appendix
Kofax Unified Client for HP
Overview
Preparing for deployment
Installing the Unified Client for HP
Using the Unified Client for HP
Device settings
Unified Client failover
Troubleshooting
Kofax Unified Client for Ricoh Deployments
Contents
Ricoh SOP 1.1 Deployment Guide for AutoStore
Ricoh SOP 1.1 Deployment Guide for AutoStore and Equitrac
Ricoh SOP 1.1 Deployment Guide for AutoStore and Output Manager
Ricoh SOP 1.1 Deployment Guide for Output Manager
Ricoh PCC 5.1 Deployment Guide for Equitrac
Ricoh PCC 5.1 Deployment Guide for Equitrac and AutoStore
Kofax Unified Client for Toshiba
Contents
AutoStore
solution overview
Equitrac
solution overview
AutoStore
and
Equitrac
solution overview
Reference
Kofax Smart UX Unified Client for Samsung
Overview
Checklist: Implementation
Requirements
Configuring the
Unified Client for Samsung Smart UX
Using the
Unified Client for Samsung Smart UX
Reference
Kofax Unified Client for Xerox
Overview
System requirements
Prepare for deployment of
Unified Client for Xerox
Deploy
Unified Client for Xerox
Using
Unified Client for Xerox
Reference
Debugging tips
Troubleshooting the
Unified Client for Xerox
Kofax Combined Unified Client for Xerox
Overview of the
Unified Client for Xerox EIP Connect
Implementation checklist
Requirements
Configuring Unified Client for Xerox EIP Connect
Using the Kofax Unified Client for Xerox EIP Connect
Application navigation
Reference
Troubleshooting
Embedded Client for Canon MEAP
Introduction
Pre-installation
Embedded Application Installation
Server-Side Configuration
User Workflows
Administrator Reference Material
Log Files
Troubleshooting
Glossary
Embedded Client for Fuji Xerox ECSP
Introduction
ControlSuite deployment
MFP configuration
Server-side configuration
Equitrac USB Card Reader plugin
User workflows
Embedded Client for Fuji Xerox EIP
Introduction
ControlSuite deployment
Server and MFP configuration
User workflows
Embedded Client for HP OXP
Overview
Installation
ControlSuite deployment
Server-Side Configuration
User Workflows
Embedded Client for Lexmark
Introduction
Pre-Installation
ControlSuite deployment
Server-Side Configuration
Embedded application installation
User workflows
Administrator reference material
Log files
Troubleshooting
Appendix A: Uninstallation
Appendix B: Third-Party Software Licenses
Glossary
Embedded Client for Sharp-OSA
Introduction
MFP and Server Configuration
User Workflows
Embedded Client for Xerox ECSP
Overview
ControlSuite deployment
MFP configuration
ColorQube 92xx series
Server-side configuration
User workflows
Embedded Client for Xerox EIP
Introduction
ControlSuite deployment
MFP configuration
Server-side configuration
User workflows
Embedded Client for Xerox EPA-EIP
Introduction
Supported MFPs
Server and MFP Configuration
User Workflows
Search
Home
Capture - AutoStore
Capture Components
Kyocera MFP (HyPAS)
Supported devices
Supported devices
For a current list of supported devices, visit the
Supported Devices
page.
Capture - AutoStore
AutoStore Overview
Welcome to AutoStore Process Designer
Using AutoStore Process Designer
AutoStore Process Designer user interface
Capture Components
Overview
AutoCapture Server
Batch Importer
POP3 Email
FTP Poll
Fuji Xerox AIP
HP MFP/Digital Sender OXPd
HP OXPd
IMAP Capture
Knowledge Package Loader Capture
Konica Minolta iOption
Kyocera MFP (HyPAS)
Welcome to the Kyocera MFP (HyPAS) component
Using this component
Kyocera MFP (HyPAS) Component configuration
Device setup and configuration
Supported devices
Lexmark MFP
Multi-Poll
MFD Capture
Ricoh ESA
Ricoh SOP
RightFax Capture
Samsung
Samsung SmartUX
SFTP Poll
SMTP Capture
Toshiba Unified Client
ControlSuite PJ Submission Workflow
Web Capture
Xerox EIP Connect
Unified Client
Universal Capture
Process Components
Route Components
Sunset Pack
Applications and Clients
Appendices
Kofax, Inc.