Guia de Administrador de NSiAutoStore6 - English

Administrator Guide
NSi AutoStoreTM 6.0
Notable Solutions, Inc.
Legal Notice
20092014 Notable Solutions, Inc.
THE INFORMATION CONTAINED IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE. NOTABLE SOLUTIONS, INC.,
MAKES NO WARRANTY OF ANY KIND WITH RESPECT TO THIS INFORMATION. NOTABLE SOLUTIONS, INC., SPECIFICALLY
DISCLAIMS THE IMPLIED WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. NOTABLE SOLUTIONS,
INC., SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, OR OTHER DAMAGE ALLEGED IN
CONNECTION WITH THE FURNISHING OR USE OF THIS INFORMATION.
Contents
AutoStore Applications............................................................................................ 9
AutoStore Process Designer................................................................................................................................. 9

What does AutoStore Process Designer do?............................................................................................9
License Manager.................................................................................................................................................30
License Manager overview.....................................................................................................................30
License Manager window.......................................................................................................................31
Activate the server devices.....................................................................................................................34
Creating a license report.........................................................................................................................34
Checking server version......................................................................................................................... 35
Checking component licensing information...........................................................................................35
Managing client licenses........................................................................................................................ 35
Extend evaluation license....................................................................................................................... 35
Update services....................................................................................................................................... 35
Status Monitor.....................................................................................................................................................36
Welcome to the Status Monitor application...........................................................................................36
QuickCapture Pro................................................................................................................................................41
Welcome to QuickCapture Pro...............................................................................................................41
AutoCapture Server............................................................................................................................................ 94
Welcome to AutoCapture Server component.........................................................................................94
Getting started.........................................................................................................................................94
Configuring AutoCapture Server............................................................................................................95
VBScript interface................................................................................................................................ 115
Date and time formats.......................................................................................................................... 124
Restrictions and limitations.................................................................................................................. 126
Troubleshooting tips............................................................................................................................. 126
AutoCapture Client........................................................................................................................................... 126
Welcome to the AutoCapture Client component................................................................................. 126
Installing the AutoCapture Client.........................................................................................................128
Using the AutoCapture Client application........................................................................................... 130
Capturing Microsoft Office documents or messages........................................................................... 131
Using AutoCapture Explorer client......................................................................................................131
How to configure settings for AutoCapture client...............................................................................132
How to customize the AutoCapture client window............................................................................. 135
AutoStore Components........................................................................................ 138
Activate Control................................................................................................................................................138
Conditional Field overview.................................................................................................................. 138
Alchemy............................................................................................................................................................ 139
Welcome to the OpenText Document Server, Alchemy component....................................................139
Alfresco............................................................................................................................................................. 145
Welcome to the Alfresco component................................................................................................... 145
ApplicationXtender Component.................................................................................................................... 158
Welcome to ApplicationXtender component.................................................................................... 158
Autonomy WorkSite......................................................................................................................................... 162
Welcome to Autonomy WorkSite component................................................................................. 162
AutoSafe............................................................................................................................................................178
Welcome to AutoSafe........................................................................................................................... 178
Barcode..............................................................................................................................................................179
Welcome to the Barcode component....................................................................................................179

Batch Importer.................................................................................................................................................. 207
Welcome to the Batch Importer component........................................................................................ 207
Bates Stamp...................................................................................................................................................... 210
Welcome to Bates Stamp......................................................................................................................210
Bates Stamp Server Administrator................................................................................................................... 224
Welcome to Bates Stamp Server Administrator...................................................................................224
Bates Stamp Server Supervisor........................................................................................................................ 231
Welcome to Bates Stamp Server Supervisor........................................................................................231
Binder................................................................................................................................................................ 233
Welcome to Binder Component........................................................................................................... 233
Box.................................................................................................................................................................... 242
Welcome to Box................................................................................................................................... 242
Content Management Queue............................................................................................................................ 250
Welcome to Content Management Queue............................................................................................250
Data Filter......................................................................................................................................................... 253
Welcome to Data Filter........................................................................................................................ 253
Data Interchange............................................................................................................................................... 285
Welcome to the Data Interchange component..................................................................................... 285
Datacap..............................................................................................................................................................285
Welcome to Datacap............................................................................................................................. 285
Directory Services.............................................................................................................................................289
Welcome to Directory Services component......................................................................................... 289
Document Writer...............................................................................................................................................309
Welcome to the Document Writer component..................................................................................... 309
Documentum (6.x)............................................................................................................................................ 310
Welcome to the Documentum (6.x) component.................................................................................. 310
DocuShare......................................................................................................................................................... 322
Welcome to DocuShare........................................................................................................................ 322
DocuWare.......................................................................................................................................................... 336
Welcome to the DocuWare component................................................................................................ 336
Send to Dropbox...............................................................................................................................................346
Welcome to Send to Dropbox.............................................................................................................. 346
EFI SendMe...................................................................................................................................................... 354
Welcome to the EFI SendMe component............................................................................................ 354
Encryption/Decryption...................................................................................................................................... 361
Welcome to the Encryption/Decryption component............................................................................ 361
FileNet............................................................................................................................................................... 363
Welcome to FileNet...........................................................................................................................363
FileNet P8......................................................................................................................................................... 371
Welcome to FileNet P8........................................................................................................................ 371
File Options.......................................................................................................................................................422
Welcome to the File Options component.............................................................................................422
Fortis..................................................................................................................................................................424
Welcome to the Fortis component........................................................................................................424
FortisBlue.......................................................................................................................................................... 427
Welcome to the FortisBlue component................................................................................................ 427
FTP Poll............................................................................................................................................................ 438
Welcome to the FTP Poll component.................................................................................................. 438
Fujitsu Network Scanner.................................................................................................................................. 443
Welcome to the Fujitsu component......................................................................................................443
Fuji Xerox AIP................................................................................................................................................. 471
Welcome to the Fuji Xerox AIP component........................................................................................471
Google Docs......................................................................................................................................................518
Welcome to Google Docs.....................................................................................................................518
HP MFP/Digital Sender OXPd........................................................................................................................ 526
Welcome to the HP MFP/Digital Sender (OXPd) component.............................................................526

HP OXPd.......................................................................................................................................................... 560
Welcome to HP OXPd component.......................................................................................................560
HP TRIM.......................................................................................................................................................... 599
Welcome to the HP TRIM component.................................................................................................599
Hummingbird/Open Text eDOCS.................................................................................................................... 611
Welcome to the Hummingbird/Open Text eDOCS component........................................................... 611
IBM CM............................................................................................................................................................617
Welcome to IBM Content Manager 8.4...............................................................................................617
IBM CM OnDemand........................................................................................................................................ 623
Welcome to IBM Content Manager OnDemand..................................................................................623
IKON DocSend.................................................................................................................................................631
Welcome to the IKON DocSend component....................................................................................... 631
IMAP Capture...................................................................................................................................................636
Welcome to IMAP Capture.................................................................................................................. 636
Interwoven WorkSite MP................................................................................................................................. 642
Welcome to the Interwoven WorkSite MP component........................................................................642
Interwoven WorkSite NT..................................................................................................................................653
Welcome to Interwoven WorkSite NT component........................................................................... 653
IXOS..................................................................................................................................................................664
Welcome to the IXOS component........................................................................................................664
Knowledge Package Builder............................................................................................................................ 666
Welcome to Knowledge Package Builder............................................................................................ 666
Getting started.......................................................................................................................................667
Configuring Knowledge Package Builder............................................................................................668
Troubleshooting tips............................................................................................................................. 669
Restrictions and limitations.................................................................................................................. 669
Knowledge Package Loader - Process............................................................................................................. 669
Welcome to Knowledge Package Loader Process component.............................................................669
Knowledge Package Loader Capture............................................................................................................... 671
Welcome to Knowledge Package Loader Capture component............................................................ 671
Kodak Scan Station.......................................................................................................................................... 674
Welcome to KODAK Scan Station...................................................................................................... 674
Konica Minolta iOption....................................................................................................................................693
Welcome to Konica Minolta iOption................................................................................................... 693
Konica Minolta MFP........................................................................................................................................ 718
Welcome to Konica Minolta MFP....................................................................................................... 718
Kyocera MFP (HyPAS).................................................................................................................................... 755
Welcome to the Kyocera MFP (HyPAS) component...........................................................................755
LAN Fax........................................................................................................................................................... 784
Welcome to the LAN Fax component................................................................................................. 784
Laserfiche.......................................................................................................................................................... 789
Welcome to Laserfiche component...................................................................................................... 789
Lexmark MFP................................................................................................................................................... 799
Welcome to the Lexmark capture component......................................................................................799
Lotus Notes Domino.........................................................................................................................................820
Welcome to Lotus Notes/Domino component..................................................................................... 820
Multi-Poll.......................................................................................................................................................... 824
Welcome to the Multi-Poll component................................................................................................ 824
Multi Router......................................................................................................................................................837
MultiRouter........................................................................................................................................... 837
Notification component.................................................................................................................................... 837
Welcome to Notification component....................................................................................................837
OPOCR component.......................................................................................................................................... 839
Welcome to the OP OCR component.................................................................................................. 839
OpenForms 360.................................................................................................................................................873
Welcome to OpenForms 360................................................................................................................873

OpenForms 360 Server Configurator............................................................................................................... 891
Welcome to OpenForms 360 Server Configurator...............................................................................891
OpenForms 360 Validation...............................................................................................................................910
Welcome to OpenForms 360 Validation.............................................................................................. 910
Starting OpenForms 360 Validation..................................................................................................... 911
Screen layout.........................................................................................................................................912
Using OpenForms 360 Plug-ins........................................................................................................... 927
Using the Mouse (SnapIt).................................................................................................................... 928
Lists of keyboard shortcut keys........................................................................................................... 943
OpenText Livelink/Content Server...................................................................................................................948
Welcome to OpenText Livelink/Content Server.................................................................................. 948
Outlook MSG Loader....................................................................................................................................... 957
Welcome to Outlook MSG Loader...................................................................................................... 957
PaperPort AutoCapture Client.......................................................................................................................... 959
Welcome to PaperPort AutoCapture Client....................................................................................... 959
PDF Converter.................................................................................................................................................. 960
Welcome to PDF Converter................................................................................................................. 960
POP3 Email.......................................................................................................................................................983
Welcome to the POP3 Email component.............................................................................................983
Professional Image Management......................................................................................................................986
Welcome to the Professional Image Management component............................................................ 986
Quick Capture Desktop.................................................................................................................................... 992
Welcome to the QuickCapture Component..........................................................................................992
Ricoh Desktop ESF........................................................................................................................................ 1016
Welcome to the Ricoh Desktop SF.................................................................................................... 1016
Ricoh ESA...................................................................................................................................................... 1033
Welcome to the Ricoh ESA component.............................................................................................1033
RightFax Capture............................................................................................................................................ 1085
Welcome to RightFax Capture........................................................................................................... 1085
RightFax Route............................................................................................................................................... 1094
Welcome to the RightFax Route component..................................................................................... 1094
Send to Database............................................................................................................................................ 1098
Welcome to Send to Database component......................................................................................... 1098
Send to Database (Bulk).................................................................................................................................1102
Send to Database Batch component...................................................................................................1102
Send to Folder.................................................................................................................................................1103
Welcome to Send to Folder component............................................................................................. 1103
Send to FTP.................................................................................................................................................... 1108
Welcome to Send to FTP component.................................................................................................1108
Send to HTTP Help........................................................................................................................................1116
Welcome to the Send to HTTP component....................................................................................... 1116
Send to Mail Recipient...................................................................................................................................1124
Welcome to the Send to Mail Recipient component..........................................................................1124
Send to PC...................................................................................................................................................... 1130
Welcome to the Send to PC component............................................................................................ 1130
Send to PC Client........................................................................................................................................... 1134
Send to PC Client Configuration dialog box..................................................................................... 1134
Troubleshooting tips........................................................................................................................... 1135
Send to Printer................................................................................................................................................ 1136
Welcome to the Send to Printer component.......................................................................................1136
Send to SFTP Help.........................................................................................................................................1141
Welcome to the Send to SFTP component........................................................................................ 1141
SFTP Poll........................................................................................................................................................ 1153
Welcome to the SFTP Poll component.............................................................................................. 1153
SharePoint 2007.............................................................................................................................................. 1158
Welcome to the SharePoint 2007 component.................................................................................... 1158

SharePoint....................................................................................................................................................... 1176
Welcome to the SharePoint component............................................................................................. 1176
Sharp MFP (OSA).......................................................................................................................................... 1199
Welcome to Sharp the MFP (OSA) component.................................................................................1199
SMARTicket Component................................................................................................................................1216
SMARTicket component.....................................................................................................................1216
Smarticket Configuration Manager................................................................................................................ 1223
Notable Solutions Smarticket Configuration Manager...................................................................... 1223
Smarticket Process Designer.......................................................................................................................... 1234
Smarticket Process Designer.............................................................................................................. 1234
Smarticket Web Client....................................................................................................................................1252
Smarticket Web Client........................................................................................................................1252
SMTP Capture................................................................................................................................................ 1290
Welcome to SMTP capture component..............................................................................................1290
TRIM Captura (4.x)........................................................................................................................................1297
Welcome to TRIM Captura (4.x)....................................................................................................... 1297
TRIM Context.................................................................................................................................................1301
Welcome to the TRIM Context Component................................................................................... 1301
VB/J Script......................................................................................................................................................1305
Welcome to the VB/J Script component............................................................................................ 1305
VIP...................................................................................................................................................................1309
Welcome to the Virtual Image Processing component...................................................................... 1309
Watermark....................................................................................................................................................... 1327
Welcome to the Watermark component............................................................................................. 1327
Web Capture....................................................................................................................................................1330
Welcome to the Web Capture component..........................................................................................1330
WebCapture..................................................................................................................................................... 1356
About WebCapture UI........................................................................................................................ 1356
WebDAV..........................................................................................................................................................1362
Welcome to the WebDAV component................................................................................................1362
Workflow Tracker........................................................................................................................................... 1371
Welcome to Workflow Tracker component........................................................................................1371
Worldox........................................................................................................................................................... 1374
Welcome to the WORLDOX component...........................................................................................1374
Xerox EIP Connect.........................................................................................................................................1387
Welcome to the Xerox EIP Connect component............................................................................... 1387
Xerox............................................................................................................................................................... 1436
Welcome to the Xerox component..................................................................................................... 1436
XML Generator...............................................................................................................................................1449
Welcome to the XML Generator component..................................................................................... 1449
XML Importer Help....................................................................................................................................... 1459
Welcome to the XML Importer component....................................................................................... 1459
Sunset Components.............................................................................................1470
Basic Image Management.............................................................................................................................. 1470

Welcome to the Basic Image Management component..................................................................... 1470
FileMagic.........................................................................................................................................................1475
Welcome to the FileMagic component...............................................................................................1475
Folder Store.....................................................................................................................................................1477
Welcome to Folder Store....................................................................................................................1477
FTP Store........................................................................................................................................................ 1480
Welcome to FTP Store....................................................................................................................... 1480
iManage........................................................................................................................................................... 1484
Welcome to the iManage (6.x) component..................................................................................... 1484
Kyocera MFP.................................................................................................................................................. 1487

Welcome to the Kyocera MFP component........................................................................................ 1487
PDF 417 Barcode........................................................................................................................................... 1502
Welcome to the PDF 417 Barcode component.................................................................................. 1502
Poll Directory..................................................................................................................................................1508
Welcome to the Poll Directory component........................................................................................ 1508
Ricoh MFP...................................................................................................................................................... 1509
Welcome to Ricoh MFP component.................................................................................................. 1509
Appendices........................................................................................................... 1530
Appendix 1. Runtime Replacement Tags.......................................................................................................1530
Runtime Replacement Tags (RRTs)................................................................................................... 1530
What are RRTs?.................................................................................................................................. 1530
How do RRTs work?.......................................................................................................................... 1530
RRT naming convention.....................................................................................................................1530
AutoStore Applications
AutoStore Process Designer
What does AutoStore Process Designer do?
AutoStore Process Designer provides a visual interface for designing workflow configurations. A workflow defines a
logical path for capturing, processing, and routing documents or files through AutoStore.
There are three functional parts of a workflow:
Capture
Capture is the initial part of a workflow, where a

document or file enters the workflow process. Generally,
the capture occurs at a MFP device or is performed
through software such as SharePoint Portal Server or
AutoCapture client. This is a required component. Every
workflow must have exactly one capture component.
More than one capture component is not allowed.
Process
Process is the intermediate part of the workflow

process, where a captured document or file is processed.
Processing can include practically anything, such as
adding barcodes to a captured item or encrypting a
document. This is an optional component. A workflow
can omit the processing component or have multiple
processing components
Route
Route is the final part of the workflow process where

items are stored after being captured and processed.
Items are stored where they may be subsequently
accessed and opened or transferred by other applications.
This is a required component. Every workflow must
have exactly one route component. More than one route
component is not allowed.
License Manager
The License Manager grants licenses for use of the server and components. Additionally, licenses are issued for
Software Maintenance which gives the ability to receive software updates. With License Manager, you can:
Request licenses
Get licenses online
Load a license
Generate a license report
Get information on the server version license
Manage client licenses
The server is licensed per CPU. The licenses assigned by unique serial numbers reported by the License Manager. A
client can be licensed using local licensing or server licensing. A local license is obtained for a particular client while
server licenses are obtained for a server and consumed by clients that connect to the server.
Important: If you are evaluating this product, you must purchase a license key within 30 days of installation.
Failure to properly install the license key within 30 days will disable the application. Any adjustment to the
date or the registry causes licenses to automatically expire.
Please refer to help for License Manager for further information about managing licensing.
Copyright 2014 Notable Solutions, Inc.
Understanding AutoStore Process Designer

The Process Designer provides a graphical user interface for creating AutoStore processes. It provides a workspace
that allows you to assemble and test the Capture, Process, and Route components that form a workflow process.
The following illustration shows the Process Designer application window:
Element
Description
Toolbox
Displays icons for registered

components that you can add to
workflows. Like other windows in
the Workflow Process Designer, you
can drag, dock, or hide the Toolbox
window.
Ribbon
Provides a command interface that

users can use to access functional
components of the Process Designer.
Command buttons are arranged on
the File, Home, and View tabs.
Workspace tab
This tab displays the name of the

configuration file for a workflow.
Component trays
Components are are the building

blocks for a workflow process.
Registered components are arranged
10
Element
Description
in three collapsible trays in the
Toolbox window. There is one
tray each for Capture, Process
and Route components. You can
expand or collapse any of these
trays by clicking the tab at the top
of a tray. You can click the menu at
the top of the Toolbox window to
choose components displayed on
each tray and to customize how they
are displayed. To add a component
to a workflow, you drag it from a
component tray into the workflow on
the active task tab.
Task tab
This tab displays the name of a

task with the icon of the capture
component in its workflow. In the
illustration above, the AutoCapture
icon is displayed on the My
workflow tab.
Process viewer
The process viewer provides a visual

presentation of a workflow. You
assemble and configure a workflow
in this space.
AutoStore Process Designer features

AutoStore Process Designer provides the following features:
The ability to display attributes of a workflow process.

Flexibility to design and implement processes using any number of components.
The ability to organize components on the component panel in different ways, to add/remove tabs and add/remove
components in the Capture, Process, and Route tabs.
Visual integration for all third-party or custom-built components.
Support for advanced servers such as Microsoft SharePoint Portal Server, Hummingbird, and other applications.
RRT Drag and Drop support.
Server Process Scheduling features.
Preserving the location of the components on the Process Viewer when re-opening a saved configuration file.
The ability to automatically open the most recent configuration file at startup.
The ability to automatically backup configuration file on save.
License Manager integrated into the Process Designer.
Direct Links to Status Monitor and Service Manager from the Process Designer Interface.
Using AutoStore Process Designer

You can build and test AutoStore processes by using the complete set of configuration development tools in
AutoStore Process Designer. The Process Designer allows access to the AutoStore components that are included in
your installation. You can also manage the AutoStore service and component licensing.
To start AutoStore Process Designer, you can click the Process Designer icon in the NSi program group.
How to start Process Designer
On the Windows Start menu, click All Programs > NSi > AutoStore Workflow 6 > AutoStore Workflow 6
Process Designer.
11
Whether you are new to AutoStore or have used earlier versions, the following topics provide information about
processes, components, and configurations.
Process Overview
Components Overview
Configuration File Overview
Options dialog box
In this dialog box, you can specify several AutoStore Process Designer settings such as the template directory and
automatic backups.
To open the AutoStore Process Designer Options dialog box, on the ribbon, click the File tab, and then click the APD
Options button.
Option
Description
Automatically open the most recent configuration file Select this check box to open the most recently used
at startup
configuration when you start AutoStore Process
Designer.
Automatically back up configuration file on save
Select this check box to back up the previously saved

version of a configuration when you save new changes.
Display properties dialog on task creation
Select this check box to open the task properties dialog

box when you create a new task.
Template directory
Specifies the location for AutoStore configuration

template (CTF) files. Template files saved to this folder
are added to the New and Add menus (located on the
Home tab of the ribbon). Subfolders added to this
directory create cascading menu items on the Add and
12
Option
Description
Home menus. You can click the browse button
to
locate a directory. For more information, see AutoStore
Configuration Templates.
Default directory
Specifies the default location when opening or saving

AutoStore configuration files. You can click the browse
button
to locate a directory.
Apply only on application startup
Select this check box to use the Default directory

location the first time that you open or save a
configuration during a session. The application
subsequently uses the last opened or saved location
as the default location. Clear this check box to use the
Default directory location throughout every session.
Color Scheme
Specifies to use Blue, Black, or Silver as the color

scheme for the AutoStore Process Designer application
window.
Task Tab
Specifies to locate the task tab on the bottom, right, left,

or top of the configuration window.
Show capture icon
Select this check box to show the capture icon for each
task on its tab:
. Clear this check box to
only show the task name without the icon:
Task Properties dialog box

The Task properties dialog boxc consists of three tabs:
General tab
Administrator Alerts tab
Scheduling tab
Advanced tab.
General tab
Attribute Name
Task Information
Attribute Description
Enter the general information about the process:
NameThe name for the process.

CommentsOptional information about the
process.
Perform this task
In the Every box, enter the frequency of execution for

this task between 1 and 999 seconds.
If this task fails
Select the Retry check box if you want the service

to retry performing the task when it does not initially
succeed. Enter the number of retries between 1 and 100.
13
Administrator Alerts tab

Attribute Name
Activate
Select this check box to enable alerts to be sent to an

email address for certain types of server notifications,
such as abnormal server shutdowns or volume license
warnings.
Server
Enter the name or IP address of the SMTP server.
Port
Enter the SMTP server port.
This server requires an encrypted connection (SSL)
Select this check box to enable Secure Sockets Layer

(SSL) encryption.
User Name
Enter the user name to connect to the SMTP server.
Password
Enter the password for the user name.
From
Enter the return email address that will be specified in

the alert.
To
Enter the email address that will be receive the alert.
Test
Click this button to test the logon credentials for the

SMPT server
Scheduling tab
Attribute Name
Standard processing
Schedule the task to run in a designated time slot by

entering Start time and End time.
Retry processing
Schedule the retries in case of failure in a designated

time slot by entering Start time and End time.
Advanced Tab
Attribute Name
Home Directory
Home directory for the task where the information

about the current task run is saved. This information
is necessary for retrying task in case of failures. By
default this value is C:\%ProductName%\Task_ID
, where %ProductName% is the name of this product and
Task_ID is the global unique identifier of the task.
Debug
The Debug option is only used for support purposes and

should only be selected when requested by a qualified
server Administrator. When the Debug option is selected,
the various components within the server create log
messages in the log file. These messages are designed
to help the support staff take a closer look at the internal
operations of the server running in the background.
Threshold has a range of 0 to10, with 0 representing the
lowest level of logging and 10 representing the highest
level of logging.
14
Attribute Name
Note: When the Debug option is turned on,
the number of log messages from each module
increases based on the Threshold level selected.
This operation requires free disk space and can
affect system operations if it is not turned off.
System performance and availability might be
impacted if the hard-disk storage is depleted.
Server processes
Overview of processes
What is a process?
Ways to use a process
What is a process?
A process is a series of components that are connected in a certain order to correctly capture, process, and route
information.
A typical process is comprised of the three types of components:
Capture
Responsible for capturing the input data stream in the

process. A process can have no more than one Capture
component.
Process
Responsible for manipulation, information extraction,

conversion, and formatting of the data stream. A process
can have any number of Process components.
Route
Responsible for connectivity, routing, and storage of

information. A process can have no more than one Route
component.
Use the Process Designer to visually assemble, configure, and save your desired process to a configuration file.
A process must contain one Capture component and one Route component. A process can contain any number of
Process components.
A Configuration file can contain one or more of the following types of processes:
Autonomous process
Multi-process chain
These are independent processes that do not feed

information to each other.
These are connected processes that feed information
to each other through files or other means. See Multiprocess chain.
Ways to use a process

You can use a process to connect, process, and route information from any Capture component to any Route
component. The first step in creating your process is to Design a process and then use the Process Designer to Create
a process.
You can use a process for the following actions:
Route
Information can be moved from one source or Capture

location to a Route or destination location by simply
designing a two-component process. One Capture
component that captures the information and one Route
15
component that routes and stores the information in an

application.
Manipulate
A process component manipulates, converts, and extracts

information from the data stream and makes it available
to other components within the same process.
Connect
Using process components with the enterprise connector

capabilities, you can store information to one destination
and link back to the information in another application.
This method of linking allows you to store and link two
destinations within one process.
Design a process
An AutoStore server is capable of handling a range of process types, from a single-threaded process to high-volume
multi-threaded processes. Use this section as a guide for designing a process. If your application requires complex
processing of data and multiple storage destinations, we recommend using information in this section to organize your
processing requirements.
The process design procedure is fairly simple and can be broken down into number of easy steps. Follow the design
steps outlined here to design your process. If your process is a simple single-threaded process (for example, read from
one or more MFP devices and store in a folder) you do not need to design your process. You can simply draw your
process on the Process Designer and implement it. The design guidelines included here help you implement more
complex, multi-threaded applications.
Step 1: Define the process attributes
The first step in designing a process is to create an outline of the following information:
Type and format of the information you are going to be processing (for example, text, .tif, .pdf, CAD, .bmp, etc.).
Volume of the information being fed into the process.
Frequency of the input data stream.
Media for this information (directory, SMTP email, etc.).
Use this information to estimate the number of servers required, and the configuration hardware for each. The
estimate should be based on sample performance data calculated by running applicable sample data through the
server. Benchmarking results vary depending on server configuration, data size, and processing steps.
Step 2: Create a list of required processes
Based on the following process design parameters, decide on the number of required processes:
A process can have one input capture component type (for example, either the Multi-Poll or MFP device, but not
both within the same process).
A process can have one output route type (for example, Send to Folder).
A process can have any number of processing process components.
The order in which the components are executed within a process is static. To create the same process in two
different orders, you will need to create two processes.
You can have one or more processes running within the same server. The server is a multi-threaded application
capable of running many processes at the same time.
Note: To have the results of one process feed into another, create two processes and chain them back-to-back
using a multi-process chain.
Step 3: Create a list of components for each process

Capture component requirements
Create a list of your capture components by categorizing

your input capture types.
16
Process component requirements
Based on your application requirements, you must decide

which process components are suitable for your needs.
Always keep in mind that the server provides a list of
standard feature components, but you can also create
custom-built components that match your processing
needs.
The process component features are in three major categories:

Conversion:
These process components convert the data-stream

format into another format. Use conversion when you
need to modify format, presentation, or searchability.
Connectors:
Use process components with connector capability

to store files in one application and place a link (for
example, a URL link pointing back to the location
of the document) in another application field. Using
this feature, you can place files in your document
management system and link back to them from other
applications.
Extractors:
These process components extract information from

images and make them available to you.
Decide which types of components you want to use and the order in which you want to use them. Remember that the
order of components is important.
Route component requirements
Create a list of different route components your process

requires.
Step 4: Decide on your overall process chain

For each process, create a chain of components based on your application requirements. Consider the following
parameters when creating your process component chain:
Each component only operates on its defined input type and passes through all other input types.
Components are executed from capture component to route component.
Components that depend on output from other components must be used after those components.
Step 5: Do you need a multi-process chain?

Consider creating a multi-process chain when the processed output from one process has to be stored in multiple
locations. For an example, if your process requires that images be converted to specific file format and stored in a
folder and that the files also be sent as email attachments, then consider chaining two processes together. The first
converts images to that file format. The second process reads the files from the destination folders and sends them to
an email address as attachments.
Create a process
Procedures in this section describe how to use the Process Designer to create a completely new process, create a
process from a template, or add a process to a configuration file.
Create a new process

Create a new process from a template
Add a process to a configuration file
Create a new process

1. On the Home tab of the ribbon, click the New button.
2. In the Task Properties dialog box configure the process properties, and then click OK.
17
Create a new process from a template

1. On the Home tab of the ribbon, click the New menu.
2. On the menu, click Wizards.
3. Select the template you want from the list of templates and click OK.
You can click the Browse button to locate other template files.
4. Configure the process properties, and then click OK.
Add a process to a configuration file
1. On the ribbon, click the Add button.
2. In the Task Properties dialog box enter the process properties and click OK.
A Process tab is added to the bottom of the process viewer window. You can add multiple processes to a
configuration file.
Modify a process
How to view and modify process properties

Add components to a new process
Add components to an existing process
Remove components from a process
How to view and modify process properties

1. On the Home tab of the ribbon, click Properties.
Alternatively, you can double-click in the process viewer window.
2. Modify process attributes in the Task Properties dialog box, and then click OK.
Add components to a new process
1. Click the component icon in the Toolbox to select it.
2. Drag the icon to the task tab in the Process Viewer.
Add components to an existing process
1. Click the component icon in the Toolbox to select it.
2. Use one of the drag-and-drop procedures listed below to add the component to your process:
A capture component icon can be dropped on a connection link between two components. Notice that the color
of the line changes when the icon is on top of a connection line.
Drop a capture component into the process viewer. If a workflow already has a capture component, you will be
prompted whether to replace it. You cannot add more than one capture component to a workflow.
Drop a route component into the process viewer. If a workflow already has a route component, you will be
prompted whether to replace it. You cannot add more than one route component to a workflow.
Remove components from a process
Do either of the following to remove a component from a workflow:
Right-click the component in the process chain and click Remove on the shortcut menu.
First click the component in the process chain to select it, then press the Delete key.
Remove a process
Note: You cannot delete a task when it is the only task in a configuration.
1. Click the task tab to select the process you want to remove.
2. Click the Delete button on the ribbon. You can also right-click in the Process Viewer and select Delete Task.
18
Multi-process chain
A multi-process chain is a set of processes where output from one feeds into the input of another. The use of process
chains is especially useful when images or data elements have to be routed to multiple destinations. For example, a
process that requires routing to SharePoint Portal Server, Microsoft Exchange, and SMTP email must be designed as
a three-process chain. The first process routes information to the SharePoint Portal Server and on success stores files
in a folder destination for use in a second process. The second process uses the poll directory component to grab the
files from the directory and route them to Microsoft Exchange. The third and final process uses the SMTP destination
module to route the same files by email.
Use appropriate frequencies for each process. Do not use high-frequency polling for your processes. A process with a
high frequency rate could deplete the hardware processing resources.
When using process chaining, consider various scenarios of failure and success in routing each segment of the
process. Design each segment of your process giving consideration to failure as well as success in routing of each
message.
The failure of a process chain can be fed into a failure notification process that has an directory designated for
saving failed routings from all processes.
Helpful tips
Rules in creating a process
The following rules apply in creating a process using the Process Designer:
A process must have a capture and a route component.

A process cannot have two process components of the same type.
If a Mapping component is used within a process, then all attributes for the components that follow it must be
configured within the mapping component.
Set the processing timer to a reasonable value for your process. The processes that have extremely short frequency
timers might deplete the hardware resources.
The order of components in a process is important. For example, a process that has OCR and image-processing
components, in that order, uses OCR with the images first and then performs the image processing (splits the
document). In this scenario, the output of the process is a single OCR text document and then multiple split
images. On the other hand, a process that uses the image processing (split-document) component followed by
OCR would create multiple split images and then multiple OCR text documents.
Server components
Overview of components
Components are the basic building blocks of processes. Each component is capable of performing a defined task on
data or images. Based on the process attributes, each component performs a designated task of reading, manipulating,
or storing the data and files.
This section provides reference information about the following topics:
Types of components
Ways to work with components
Setting field attributes
Introduction to components
Components are the basic building blocks of processes. Each component is capable of performing a defined task on
data or images. Based on the process attributes, each component performs a designated task of reading, manipulating,
or storing the data and files.
Types of components
There are 3 types of components you can use to build your process.
19
Capture component
All processes must start with a capture component. A

capture component reads data, images, or other types of
files to a process.
Process component
This type of component retrieves data, extracts

information, converts formats, or manipulates the
content of information. The process component objects
are important for processing the data content of files.
Examples of this type of component include OCR,
WaterMark, and File Options.
Route component
This type of component forwards the information to its

final Route component. The Route component could
be an email address, a database file, an FTP site, or a
number of other Routes.
Note: A capture or process component can be further categorized as a Mapping component based on
configuration requirements.
Ways to work with components
Using the Process Designer GUI, components are chained together to create a process. A process is then saved to a
configuration file and can be used to start a service.
When you use the Process Designer to manipulate a configuration file, you can do the following tasks:
Select one component by clicking that component. Select multiple components by dragging an area around
multiple components within a process design screen.
Add a component to a process by using the drag-and-drop procedure to bring a component to the process screen.
Remove a component from a process by highlighting the component and pressing the DELETE key or clicking
Remove.
Insert a component by dragging it to the appropriate place on a connecting line.
Modify component properties by double-clicking a component, or right-clicking the component and clicking
Properties.
Note that to add a component to an existing process either drag the component to the end of the process component
list or insert the component between two other components by dropping the component on a connecting line between
the two components. Also note that the user can reposition components by dragging them around on the process
design screen. The screen location of a component on the process design screen is not related to its operation. To
change the order of component within the same process, the user must remove a component and add it back into the
new location within the process.
Setting field attributes
You can Modify component properties and set processing attributes for any component. Two basic methods are
available for setting attribute values:
Statically
Dynamically
Assign any static value by simply typing a constant

static value in the attribute. For example, to set the
Exchange server name to ExchServer01, simply type
the string ExchServer01 in the server name attribute of
the Exchange destination component.
Use Runtime Replacement Tags (RRTs) to assign a
variable field value to an attribute. Use this method
when the attribute value cannot be statically type the
defined RRT string in the field value. Please refer to
each component for further detail assigned (for example,
the value for the time of day the process is being
20
performed, the applied barcode value within the image

being processed, or the invoice number from the form
recognition). The dynamic values are generally derived
from the process data stream and cannot be statically
defined.
AutoStore Process Designer component operations
Learn about types of components and ways you can work with components to create a process.
What do you want to do?
Select a component
Add a component to a process
Remove a component from a process
Insert a component in an existing process
Modify component properties
To select a component
Click a component on the process design screen.

To select multiple components, drag an area around the desired components.
To add a component to a process

This procedure adds the component to the end of the process. To add the component between two existing
components, see Insert a component in an existing process.
1. If necessary, click the task tab to select the process where you want to add a component.
2. In the Toolbox window, click and drag the component you want to the process window.
Remove a component from a process
1. If necessary, click the task tab to select the process where you want to delete a component.
2. Do either of the following to delete the component.
a) Right-click the component, then click Remove to remove the component.
b) Click the component to select it, then press the Delete key.
Insert a component in an existing process
Note: You can insert a component after a mapping component, but you should configure the component
properties by opening the mapping component properties.
1. If necessary, click the task tab to select the process where you want to insert a component.
2. In the Toolbox, click and drag the component you want to insert to the connecting line where you want to insert it.
Completing this procedure inserts the component between the two components attached by the connecting line.
Modify component properties
To properly configure a blocked component, you must access its properties through the mapping component
properties that appear on the process list.
1. If necessary, click the task tab to select the process where you want to modify a component.
2. Click the component you want to modify to select it, then click Properties on the Home tab of the ribbon.
You can also either double-click the component icon or right-click the icon and click Properties.
3. Edit the attributes and click OK.
You can also press Alt+Enter to access properties for a selected component. Select the component on the process
design screen, and then press Alt+Enter.
Field assignment
Using the field assignment, you can configure one-to-one field-mapping assignments from various index fields to the
component fields. Table below provides a summary description of this feature.
21
Item
Description
Name
The destination field is the component field names.
Value
These are the index fields available through use of

Runtime Replacement Tags or the static strings values.
Use the Add, Modify, or Remove buttons to manipulate the entries.

Using the matching feature
When adding a field assignment, you can select the Search Key check box (not available on all components) to
use that field as a matching key field. Use this feature to add images to an existing record in the destination storage
location. Using the Search Key feature, you can look for records that match the search key field value and deposit
scanned images to these existing records in the destination storage location rather than creating a new record for each
image received.
You can also use the Set field values on Search option to force an update of the index field values on the matching
record. If this is set to False, then the document is attached but the field values are NOT updated when a matching
record is found.
The match feature does have certain limitations, however. If the search-keys result finds more than one matching
record, the server cannot determine which record the image should be attached to. Therefore, the server creates a new
record and attaches the image to it. Also, because the server does not overwrite the field values of any existing record,
no field value is changed when an image is added to a matching record.
Here is a simple example of how the matching feature can work for you. In a legal office, users scan documents using
a an MFP device and enter the Case ID as the application tag on the MFP control panel. The record for each case
already exists in the destination database and the image must be deposited in the record that matches the Case ID.
The component can be configured to map the application tag to the CASE_ID field in the destination database and
designate that field as a search key field. The server first looks for the record with a matching key field value. If a
single matching record is found, the image will then be added as an attachment to that record. If no matching record is
found or more than one match is found, a new record is created and the image is attached to the new record.
It is important to note a blank search key field will match against a record with blank key field value and if such
record is found all the images will be attached to the same record. The server will search for records that match ALL
search key fields. This is equivalent to a logical AND operation.
Capture components overview
The AutoStore server uses a capture component to create a work-object for a process. The capture components must
always appear at the beginning of a process. These components initiate a process by capturing data (data files from
the inbox directory, data elements from the database file, and so on) and delivering it to the processing components.
Each process is required to have a single capture component.
Ways to work with capture components
Add capture components at the beginning of each process. Each process can have only one capture component. The
capture component can be a mapping component or a blocking component.
You can replace the capture component of a process by dragging a replacement capture component to the process. The
system prompts you to confirm replacement of a capture component. After confirmation, the capture components are
replaced.
Process components overview
The server uses process components to manipulate the data stream (images or data elements) within a process. The
process components must always appear between the Capture component and the Route component. Each process
component can accept a defined input data type and produce a defined output type.
Use of a process component is optional within a process.
22
Please note a process component will only operate on its defined file format or data type. If the input does not match
the supported input specification then the process component simply passes the data through to the next component
without any manipulation.
Types of process components
Process components perform several types of operations:
Process operation
Description
Extractor
The images, files, or other types of objects passing

through a process contain data elements in the form of
imaged data (barcodes), fields (PDF-embedded fields),
and content (OCR text, forms, and so on) in extraction
of these data elements. Part of a process components
responsibility. All extracted data fields (for example,
barcode values) are made available to the components
that follow a process component within a process chain
through use of Process Designer component RRT.
Enterprise connector
A process component is an enterprise connector if

you can use it to store information in a destination and
produce a link to the newly stored information. This
type of process components is extremely useful when
the process requires storage in one central location and
links to other related systems (workflow automation,
ERP, and so on). An example of this type of component
is the SharePoint Portal Server component. This process
component stores objects in the SharePoint Portal and
can create URL links that point from other destinations
back to the document.
Manipulator
This type of process component manipulates the data

content of the data stream and actually changes the data
type, content, or format. The image-processing process is
an example of this type of process. This process can split
an image into multiple images, or despeckle the image.
Both of these operations change the actual data content.
Ways to work with process components

Add a process component after a capture and before a route component within the process. The process components
are executed in the order that they appear on the process chain. The output of each process component (file or data
elements) is made available to the components that follow it.
Route components overview
The server uses a route component to store the data stream (images or data elements) into its final destination
location. The route components must always appear as the last component within a process.
Ways to work with route components
Use route components to store the file and related data elements into a final location. Each route component is
designed to work with a specific type of application and will store into that one application. You can store into
multiple application by using Multi-process chain design. Also see Ways to use a process for information on
connector components and capabilities.
Note that if the user is using any supported databases or line-of-business applications, you must make sure that the
associated client application is fully installed and configured. For example, if your server installation is required to
23
work with Microsoft SharePoint Portal server, you must make sure the SharePoint Portal Server and client is fully
installed and configured.
Configuration file
Overview of the configuration file
Types of configuration files
You can start from two types of configuration files:
Blank Process. Start with a blank process when you want to design your process from scratch. This option gives
you the most flexibility in creating a configuration file.
Templates. Use a template when you want to reuse boilerplate configuration file, attributes, and component
entries.
When you save a configuration file, it's file type (by default) determines the file format it is saved in.
Working with configuration file window:
When you create or open a configuration file in the Process Designer,the file opens in a separate screen. You can
quickly switch from one configuration file to another by pressing Ctrl+Tab or clicking the file name listed under the
Window menu.
Create a configuration file
You can create an empty configuration file or use a template to create a configuration or to add tasks to an existing
configuration.
Create a new configuration file

Use a template to create a new configuration
Use a template to add a task to an existing configuration
How to create a new configuration file

1. On the Home tab of the ribbon, click the New button.
2. In the Task Properties dialog box, specify a name for the task and click OK.
Note: The Task Properties dialog box does not show if the Display properties dialog on new task
creation check box is not selected in the APD options.
3. Click OK.
A new configuration is initially named "CFG" followed by an ordinal number. You can click the Save As on the File
tab of the ribbon to specify a different name and location.
How to use a template to create a new configuration
1. On the Home tab of the ribbon, click the New menu, and then click the template you want to use.
This creates a copy of the template configuration.
2. On the Home tab of the ribbon, click the Save button, specify the name and location you want to use for the
configuration, and then click Save.
How to use a template to add a task to an existing configuration
Process template files stored in AutoStore's template directory appear on the New and Add menus on the Home tab
of the Process Designer ribbon. A template in a subfolder in the template folder appears on a cascading menu on the
New and Add menus using the hierarchy of subfolder names.
Tip: The default template directory is specified by the Template Directory option in the Options dialog box.
To verify or change the default template directory used by Process Designer, click the File tab on the ribbon,
and then click the APD Options button. For more information, see Options.
1. Make sure the configuration in which you want to create the task shows in the workspace.
2. On the Home tab of the ribbon, click the Add menu, and then click the template you want to use.
This adds the template configuration as a new task in the configuration.
3. On the Home tab of the ribbon, click Properties to change the name or configure other properties for the task.
24
4. On the Home tab of the ribbon, click the Save button to save the changes the configuration.
How to Open an existing configuration file
Complete steps in this procedure to open a configuration from a local or network drive.
1. On the ribbon, click Open.
2. Click the desired configuration file and then click Open, or simply double-click the configuration file.
Save a configuration file
Save a configuration on a local or network drive

Save an existing configuration file
Save a copy of a configuration file
Overwrite an existing configuration file
To save a configuration on a local or network drive

1. On the ribbon, click Save.
2. Type the name of your configuration file and click Save.
To save an existing configuration file
On the ribbon, click Save.
To save a copy of a configuration file

2. Type the name of your configuration file and click Save.
To overwrite an existing configuration file
2. Select an existing configuration file and click Save.
3. Process Designer prompts you to confirm that you want to overwrite an existing configuration file. Click OK to
overwrite.
How to close a configuration file
On the ribbon, click the Close button.

If prompted whether to save changes, click Yes to save changes or No to close without saving changes.
Helpful tips
Ways to create a configuration file
You can create a configuration file by starting from any of the following types of files.
Blank process
If you want the most flexible way to create a

configuration file, use a blank process. This choice
provides you with a blank configuration file that contains
a blank process. You can add components, add new
processes, and set configuration attributes.
Template
If you want to create a document that reuses components,

processes, processing steps,and attributes, use a template
that includes this information.
Note: For rules about and restrictions to creating a configuration file, building a process, and configuring
component attributes, see Common practices.
Ways to save a configuration file
The configuration files can be saved to two types of files:
25
Configuration (.cfg)
Configuration template (.ctf)
This is the generic configuration file format. You must

save your configuration in .cfg file format for it to run
properly. Use .cfg files in Service Manager to start the
Service.
This is the format for template files used primarily to
save frequently used configuration templates. Use this
option if you want to save your current configuration file
as a template for future use.
Note that the .ctf files must be saved in the server Templates directory. See Create your own template for the location
of your template directory.
You can also save a single process as a template (see Save a Single Process in a Configuration as a Template) or save
a configuration file as a template (see Create a Configuration Template).
AutoStore configuration templates
Templates are a simple method of saving a frequently used set of configuration parameters. After a template is created
you can always copy this template to a new configuration file by selecting it when the Process Designer presents the
list of templates. For details about using templates, refer to the following topics:
Create a configuration template

Save a single process in a configuration as a template
Common practices
How to create a configuration template

To use a configuration repeatedly, you can save it as a configuration template (CTF) file.
Tip: he default template directory is specified by the Template Directory option in the Options dialog box.
and then click the APD Options button. For more information, see Options Dialog Box.
1. Make sure that the configuration you want to use shows in the Process Designer workspace.
2. On the Home tab of the ribbon, click the Save menu, and then click Save As.
You can instead click the File tab, and then click Save As.
3. Make sure that the location shown in the Save in box is the template folder, or a folder in the template folder.
4. In the File name box, type the template file name that you want to use.
Make sure to remove the ".cfg" extension if it is appended to the file name.
5. Int the Save as type box, click "CTF Template (*.ctf)" as the file type.
6. Click the Save button.
How to save a single process in a configuration as a template
To create save a single process tab in a configuration to a template, you must first save the entire configuration to a
template file and then delete task tabs that you do not want from the template.
Tip: The default template directory is specified by the Template Directory option in the Options dialog box.
and then click the APD Options button. For more information, see Options Dialog Box.
1. In AutoStore Process Designer, make sure that the the configuration containing the process that you want to save
shows in the workspace.
26
2. On the Home tab of the ribbon, click the Save menu, and then click Save As.
You can instead click the File tab, and then click Save As.
3. Make sure that the location shown in the Save in box is the template folder, or a folder in the template folder.
4. In the File name box, type the template file name that you want to use.
Make sure to remove the ".cfg" extension if it is appended to the file name.
5. In the Save as type box, click "CTF Template (.ctf)".
6. Click the Save button.
7. Right-click each process that you want to remove from the configuration, and click Delete Task on the shortcut
menu.
8. On the Home tab of the ribbon, click the Save button.
Common practices
This topic provides helpful tips and suggestions for implementing uniform practices for administrators.
Where to store your configuration files?
Keep all your configuration files organized in one

directory on the server. If you have a large number of
configuration files, use sub-directories to organize them
further. Remember that each server can be started using
one configuration file.
How to name configuration files?
Define and use a file-naming convention to name your

configuration files.
Where to run the Process Designer?
You must run the Process Designer on the machine

where the server is installed. Process Designer looks for
registered components and displays these components
on the Component Tray. If the server is not installed, the
Process Designer returns an error.
Where to store your templates?
Always store your template under the template subdirectory, and remember that a template contains all the
processing parameters, including process names, and
attributes.
How to set up the Inbox, Working,

Success, and Failure directories?
The best way to create your set of directories is to create

them under a directory with the same name as your
process directory. For example, if you have a process
called SPS Store, then create a directory called SPS
Store and create your Inbox, Working, Success, and
Failure directories in SPS Store directory.
Service Manager
The Service Manager allows you to start, stop, or configure the AutoStore service. The AutoStore service is started by
running batch.exe as a service. It can be run using Windows Services or using the Windows Task Manager.
During an AutoStore process development cyle, you first use AutoStore Process Designer to create and save
a workflow process in a configuration (CFG) file. Then you start (or restart) the AutoStore service using the
configuration file. On the Home tab of the AutoStore Process Designer ribbon, you can click Start, Stop, or Restart
to start, stop, or restart the AutoStore service. On the Home tab, you can also click Service Manager to administer
the AutoStore service.
Service Manager reference
Use Service Manager to stop, start, or configure the AutoStore service. Do any of the following to administer the
AutoStore service:
In AutoStore Process Designer, click Service Manager on the ribbon.
27
On the Windows Start menu, click All Programs > NSi > AutoStore Workflow6 > AutoStore Workflow 6
Service Manager.
In Windows Administrative Tools, open Services, and then double-click the AutoStore service.
The Service Manager configuration window consists of three tabs:
General tab
Log On tab
Recovery tab
General tab
The following table describes Service Manager fields and operations:
Name
Description
Configuration file
This field contains the configuration file name. The

Process Designer generates this file when you save your
server parameters. The file has a .cfg file extension.
Click the browse button (...) to select a configuration file
in the Windows Explorer view. The latest configuration
file saved by the Process Designer is displayed on top of
the list.
Log file
This field contains the log file name. The service creates
a log file for the process activities. This file must reside
on the local machine.
Path to executable
This field contains path to the executable file for the

service. The service is started by batch.exe.
Startup type
Using this field, you can select the startup type for the
service. Automatic restarts the service automatically if
the server is restarted. Manual requires the service to
be restarted manually every time the server is restarted.
Disabled marks the service as disabled so that it cannot
be started.
Service status
This field displays the current service status.
Start
Click this button to start the AutoStore service.
Stop
Click this button to stop the AutoStore service.
Log On tab
This tab allows you to specify the account used to run AutoStore. You must first stop the service to configure these
options.
Name
Log on as
Description
Select the account you want to use to log on to the
service:
Local system accountSpecifies that the service

runs under the local system account. This is a default
value.
Allow service to interact with desktopSelect
this check box to allow the service to provide a user
interface on a desktop that can be used by whomever
is logged on when the service is started. This option
28
Name
Description
is available only if the service is running as a Local
System account.
This may be useful in situations when components
used in a process interact with applications that
generate dialogs or pop-up messages. The service can
then interact with the service without hanging.
Note: This option should not be selected

unnecessarily, as doing so can create a
security vulnerability.
This accountSpecifies that the service should
run under a designated domain account. A domain
account may be required to provide access to
protected resources, such as files or folders in shared
network locations. Type the domain name followed
by the account name in the following format:
domain name\user ID . You can click the
Browse button to use the Select User dialog box to
specify a domain user account.
Password
Type the password for the service account.
Confirm password
Type the password again to confirm it.
Recovery tab
Name
Description
Select the response if service fails
In each box click the a response:
First failureSpecifies the action that occurs

during the first recovery attempt.
Second failureSpecifies the action that occurs
during the second recovery attempt.
Subsequent failuresSpecifies the action that
occurs for all recovery attempts that occur after the
second recovery attempt.
Reset fail count after
Specifies the number of days that a service must run

successfully before the fail count is reset to zero. When
the fail count is reset to zero, the next failure triggers the
action that is set for the first recovery attempt.
Restart service after
Specifies the number of minutes to wait before restarting

the service. This option is available only if you select
Restart the Service as the action to take when the
service fails.
Status Monitor
This application enables the viewing of real-time status messages associated with all active processes running on
a server that is "powered by AutoStore". Monitoring status messages can help insure the desired result for a given
process. It will also help predict and identify the sources of any potential system problems.
Please refer to Status Monitor help files for details.
29
Glossary
blocking component
A component in which configuration of other components further down the workflow takes place. It is the first
component in a workflow.
Note: Two blocking components cannot be used within a single process.
capture component
This is an AutoStore component responsible for reading/capturing documents or files from a particular source and
sending the information to a process or route component. Every process must have one capture component.
component
Components are AutoStore applications that capture, process or route documents or files. Components are combined
in a linear workflow to create a process.
A series of processes and process attributes are stored in a configuration file. A configuration file
has the .cfg file extension.
mapping component
This type of component maps the processing attributes of other components to its own internal properties.
process
A process is a series of components connected together for capturing, processing, and routing documents or files. A
process is often referred to as a workflow.
process component
The AutoStore component responsible for processing content in captured files or documents (for example, image
processing or form recognition). A process can have any number of processing components (or none).
process template
A special kind of configuration file that provides basic tools for shaping a final configuration file. Process templates
can contain the following elements:
One or more processes.

Process attributes and settings.
Component attributes and settings.
Route component
The AutoStore component that delivers captured and processed documents or files to a final destination.
task
A single workflow in a configuration. A configuration may contain multiple tasks.
ribbons and toolbars
Ribbons and toolbars provide quick access to application functionality.
License Manager
License Manager overview
The License Manager grants licenses for use of the server and components and for software maintenance, which
includes support and software updates. You can load a license onto a machine, get a Web license, create a license
request, generate a license report, and get information about the server license and version.
The server is licensed per CPU. The licenses are directly associated with unique serial numbers reported by the
License Manager.
Use License Manager for the following tasks:
Category
Web license
Task
Automated process to post your serial numbers through
a web portal and activate your current version of the
server software. It requires internet access. Please
30
Category
Task
note sometimes corporate firewalls interfere with this
operation.
License report
Create the report containing the licensing information.
Load keys
Load a generated license file sent to you by your reseller.
Create request
Generate a license file set of serial numbers which are

unique to this server. These serial numbers will be used
to generate an unlock key for this server.
Information
Get the server information including ID, version, build,

license of the server and Software maintenance.
License Manager window

The License Manager window displays licensing information on six different tabs.
Tab
Description
Server tab on page 32
This tab displays the information about licenses of the

server and the Software Maintenance. Licenses include
access to support and software updates.
Capture
This tab displays the information about licenses of

Capture components.
Process

process components.
Route

route components.
Other
This tab displays the information about licenses of

the components that are not included into the server
installation, are installed additionally and use the server
license.
Log
This tab displays the operations performed on the

licenses.
The following buttons provide licensing functionality.

Button
Description
Information
Displays build and version information for the AutoStore

application (see Checking server version on page 35
or installed components (see Checking component
licensing information on page 35). This information
may be requested by Notable Solutions support
personnel.
Web License
Used to update or add licenses via the Notable Solutions

licensing web site using the method described in Method
1Web license on page 34.
License Report
Creates a license report in HTML format. For more

information, see Creating a license report on page
34.
31
Button
Description
Load Keys
Loads licensing keys that have been received from

Notable Solutions using either the web or email licensing
methods.
Create Requests
Creates a licensing request file that can be emailed to

Notable Solutions. See Method 2Email on page
34.
Server tab
This tab displays the information about licenses of the server and the Software Maintenance. Licenses include access
to support and software updates.
Option
Description
Name
Displays the name of the component.
License
Displays the licenses with their status, available devices

or other information. The possible license statuses are:
EvaluationHas 30-days evaluation license.

ExpiredThe expiration of the license.
LicensedHas a permanent license.
N/AThe license is not supported and the
component is free.
Capture tab
This tab displays the information about licenses of Capture components.
Option
Description
Name
License

or other information.
The possible license statuses are:

component is free.
Process tab
This tab displays the information about licenses of the process components.
Option
Description
Name
License


32
Option
Description

component is free.
Route tab
This tab displays the information about licenses of the route components.
Option
Description
Name
License


component is free.
Other tab
This tab displays the information about licenses of the components that are not included into the server installation,
are installed additionally and use the server license.
Option
Description
Name
License


ExpiredExpiration of the license.
component is free.
Log tab
This tab displays the operations performed on the licenses.
Column
Description
Time
Displays the time when the operation was performed.
Name
Displays the name of the operation object (server,

component or software maintenance).
Operation
Displays the operation.
Status Before
Displays the license status before the operation.
Status After
Displays the license status after the operation.
License Info
Displays the type of license.
Serial Number
Displays the license serial number.
33
Column
Description
Key
Displays the license key.
Server ID
Displays the server ID.
Note: This tab does not display the information when the license expires.
Activate the server devices

The following methods are available to activate the server devices:
Obtain Web licenses. To obtain a Web license,the server must have complete Internet access.
Obtain license from another computer via email.
Note: Corporate firewalls can interfere with Web Licensing.
Method 1Web license

Update or add licenses by using Web license.
1. Open License Manager.
2. Click the Create request button.
3. Save the request as a text (.txt) file.
4. Click the Web License button.
5. If you are a new user, register your user information. Otherwise, use your login information to log into the
website.
Note: Email addresses from free email services such as Google or Hotmail cannot be used.
6. Enter all of the required information on the Web License form and upload the request file that was created.
7. Click Submit.
An activated license file is sent by email.
8. Save the received license file and note the location.
9. In License Manager, click the Load Keys button.
10. Open the activated license file that was saved in step 8 on page 34 and click OK to apply the license.
Method 2Email
1.
2.
3.
4.
Update or add licenses from a different computer using email.

Open server License Manager.
Click the Create request button.
Save the license information as a text (.txt) file.
5. On a computer with email access, send the file generated in step 4 on page 34 to the appropriate recipient in
charge of issuing licenses for your enterprise, with subject line "Activation Request".
6. A license file will be sent back to you via email.
7. Save the received file to a folder on the server.
8. Click Load Keys on the License Manager.
9. Open the activated license file that was saved in step 7 on page 34.
Creating a license report

Open server License Manager and click the License Report button. Save the HTML (.html) file that displays the
licensing information from all tabs of the License Manager.
34
Checking server version

Open server License Manager and click the Information button. The information window shows information for the
AutoStore Server:
Server ID
Server version
Server build
Server license status
Software maintenance license status
Checking component licensing information

Open server License Manager, click a component on the Capture, Process, or Route tab and click the Information
button. The information window shows component information:
License status
Company name
Location
Size
Date
Description
Managing client licenses

Open server License Manager, on the Capture tab, click a component that supports client licensing (AutoCapture)
and click the Information button. The information window shows component information and the total numbers of
client licenses on the server. To manage clients that are using licenses, click the License Status button.
In the list box above the tabs, you can select to manage a particular client (AutoCapture or Quick Capture Pro). The
Licenses tab lists clients that are currently using licenses. The Blocked tab lists clients that are currently blocked from
using licenses.
To block a client from using a license, click the client on the Licenses tab and click the Block button.
To unblock a client, click the client on the Blocked tab and click the Unblock button.
To edit comments for any client in either list, click the Edit button.
Extend evaluation license

To continue using the server after the evaluation period expires, request a license extension.
Note: The trial period for the software cannot be extended before the trial period expires. It is only possible to extend
a license once.
1.
2.
3.
4.
Open the License Manager

Click Generate.
Contact appropriate contact to submit the license file to and obtain an unlock extension key.
Update services
The Update Service is a web-based service that helps you to keep your software up-to-date. The Update Service
allows you to view a list of available updates and get information on the updates.
Enter your password to download and install the updates. Select Show Updates button on the software Update Server
home page to see a list of the server software updates. The updates will be listed with a description and with the size
of the update.
Select the desired update and follow the wizard instructions to download and install the updates.
35
Status Monitor
Welcome to the Status Monitor application
Status Monitor enables the viewing of real-time status messages associated with all active services and processes
running on the server. Monitoring status messages can help to ensure the desired result for a given process. Messages
are categorized according to their component. Status Monitor also helps identify the sources of any potential system
problems.
Introduction
The Status Monitor GUI is made up of the following:
Component
Menu bar
Description
The menu bar consists of the following tabs:
File tabDisplays buttons for connecting,

disconnecting, printing and exiting.
Home tabContains the File, Edit, Messages
settings. See Home Tab.
View tabContains the Show/Hide and Window
settings. See View tab.
To add or customize toolbars, right-click in any of

these groups and click Customize on the shortcut
menu to display the Customize dialog box. For more
information, see Customize Dialog Box.
Status bar
This bar displays information about the current state of

the application.
Color menu
This drop down list allows you to select the GUI color
scheme (black, blue, silver).
Server window
This window displays all the servers that are configured

to run the service.
Status Monitor window
This window displays status monitor information about

the current service. Double click on the desired service
and a status monitor window opens. For every service, 3
columns are displayed:
TypeThe type of status message.

MessageThe message text associated with an
event.
TimeThe time of the event on the server.
The following status message types are displayed:
ErrorIndicates significant problems that the

user should know about. Error events usually indicate
a loss of functionality or data.
WarningIndicates problems that are not
immediately significant, but that may indicate
conditions that could cause future problems.
InformationIndicates successful operations.
36
Home tab
The Home tab has the the following command groups:
File commands on page 37File commands

Edit commands on page 37Edit commands
Messages commands on page 37Messages commands
Help commands on page 38Help commands
File commands
Command
Connect
Description
Opens the Monitor dialog that allows you to select one
of the following alternatives:
Local computerStatus Monitor will be used to

monitor status messages on a local computer that
is powered by the server. This option is selected by
default.
Another computerStatus Monitor will monitor
status messages on a remote server. To connect to a
remote computer, click the Browse button to select a
computer or provide the remote servers IP address.
Disconnect
Closes the current connection to the server that is being

monitored.
Save
Saves the status messages in the current tab window in

to text file. This feature provides the capability to save
status messages and send them for support or analysis.
Print
Opens the Print dialog box that allows to configure print

settings and to print the existing log entries.
Stop
Stops displaying status messages.
Continue
Continues displaying status messages.
Edit commands
Command
Description
Cut
Cuts selected text and put it in to the clipboard so you

can paste it in another location.
Copy
Copies selected text in to the clipboard so you can paste

it in another location.
Clear
Clear any existing status messages in the current tab

window.
Messages commands
Command
Description
Information
Select this check box to display the information status

messages.
Warning
Select this check box to display the warning status

messages.
37
Command
Description
Error
Select this check box to display the error status

messages.
Messages
Specifies the maximum number of status messages to

display before wrapping messages. This setting only
affects the number of message entries in the Status
Monitor and does not affect server log files.
Help commands
Command
Description
Help contents
Displays the Status Monitor help contents.
About
Diplays the version number and copyright for Status

Monitor.
View tab
The View tab has the the following command groups:
Show/Hide commands
Window commands
Show/Hide commands
Command
Description
Toggle StatusBar
Select or clear this check box to show or hide the status

bar.
Workspace
Select or clear this check box to show or hide the

workspace bar.
Window commands
Item
Description
Arrange All
Arranges icons within the status monitor workspace.
Switch Windows
Switch between windows in the status monitor

workspace.
Customize dialog box

You can customize the Status Monitor window by right-clicking within a command group on the menu bar and
clicking Customize on the shortcut menu.
Toolbars tab
Commands tab
Keyboard tab
Options tab
Toolbars tab
Use this to add or remove custom toolbars that are displayed in the Status Monitor window. You can use a custom
toolbar to display selected commands.
38
Option
Description
Toolbars
This box lists currently defined toolbars. You can select

or clear a check box to display or hide a toolbar. The
default toolbar is labeled The Ribbon.
New
Click this button to create a new toolbar. Specify a name

for the toolbar in the New Toolbar dialog box. After you
display a new toolbar, it appears in the Status Monitor
window.
Rename
Click this button to create a rename the currently

selected toolbar. You cannot rename the default toolbar.
Delete
Click this button to create a delete the currently selected

toolbar. You cannot delete the default toolbar.
Reset
Click this button to reset the The Ribbon toolbar to its

initial state. This removes any changes that were made
to The Ribbon toolbar on the Commands, Keyboard, or
Options tab.
Commands tab
Use this tab to add commands to custom toolbars.
Option
Description
Categories
Click an item here this to display commands in a

command group that may be added to toolbars.
Commands
Drag a command or menu from this list to a toolbar or a

menu on a toolbar in the Status Monitor window to add
the command to the toolbar or menu.
To remove a command from a toolbar, and click and drag
the command button out of the toolbar.
FileAdd a command found on the File menu.

EditAdd a command found on the Edit menu.
ViewAdd a command found on the View menu.
WindowAdd a command found on the Window
menu.
HelpAdd a command found on the Help menu.
All CommandsAdd from any of the Status
Monitor commands.
Built-in MenusAdd one of the Status Monitor
menus (File, Edit, View, Window, or Help).
New MenuAdd a new menu to a toolbar.
Note: While the Customize dialog box is open,
you can right-click a command or menu and
access shortcut menu commands to customize it.
Keyboard tab
Use this tab to assign and edit keyboard shortcuts for the Status Monitor commands.
39
Option
Description
Category
Click an item here this to display commands in a

command group.
Commands
Click a command in this list to edit its keyboard shortcut

assignment.
Key assignments
This box lists keyboard shortcuts that are currently

assigned to a command.
Press new shortcut key
Click in this box and press a key combination to define a

keyboard shortcut.
Assign
Click this button to assign the keyboard shortcut

displayed in the Press new shortcut key to the currently
selected command in the Commands box.
Remove
Click this button to remove the currently select keyboard

shortcut assignment in the Key assignments box.
Reset All
Click this button reset all keyboard shortcuts to their

default assignments.
Description
Describes the command that is currently selected in the

Commands box. This is read only.
Options tab
Option
Description
Always show full menus
Select this check box to always show all commands on

the menus. Clear the check box to only show previously
used commands.
Show full menus after a short delay
Select this check box to show all commands on menus

after a short delay.
Reset menu and toolbar usage data
Reset usage data used to display commands on the

menus.
Large icons
Select this check box to display large icons on the

toolbars.
Show ScreenTips on toolbars
Select this check box to display tooltips when you move

a pointer over toolbar buttons or menu commands.
Show shortcut keys in ScreenTips
Shows command shortcut key combinations assigned to

commands in the tooltips.
Menu animations
Specifies the animation used to expand menus.
(System default)
Random
Unfold
Slide
Fade
None
40
QuickCapture Pro
Welcome to QuickCapture Pro
The QuickCapture Pro Capture desktop application allows users to scan documents via scanner of their choice,
preview and interactively improve image quality, break batches into separate files, index documents, and finally
release the document to workflow. The indexing forms are centrally managed using AutoCapture.
QuickCapture Pro supports the following tasks:
Scan documents using TWAIN or ISIS compliant scanners.

Review scanned images, clean images using available image processing filters and save the resulting images into
another file.
Create one batch of digital images and review, clean, index and send images to the server using AutoCapture.
Break a large batch of scanned images to multiple smaller documents.
QuickCapture Pro communicates with the AutoCapture Server to retrieve Group, Menu, Form, and Action
information for presentation on the QuickCapture Pro GUI. There are some unique indexing features that are designed
to help with indexing documents faster and easier. These features include index data retention across jobs, index from
definition refresh capabilities, single clink send, and SnapIt indexing for fast and accurate rule-based point-and-click
indexing of documents prior to submitting documents into workflows.
Please refer to the AutoCapture Server help file for information on how to configure the server.
Getting started
Feature highlights
Following is the list of features provided by QuickCapture Pro:
Image acquisition
Image review
Image clean-up
Indexing
Image acquisition:
Support for scanners with TWAIN or ISIS drivers.

Opportunity to open image files directly from the disk.
Reads 1D barcodes.
Reads 2D barcodes (with additional license).
Image review:
Zoom in/out, width, whole page.

Thumbnail view.
Small, Medium and Large Thumbnail size.
Insert or Append a page anywhere within a document.
Pane zoom
Magnifying glass for close inspection of a region.
Image clean up:
Add/remove pages.
Configure and apply image enhancement.
Apply correction filters to a selected region, a page or all pages.
Undo feature to undo image cleanups.
Batch image processing allows you apply image clean up to all pages.
41
Index form retention, allows the user to index once and send many times.
Process single and multipage images.
Break multipage document to multiple jobs.
Save all image processing configuration.
Apply Image processing filters in silent mode (no dialog).
Indexing:
Centrally defined forms allow you to control all indexing forms from one server.
Hierarchical menu definitions for indexing forms.
Centralized form definitions using AutoCapture.
Rule-based pattern matching that provides visual cues for speedy document indexing.
Visual cues along with simple point and click operation for fast indexing.
Read barcodes in a document and with a simple point and click to index documents.
Action button definition for SnapIt (requires OCR, which is included for the professional license).
Rename digital images on send.
Customizable forms using standard XML Style sheets.
Direct integration with AutoCapture server allows you to get information about AutoCapture groups, forms,
menus and actions from AutoCapture Server.
Save images, print them and send to AutoCapture.
How to use QuickCapture Pro for the first time

The first time that you use QuickCapture Pro you must configure it to recognize with your scanning device and to
communicate with the AutoCapture server.
1. Make sure you have your TWAIN or ISIS driver compatible scanner connected to your work station.
2. Using the software tools provided by the scanner manufacturer, make sure that your scanner functions properly
and is able to acquire images.
3. Start QuickCapture Pro.
On the Windows Start menu, click NSI > QuickCapture Pro > QuickCapture Pro.
4. Before you start working, select a scanner.
To use a
TWAIN compatible device
ISIS compatible device
Click
Options > Scanner > Select TWAIN Source
Options > Scanner > Select ISIS Source
5. In the Scanner Selection dialog box, select from the list of installed scanners for the selected interface.
For more information, see Select a Scanner.
6. Connect QuickCapture Pro to the AutoCapture server.
a) Click Options > AutoCapture > Settings Options > AutoCapture > Settings.
Alternatively, you can just click the AutoCapture Settings button

on the AutoCapture toolbar.
b) In the AutoCapture Configuration dialog box, enter the server name and port used to connect to the server.
If you do not know the server or port, contact your AutoStore administrator to acquire this information.
c) Click OK.
The server node will appear in the AutoCapture Menu window.
d) To see AutoCapture forms and actions that are available on the server, click the server node to expand it.
Now, images can be retrieved from the scanner. You can also open them from your computer.
42
7. To scan a file click the Scan button on the File toolbar or on the ribbon, click Page > Insert or Append > From
Scanner.
The image will appear in the viewport of the application and you can perform modify, save, or print the image
prior to sending it to the AutoCapture server.
8. Optional: You can use the SnapIt feature of QuickCapture Pro to capture index data from images processed with
OCR for input into the AutoCapture forms.
9. Optional: You can use the Barcode features of QuickCapture Pro to capture index data from Barcodes for input
into the AutoCapture forms.
10. Finally, send images to the AutoCapture server.
a) Click Send to AutoCapture button on the ribbon.
b) In the Send to AutoCapture dialog box, select the form or an action to receive the images.
c) Enter the name of the document, select type, in which the document will be sent to AutoCapture.
d) Click OK.
e) If a form was selected in the Send to AutoCapture dialog box, enter field values and click OK.
After you complete these steps, a message box informs you about documents that were sent to AutoCapture.
Licensing QuickCapture Pro
The following methods are available to receive and activate licenses:
Obtain Web licenses.

Obtain license on a different computer by email.
Obtain a license from the AutoStore server with server licensing.
Method 1 How to license QuickCapture Pro using Web License

Update or add licenses by using Web license.
The AutoStore server must have Internet access to support Web licensing.
Note: Corporate firewalls can interfere with Web licensing.
1.
2.
3.
4.
5.
Click Options > Licensing to open the Licensing dialog box.

Click the Create request button.
Save the request as a text (.txt) file.
Click the Web License button.
If you are a new user, register your user information. Otherwise, use your logon information to log into the
website.
Note: Email addresses from free email services such as Gmail or Hotmail cannot be used.
6. Enter all of the required information on the Web License form and upload the request file that was created. Click
Submit. An activated license will be made available for download.
7. Save the license file. Note down the location.
8. In the Licensing dialog box, click the Load Keys button.
9. Open the activated license file that was saved in step 7 on page 43 and click OK to apply the license.
Method 2 How to license QuickCapture Pro by email
Update or add licenses for QuickCapture Pro remotely using email.
1.
2.
3.
4.
Click Options > Licensing to open the Licensing dialog box.

Click the Create Request button.
On a computer with email access, send the file that was saved in step 3 on page 43 to the appropriate recipient
in charge of issuing licenses for your enterprise, with subject line "Activation Request".
5. A license file should be sent back to you via email.
6. Save the received file to the server's hard disk.
43
7. Click Load Keys.

8. Open the activated license file that was saved in step 6 on page 43.
Method 3 How to license QuickCapture Pro using server licenses
When server licensing is enabled, QuickCapture Pro queries the AutoStore server for a license when it starts up.
Before you perform this procedure, make sure that your AutoStore administrator has QuickCapture Pro client licenses
available on the AutoStore server.
1. Click Options > Licensing to open the Licensing dialog box.
2. Click the Server License button.
This opens the Server License dialog box.
3. Select the Enable server licensing check box.
Caution: Enabling server licensing will discard any existing license.
4. Click the Configuration button.
This opens the AutoCapture Configuration dialog box.
5. In the Server box, type the IP address or host name for the AutoStore server, or type "localhost" if configuring the
QuickCapture Pro client on the AutoStore server.
6. In the Port box, type the port that AutoStore uses to communicate with clients.
The default port is 8085.
7. Click OK twice to return to the Licensing dialog box.
The application status for a server licensed installation of QuickCapture Pro shows as "Licensed (Server
License)", while software maintenance shows as "N/A" (for not applicable).
8. Try restarting QuickCapture Pro if the licensing information is not updated immediately.
Important: QuickCapture Pro will be switched to unlicensed status if you enable server licensing and
QuickCapture Pro is unable to retrieve a valid license from the server.
Application interface
Menus
File menu
The File menu contains file options, such as New, Open, Print, and Save As. The File menu commands may also be
invoked by command buttons on the File toolbar.
Command
Description
New
Closes the active document.
Open
Opens a document while closing the previously active

document. You can preview files. To view properties
(such as format, name, and image size) of a selected file,
click the File Info button on the left side of the window
(under Paths). When a multipage file is selected in this
window, you can select which page of the file to display
in the preview pane by entering the page number in the
Page No box.
Insert
Inserts images from a file after the current page of the

active document. For a file containing multiple images
(such as a multipage TIFF file), you will be prompted
to specify the page Range, either All or a specified
From/To range of Pages.
Append
Appends images from a file after the last page of the

active document.
44
Command
Description
Print
Sends the active document to a printer. This command

opens standard Print dialog box in which you can select
a printer and adjust print settings before sending pages in
the document to a printer.
Save As
Saves the current document to a file. This command

opens the standard Save As dialog in which you can
specify path, name, and type of the image file in which
to save the document. You can also configure the
following image options:
BPPSpecifies color depth in bits-per-pixel.

Available color depths depend on the type of the
image.
Sub TypeSpecifies a subtype of the currently
selected image type. Available subtypes depend on
the selected image type and color depth.
All pages in a document are saved to a single file for

multipage image formats (such as TIFF). When you
select a single page image format, multiple pages are
saved to separate files.
Save Workspace
Allows you to save the settings and the layout of your

workspace to a file for future use.
Open Workspace
Allows you to load a previously saved workspace.
Exit
Closes the QuickCapture Pro application window.
Edit menu
This menu contains options for editing a page or a region. These commands are duplicated on the File toolbar.
Command
Description
Copy Image
Copies the current page.
Paste Image
Pastes a copied page after the currently selected page.
Undo Image
Undoes the last image processing action.
Redo Image
Cancels the previous undo.
View menu
The View menu provides the ability to manage certain application windows in QuickCapture Pro. These commands
are duplicated in the AutoCapture toolbar.
Command
Description
Thumbnail View
Displays or hides the Thumbnail View window.
AutoCapture Menu
Displays or hides of the AutoCapture Menu window.
AutoCapture Form
Displays or hides the AutoCapture Form window.
Status Bar
Displays or hides the status bar.
45
Document menu
This menu makes available commands for inserting or appending scans and switching between documents.
The Scan Insert and Scan Append commands are also available on the File toolbar.
Option
Description
Scan Insert
Scans and inserts content to the selected location in the

current document.
Scan Append
Scans and inserts content to the end of the current

document.
Next
Switches to the first page of the next document.
Previous
Switches to the first page of the previous document.
Send to AutoCapture
Sends the active document to the AutoCapture server.
Send All to AutoCapture
Send all open documents to the AutoCapture server

when they are ready for sending.
Page menu
The Page menu provides commands to navigate and manipulate pages in a document.
Command
Description
Next
Go to the next page in the current document. This

command is also available from the Image toolbar.
Previous
Go to the previous page in the current document. This

First
Go to the first page in the current document. This

Last
Go to the last page in the current document. This

Go to
Go to a specified page in the current document. This

Print Page
Prints specified pages or selected content.
Rotate Left
Rotates selected pages 90 degrees to the left. This

command is also available from the Advanced Image
toolbar.
Rotate Right
Rotates selected pages 90 degrees to the right. This

command is also available from the Advanced Image
toolbar.
Delete Page
Deletes the current page. If multiple pages are selected in

the Thumbnail window, this deletes the selected pages.
You can also press either Ctrl+Delete or Delete to delete
pages.
Export
Exports All pages or a specified range of Pages to a

specified file type. This command functions like the File
> Save As dialog box.
Document Imaging
Applies a specified filter to selected images. Filters are

also available from the Advanced Image toolbar. See
Applying Image Processing Filters for details.
46
Zoom menu
These options help you to set an appropriate view of an image in the window. These commands are duplicated in
Image toolbar.
Command
Description
Zoom In
Zooms in on an image.
Zoom Out
Zooms out from an image.
Fit to Window
Resizes the current image to fit the height and width of

the window.
Fit to Width
Resizes the current image to fit the width of the window.
Fit to Height
Resizes the current image to fit the height of the window.
Pan Window
Displays a view of the main image at a smaller

magnification and a rectangle indicating the size and
position of the visible portion of the image. You can drag
the rectangle to view parts of the image.
Magnifying Glass
Enlarges the portion of the window under the pointer.
Options menu
Command
Scanner
Description
Allows you to select the default scanner for scanning
images directly into QuickCapture Pro from installed
scanners or to configure settings for the currently
selected scanner.
Desktop
Select TWAIN sourceAllows you to select a

scanner that is configured on your system to use the
TWAIN interface.
Select ISIS sourceAllows you to select a scanner
that is configured on your system to use the ISIS
interface.
SettingsOpens the settings dialog for the
currently selected scanner.
ToolbarsAllows you to manage the QuickCapture
Pro toolbars, create your own toolbars from available
buttons, and edit them.
Thumbnail SizeSelect an size of image for
thumbnails (Small, Medium, Large) that show in
the Thumbnail window. The corresponding toolbar
buttons are on the Image toolbar. To show or hide the
Thumbnail window, click View > Thumbnail View.
Default Page ZoomSets the default page zoom
for images: Fit to Window, Fit to Width, or Fit to
Height. The corresponding toolbar buttons are on the
Image toolbar.
For more information, see Customize the workspace.

Document Processing
Opens the Document Processing Options dialog box,

which contains options for user confirmations, options
for actions after sending documents to AutoCapture, and
47
Command
Description
toolbar button confirmations. For more information, see
Document Processing Options.
SnapIt
Lets you configure the appearance of the settings of the

SnapIt function. See SnapIt Settings for details.
Barcode
Opens the Barcode Options dialog box to configure

options for reading barcodes. See
Blank Page
Opens the Blank Page Options dialog box, which

allows you to configure how blank pages are processed.
See Break Options options for details.
Break
Opens the Break Options dialog box, which allows you

to configure page breaks on barcode, on blank page, or
page count. See Break Options options for details.
Logging
Opens a dialog box where you configure message

logging. See Message Log Settings for details.
AutoCapture Configuration
Lets you configure the AutoCapture Server name and

the Port to connect to it. See Configure AutoCapture for
details.
Licensing
Opens a dialog box where you can view your license

information, request a license via Internet and see the log
of licensing operations. See Licensing for details.
Help
The Help menu contains the following commands:
Command
Description
Contents
Provides you with the access to the application's help

files.
About
Displays a box containing information about your

version of QuickCapture Pro.
Check for Updates
Allows you to search the available updates for

QuickCapture Pro. This command opens InstallShield
Wizard window that displays all the found updates that
are available on the internet.
Toolbars
File toolbar
The File toolbar buttons provide standard operations with files.
Button
Command
Description
New
Closes currently opened document to

create a new document.
Open
Opens an existing document while

closing any previously opened
document.
48
Button
Command
Description
This command allows you to preview
files and view properties (such as
format, name, and image size) of a
selected file by clicking the File Info
button on the left side of the window,
under Paths. When a multipage
file is selected in this window, you
can select which page of the file
to display in the preview pane by
entering the page number in the Page
No box.
Insert
Inserts a document after the active

page.
Append
Appends a document after the last

page.
Save As
Saves the current document to a file.

This command opens the standard
Save As dialog in which you can
specify path, name, and type of
the image file in which to save the
document. You can also configure
the following image options:
BPPSpecifies color depth in

bits-per-pixel. Available color
depths depend on the type of the
image.
Sub TypeSpecifies a subtype
of the currently selected image
type. Available subtypes depend
on the selected image type and
color depth.
Scan Insert
Scans a document and inserts

scanned pages after the active page.
Scan Append
Scan and append additional scanned

pages to the current scan process.
Show Scanner Settings
Shows the TWAIN or ISIS interface

during the scan process. When this
option is selected, select either Scan
Insert or Scan Append. The settings
dialog box for the corresponding
driver, either TWAIN or ISIS, will be
displayed.
Scanner Settings
Click to select the scanner settings

to be used for scanning documents.
Scanner settings can be set by
clicking Options > Scanner
Settings. By default, Scanner Default
49
Button
Command
Description
is selected. The default cannot be
removed.
Undo
Undoes an image processing action.
Redo
Cancels the previous undo.
Copy
Copies a selected image.
Paste
Pastes a copied image.
Print
Sends the current document to

a printer. This command opens
standard Print dialog box in which
you can adjust print settings before
sending the document to printer.
About
Displays the About dialog box,

which shows build and version
information for the QuickCapture
Pro application. You can provide this
information when filing a service
request.
Image toolbar
The Image Toolbar commands help you to set an appropriate view of an image in the viewport and navigate between
pages.
Button
Command
Description
Print Page
Prints specified pages or selected

content.
Delete Page
Deletes selected pages.
Previous Page
Go to the previous page in the

current document.
Go To Page
Goes to a specified page in the

current document.
Next Page
Go to the next page in the current

document.
Previous Document
Go to the first page in the previous

document.
50
Button
Command
Description
Next Document
Go to the first page in the next

document.
First Page
Go to the first page in the current

document.
Last Page
Go to the last page in the current

document.
Zoom In
Zooms in on an image.
Zoom Out
Zooms out from an image.
Fit to Window
Resizes the current image to fit the

height and width of the window.
Fit to Width

width of the window.
Fit to Height

height of the window.
Pan Window
Displays a view of the main image

at a smaller magnification and a
rectangle indicating the size and
position of the visible portion of the
image. You can drag the rectangle to
view parts of the image.
Magnifying Glass
Enlarges the portion of the window

under the pointer.
Small Thumbnails
Displays pages as small-sized

thumbnails in the Thumbnail View
window, which can be toggled on or
off by clicking View > Thumbnail
view or by pressing Ctrl+T. You can
drag a page to change the order.
Medium Thumbnails
Displays pages as medium-sized

thumbnails in the Thumbnail View
window, which can be toggled on or
off by clicking View > Thumbnail
view or by pressing Ctrl+T. You can
drag a page to change the order.
Large Thumbnails
Displays large-sized thumbnails

in the Thumbnail View window,
which can be toggled on or off by
clicking View > Thumbnail view or
by pressing Ctrl+T. You can drag a
page to change the order.
51
Advanced Image toolbar

The Advanced Image toolbar supplies image filters which can be applied to images.
Button
Command
Description
Select Region
Click this button and drag to select

a rectangular region to which you
can apply filters. To remove a region,
click this button again. A filter
applies to the entire image if no
region is selected.
Rotate Left
Rotates selected images 90 degrees

to the left.
Rotate Right
Rotates selected images 90 degrees

to the right.
Deskew Page
Straightens skewed images.
Hole Punch Removal
Removes office hole punch traces

from selected images. Configure
filter settings in the Hole Punch
Removal dialog box.
Border Removal
Removes borders from selected

images. Configure filter settings in
the Border Removal dialog box.
Dot Removal
Deletes dots, garbage, and blemishes

filter settings in the Dot Removal
dialog box.
Smooth
This filter smooths selected images.

Configure filter settings in the
Smooth dialog box.
Line Removal
Deletes horizontal or vertical lines

filter settings in the Line Removal
dialog box.
52
Button
Command
Description
Inverted Text
Inverts RGB color values for text

inside a black box and removes the
box itself. Configure filter settings in
the Inverted Text dialog box.
Invert
Inverts RGB color values in selected

images.
Despeckle
Improves speckled images.
Resize
Resizes selected images. Configure

filter settings in the Resize dialog
box.
All Pages
This option selects all pages in the

Thumbnail View. To simultaneously
modify all pages, click this button
and then apply an image filter. All
thumbnail pages will remain selected
until you click this button again to
clear the selection from all pages.
AutoCapture toolbar
The AutoCapture toolbar provides buttons to work with AutoCapture.
Button
Command
Description
AutoCapture Configuration
Configure AutoCapture settings to

make QuickCapture Pro work with
the AutoCapture server.
AutoCapture Menu
Opens or closes the AutoCapture

Menu window.
AutoCapture Form
Opens or closes the AutoCapture

Form window.
Clear Form
Clears values from fields in the

currently active AutoCapture form.
Send all open documents to the

AutoCapture server when they are
ready for sending.
53
Button
Command
Description
Send to AutoCapture
Sends the active document to the

AutoCapture server.
Output files list
The drop down list provides the list

of output files created as a result of
your selection (numbers in brackets)
when splitting the document. The
number outside brackets in each
option will indicate how many times
this selection of pages has been
already sent to AutoCapture.
Assume that you have 10 pages in
the thumbnail panel. The numbers in
brackets indicate the suggested page
range for sending to AutoCapture as
one file. For example, (1-5) means
that based on your splitting, the
program suggests the first five pages
for sending to AutoCapture, because
you made the page 5 a break page.
The list will also contain an option
looking like this (6-10), which means
that you can send the second part of
the pages (from page 6 to page 10).
Break Options
Opens the Break Options dialog

box in which you can configure
breaks on barcodes, blank pages, or
page numbers, which you select in
the Thumbnail View when splitting
documents.
SnapIt toolbar
The SnapIt toolbar buttons let you activate SnapIt feature and navigate the document.
Button
Command
Description
SnapIt
Click this button to activate SnapIt.

The AutoCapture server must be
running before you can activate
SnapIt.
Previous Field
Navigates to the previous form field.

This button is only available if the
AutoCapture form fields are enabled
with SnapIt.
Next Field
Navigates to the next form field.

with SnapIt.
First Field
Navigates to the first form field.

54
Button
Command
Description
with SnapIt.
Last Field
Navigates to the last form field.

with SnapIt.
Note: This toolbar is only included with the professional version of QuickCapture Pro. The basic version of
QuickCapture Pro does not include OCR.
Special Action toolbar
The Special Action toolbar allows you to highlight, break, and read barcodes on pages in a document.
Button
Command
Description
Break
Opens the Break Options dialog box

and applies the break options when
you click OK in the dialog box. See
Break Options for details.
Clear Breaks
Removes breaks that were created

previously.
Remove Blank Pages
Removes blank pages according to

criteria specified by the Blank Page
Options. See Blank Page Options for
details.
Show Barcode
Highlight the bar codes that are

embedded in a page.
Read Barcode
Read the bar codes and display the

bar code values as strings.
QuickCapture Pro view windows

The View Windows, considered together, will give a good survey of the currently processed document. The following
windows will be described in the next sections:
AutoCapture Menu window

Thumbnail View window
AutoCapture Form window
Document window
AutoCapture Menu window

QuickCapture Pro receives information from the AutoCapture server about groups, menus, forms and actions set in
AutoCapture and displays this information in the AutoCapture Menu window. By default, the AutoCapture Menu
window appears to the left of the main window of the application. If options for connecting to the AutoCapture server
were set up correctly then available AutoCapture menus, forms and actions are displayed in the AutoCapture Menu
window. Until correct connection options are set up, the only node displayed in this window is No AutoCapture
Server.
Any form or action in the AutoCapture Menu window can be set active by clicking Set Active on the shortcut menu
for a form. A green check mark next to the Set Active command indicates that a form is active. To set a tree element
55
active, either double-click the element or right-click the element and click Set Active on the context menu. To switch
an element to inactive, click Set Active again or double-click this element.
To set the properties for a form or action, right click the element and click Properties. This displays the Item
Properties dialog box.
Document name and Document format specify the default values when you send a document to AutoCapture. You
can select the Prompt for document name/format check box to prompt the user for the document name and format.
If this check box is not selected, values entered for Document name and Document format will be used without
prompting the user. You can enter a name in the Document name box or use the RRT, ~QCP::GUID~. The GUID is
used if Document name is left empty.
The check mark on Set Active means that the active image will be sent to this menu item after you click the Send to
AutoCapture button. If no element in the AutoCapture Menu window is active, QuickCapture Pro prompts you to
choose the AutoCapture element that you want to use to send images.
To refresh the elements in the window to match the current state of the server, click Refresh on the shortcut menu.
Item Properties Dialog Box
This dialog box displays properties of a selected AutoCapture element.
The Item Properties dialog window can be opened by right-clicking an element in the AutoCapture menu and
clicking Properties on the shortcut menu.
This dialog contains information about type of the element (Menu, Form, or Action), name of the element, and
the element's GUID. This information is taken from the AutoCapture Server. You can refer to the AutoCapture
documentation for more information about particular properties.
56
Option
Description
Type
Shows the type of element.
Menu
Form
Action
Name
The name of the element that is configured in

AutoCapture. This is read only.
GUID
The globally unique identifier for element that provides

a unique reference when communicating with the
AutoCapture server. This is read only.
Prompt for document name/format
Click this check box to display any default settings

defined here and prompt the user for the document
name and format before sending documents to the
AutoCapture server. You can clear this check box to use
the default values without prompting the user.
Document Name
Specifies the name for files being sent to this

AutoCapture element. You can enter a name here or the
RRT ~QCP::GUID~ to use the GUID for a form or
action. The GUID is the default if no value is entered in
this box.
Document Format
You can select the format of files being sent to this

AutoCapture element:
B/W TIFF (black-and-white TIFF)

Color TIFF
Mixed TIFF
B/W PDF (black-and-white PDF)
Color PDF
Mixed PDF
Thumbnail window
This window provides a thumbnail view of pages in documents.
To open or close the Thumbnail window, click View > Thumbnail View.
57
Figure 1: Thumbnail View window

Horizontal red lines break groups of pages to be sent to AutoCapture into separate documents. The numbers to the
right of a split show the page range for a document and the number of pages in the document. The active document
contains the page that is displayed in the Document window. The active document is sent to AutoCapture by the
Send to AutoCapture command on the Document menu. The thumbnail for this page is highlighted with a blue
border in the Thumbnail window.
Table 1: Commands, toolbar buttons, and keyboard shortcuts
You can click a thumbnail to display a page in the Document window, or use a menu command, toolbar button, or
keyboard shortcut to navigate between thumbnails.
Move to
Menu command
Toolbar | button
Keyboard
Specific page
Page > Go to
Next page
Page > Next
Previous page
Page > Previous
First page
Page > First
Last page
Page > Last
Next document
Document > Next
Document |
Ctrl+Page Down
Previous document
Document > Previous
Document |
Ctrl+Page Up
Image |
Image |
Image |
Image |
Image |
Ctrl+G
Ctrl+Down Arrow
Ctrl+Up Arrow
Ctrl+Home
Ctrl+End
To split a document, right-click a page. This creates a document split right after the page. To merge split documents,
right-click the last page before a split. You can also press the Break key to add or remove a break. For step-by-step
instructions, see Splitting a multipage document.
58
Filters apply to selected pages in the Thumbnail window. Selected pages are marked by a red border around their
thumbnails. Clicking a page selects that page. You can then press the Ctrl key and click to add pages to the selection
or press the Shift key and click to extend the selection to adjacent pages. You can also press Shift+Up Arrow, Shift
+Down Arrow, Shift+Ctrl+Home, or Shift+Ctrl+End to extend the selection. You can press the Delete key or Ctrl
+Delete to delete selected thumbnail pages.
A blue check mark shows above the break line after you send a document to AutoCapture. This indicates that all
of the pages have been sent for that document. You can send all pages for all documents shown in the Thumbnail
window to AutoCapture by clicking Document > Send All to AutoCapture.
AutoCapture Form window
To open the AutoCapture Form window, click to the View > AutoCapture Form. If your application is not
connected to the AutoStore server the window will be empty. Otherwise, activate the desired form available in the
AutoCapture Menu window by double-clicking it. The AutoCapture form opens in the AutoCapture Form window
displaying the indexing fields that you previously configured with the AutoCapture capture component.
Document window
The Document window is the main window of the application. It displays pages for the currently loaded document
and lets you see changes that you apply to the images. You can fit the size of an image to the window, or to its height
or width by clicking the respective buttons on the Image toolbar.
Using QuickCapture Pro
Customize the workspace
You can change the QuickCapture Pro screen layout by selecting toolbars that you want to be displayed, adding or
removing buttons from the toolbars, or creating your own toolbars.
To customize toolbars open the Customize dialog box expanding Options > Desktop, and then clicking one of the
following commands:
Command
Description
Toolbars
This opens the Customize dialog

box. On the Toolbars tab, you can
hide or display toolbars, create
new toolbars, and change the
appearance of toolbars. On the
Command tab, you drag command
buttons to customize toolbars. For
more information see Toolbars or
Command.
Thumbnail Size
Allows you to change the size of

thumbnails in the Thumbnails
window (Small, Medium, or Large).
Default Page Zoom
Allows you to set the default page

zoom:
Fit to Window
Fit to Width
Fit to Height
Toolbars tab
Options on this tab of the Customize dialog box allow you to configure the general properties of a toolbar.
To open the Customize dialog box, click Options > Desktop > Toolbars.
59
Setting Name
Description
Toolbars
Displays the current toolbar selection. To display or hide

a toolbar on the toolbar panel of the application, select
or cancel the current selection. Note that the Menu bar
toolbar cannot be hidden.
Show Tooltips
Select this check box to turn the display of the tooltips

on or off when you move the mouse over a toolbar
button.
Cool Look
Select this check box to change the appearance of

buttons and toolbars
Large Buttons
Select this check box to show large buttons on the

toolbars.
New
Allows creating a new toolbar to the current list. Click

this button to open the New Toolbar dialog box and enter
the name of the Toolbar Name field. The new toolbar
will be displayed in the Toolbars list.
Toolbar name
Displays the name of the currently selected toolbar. This

box is active if a custom toolbar in the Toolbars list is
selected. You can change the current name of a custom
toolbar.
Reset
Click this button to return to the default configuration of

one of the standard toolbars.
Delete
Click this button to delete a custom toolbar.
Command tab
Options on this tab of the Customize dialog box allows you to specify which buttons should be present on a toolbar.
To open the Customize dialog box, click Options > Desktop > Toolbars.
Option
Description
Categories
Displays the default list of toolbar.
Buttons
Displays he default set of buttons of the currently

selected toolbar. To add a button to a toolbar that is
displayed in the main window of the application, drag
the button from the Buttons group and drop it over an
existing toolbar. If you want to remove a button, drag it
away from the toolbar and drop anywhere on the screen.
Description
Displays the description of a button currently selected

within the Buttons group.
You can create a new toolbar by dragging desired buttons from the Buttons group and dropping them anywhere in the
application. The new toolbar will appear in the Toolbars list on the Toolbars tab.
Working with documents
Opening a document
How to open a document from a file
Use this procedure to open an existing file.
1. Click File > Open.
2. In the Open dialog box, locate the file you want to open.
60
You can open one of the many different file types that are listed in the Files of type box.
3. Click Open.
How to scan an image into a QuickCapture Pro document
1. Make sure that your TWAIN or ISIS driver compatible scanner is added on your work station.
2. On the Options > Scanner > menu click either Select TWAIN Source or Select ISIS Source and select the
scanner.
Images can now be retrieved from the scanner.
3. To scan a document into AutoCapture Pro, click the Document menu, and then choose to insert or append the
scanned images
Option
Scan Insert
Scan Append
Description
Inserts images from a scanner after the currently
selected page in the active document.
Inserts images from a scanner after the last page in the
last document.
How to insert a document

Inserting a document adds a document from a scanner or from a file after the currently selected page of the current
document.
Insert from a file

Insert from a scan
To insert a document from a file

1. Click File > Insert.
2. In the Open dialog, locate the document that you want to insert.
3. Click Open.
To insert a document from a scan
Click Document > Scan Insert.
How to append a document to the active document

Appending a document adds a document from a scanner or from a file to the end of the active document.
Append from a file

Append from a scan
To append a document from a file

1. Click File > Append.
2. In the Open dialog, locate the document that you want to append.
3. Click Open.
To append a document from a scan
Click Document > Scan Append.
How to split multipage document

A split in a multipage document groups images into separate documents when you send them to the AutoCapture
server.
1. If the Thumbnail window is not already open, press Ctrl+T to open it.
Alternatively, you can click View > Thumbnail View.
2. In the Thumbnail window, right-click the page where you want to break the document.
A red line is added after the selected image, with a tag showing the selection.
3. To remove a split, right-click the last image before the split.
61
This would be the same image used to create a split.

The split tag shows the range of pages in the document and total number of pages in the split.
For example, (4-8)-5 shows that pages 4 through 8 are included in the split, and that the total
number of pages is 5.
Tip: You can also press the Break key on the keyboard to add or remove breaks in a document.
Applying Image Processing Filters
QuickCapture Pro provides the following imaging filters:
Hole punch removal

Border removal
Dot removal
Smooth
Line removal
Inverted text
Resize
Deskew page
Despeckle page
Invert page
These filters are accessible either from the Page > Document Imaging command or from the Advanced Image
toolbar.
If you want to apply a filter to all pages of a document, click the All Pages button on the Advanced Image toolbar.
Then the dialog box with the filter settings appears only once, and the filter is applied to all pages using the same
parameters.
Note: The following imaging filters are available exclusively for processing 1-bit (black-and-white) images:
Hole Punch Removal, Border Removal, Dot Removal, Smooth, Line Removal, and Inverted Text.
Border removal
Using this filter you can remove borders you want to get rid of from 1-bit images.
In the Settings section of the dialog you can set Border Percent, Variance, and White Noise Length values:
Border Percent is a percentage of the image dimension in which the border will be found. For most images, use
20. For example, if an image is 200 pixels wide, Border Percent is set to 20 and Border To Remove (see below)
is set to Left, then the left border will be found in the area between the left edge of the image and a line 40 pixels
from the left edge. If the border is closer to the edge of the image, use a smaller value. If the border is farther from
the edge, use a larger value.
VarianceCheck box allows you to set the amount of variance tolerated in the border. If the border varies
significantly in thickness, you should use a higher value for Variance. The possible value range is 0 to 10 pixels.
White Noise LengthInput field is used to set the amount of white noise tolerated when determining the border.
The measure units are pixels. Values of 0 to 10 are sufficient for most images.
Border To RemoveSection of the dialog allows you to select the side(s) border(s) will be removed from. You
can select the Left, Right, Top, Bottom boxes separately or in any combination.
Image modification is displayed in the viewport at the top of the dialog box. It can also be shown as color selection.
To display changes in the resulting image, select the Show modification as color selection check box and pick the
color in the Color Picker dialog box that opens by click on the button at the bottom of the dialog.
Deskew Page
This filter rotates an image to straighten it. Rotation is limited to 20 degrees in either direction. This filter is
intended for images of scanned documents that contain horizontal lines of text. Such lines are used as a guide when
straightening the image. Images without these horizontal lines may be altered improperly.
62
This filter does not support 12, 16 or 32-bit grayscale images.

This filter does not support 48 or 64-bit color images.
Despeckle Page
This filter removes unwanted speckles from an image. Specifically, it removes 1-pixel speckles and can shrink larger
speckles. Note that the fact that it shrinks larger speckles makes it potentially worthwhile to run this filter more than
once on a given image.
This filter supports 12 and 16-bit grayscale images, but does not support 32-bit grayscale images.
This filter supports 48 and 64-bit color images.
Dot removal
Using this filter you can find and remove dots, specks and blobs of various sizes in 1-bit documents. The dots, specks,
and blobs may or may not be all black.
Prior to configuration, set appropriate Measure unit (one thousandth of an inch or pixels).
You can set minimum and maximum size of objects to be removed through Minimum/Maximum dot Width and
Height input boxes. If you clear the Use Dot Sizes check box, the default values will be used.
You can switch on/off the use of Diagonals in search of spots to be removed.
This option allows you to treat the pixels that are diagonal as part of the dot or not. Consider the "speck" below
consisting of nine pixels.
If Use Diagonals box is checked, this speck is considered a single dot that is 5x5 pixels. If Use Diagonals box is
unchecked, the speck is considered three separate dots (2x2, 1x1, 2x2).
You set all dot size parameters or rely on the defaults provided and preview the results in the viewport at the top of
the dialog box using different colors for indication of white and black regions at the output. To display changes in the
resulting image, check Show Changes as Color Selection box and pick the colors in the Color Picker dialog that
opens by click on Black Area and White Area buttons at the bottom of the dialog.
Hole punch removal
When you scan a page that contains punch holes, their traces might be visible on the resulting image. This filter
removes hole marks of a particular size set in the dialog from 1-bit documents.
To remove hole traces, select appropriate Measure unit (one thousandth of an inch or pixels) and indicate Hole
Location (left, right, top, bottom or default, which is set to left).
You can set Hole Dimensions (width and height ranges) or rely on default dimensions. The default dimensions are
calculated from the image width and height (if the selected measure unit is Pixels) or from the image DPI (if the
selected measure unit is Inches).
In the Hole Count section you can set the minimum and maximum amount of holes to be removed with use of two
respective sliders. The minimum possible number of holes is 2. If you select the Use Default Count check box, the
default values for hole count will be used: 2 for minimum hole count, and 4 for maximum hole count.
Changes that will be applied to the image are reflected in the preview at the top of the window. Select the appropriate
image scale (1:1 or Fit to Window).
63
You can preview the results in the viewport at the top of the dialog box using different colors for indication of
white and black regions at the output. To display changes in the preview image, select the Show Changes as Color
Selection box and pick the colors in the Color Picker dialog that opens by clicking on the Black Area and White
Area buttons at the bottom of the dialog.
Invert page
This filter inverts the colors on an image. Bright colors become darker while darker colors become lighter when the
filter is applied. This filter can be used to make certain text document images more readable. This filter can also be
used to restore previously inverted images to their original state.
Inverted text
This filter is used to find and invert areas of inverted text in a 1-bit black and white image.
Inverted text is commonly found in scanned text documents.
Below is an example of inverted text often found in scanned images:
The result of application of the filter looks like this:
Prior to configuration, set the appropriate Measure unit (one thousandth of an inch, or pixels).
In the Invert section, set Minimum Width parameter to indicate the minimum width of an area that is considered to
be inverted text.
Set Minimum Height to define the minimum height of an area that is considered to be inverted text.
Black Percent section allows you to configure the minimum and maximum percent of total pixels in an inverted text
area that must be black. Use respective sliders to set the desired value range. Areas with a lower-than-minimum-set
percent of black pixels are not considered as well as areas with a higher- than-maximum-set percent of black pixels.
Image modification can be shown in the dialog's viewport at the top of the dialog box as color selection. To display
changes in the resulting image, check Show Changes as Color Selection box and pick the colors in the Color Picker
dialog that opens by click on Black Area and White Area buttons at the bottom of the dialog.
Line removal
The filter removes horizontal or vertical lines on the images. This filter might be very useful for OCR optimization of
printer filled forms with misplaced text. You can choose either to remove vertical or horizontal lines.
Prior to configuration, set appropriate Measure unit (thousandths of inch or pixels).
You can specify what kind of lines QuickCapture Pro will look for to remove.
Line direction can be selected from Remove drop down list. You can select vertical or horizontal lines.
In Dimensions section of the dialog you can specify minimum and maximum line length along with Wall Height and
Max Wall Percent values.
Wall Height. Walls are slices of a line that are too wide to be considered parts of the line. Examples of walls include a
character that a line passes through or a perpendicular line. If the image contains lines that pass through characters, set
Wall Height to be equal to or a little larger than Maximum Line Width.
Max Wall Percent. Stands for maximum number of wall slices (expressed as a percent of the total length of the line)
that are allowed. A line consists of wall slices and non-wall slices (see description of Wall Height above). Lines that
have a wall percent that is larger than Max Wall Percent will not be removed. For example, consider the line below
that is 10 pixels in length, and 1 pixel in height in some places, and five pixels in height in other places.
64
Setting Minimum Length to 10 pixels and Wall Height to four pixels will identify the line below as a candidate for
removal. Note that the wall percent for this line is 60% (because six of ten line slices are walls). If Max Wall Percent
is 80 then the line will be removed (actually, the pixels marked as red will be removed). If Max Wall Percent is 30,
then the line will not be removed.
65
Optional processing section of the dialog provides Line Variance, Max Gap Length, and Remove Entire Line
settings.
Line Variance is amount of width change that is tolerated between adjacent line slices. For example, the following
horizontal line is 30 pixels in length (X represents a pixel)
XXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXX
XXXXXXXXXX
If Line Variance is 2 pixels (that is, to tolerate width changes of 2 pixels or less), the first 10 columns and the last 10
columns of the line will be removed. The middle 10 columns will be unchanged. This helps to preserve characters that
intersect a line that is being removed.
Max Gap Length is a maximum length of a break or a hole in a line. Use it to remove dotted lines, dashed lines, or
lines that have breaks due to scanning.
Remove Entire Line. This option tells the program to remove the entire line, even if the line passes through a
character or a wall. Consider the line below.
66
Setting Max Wall Percent as 80 checking Remove Entire Line will remove the red pixels as shown below.
67
Resulting image modification can be shown in the viewport at the top of the dialog box as Color Selection. To
display changes in the resulting image, check Show Changes as Color Selection box and pick the color in the Color
Picker dialog that opens by click on the button at the bottom of the dialog.
Resize
The filter allows you to change image size. A range of resize methods are provided in the Resize dialog box, where
you can see the size of the original image and specify the New Image dimensions in pixel or percentage.
Following resize settings are available in this dialog box:
NormalUse this method if you want to increase the resolution of the original image. The resulting image is larger
than the original, and preserves all the original detail, but has undesirable jaggedness. For example, the diagonal lines
of the letter "W" would have the shape of a stairway and would be much more jagged if you used this method.
ResampleAn image is upsampled to increase the resolution by adding new pixels. An image is downsampled to
decrease the resolution by throwing out pixels. Resampling an image usually results in a loss of image quality because
pixels must either be interpolated or thrown out.
BicubicMinimizes the raggedness normally associated with enlarging an image by estimating how the 'missing'
pixels should appear, then filling them in with the appropriate color to smooth out the rough spots. Use the Bicubic
Method to enlarge photographic type images.
You can set the Width and the Height of the image in dpi or percent.
Furthermore, by specifying the Horizontal and the Vertical Resolution values (in dpi) you can determine the logical
resolution of the image. If you choose to resize by percentage, all images will be upsized/downsized based on the
resizing percentage. The percentage would be in relations to the original image size.
Identical Values (in pixel)Select this check box if you want the resolution to be the same vertically and
horizontally.
Maintain Aspect RatioSelect this check box if you want the proportions of the resulting image to be preserved.
When you select this check box, the Identical Values check box become selected and disabled as the vertical and
horizontal resolution will be identical in this case.
Smooth
This filter softens images by smoothing image bumps and nicks often produced as a result of image scanning,
binarization or faxing.
Set the Bump/Nick Length value pixels to delimit the length of the bump (or nick) to be removed (or filled). All
bumps and nicks less than or equal to this size are processed.
Favor option is used to set bumps/nicks processing preference. If the option is set to Long Bump/Nick, the program
will process long bumps or nicks before short bumps or nicks. If Short Bump/Nickis selected, short ones are favored
over long ones. For example:
Smooth the following image with Bump/Nick Length = 3
XX
XXXXXXXXXX
Favoring short would remove the two "bumps" giving:
XXXXXXXXXX
Favoring long would fill in the "gap" giving:
XXXXX
XXXXXXXXXX
Image modification is reflected in the viewport at the top of the dialog box and can be shown as color selection. To
display changes in the resulting image, check Show Changes as Color Selection box and pick the colors in the Color
Picker dialog that opens on click on Black Area and White Area buttons at the bottom of the dialog.
68
Indexing Documents
QuickCapture Pro provides some unique indexing functions such SnapIt and Barcode functions that are designed to
help you index documents quickly, accurately, without even getting up from you chair. The indexing information is
entered into an AutoCapture form displayed in the AutoCapture Form window.
Working with an AutoCapture form
To activate a form, double-click the form on an AutoCapture menu. The form appears in AutoCapture Form
window. This window initial appears at the bottom pane of QuickCapture Pro application window.
All form elements previously configured on the AutoCapture server are displayed in this window. You can enter
values in form fields to send the information to AutoCapture. When all fields of an AutoCapture form are filled in,
QuickCapture Pro prompts you to send the form to AutoCapture.
If an AutoCapture field was enabled for SnapIt in AutoCapture component, you can take advantage of SnapIt features
for the field.
The Web form and scripting functionality of the AutoCapture component may be used to fill a form in QuickCapture
Pro.
AutoCapture web form
The following example includes using of the web form of the AutoCapture component.
Sending documents to a user by email using a web form for entering the logon name. Design a process with the
AutoCapture component and the Send to Mail recipient component. Configure the AutoCapture component to use a
web form of the mail server site to enter the logon name of the user. Configure the Send to Mail Recipient component
to send emails to the user with the specified logon name. Start the process.
Open the document in the QuickCapture Pro application, select the form for the sending document. The application
displays the web page that allows to enter the logon name and password.
Enter values in the form fields and click the Send to AutoCapture button to send the document. For Send to Mail,
the document is sent to the user with the specified email address.
AutoCapture scripting
The following example illustrates the scripting functionality of the AutoCapture component.
The script should send documents with 1000 or fewer pages directly to a folder specified by the DocumentType field.
Design a workflow with the AutoCapture component and the Send to Folder component. In AutoCapture component
create a form, containing the following fields:
69
Configure the form to use the following script:
Configure the Send to Folder component to save documents in the folder specified by the RRT string ~ACC::
%DocumentType%~. Start the process.
Open a document in the QuickCapture Pro and choose the AutoCapture form for sending the document. The script
fills the CompanyName field by ABC value automatically.
70
71
If the type of the document is invoice, click the Invoice button and the script will fill the DocumentType field
by the Invoice value. Then fill the number field by the number of pages in the document and click the Send to
AutoCapture button to send the document. If the number of pages is greater than 1000, the document will not be sent
and the error message will appear:
If the entered number value is less than 1000, then the document will be successfully sent to the Invoice folder.
You can use other Samples of scripts.
Samples
Script samples
1. This script fills the "UserName" field when the form is loaded, validates the value of the "number" field when the
user attempts to submit the form, validates the "list" field when user attempts to set a new value for this field, changes
the "UserName" field when user clicks a button field on the form.
72
2. This script fills all the form fields by predefined values when the following events take place: when the form is
loaded; when the form is open and the user attempts to submit it; when a List or Boolean field value on the form has
changed; when user clicks a button field on the form.
73
SnapIt
Prerequisites
SnapIt requires the professional version of QuickCapture Pro. The basic version of QuickCapture Pro does not
support OCR.
Before you can start using QuickCapture Pro SnapIt, you must:
Create AutoCapture forms and fields.

Configure the AutoCapture form fields with QuickCapture Pro SnapIt.
For details about enabling the AutoCapture form fields with SnapIt, please refer to AutoCapture online help.
Data entry with SnapIt
The SnapIt function is used for indexing documents. It combines the following three steps:
Searching a digitized document.

Identifying data to be entered in an AutoCapture form.
Transferring this identified information to index the document with a single click.
In order for SnapIt to work, make sure that:
AutoCapture Server is running.

An AutoCapture form is open.
The following example shows how indexing with SnapIt works:

74
After initiating SnapIt on a digitized document it is searched for any string of characters that match the search pattern
(regular expression) defined for the currently selected AutoCapture form field. All matches are highlighted.
When you move the mouse over a highlighted text in the document, the text is displayed in a special window below
the pointer, tracking all its movements. This window is the SnapIt Navigator. This window comprises the following
three labels:
Form Field Label
The top section of the window where the name of the

AutoCapture form field currently selected for data entry
(in this example it is the 'Policy Number').
Text Label
A label that appears below the top section of the window

displayed the data that your mouse is currently pointing
to (in this example it is 'A-0815/3314-PPT'). You can
click to transfer this label's value into the respective
AutoCapture form entry field. The next field is selected
after the transfer.
Error Label
This appears only when the current value does not match
the search pattern defined for this field in AutoCapture.
The background color of each label and the font color can be defined by the user (see SnapIt Settings).
To select any amount of text as index data, use the Lasso function. For example, this is useful if you want to select an
entire address block. Move the mouse pointer to the top left corner of the address block and drag it to the bottom right
corner while holding the left mouse button down. You can also drag this rectangle from the bottom right or any other
corner. Once you release the mouse button, the data is transferred to the target application.
Using the Barcode option
With the Barcode feature, you can capture barcode information as indexing data. Open the document in the view port,
and once the document is loaded, the bar code value is read.
Navigate to the AutoCapture form field that needs to be populated with the barcode value and then from the viewport
select and click the highlighted barcode value. A simple click with the left mouse button will transfer the barcode
value to the desired AutoCapture form field.
When you open a file that has one or more bar codes embedded in the document you can perform a number of
operations by clicking the respective button on the Barcode toolbar.
How to send a document to AutoCapture
This task describes how to send all pages in the currently active document to the AutoCapture server.
This procedure describes how to send all pages in the active output document to the AutoCapture server. If there are
breaks defined in the Thumbnail window, the active document is the document that contains the page that is currently
displayed in the Document window. If there are no breaks in the Thumbnail window, this procedure sends all pages
to the AutoCapture server.
1.
Click the Send to AutoCapture button

2. If prompted whether you are sure that you want to send the document, click Yes.
75
3. In the Send to AutoCapture dialog box, select the item in the AutoCapture menu to which you want to send the
document.
4. In the Name field, enter the name of your document to specify the document name on the AutoCapture server.
The name specified here may be changed depending on the naming rules that are configured on the AutoCapture
server.
5. In the Type box, select one of the image file formats for the destination file:
Option
B/W TIFF
Choose to
Send a black and white TIFF image
Color TIFF
Send a color TIFF image.
Mixed TIFF
Send a mixed (B/W and color) TIFF image.
B/W PDF
Send a black and white PDF image.
Color PDF
Send a color PDF image.
Mixed PDF
Send a mixed (B/W and color) PDF image.
6. Click OK.
7. Enter values in any form fields and click the button for sending files.
A blue check mark is added to the Thumbnail window to indicate that the document was sent to AutoCapture.
How to send all documents to AutoCapture
This task describes how to send all pages in all documents to the AutoCapture server.
This procedure describes how to send all pages in all documents to the AutoCapture server. Output documents are
defined by breaks in the Thumbnail window.
1.
2.
3.
4.
5.
Click the Send All to AutoCapture button

If prompted whether you are sure that you want to send the document, click Yes.
In the Send to AutoCapture dialog box, select the item in the AutoCapture menu to which you want to send the
document.
In the Name field, enter the name to be assigned to the document on the AutoCapture server.
If there are breaks in the Thumbnail window, this option specifies the name for the first document to be sent to
AutoCapture.
The name specified here may be changed depending on the naming rules that are configured on the AutoCapture
server.
In the Type box, select one of the image file formats for the destination file:
Option
B/W TIFF
Choose to
Send a black and white TIFF image
Color TIFF
Send a color TIFF image.
Mixed TIFF
Send a mixed (B/W and color) TIFF image.
B/W PDF
Send a black and white PDF image.
Color PDF
Send a color PDF image.
Mixed PDF
Send a mixed (B/W and color) PDF image.
6. Click OK.
7. Enter values in any form fields and click the button for sending files.
8. Repeat steps 4 on page 76 through 7 on page 76 for each document that is defined in the Thumbnail
window.
76
Note: When you send a document that was previously split into a number of new documents, you will see a
blue check mark added at the break in the Thumbnail window after a document is sent.
List of shortcut keys
Table 2: Shortcut keys used for common tasks in QuickCapture Pro
Menu
File
Command
Press
New
Ctrl+N
Open
Ctrl+O
Print
Ctrl+P
Copy image
F6, Ctrl+C
Paste Image
F7, Ctrl+V
Undo Image
F8, Ctrl+Z
Redo Image
F9, Ctrl+Y
View
Thumbnail View
Ctrl+T
Document
Scan Append
Ctrl+D
Scan Insert
Ctrl+I
Send to AutoCapture
Ctrl+S
Ctrl+L
Next
Ctrl+Down Arrow
Previous
Ctrl+Up Arrow
First
Home,Ctrl+Home
Last
End, Ctrl+End
Go to
Ctrl+G
Print Page
Ctrl+R
Rotate Left
Ctrl+Left Arrow
Rotate Right
Ctrl+Right Arrow
Delete Page
Delete or Ctrl+Delete
Add/Remove Break
B, Alt+B
Fit to Window
Ctrl+F
Fit to Height
Ctrl+H
Zoom In
Ctrl+Plus Sign (+)
Zoom Out
Ctrl+Minus Sign (-)
Zoom to Width
Ctrl+W
Pan Window
F10
Options
Break Options
Ctrl+B
Help
Contents
F1
Edit
Page
Zoom
77
Configuring QuickCapture Pro

How to select the default scanner
Complete this procedure to specify the default scanner to scan images directly into QuickCapture Pro. The specified
scanner is used when "Scanner Default" is selected in the scanner list box on the File toolbar.
1. Click the Options menu, point to Scanner, and then click to choose a scanner that uses the TWAIN or ISIS
interface.
To use a
TWAIN compatible device
ISIS compatible device
Click
Select TWAIN Source
Select ISIS Source
2. In the Scanner Selection dialog box, select from the list of installed scanners for the selected interface.
You can click the Add button to add a scanner to the list.
The scanner that you select in this procedure will be used when you click Scan Insert or Scan Append on the
Document menu, or if you click the corresponding buttons on the File toolbar when "Scanner Default" is selected in
the scanner list box.
To configure settings for the selected scanner, you can click Options > Scanner > Settings.
AutoCapture Configuration dialog box
Prior to working with AutoCapture, you have to configure the AutoCapture server options and make sure that
AutoCapture server is running. This can be made in the AutoCapture Configuration dialog box.
To open this dialog box, click Options > AutoCapture > Configuration, or click the AutoCapture Settings button

In this dialog configure the following two options with the appropriate values for connecting to the AutoCapture
server:
Option
Description
Server
Enter IP address or host name of the computer running

the AutoCapture server.
Port
Enter the port number that the AutoCapture server uses

to communicate with clients.
Contact your system administrator if you are uncertain
what value to enter here.
Note: The default port number for AutoCapture
is 8085.
SSL
Select this check box to require SSL encryption to

communicate with the AutoCapture server. SSL must be
enabled for the AutoCapture server or QuickCapture Pro
will fail to communicate with the server.
Note: QuickCapture Pro always uses SSL when
it is enabled on the AutoCapture server. If this
option is not selected, QuickCapture Pro permits
unencrypted communication when SSL is not
enabled on the server.
256-bit
Select this check box to require 256-bit SSL encryption

to communicate with the AutoCapture server.
78
After you configure the Server and Port options, the available server nodes will appear in the AutoCapture menu.
To see AutoCapture forms and actions that are available on a server, expand a node by clicking on it.
Barcode Options dialog box (1D and 2D)
This dialog box specifies options for reading and interpreting both 1D and 2D barcodes in documents. These options
are displayed when 2D barcode support is licensed for QuickCapture Pro.
Option
Read
Description
You can specify the mode in which the barcodes in a
document are to be read.
On demandChoose this option to read barcodes

only after clicking the Read Barcode button on the
Special Action toolbar.
AutoChoose this option to read barcodes
automatically as soon as you go to a page.
Auto in backgroundChoose this option to read
all barcodes in a document in the background when
you load a document.
Selecting either of the auto options may slow the process

of loading large-size images.
Barcode type
Specifies 1D or 2D barcode types to be read by

QuickCapture Pro. You can select All to read any of the
barcode types listed in this dialog box.
Note: The recognition of barcodes of the UPC
E type returns Full UPC A Value. For example,
if the barcode is displayed as 01234565, it is
recognized as 012345000065.
Direction
1D barcodes
CODABAR
Code 1 2 of 5
Code 3 of 9
Code 128
EAN 8
EAN 13
UCCEAN 128
UPC A
UPC E
2D barcodes
DataMatrix
Micro PDF417
PDF417
QR
Specifies the direction in which a barcode is to be read.

This option applies only to 1D barcodes.
Maximum length of a barcode
Specifies the maximum length barcode string for 1D

variable-length barcodes that are captured in a field.
This value cannot be less than the value specified for
Minimum length of a barcode. This setting can be
between 1 and 63.
79
Option
Description
Minimum length of a barcode
Select the minimum length (between 1 and 63) barcode

string for 1D variable-length barcodes that are captured
in a field. This value cannot be greater than the value
specified for Maximum length of a barcode. This
setting can be between 1 and 63.
Number of lines of white space above and below the

barcode symbol
Set the amount of horizontal one pixel lines of white

space that should limit the barcode symbol above and
below (concerning the horizontal barcodes). This option
is useful in cases when the barcode is blurred and allows
to avoid the situation when a single barcode is read as
two barcodes.
For example, this option can help in reading such
barcodes:
- or -

Number of scanned lines per column to skip
Set the amount of horizontal one pixel lines that will be

skipped when reading a barcode symbol (concerning the
horizontal barcodes). This option allows to reduce the
time of reading a barcode. In case when the barcode is
not read properly you can reduce the amount of pixels to
be skipped, however this will take more time to read the
barcode.
For example, this barcode is read faster with value 120
then with value 50:
However it is not read when you set value 130 to this

option:
as this value is greater than the bars height.
80
Option
Description
Return check digit
Select this check box to display the check digit when a

barcode contains a check digit.
For example, when the following barcode is read, the
check digit 1 is displayed:

Error check digit
Select this check box to not display the check digit if a

barcode contains one.
Dilate filter
Select this check box to fill missing pixels when reading

a barcode. This can help to recognize indistinct barcodes.
You should use this option only when required, because
the component may perform excessive dilation that
prevents a barcode from being recognized correctly.
Double Pass
Select this check box to enable double pass for reading

2D barcodes. This option performs preprocessing on
the images and tries again if the barcode engine cannot
detect the barcode value. Enabling this option may
increase the barcode detection time, and should only
be used when reading barcodes will always be more
important than recognition speed.
Use this option when barcode images have small
resolution (DPI) or are known to come from a source
(such as a fax machine or scanner) that does not provide
clean images. Enabling double pass may then ensure that
QuickCapture Pro reads the barcodes regardless of the
image quality.
Note: This option applies only to 2D barcodes.
Double pass is never used to read 1D barcodes.
Barcode Options dialog box (1D)

This dialog box specifies options for reading and interpreting 1D barcodes in documents. These options are displayed
when 2D barcode support is not licensed for QuickCapture Pro.
Option
Read
Description
You can specify the mode in which the barcodes in a
document are to be read.
On demandChoose this option to read barcodes

only after clicking the Read Barcode button on the
Special Action toolbar.
81
Option
Description
AutoChoose this option to read barcodes

automatically as soon as you go to a page.
Auto in backgroundChoose this option to read
all barcodes in a document in the background when
you load a document.
Selecting either of the auto options may slow the process

of loading large-size images.
Barcode type
Select the type of the barcode to be read. You can select

All to read any of the barcode types listed in this dialog
box.
Note: The recognition of barcodes of the UPC
E type returns Full UPC A Value. For example,
if the barcode is displayed as 01234565, it is
recognized as 012345000065.
1D barcodes
CODABAR
Code 1 2 of 5
Code 3 of 9
Code 128
EAN 8
EAN 13
UCCEAN 128
UPC A
UPC E
Direction
Specify the direction in which a barcode is to be read.
Maximum length of a barcode
Select the maximum length in characters of the barcode

to be read. This value can be between 2 and 64 and must
be greater than the value specified for Minimum length
of a barcode.
Minimum length of a barcode
Select the minimum length in characters of the barcode

to be read. This value can be between 1 and 63 and must
be less than the value specified for Maximum length of
a barcode.
Number of lines of white space above and below the

barcode symbol
Set the amount of horizontal one pixel lines of white

space that should limit the barcode symbol above and
below (concerning the horizontal barcodes). This option
is useful in cases when the barcode is blurred and allows
to avoid the situation when a single barcode is read as
two barcodes.
For example, this option can help in reading such
barcodes:
- or -
82
Option
Description
Set the amount of horizontal one pixel lines that will be

skipped when reading a barcode symbol (concerning the
horizontal barcodes). This option allows to reduce the
time of reading a barcode. In case when the barcode is
not read properly you can reduce the amount of pixels to
be skipped, however this will take more time to read the
barcode.
For example, this barcode is read faster with value 120
then with value 50:
However it is not read when you set value 130 to this

option:
as this value is greater than the bars height.

Return check digit
Select this check box to display the check digit when a

barcode contains a check digit.
For example, when the following barcode is read, the
check digit 1 is displayed:
Error check digit
Select this check box to not display the check digit if a

barcode contains one.
Dilate filter
Select this check box to fill missing pixels when reading

a barcode. This can help to recognize indistinct barcodes.
You should use this option only when required, because
the component may perform excessive dilation that
prevents a barcode from being recognized correctly.
Check digit
The check digit property is characteristic for barcodes of some types, in particular, Code 39, Interleaved 2 of 5 and
Codabar types. The barcode with the check digit has the following symbol structure: quiet zone, start symbol, actual
digit, check digit, stop symbol, quiet zone.
83
Check digit calculation for Codabar type

The check digit is calculated according to Modulo 16. The calculated number is again a symbol of the reference table.
Table 3: Example
Start and stop symbol each "A"
Actual digit A 1 2 3 4 A
Reference digits 16 1 2 3 4 16
Sum of ref. digits 42
Modulo 16: 42/16 = 2, rest 10
Difference to 16: 1610 = 6
Check digit is "6" = reference digit for 6
Total character string is A 1 2 3 4 6 A
Check digit calculation for Code 39 type
The check digit is calculated according to Modulo 43.
Here is how to do the check digit calculation:
1.
2.
3.
4.
Take the value (0 through 42) of each character in the barcode excluding start and stop codes.
Sum the values.
Divide the result by 43.
The remainder is the value of the check digit character to be appended.
Table 4: Example
Actual digit + 1 1 10 0 0 1 1 1 1
Reference digits 41 1 1 1 0 0 01 1 1 1
Sum of ref. digits is 48
48/43=1, remainder 5
Check digit is 5
Total character string + 1 1 1 0 0 0 1 1 1 1 5
Check digit calculation for Interleaved 2 of 5 type
1. Start with the right-most digit in the message; mark the characters with even and odd position. The right-most
digit has the even position.
2. Sum all digits in the odd position, and then multiply by 3.
3. Sum all digits in the even position.
4. Add the results from step 2 on page 84 and step 3 on page 84.
5. Divide the result of step 4 on page 84 by 10. The check digit is equal to 10 minus the remainder.
Table 5: Example
Actual digit 4 4 43 3 3 3
Sum of all digits in the odd position S1=14
84
Sum of all digits in the even position S2=10

S1*3+S2=52
52/10=5, remainder 2
Check digit is 10-2=8
Total character string 4 4 4 3 3 3 38
Blank Page Options dialog box
Blank page options specify content that can be ignored when QuickCapture Pro determines whether a page is blank.
To open the Blank Page Options dialog box, click Options > Blank Page.
Option
Description
Process pages in background
Removes blank pages in the background after you load

a document. Clear this check box to only remove blank
pages after you click the Remove blank pages button
on the Special Action toolbar.
Ignore noise on page
Select this check box to allow noise on blank pages.
Ignore lines on page
Select this check box to allow lines on blank pages.
Ignore bleed-through on page
Select this check box to allow bleed-through on blank

pages.
Ignore page area outside defined margins
Select this check box to allow content outside of

specified margins on a blank page.
Required detection accuracy
You can adjust the blank page detection accuracy if

not all blank pages are being detected. For example, if
detection occurs at 98.4% accuracy, you can set this to
98% to allow processing to complete normally.
Break Options dialog box

Use this dialog box allows you to break documents on barcodes, blank pages, or page counts.
Break on barcode page

Break on blank page
Break on page count
Auto-process after scan/load
When you specify break options, you can select the

Auto-process after scan/load check box in this dialog
box to automatically break documents. When this check
box is selected, breaks are added after you open a file,
scan and insert or append images, or insert or append
files into QuickCapture Pro. Breaks are also added
automatically if content is reloaded after QuickCapture
exits abnormally. If you do not select the Auto-process
after scan/load check box, you can apply the break
options by clicking the Break button on the Special
Actions toolbar. This opens the Break Options dialog
box and adds the breaks when you click OK.
Clear existing breaks before processing
Breaks are normally added to previously created breaks

when you use QuickCapture Pro to repeatedly process
a document. Select this check box to remove existing
breaks when you reprocess a document.
85
Break on barcode page

Choose Break on barcode page to split a document on barcodes.
Table 6: Break options
Option
Description
Break on
Choose an option to specify the barcodes that create page

breaks.
Any barcodeChoose this option to split a

document on any barcode in a document.
Regular expressionChoose this option to use a
regular expression to split a document on specific
barcodes.
To specify a bar code pattern, type in a regular
expression in the box. For example, you can use the
following regular expression to specify any 10-digit
telephone number in various formats:
$?([0-9]{3})[ |$|/|-]{1,2}
([0-9-]{3})[ ]?[-]?[ ]?([0-9]{4})
Regular expression
Select this check box to split documents on a particular

bar code.
To specify the bar code, type in a regular expression in
the text field (for example, $?([0-9]{3})[ |$|/|-]{1,2}
([0-9-]{3})[ ]?[-]?[ ]?([0-9]{4}) for telephone number).
Set break
To specify where to locate the break, click one of the

following options:
Remove barcode page after setting break
Before barcode pageSplit the document before

the page that contains the barcode.
After barcode pageSplit the document after the
page that contains the barcode.
After next pageSplit the document after the page
the that follows the page that contains the barcode.
Select this check box to any page that contains a barcode

that is used to split a document.
Break on blank page

Choose Break on blank page to split a document on blank pages.
Option
Set break
Description
To specify where to locate the break, click one of the
following options:
Before blank pageSplit the document before

each blank page.
After blank pageSplit the document after each.
After next pageSplit the document after the page
the that follows each blank page.
86
Option
Description
Remove blank page after setting break
Select this check box to remove any blank page that is

used to split a document.
Break on page count

Choose Break on page count to split a document on based on page counts or page numbers.
Option
Description
Every n pages
Choose this option to split after a specified number of

pages. In the box, enter the number of pages between
each split.
On custom page list
Choose this option to split documents on specified page.

Enter page numbers separated by commas counting from
the start of the document. For example, type 3,7,11 to
split a document on pages 3, 7, and 11.
Document Processing Options dialog box

This dialog box permits allows you to configure various document processing options.
To configure the options for document processing, click the Options menu on the main menu bar and then click
Document Processing.
Option
Description
Prompt user for confirmation prior to sending

documents to AutoCapture
Select this check box to enable or disable the

confirmation prompt.
After sending documents to AutoCapture
Specifies the action to take after using the Send to

AutoCapture command to the active document to
AutoCapture.
After sending all documents to AutoCapture
Automatically start new empty document

Choose this option to automatically create a new
document without prompting the user after sending
documents to AutoCapture.
Leave current documents openChoose this
option to leave documents open and available for
further processing without prompting the user after
sending documents to AutoCapture.
Prompt user for choiceChoose this option to
prompt the user to choose either to create a new
empty document or to leave the current document
open after sending documents to AutoCapture.
Specifies the action to take after using the Send All

to AutoCapture command to send all documents to
AutoCapture.
Automatically delete document source files

Choose this file to delete the source files for the sent
documents. AutoCapture Pro will prompt to confirm
that you want to delete the files before it performs the
deletion.
87
Option
Description
Leave document source files aloneChoose

this option to not delete the source files for sent
documents.
Prompt user for choiceChoose this option to
prompt the user to delete or leave the source files
after sending all documents. See Source File Delete
dialog box.
Clear form on new document
Select this check box to clear the form when starting a

new document. Clear this check box to retain previous
selections in a form when starting a new document. This
command affects what happens when you use the File >
New and File > Open commands.
Toolbar button confirmations
Select or clear check boxes to determine whether dialogs

with filter settings will appear before a filter is applied.
There is a check box for each filter that has an options
dialog:
Hole Punch RemovalRemoves hole punches from

images of pages.
Border RemovalRemoves borders from 1-bit
images.
Dot RemovalRemoves dots, specks and blobs of
various sizes in 1-bit documents
SmoothSoftens images by smoothing image
bumps and nicks.
Line RemovalRemoves horizontal or vertical lines
on the images.
Inverted TextFinds and inverts areas of inverted
text in a 1-bit black and white image.
ResizeResizes images.
BreakSplits documents on barcodes, blank pages,
or page numbers.
Blank Page RemovalRemoves blank pages.
Select a check box to ensures that a dialog box will

appear before the filter is applied after you click the
respective button on the Advanced Image toolbar.
In these dialog boxes, you can adjust the settings and
proceed.
If you do not want to change default settings of a filter
before applying it, clear the corresponding check box.
If you want to apply a filter to all pages of the selected
documents, click the All Pages button on the Advanced
Image toolbar. In this case the dialog box with the filter
settings will appear only once. The filter will be applied
to all pages with the same parameters.
For example, if you want the apply the same settings
each time that you apply the Smooth filter to an
image, configure the filter settings using the Smooth
configuration dialog box the first time that you apply the
filter, and then open the Document Imaging Options
88
Option
Description
dialog box and clear the Smooth check box. The next
time that you click the Smooth button on the Advanced
Image toolbar, the filter is applied to the image without
opening the Smooth configuration dialog box.
Source File Delete dialog box

This dialog box allows you to choose to delete files that were opened to load pages which have subsequently been
processed and sent to AutoCapture. QuickCapture Pro only displays this dialog box after all loaded pages have been
sent to AutoCapture.
You can select whether to delete files only if you have chosen Prompt user for choice for the After sending all
documents to AutoCapture option in the Document Processing Options dialog box.
Option
Source files to be deleted
Description
This box lists files that were opened when starting a
new processing job, opened for insert, or opened for
append. All files listed in this box are initially selected
for deletion. You can clear the check box next to any file
that you do not want to delete.
Selected files are deleted when you click OK. This list is
cleared when you start a new document.
Message Log Settings dialog box

Configure message logging options in the Message Log Settings dialog box.
You can configure message logging in the Message Log Settings dialog box, which can be opened by clicking
Options > Logging. The Message Log Settings dialog box displays options for specifying Logged Message Types.
Option
Logged Message Types
Description
ErrorSelect this check box to log error messages.

WarningSelect this check box to warning
messages.
InformationSelect this check box to
informational messages.
TraceSelect this check box to activate a trace
when a product support representative requests a
trace for debugging purposes. You can then choose
whether to log basic or detailed information in the
trace:
BasicSpecifies to log basic information in a

trace.
VerboseSpecifies to log detailed information
in a trace.
The Trace option is initially turned off.

Maximum File Size
Enter the maximum file size in megabytes (MB) for the

log file.
Log File History
Enter the maximum number of days that are logged in

a message file. The oldest messages are dropped when
either of these limits are reached.
89
Option
Description
Log Directory
Shows the location of the message log file.
Restore Defaults
Click this button to destroy the default settings for

message logging.
Product Setup dialog box

This dialog box allows you to specify professional or basic and 2D barcode licensing for QuickCapture Pro.
This dialog box may be displayed first when you initially license QuickCapture Pro.
Option
Description
Professional
Choose this option to license the professional version

of QuickCapture Pro. The professional version includes
support for optical character recognition (OCR) and the
SnapIt application used for indexing OCR'd documents.
Basic
Choose this option to license the basic version of

QuickCapture Pro. The basic version includes does not
support OCR.
2D barcode support
Select this check box to license 2D barcode recognition

in QuickCapture Pro. This option allows QuickCapture
Pro to read Quick Response Code (QR code), Data
Matrix, PDF414, and Micro PDF417 barcodes.
SnapIt Settings dialog box

This dialog box specifies the appearance of data that is matched by SnapIt.Options > SnapIt menu.
Settings
After an image has been processed by SnapIt, the matched data is highlighted in the image. The appearance of data
values and data types can be configured in the SnapIt settings.
To configure these settings, click Options > SnapIt.
Option
Description
Process Pages in the Background
Select this check box to perform OCR on the entire

document as the document is being loaded into the
viewport. This option saves time by using OCR to
digitize the entire document instead of performing OCR
on each page as they are loaded.
Auto Rotate
Select this check box to rotate images to visually

orientate them properly. If auto rotation is not required,
you can clear this check box to speed up processing.
View Port
This section allows the configuration of the colors used

to highlight the matched data in the image displayed
in the view port of QuickCapture Pro. The available
settings are as follows:
Select Color highlights data as you move over it with

the pointer.
Selected Color highlights selected data after
you click on it. Selected data is transferred to the
AutoCapture field value.
90
Option
Description
Form Field Label
Data Type Color highlights all matched patterns as

defined in the regular expression for the data type.
The regular expressions for data types are defined in
AutoCapture form fields.
This section allows the color configuration for the form

field label of the SnapIt Navigator window where the
data is displayed as you point to it with the mouse:
Text Label
EnabledSelect this check box to display the form

field label of the SnapIt Navigator window.
Text ColorThe color of the text that appears in
the form field label of the SnapIt Navigator window
correspondingly to the currently selected field of the
AutoCapture form.
Background ColorBackground color of the form
field label.
Allows the color configuration for the text label of the

SnapIt Navigator window where the data is displayed
as you point to it with the mouse:
Error Label
EnabledSelect this check box to display the

matched string.
Text ColorWhen matching text is detected, the
color of the matched text string appears in this color.
Background ColorBackground color of the text
label.
Allows the color configuration for the error label of the

SnapIt Navigator window where the data is displayed
as you point to it with the mouse:
EnabledSelect this check box to enable the

highlighting of irrelevant string.
Text ColorSpecifies the text color of the error
label.
Background ColorBackground color of the error
label.
Note: This dialog box is only included with the professional version of QuickCapture Pro. The basic version
of QuickCapture Pro does not include OCR.
Restrictions and limitations
Table 7: Image formats supported by QuickCapture Pro
Image Format
Supported Color Depths

(bits per pixel bpp)
AFP Format IOCA MMR Compressed (AFP for IM1)

(*.afp)
Animated Cursor (*.ani)
1, 4, 8, 24
CALS (*.cal)
91
Image Format

Cineon (*.cin)
24
CLP (*.clp)
1, 4, 8, 24
Compressed Windows Metafile (*.wmz)
24
CServe PNG (*.png)
1, 4, 8, 24, 32
Dr Halo (*.cut)
DJVU Format (*.djvu)
1, 8, 24
EMF (*.emf)
8, 24
EPS (*.eps)
EXIF (*.tif)
24
FIT (*.fit)
8, 16, 32
FLC (*.flc)
FPX (*.fpx)
8, 24
GEM (*.img)
GeoTIFF (*.tif)
16
GIF (*.gif)
1, 2, 3, 4, 5, 6, 7, 8
IFF (*.iff)
8, 24
ITG (*.itg)
JBIG (*.jbg)
18
MacPaint (*.mac)
Mac PICT (*.pct)
1, 4, 8, 16, 24
Mayo Clinic Analyze Format (ANZ) (*.anz)
24
MODCA IOCA (*.ica)
Microsoft PowerPoint (PPT) (*.ppt)
1, 4, 8, 16, 24
Microsoft Excel (XLS) (*.xls)
24
Microsoft Word Document (DOC) (*.doc)
24
Microsoft XML Paper Specification (XPS) (*.xps)
24
Microsoft Thumbnail Cache Format for Windows XP

(TDB) (*.tdb)
24
Microsoft Thumbnail Cache Format for Windows Vista

(TDB Vista) (*.tdb)
24
Microsoft Access Snapshot (SNP) (*.snp)
24
MRC (*.mrc)
24
MrSid Format (*.sid)
24
MS FAX (AWD) (*.awd)
92
Image Format

MS Paint (*.msp)
OS/2 BMP (*.bmp)
1, 4, 8, 24
PBM (*.pbm)
PCX (*.pcx)
1, 4, 8, 24
PDF (*.pdf)
1, 2, 4, 8, 24
PGM (*.pgm)
PPM (*.ppm)
24
PSD (*.psd)
1, 8, 16, 24
PSP (*.psp)
1, 4, 8, 24
Raw IOCA (*.ica)
Scitex Continuous Tone SCT (*.sct)
24
SGI (*.sgi)
8, 24, 32
Structured Fax File (*.sff)
SUN Ras (*.ras)
1, 4, 8, 24, 32
TGA (*.tga)
8, 16, 24, 32
TIFF (*.tif)
1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 24, 32, 48, 64
TIFX (*.tifx)
1, 3, 8, 24
Winfax (*.wfx)
Win BMP (*.bmp)
1, 4, 8, 16, 24, 32
Win Cursor (*.cur)
1, 4, 8, 24
Win Icon (*.ico)
1, 4, 8, 24
Wireless Bitmap (WBMP) (*.wbmp)
WMF (*.wmf)
8, 24
WPG (*.wpg)
1, 4, 8
XBM (*.xbm)
Xionics SMP (*.smp)
XPM (*.xpm)
8, 16, 24, 32
XWD (*.xwd)
1, 4, 8, 16, 24, 32
Troubleshooting tips
Problem
If the All Pages button is clicked and if the Read
Barcode button is clicked, then the application reads
only the current document and does not read barcodes
for all the pages.
Solution
The All Pages option takes affect only with such options
as Deskew, Despeckle, Rotate and other options from
the Advanced Image Toolbar. This option does not
influence on the Read Barcode option.
93
Problem
Solution
If a barcode is inside a gray-textured background it is not The application cannot read barcodes with the textured
read by the application. For example:
background.
A barcode is not properly read.
Make sure that Barcode read options are specified

correctly. The Minimum length of a barcode must be
between 1 and 63 and less than the Maximum length of
a barcode. For more information, see Barcode Options
dialog box (1D) on page 81.
If you use the AutoCapture Scripting functionality and

the used script has a message box or any other windows
that pop up, the QuickCapture Pro hangs.
This is because QuickCapture Pro is running as a service

and cannot handle pop-up windows that are going to
be shown on the AutoCapture side. Until these pop-up
windows are not clicked, the QuickCapture Pro does not
react and seems to be hanging.
AutoCapture Server
Welcome to AutoCapture Server component
AutoCapture component extends the capture capabilities to the user desktop. Use this component to capture all file
types that reside on the user's machine into the workflow. Any file type that resides on the user PC, such as Microsoft
Word document or an image file can be processed in to workflow.
AutoCapture comprises of a server software that runs on the server and a client software that runs on the user
machine. The AutoCapture client communicates with the AutoCapture server to get the menu, form information
for presentation on the user desktop. When the server and client software are configured, a user selects a file(s) by
clicking the right button on the mouse and the AutoCapture menus and forms are displayed.
This document describes the AutoCapture server configuration. Please refer to the AutoCapture Client help file for
information on how to configure the client.
Getting started
Feature highlights
The following is a list of features provided with this component:
Ability to select the NT groups and/or users that will be presented with AutoCapture feature.
Define logical group names for the users/groups that will have access to specific workflow(s).
Customize the forms by defining your own style sheet.
Specify the file types that will be processed through this component.
Create a menu hierarchy for ease of use.
Licensing AutoCapture Server

An AutoCapture client license is required for each AutoCapture client that accesses the AutoCapture on the AutoStore
server. AutoStore assigns an available AutoCapture client license to an AutoCapture client the first time that the client
attempts to access the server. A client is denied access to the server when there are no available licenses.
AutoCapture client licenses are managed on the AutoStore server. Use License Manager on the AutoStore server to
manage AutoCapture client licenses.
94
Using the AutoCapture Server component

Use this component to capture any type of file from a user desktop and process into a workflow. The user machine
running AutoCapture client communicates with the AutoCapture server over a configured port to retrieve group,
menu, form, action displays for the client desktop.
Create and save a process with AutoCapture component. Start the process from the Service Manager interface. Select
a file that you want to process though the server by right-clicking the file. You will be presented with menu items next
to the AutoCapture icon.
You can choose a form to fill out index data for a file. If there is no need for indexed data, you can select an action
that would process the files through the process components and the route component defined in the workflow
definition.
Installing AutoCapture client
AutoCapture consists of server software that runs on the AutoStore product server and client software that runs on the
user machine. The AutoCapture client communicates with the AutoCapture server to capture all file types that reside
on the user's machine into the workflow.
Copy the executable file of AutoCapture Client to the user machine where you plan to run the AutoCapture Client
software, double click on the executable file and follow the instructions on your screen to complete the installation.
The AutoCapture Client executable file is located within the following directory in the product installation directory:
installation_directory\Distributable\AutoCapture
Configuring AutoCapture Server

Menu tab
Use the Menu tab to add, edit, or remove the any of the following:
Groups
Menus
Forms
Actions
How to Add a Group, Menu, Form, or Action

1. In a workflow, double-click the AutoCapture component to open the AutoCapture dialog box.
2. On the Menu tab, click Add and then click one of the following:
Command
See
Group
Group
Menu
Menu
Form
Form
Group
Action
Group
A group provides a container for forms, menus, and actions. Configure options for a group in the Group dialog box.
Table 8: Group options
Option
Name
Description
Enter a name for the group you are creating. This is a
string value describing the name of the group. This name
95
Option
Description
does not appear on the desktop and it is used strictly as
logical group name.
This component is equipped with a default group
called Common Group. You may add a menu, form or
action to the Common Group. After the component
is configured, the user can right click on the file that
requires processing. The user will be presented with an
AutoCapture icon labeled Send To. At this point the user
can select the configured menu, form or action that is
desired.
Root Menu Title
Enter a menu title. This menu title appears on the client

desktop. The user should be able to immediately relate
this menu title to his/her function and the task at hand.
Members
Click Add to enter either groups or users that you want

to have access to this menu entry. Click Remove to
delete a user or group.
Icon File
Browse to the folder location that contains image icon

file for this menu entry. The menu icon is 12x12 on the
standard windows explorer AutoCapture client.
Menu
Add a menu to create a hierarchy of submenus, forms, and actions. A menu guides users to select a desired workflow.
Table 9: Menu options
Field Name
Description
Name
Enter the name of the menu entry.
Icon File

Form
Add a form when a workflow requires capture of index data.
To create a form, configure options on the following 2 tabs:
General tab
Components tab
General Tab
Table 10: General options
Option
Form Name
Description
The name of the form to be displayed on the desktop
hierarchy. A maximum of 32 characters are displayed by
the AutoCapture client.
96
Option
Description
Icon File

Button Name
The button name that will be displayed at the lower right

corner of the form. Use a descriptive action name such as
"Submit".
Form Type
Choose one of the two form types:
Local Form
Local Form
Form is defined locally

through the form dialog
by configuring the fields,
style sheet, and scripting
options.
Web Form
Create a web app/form

and provide the URL.
The web app/form will
be displayed in web form
enabled AutoCapture
clients.
After the user clicks the
Submit button, all the
standard HTML control
name/value pairs along
with any hidden fields (the
name of the hidden field
must end with _RRT) are
captured as RRT enabled
meta data for the captured
documents.
Style SheetEnter the name of an XSLT style sheet.

The style sheet contains templates that match XML
element names for field types (ACBoolean, ACButton,
ACDateTime, ACLabel, ACNumber, ACString, ACList,
ACStringMultiline). If you leave this field blank, the
AutoCapture default style sheet is enabled.
The default style sheet is AC.xslt, which is located at the
AutoStore installation directory. The style sheet contains
templates that match XML element names for field
types (ACBoolean, ACButton, ACDateTime, ACLabel,
ACNumber, ACString, ACList, ACStringMultiline).
You can copy the default style sheet and use it as the
basis for creating your own XSLT style sheet that
formats your form. When a user right clicks on a file
and selects a form, the AutoCapture client retrieves the
form definition from the server in XML format. The
form definition has all the field setting definitions for the
form. The XSLT style sheet specified here transforms the
field definitions to display in HTML format. The HTML
code uses the cascading AC.css, also in the AutoStore
installation directory, which you can edit to change how
content is styled, as defined by your business needs.
97
Option
Description
Whether you copy and modify the default XSLT style
sheet or create your own from scratch, your XSLT style
sheet must render of the ACForm element as defined in
the AutoCapture XML schema.
If there are references in the custom XSLT style sheet to
external files, you can enter a "comma" or "semi-colon"
separated list of files in the following order:
1. Style sheet name
2. Image file name(s)
3. Java scripts file name(s)
VBScript
Script FileEnter the VB Script file name for loading/

validating the index data on the client.
Run on form loadIf this option is checked, the
provided script file will be executed on the server prior
to loading the form on the script enabled client.
Run on form validateIf this option is checked, the
provided script file will be executed on the server to
determine if the form data submission is allowed.
Form Fields
Add fields by clicking on the new field button, labeled

by N in the column header. After you add a field, you
can press the Tab key to navigate between field attributes
and to add additional fields.
For each field you can configure the field attributes:
Field NameField name is a string type and can

be any alphanumeric characters. Use of special
characters (~, &, <, >, %, ", /, \, :, ?, | ) are not
recommended.
TypeThe supported string types are:
Boolean
Button
Date/Time (see Date and Time Formats)
Label
Number
String
String list
Optionally, in the field properties you can

click Import or Export to import or export a
string list in CSV (comma separated
value) format.
String Multi-line
RequiredSelect this check box, in the column
labeled by R, to require the user to enter data in a
field.
Help MessageProvides space to type a help
message that is displayed in the client as a tool tip
when the mouse cursor is moved over a field on
98
Option
Description
the form. This can be used to guide a user who is

entering data in a form.
CheckboxIf selected, the provided script file will
be executed on the server once the field value has
changed the script enabled client.
PropertiesClick this button, ... in the column
labeled by P, to set the field attributes.
SnapItClick this button to designate the form
field to be available to QuickCapture Pro SnapIt
application.
Note: Configuring this field is only required
if the user wants to use AutoCapture forms
with QuickCapture Pro SnapIt application.
If the user is not using QuickCapture Pro
application, this field can be ignored.
Web Form
AddressThe URL address of the web form that to

display in the client.
If the web form contains a QuerySubmit JavaScript

function, then it will be called when the user tries to
submit the form. The QuerySubmit function will allow
the web form to do any required validation and display
any potential messages. If the function returns False, the
form is not submitted, if the call returns True then the
form data/document will be submitted to the workflow
server.
On submission of the form, all the standard HTML
control name/value pairs along with any hidden fields
(the name of the hidden field must end with _RRT) will
be captured as RRT enabled meta data.
RRT Fields
A comma-separated list of field names contained on the

web form to be populated in the available RRT window
when configuring the other components in the task. This
field is optional as RRTs may be entered in the fields on
the web form using RRT syntax (for example, ~ACC::
%WebForm_Field1%~ ).
Components Tab
The Components tab lists processing and routing components in a workflow, their description, type, and the
configuration button to set component options. The configuration button is labeled by the ellipsis () in the last
column of each row.
Select a component by clicking the configuration button and configuring options in its properties dialog box. For
some components, you have to explicitly activate the component by selecting the Activate button in its properties
dialog box. Others are activated after you configure options that allow them to function, such as the destination folder
for the Send To Folder component.
OpenScan SnapIt
What is SnapIt
How do you configure SnapIt for AutoCapture form fields?
How do you use SnapIt?
99
Overview of SnapIt
Entering data from documents into AutoCapture forms can be a time-consuming and repetitive task, especially if the
amount of data and the number of documents is large. Even with documents that are in digital format (scanned or
native digital), there is a need to quickly and efficiently locate the relevant data for transfer into an AutoCapture form.
SnapIt provides an QuickCapture Pro desktop user with an easy to use interface for capturing data from a file and
transferring that data into AutoCapture form field value. SnapIt is a fast and easy way of capturing data from an
OCR'ed image into AutoCapture form fields with a simple click of the mouse. SnapIt drastically improves the speed
and quality of data entry (indexing) by eliminating manual data entry into AutoCapture fields value.
For details on SnapIt operation, please refer to the QuickCapture Pro documentation.
Configuring SnapIt for an AutoCapture Form
When you configure AutoCapture form fields with SnapIt, you are specifying which AutoCapture form fields can be
indexed by QuickCapture Pro SnapIt user.
When you configure AutoCapture form fields with SnapIt, you are specifying which AutoCapture form fields can be
indexed by QuickCapture Pro SnapIt user.
To control how a field is supported by SnapIt, click the browse button (...) under the S column of the AutoCapture
form fields. The SnapIt configuration dialog opens. Configure the following:
Data Types tab

Formats tab
Using SnapIt
SnapIt is designed for use with the QuickCapture Pro application. If you are not using QuickCapture Pro, you are not
required to configure SnapIt.
For details of the SnapIt functionality, refer to QuickCapture Pro documentation.
The following provides a hi-level step-by-step procedure for using "SnapIt"-enabled fields of an AutoCapture form:
1.
2.
3.
4.
5.
6.
Decide which of the AutoCapture fields values need to be populated using the QuickCapture Pro SnapIt.
Configure the AutoCapture form fields with the desired SnapIt Data Types and Formats.
Complete the configuration of the remaining components in your process workflow.
Save the configuration file and start the service with the newly-saved configuration.
Start the QuickCapture Pro application and load the AutoCapture form(s).
The QuickCapture Pro user opens the file in the Image Viewer. This file contains the information that is used for
populating the AutoCapture form field values.
7. The QuickCapture Pro user selects the desired form and the corresponding form fields are displayed.
8. If the AutoCapture form field was configured with SnapIt, the QuickCapture Pro user:
a.
b.
c.
d.
Moves the mouse to the QuickCapture Pro AutoCapture form viewer and highlights a field value.
Moves the mouse to the QuickCapture Pro Image Viewer.
Clicks the desired character string that is highlighted in the QuickCapture Pro Image Viewer.
The highlighted character string is automatically entered into the field in step (1).
SnapIt has provided the QuickCapture Pro user a way to use rule-based visual cues of Snapit for speedy indexing of
documents.
The AutoCapture form fields are now populated with speed and accuracy; the file and associated metadata have
entered the workflow process.
100
Data Type Tab

SnapIt is equipped with a number of predefined data types. You can customize the data types to your business
application needs by adding additional data types. Some data types are country-specific, such as telephone numbers
and post codes while others are internationally standardized, such as email addresses.
1. The Data Types dialog shows all the available data types. You may add additional data types to the default set.
Click Add to Add New Data Types.
2. To remove a data type, highlight the data type and click Remove.
3. To modify a data type setting, highlight the data type and click Edit.
Formats Tab
SnapIt is equipped with a number of predefined formats. You can customize the format of data types to your business
application needs.
You may add additional formats to the default set. Click Add to Add New Formats
To remove a format, highlight the format and click Remove.
To modify a format setting, highlight the format and click Edit.
Add New Data Types

You can add additional SnapIt data types to the list. The Data Type dialog contains settings for the currently active
data type. The following attributes need to be configured:
NameEnter the name of the data type. This name describes the data type and is not displayed anywhere within
the QuickCapture Pro SnapIt GUI.
ExpressionEnter a regular expression script for defining the data type. The regular expression entered triggers
a search and match on the OCR'd file within the QuickCapture Pro Image Viewer. SnapIt displays the regular
expression matches in the QuickCapture Pro Image Viewer GUI as highlighted text.
Sample Input DataThis field lets you test the script you entered in the Expression field. Enter a series of
characters and click Run Match. A pop-up window reports the match result.
Example
If you want the QuickCapture Pro user to enter a zip

code in an AutoCapture field, the data type display
will aid you in locating the zip code on the document
that is displayed in the QuickCapture Pro's Image
Viewer. SnapIt simply highlights all entries that can be
detected as zip code. With the AutoCapture field value
highlighted, the user simply clicks on the desired zip
code. The zip-code is transferred to the field value within
the AutoCapture form. All with a simple click.
Add New Formats

You can add additional formats to the list. The formats dialog contains settings for the currently active format. The
following attributes need to be configured:
NameEnter the format name describing the format. This name is not displayed anywhere within the
QuickCapture Pro SnapIt GUI.
ExpressionEnter a regular expression script for defining the format. The regular expression entered triggers a
formatting operation on the data. The reformatted data is then transferred to the AutoCapture field value.
Sample Input DataThis field lets you test the script you entered in the Expression field. Enter a series of
characters and click Run Match. A pop-up window reports the match result.
Example
You may want the telephone number data to be formatted

prior to transfer into the AutoCapture field value. Let's
say the "-" separator must be removed from the telephone
number. Simply select the Numbers-only option.
101
When the user clicks on the telephone number in the

QuickCapture Pro Image Viewer, the telephone number
(without the "-") is transferred to the AutoCapture Field
value.
Regular Expression
A regular expression describes a string of characters corresponding to a data type.
For example, the expression a.b, describes all strings of three characters where the first character is "a" and the last
character is "b". The middle character can be anything. The expression therefore describes strings such as:
aab
aXb
a3b
aab
a-b
a.b
The two characters "a" and "b" simply describe themselves; the period in between them is a place-holder (wildcard)
for any alphanumeric or numeric character.
This table summarizes the most important syntactic elements found in regular expressions:
102
AutoCapture XML Schema

The AutoCapture XML schema defines form elements.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:complexType name="ACField">
<xs:complexContent>
<xs:extension base="ACBase">
<xs:attribute name="HelpMsg" type="xs:string"/>
<xs:attribute name="Required" type="xs:boolean" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ACBase">
<xs:attribute name="Title" type="xs:string" use="required"/>
</xs:complexType>
103
<xs:element name="ACForm">
<xs:complexType>
<xs:complexContent>
<xs:extension base="ACBase">
<xs:sequence>
<xs:element ref="ACString" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACStringMultiline" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element ref="ACList" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACBoolean" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACDateTime" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACButton" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACNumber" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="ACLabel" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACButton">
<xs:complexType>
<xs:complexContent>
<xs:extension base="ACField">
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACNumber">
<xs:complexType>
<xs:complexContent>
<xs:attribute name="Min" type="xs:int" use="optional"/>
<xs:attribute name="Max" type="xs:int" use="optional"/>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACString">
<xs:complexType>
<xs:complexContent>
<xs:attribute name="Size" type="xs:integer" use="optional"/>
<xs:attribute name="MaxLength" type="xs:integer" use="optional"/>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACList">
<xs:complexType>
<xs:complexContent>
<xs:sequence>
<xs:element ref="ACOption" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACOption">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="Label" type="xs:string" use="required"/>
104
<xs:attribute name="Selected" type="xs:boolean" use="optional"

default="0"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="ACStringMultiline">
<xs:complexType>
<xs:complexContent>
<xs:attribute name="Width" type="xs:string" use="optional"/>
<xs:attribute name="Height" type="xs:string" use="optional"/>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACBoolean">
<xs:complexType>
<xs:complexContent>
<xs:attribute name="TrueValue" type="xs:string" use="required"/>
<xs:attribute name="FalseValue" type="xs:string" use="required"/>
<xs:attribute name="Value" type="xs:string" use="optional" default="0"/
>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACDateTime">
<xs:complexType>
<xs:complexContent>
<xs:attribute name="Format" type="xs:string" use="optional"/>
<xs:attribute name="Size" type="xs:integer" use="optional"/>
</xs:extension>
</xs:complexType>
</xs:element>
<xs:element name="ACLabel">
<xs:complexType>
<xs:attribute name="Title" type="xs:string" use="required"/>
<xs:attribute name="Text" type="xs:string" use="required"/>
<xs:attribute name="FontSize" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
</xs:schema>
AutoCapture Default XSLT Style Sheet (AC.xslt)
The default style sheet AC.xslt is located in the AutoStore installation directory and contains templates that match
XML element names for field types (ACBoolean, ACButton, ACDateTime, ACLabel, ACNumber, ACString, ACList,
ACStringMultiline)..
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/
Transform">
<xsl:output method="html" encoding="utf-8" indent="yes" />
<xsl:template match="/">
<xsl:param name="stringNoSpaces" >
<xsl:call-template name="stringreplace">
<xsl:with-param name="stringvalue" select="@Field-XPath" />
105
<xsl:with-param name="from" select="string(' ')" />

</xsl:call-template>
</xsl:param>
<xsl:text disable-output-escaping='yes'><!DOCTYPE html></xsl:text>
<xsl:text disable-output-escaping='yes'>

</xsl:text>
<!-</xsl:text>
<xsl:copy-of select="*"/>
-->
</xsl:text>
<html>
<meta http-equiv="Content-Type" content="text/html;
charset=Windows-1252" />
<head>
<title>AutoCapture</title>
<xsl:text disable-output-escaping='yes'><meta http-equiv="X-UACompatible" content="IE=Edge" ></xsl:text>
<xsl:text disable-output-escaping='yes'><meta httpequiv="MSThemeCompatible" content="NO"></xsl:text>
<link rel="stylesheet" href="AC.css" type="text/css"/>
<script type="text/javascript" src="AC.js"/>
<script type="text/javascript">
var nsi_FORMTAGS = {};
<xsl:for-each select="ACForm">
nsi_FORMTAGS["<xsl:value-of select="@Title"/>"] = "<xsl:value-of
select="@Tags"/>";
</xsl:for-each>
$(document).ready(function(){
nsi.autocapture.theme.applyFromTagArray(nsi_FORMTAGS);
var ac = nsi.autocapture.getInstance();
});
</script>
</head>
<body>
<div class="ACBody">
<div class="header">
<div class="OEMLogo"></div>
<div class="title">
<xsl:text>Send To</xsl:text>
</div>
</div>
<form id="ACForm" method="POST" action="--WEBBOT-SELF--">
<xsl:for-each select="ACForm">
<div class="ACForm">
<xsl:attribute name="id">ACForm_<xsl:value-of select="@Title"/></
xsl:attribute>
<xsl:if test="@Smallimage">
<div class="icon">
<image width="32" height="32" border="0">
<xsl:attribute name="src">
<xsl:text>data:image/png;base64,</xsl:text>
<xsl:value-of select="@Smallimage"/>
</xsl:attribute>
</image>
106
</div>
</xsl:if>
<div class="name"><xsl:value-of select="@Title"/></div>
<div class="form">
<xsl:apply-templates select="ACString | ACStringMultiline | ACList
| ACBoolean | ACDateTime | ACNumber | ACLabel | ACButton"/>
</div>
<div class="clear" style="height:20px;"></div>
</div>
</xsl:for-each>
</form>
<div class="push"></div>
</div>
<div class="footer">
<div class="AutoStoreLogo"></div>
</div>
</body>
</html>
</xsl:template>
<xsl:template match="ACString">
<div class="ACInputField ACString">
<div class="ACLabel">
<xsl:choose>
<xsl:when test="@Required = 'true'">
<xsl:attribute name="class"><xsl:text>ACLabel ACRequired</xsl:text></
xsl:attribute>
<div class="Icon"><xsl:text>*</xsl:text></div>
<div class="Title"><xsl:value-of select="@Title"/></div>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
<div class="ACInput">
<xsl:if test="@HelpMsg">
<xsl:attribute name="title"><xsl:value-of select="@HelpMsg"/></
xsl:attribute>
</xsl:if>
<input type="text">
<xsl:attribute name="id">
<xsl:with-param name="stringvalue" select="@Title" />
</xsl:attribute>
<xsl:attribute name="name"><xsl:value-of select="@Title"/></
xsl:attribute>
<xsl:attribute name="size"><xsl:value-of select="@Size"/></
xsl:attribute>
<xsl:attribute name="maxlength"><xsl:value-of select="@MaxLength"/></
xsl:attribute>
<xsl:attribute name="value"><xsl:value-of select="."/></xsl:attribute>
<xsl:if test="@Required = 'true'">
<xsl:attribute name="class"><xsl:text>required</xsl:text></
xsl:attribute>
</xsl:if>
</input>
</div>
107
<div class="clear"></div>
</div>
</xsl:template>
<xsl:template match="ACButton">
<div class="ACInputField ACButton">
<button class="ACButton" type="button">
</xsl:attribute>
xsl:attribute>
<xsl:attribute name="value"><xsl:value-of select="@Title"/></
xsl:attribute>
<span><xsl:value-of select="@Title"/></span>
</button>
</div>
</xsl:template>
<xsl:template match="ACLabel">
<div class="ACLabelField ACLabel">
</xsl:attribute>
<div class="Title">
<xsl:attribute name="style">
<xsl:text>font-size:</xsl:text>
<xsl:value-of select="@FontSize"/>
</xsl:attribute>
<xsl:value-of select="@Text"/>
</div>
</div>
</div>
</xsl:template>
<xsl:template match="ACNumber">
<div class="ACInputField ACNumber">
<xsl:choose>
xsl:attribute>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
xsl:attribute>
</xsl:if>
108
<input type="text" class="number">

</xsl:attribute>
xsl:attribute>
<xsl:attribute name="min"><xsl:value-of select="@Min"/></xsl:attribute>
<xsl:attribute name="max"><xsl:value-of select="@Max"/></xsl:attribute>
<xsl:attribute name="class"><xsl:text>number required</xsl:text></
xsl:attribute>
</xsl:if>
</input>
</div>
</div>
</xsl:template>
<xsl:template match="ACStringMultiline">
<div class="ACInputField ACStringMultiline">
<xsl:choose>
xsl:attribute>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
<textarea>
</xsl:attribute>
<xsl:attribute name="name">
<xsl:value-of select="@Title"/>
</xsl:attribute>
xsl:attribute>
</xsl:if>
<xsl:if test="@Width">
<xsl:attribute name="cols">
<xsl:value-of select="@Width"/>
</xsl:attribute>
</xsl:if>
<xsl:if test="@Height">
<xsl:attribute name="rows">
<xsl:value-of select="@Height"/>
</xsl:attribute>
109
</xsl:if>
xsl:attribute>
</xsl:if>
<xsl:value-of select="."/>
</textarea>
</div>
</div>
</xsl:template>
<xsl:template match="ACList">
<div class="ACInputField ACList">
<xsl:choose>
xsl:attribute>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
<select>
</xsl:attribute>
xsl:attribute>
xsl:attribute>
</xsl:if>
<xsl:for-each select="ACOption">
<xsl:element name="option">
<xsl:attribute name="value"><xsl:value-of select="."/></
xsl:attribute>
<xsl:if test="boolean(@Selected)">
<xsl:attribute name="selected">on</xsl:attribute>
</xsl:if>
<xsl:value-of select="@Label"/>
</xsl:element>
</xsl:for-each>
xsl:attribute>
</xsl:if>
</select>
</div>
</div>
</xsl:template>
<xsl:template match="ACBoolean">
<div class="ACInputField ACBoolean">
110
<xsl:choose>
xsl:attribute>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
<input type="radio">
</xsl:attribute>
</xsl:attribute>
xsl:attribute>
</xsl:if>
<xsl:attribute name="value">
<xsl:value-of select="@TrueValue"/>
</xsl:attribute>
<xsl:if test="@Value = 'true'">
<xsl:attribute name="checked">on</xsl:attribute>
</xsl:if>

</xsl:if>
</input>
<label class="ACInputValue">
<xsl:attribute name="for">
<xsl:text>cb_</xsl:text>
</xsl:attribute>
<xsl:value-of select="@TrueValue"/>
</label>
<input type="radio">
</xsl:attribute>
</xsl:attribute>
xsl:attribute>
</xsl:if>
<xsl:attribute name="value">
111
<xsl:value-of select="@FalseValue"/>
</xsl:attribute>
<xsl:if test="@Value = 'false'">
<xsl:attribute name="checked">on</xsl:attribute>
</xsl:if>

</xsl:if>
</input>
<label class="ACInputValue">
<xsl:attribute name="for">
<xsl:text>cb_</xsl:text>
</xsl:attribute>
<xsl:value-of select="@FalseValue"/>
</label>
</div>
</div>
</xsl:template>
<xsl:template match="ACDateTime">
<div class="ACInputField ACDateTime">
<xsl:choose>
xsl:attribute>
</xsl:when>
<xsl:otherwise>
</xsl:otherwise>
</xsl:choose>
</div>
<input type="text" class="date">
xsl:attribute>
</xsl:if>
<xsl:attribute name="rel"><xsl:text>datepicker</xsl:text></
xsl:attribute>
</xsl:attribute>
xsl:attribute>
<xsl:attribute name="size"><xsl:value-of select="@Size"/></
xsl:attribute>
<xsl:attribute name="class"><xsl:text>date required</xsl:text></
xsl:attribute>
</xsl:if>
112
</input>
</div>
</div>
</xsl:template>
<xsl:template name="stringreplace">
<xsl:param name="stringvalue" />
<xsl:param name="from" />
<xsl:choose>
<xsl:when test="contains($stringvalue, $from)"><xsl:value-of
select="substring-before($stringvalue, $from)" />
<xsl:if test="contains(substring($stringvalue, 1, stringlength($stringvalue) - 1), $from)">
<xsl:with-param name="stringvalue" select="substringafter($stringvalue, $from)" />
<xsl:with-param name="from" select="$from" />
</xsl:if>
</xsl:when>
<xsl:otherwise><xsl:value-of select="$stringvalue" /></xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>
Action
You can assign an action to a menu entry item if there is no need for the user to assign index fields. This applies to
a workflow scenario where the user selects a file that does not require any indexing field information to be captured
and submits the file directly to the server process. Files are processed and delivered to the route component in the
workflow.
For every action you create, you are configuring a distinct workflow based on the selected process and route
components.
If the workflow process requires index fields to be added to the stored document, you need to create a form.
How to Edit a Group, Menu, Form, or Action
Select the group, menu, form or action that you want to update and click the Edit button.
How to remove a Group, Menu, Form, or Action

Select the group, menu, form or action that you want to delete and click the Remove button.
Preferences tab
On this tab you can configure the following settings for the AutoCapture server.
Option
Description
Home Directory
The root directory is the working folder where the server

creates all temporary directories and files necessary for
controlling device related traffic. The account used to run
the server must have permission to write to this folder.
Port Number
The port that the AutoCapture server uses to

communicate with clients. The port setting for
AutoCapture clients must match this port number. The
default port is 8085.
113
Option
Description
Secure communication (SSL)
Enable this option to allow information exchange

between the server and the clients to be over a SSL
(Secure Sockets Layer) secured connection. This option
requires a SSL enabled client.
Note: If the AutoCapture client was installed
prior to this feature enhancement, the client will
not support SSL encryption. The user will need
to upgrade to the latest SSL enabled client.
Processed Files
Select this check box to save processed files. This is

the folder where the captured files are stored after they
are successfully routed. If you select this check box, all
files are stored into the Processed Files folder when the
service successfully completes writing them into the
destination location.
Important: Enabling this option saves a
copy of every successfully routed file in this
folder. Make sure that sufficient disk storage is
allocated for this folder.
Rejected Files
Select this check box to save rejected files. This

folder is used for storing any files that were not routed
successfully. Typically, a secondary process uses this
folder as an input folder to notify a system administrator
of the failure. A system administrator can then identify
reasons for failures by searching application log file
entries.
AutoCapture Component RRTs

Component RRT ID
The RRT ID for this component is ACC.
Reserved Replacement Tag Names (RRTN)
The following table describes the reserved RTN values for this component:
Name
Description
AttachmentsPathList
A pipe (|) delimited list of full paths to attachments on

the computer hosting the client.
ComputerName
The NetBIOS name of the computer hosting the client

that is submitting documents.
Domain
The logged on domain of the client that is submitting

documents.
UserName
The logged on user name of the client that is submitting

documents.
114
Field Replacement Tag Names (FRTN)

This component supports FRTNs and replacement of field names generated from the MFP devices. The following
example provides some sample usage for your reference:
~ACC::%Client ID%~
This is replaced by Company if the user types in Company for the field name called Client ID.
Special Set Replacement Tag Names (SSRTN)
There are no SSRTNs defined for this component.
VBScript interface
The VBScript interface AutoCapture server provides the ability to extend the functionally of otherwise static forms by
allowing custom VBScripts to be executed on the server at runtime. You can create scripts to update form field values
and perform any necessary form field validation based on any available runtime data.
The VBScript interface has the following events and objects.
Events
Objects
The VBScript interface for AutoCapture server has these events.

Event
Description
Form_OnLoad
This event occurs before a form is displayed.
Form_OnValidate
This event occurs when a form is open and the user

attempts to submit it.
Field_OnChange
This event occurs when a List or Boolean field value on

the form has changed.
Field_OnValidate
This event occurs when a when user attempts to set a

new value for a List or Boolean field on the form.
Button_OnClick
This event occurs when a when user clicks a button field

on the form.
The VBScript interface for AutoCapture server has these objects.

Event
Description
Form Object
A Form object provides fields for user entries. RRTs

access field values in a workflow.
Fields Object
A Fields object provides a container object for fields in a

form.
Boolean Field Object
The BooleanField object accesses information for a

Boolean field in a form.
Data Field Object
The DateField object accesses information for a datetime field in a form.
Label Field Object
The LabelField object accesses information for a label

field in a form.
115
Event
Description
List Field Object
A ListField object provides fields for user entries. RRTs

Number Field Object
The NumberField object accesses information for a

numeric field in a form.
String Field Object
The StringField object accesses information for a string

field in a form.
AutoCapture Server events

This section describes AutoCapture server events.
The VBScript interface for AutoCapture server has these events.
Event
Description
Form_OnLoad
Form_OnValidate
This event occurs when a form is open and the user

attempts to submit it.
Field_OnChange
This event occurs when a List or Boolean field value on

the form has changed.
Field_OnValidate

new value for a List or Boolean field on the form.
Button_OnClick
This event occurs when a when user clicks a button field

on the form.
Form_OnLoad event
Syntax
Form_OnLoad ( Form )
Arguments
Form
The form object to be loaded.
Remarks
You can use this event to perform tasks such as initializing the form fields or the form scan settings.
Example
Sub Form_OnLoad(Form)
'Write custom code to lookup the authenticated user's home directory.
Form.SetFieldValue Path, LookupHomeDirectory(Form.UserName)
End Sub
116
Form_OnValidate event
This event occurs when a form is open and the user attempts to submit it.
Syntax
Form_OnValidate ( Form )
Arguments
Form
The form object to be validated.
Remarks
You can use this event to perform tasks such validating user input for a form field. If the return value is empty string
then validation is assumed to have been successful.
Example
Function Form_OnValidate(Form)
'Write custom validation to check that the user is attempting to enter a
value for the Amount field that is less than 100.
If (CInt(Form.GetFieldValue(Amount)) Then
Form_OnValidate = Amount cannot be greater than 100.
End If
End Function
Field_OnChange event
This event occurs when a List or Boolean field value on the form has changed.
Syntax
Form_OnChange ( Form , FieldName , FieldValue )
Arguments
Form
The form object.
FieldName
The name of the field.
FieldValue
The value of the field.
Remarks
You can use this event to perform tasks such as populating other form field values based on the changed field value.
Example
Sub Field_OnChange(Form, FieldName, FieldValue)
'Write custom code to lookup the users home directory.
If (FieldName = UserName) Then
Form.SetFieldValue Path, LookupHomeDirectory(FieldValue)
End If
End Sub
117
Field_OnValidate event
This event occurs when a when user attempts to set a new value for a List or Boolean field on the form.
Syntax
Field_OnValidate FieldName , FieldValue )
Arguments
FieldName
The name of the field to validate.
FieldValue
The value of the field to validate.
Remarks
Example
Function Field_OnValidate(FieldName, FieldValue)
Field_OnValidate = ""
value for the Amount field that is less than 100.
If (FieldName = Amount) Then
If (CInt(FieldValue) > 100) Then
Field_OnValidate = Amount cannot be greater than 100.
End If
End If
End Function
Button_OnClick event
This event occurs when a when user clicks a button field on the form.
Syntax
Button_OnClick Form , ButtonName )
Arguments
Form
The form object.
ButtonName
The name of the button field that was clicked.
Remarks
You can use this event to perform tasks such validating user input for a form field or populating other form field
values on the form.
Example
Function Button_OnClick(Form,ButtonName)
'Write custom code to lookup the user's home directory.
118
End Function
AutoCapture Server objects
This section describes AutoCapture server objects.
The VBScript interface for AutoCapture server has these objects.
Event
Description
Form Object
A Form object provides fields for user entries. RRTs

Fields Object
A Fields object provides a container object for fields in a

form.
Boolean Field Object
The BooleanField object accesses information for a

Boolean field in a form.
Data Field Object
The DateField object accesses information for a datetime field in a form.
Label Field Object
The LabelField object accesses information for a label

field in a form.
List Field Object
A ListField object provides fields for user entries. RRTs

Number Field Object
The NumberField object accesses information for a

numeric field in a form.
String Field Object
The StringField object accesses information for a string

field in a form.
Form object
A Form object provides fields for user entries. RRTs access field values in a workflow.
Properties
Property
Access Type
Description
Name
Read
The name of the form.
GUID
Read
The globally unique identifier

(GUID) attribute of the form object.
The GUID property is read-only.
UserName
Read
The account name of the user.
ComputerName
Read
The computer name of the user's

computer.
Fields
Read
The object that contains the fields

defined on the form.
Methods
Method
Description
GetFieldValue
Returns the value of a form field.
SetFieldValue
Sets the value of a form field.
119
Method
Description
StatusMsg
Displays a status message in the status monitor.
ErrorMsg
Displays an error message in the status monitor.
WarningMsg
Displays a warning message in the status monitor.
TraceMsg
Displays a debug message in status monitor if the debug

option has been turned on for the task.
GetFieldValue method
Returns the value of a form field.
object . GetFieldValue ( fieldname )
Part
Description
object
An object expression that evaluates

to the Form object.
fieldname
Required. The name of the field.
SetFieldValue method
Sets the value of a form field.
object . SetFieldValue ( fieldname , fieldvalue )
Part
Description
object

to the Form object.
fieldname
Required. The name of the field.
fieldvalue
Required. The value to be assigned to

the field.
StatusMsg method
Displays a status message in the status monitor.
object . StatusMsg ( message )
Part
Description
object

to the Form object.
message
Required. The message to be

displayed.
ErrorMsg method
Displays an error message in the status monitor.
object . ErrorMsg ( message )
Part
Description
object

to the Form object.
message

displayed.
120
WarningMsg method
Displays a warning message in the status monitor.
object . WarningMsg ( message )
Part
Description
object

to the Form object.
message

displayed.
TraceMsg method
Displays a debug message in status monitor if the debug option has been turned on for the task.
object . TraceMsg ( message )
Part
Description
object

to the Form object.
message

displayed.
Fields object
A Fields object provides a container object for fields in a form.
Properties
Type
Access type
Description
Count
Read
The number of fields in a container.
Field(name)
Read
The field object by name.
Item(index)
Read
The field object by index.
BooleanField object
The BooleanField object accesses information for a Boolean field in a form.
Properties
Type
Values
Description
Name
Read
Gets the name of the field.
Value
Read/write
Get/Set the value of the field.
True
Read/write
Get/Set the true value of the field.
False
Read/write
Get/Set the false value of the field.
Required
Read/write
Get/Set whether the field value is

required.
HelpMsg
Read/write
Get/Set the help message for the

field.
121
DateField object
The DateField object accesses information for a date-time field in a form.
Properties
Type
Values
Description
Name
Read
Value
Read/write
Format
Read/write
The date format of the field.
Required
Read/write
Whether the field value is required.
HelpMsg
Read/write
The help message for the field.
LabelField object
The LabelField object accesses information for a label field in a form.
Properties
Type
Access type
Description
Name
Read
Text
Read/write
The label text defined by the field.
FontSize
Read/write
The text size for the field.
xx-small
x-small
medium
large
x-large
xx-large
Required
Read/write
Specifies whether the field value is

required.
HelpMsg
Read/write
ListField object
A ListField object provides fields for user entries. RRTs access field values in a workflow.
Properties
Type
Access type
Description
Name
Read
Value
Read/write
Format
Read/write
The date format
Required
Read/write
Specifies whether the field is

requiered
HelpMsg
Read/write
122
Methods
Method
Description
Adds a new item to a list.
AddListItem
AddListItem method
Adds a new item to a list.
object . ListField ( label , value )
Part
Description
object

to the ListField object.
label
Required. The label for the new list

item.
value
Required. The value of the new list

item.
NumberField object
The NumberField object accesses information for a numeric field in a form.
Properties
Type
Access Type
Description
Name
Read
Gets the name of the field.
Value
Read/write
Get/Set the value of the field.
MinValue
Read/write
Get/Set the minimum value allowed

for the field.
MaxValue
Read/write
Get/Set the maximum value allowed

for the field.
Required
Read/write
Get/Set whether the field value is

required.
HelpMsg
Read/write
Get/Set the help message for the

field.
StringField object
The StringField object accesses information for a string field in a form.
Properties
Type
Access type
Description
Name
Read
Value
Read/write
Required
Read/write
Specifies whether the field value is

required.
HelpMsg
Read/write
123
Date and time formats

Date and time format strings define text representation of a date/time value for a Date/Time form field.
Table 11: Date/Time format specifiers
Format specifier
Description
Examples
%a
The abbreviated name of the day of

the week.
%A
The full name of the day of the week. 6/15/2009 1:45:30 PM -> Monday
(en-US)
6/15/2009 1:45:30 PM ->
(ru-RU)
6/15/2009 1:45:30 PM -> lundi (frFR)
%b
The abbreviated name of the month.
6/15/2009 1:45:30 PM -> Jun (enUS)

6/15/2009 1:45:30 PM -> juin (frFR)
6/15/2009 1:45:30 PM -> Jun (zuZA)
%B
The full name of the month.
6/15/2009 1:45:30 PM -> June (enUS)

6/15/2009 1:45:30 PM -> juni (daDK)
6/15/2009 1:45:30 PM -> uJuni (zuZA)
%C
The number of the century.
6/1/2009 1:45:30 PM -> 20

6/1/1992 1:45:30 PM -> 19
%d
The day of the month, from 01

through 31.
6/1/2009 1:45:30 PM -> 01

6/15/2009 1:45:30 PM -> 15
%e

through 31.
6/1/2009 1:45:30 PM -> 1

6/15/2009 1:45:30 PM -> 15
%H
The hour, using a 24-hour clock from 6/15/2009 1:45:30 AM -> 01

00 to 23.
6/15/2009 1:45:30 PM -> 13
%I

01 to 12.
6/15/2009 1:45:30 PM -> 01
%j
The day of the year from 000 to 366.
6/15/2009 1:45:30 PM -> Mon (enUS)

6/15/2009 1:45:30 PM -> (ruRU)
6/15/2009 1:45:30 PM -> lun. (frFR)
1/5/2009 1:45:30 AM -> 015
124
Format specifier
Description
Examples
6/15/2009 1:45:30 PM -> 166
%k

0 to 23.
6/15/2009 1:45:30 PM -> 13
%l

1 to 12.
6/15/2009 1:45:30 PM -> 1
%m
The month, from 01 through 12.
6/15/2009 1:45:30 PM -> 06
%M
The minute, from 00 through 59.
6/15/2009 1:09:30 AM -> 09

6/15/2009 1:09:30 PM -> 09
%n
The newline character.
%p
The AM/PM designator.
6/15/2009 1:45:30 PM -> PM (enUS)

6/15/2009 1:45:30 PM -> (ja-JP)
6/15/2009 1:45:30 PM -> PM (esES)
%P
The am/pm designator.
6/15/2009 1:45:30 PM -> pm (enUS)
%S
The second, from 00 through 59.
6/15/2009 1:45:09 PM -> 09
%s
The number of seconds since Epoch

(since Jan 01 1970 00:00:00 UTC).
6/15/2009 1:45:09 PM ->

1245073509
%t
The tab character.
%U
The week of the year, with Sunday as 2/15/2001 -> 49

first day of week, from 00 to 53.
%u
The day of the week from 1 to 7 (1 =

Sunday)
6/15/2009 1:45:09 PM -> 2
%W
The week of the year, with Monday

as first day of week, from 00 to 53.
12/15/2001 -> 50
%y
The year, from 00 to 99.
1/1/0001 12:00:00 AM -> 01

1/1/0900 12:00:00 AM -> 00
6/5/1975 1:45:09 PM -> 75
6/5/2009 1:45:09 PM -> 09
%Y
The year as a four-digit number.
1/1/0001 12:00:00 AM -> 0001

1/1/0900 12:00:00 AM -> 0900
1/1/1900 12:00:00 AM -> 1900
6/15/2009 1:45:30 PM -> 2009
%%
The literal % character.
%%Y -> %Y
125

The AutoCapture port (such as 8085) cannot be locked by another process. If AutoCapture fails to start, check for
another process that could be listening on the AutoCapture port.
If you plan to use form field names in the rename schema of a subsequent component, you cannot use the following
characters:
/
\
:
?
"
<
>
|
Using one of the following characters is illegal within a menu, form, button, group or action:
&
<
>
No information is available at this time.
AutoCapture Client
Welcome to the AutoCapture Client component
AutoCapture client is an AutoStore component that extends capture capabilities to the desktop on a user's workstation.
You can use this component to capture specified file types that reside on a workstation into a workflow.
126
Figure 2: The AutoCapture Client Window

The AutoCapture client component includes three features:
AutoCapture client applicationA stand-alone application window that lets you select and capture documents
using AutoCapture menus, forms, and actions defined on an AutoCapture server.
AutoCapture OfficeA Microsoft Office add-in that allows you to capture a document in Microsoft Word or to
capture selected messages in Microsoft Outlook.
AutoCapture ExplorerAn Explorer add-in that adds AutoCapture menus to the Windows Explorer shortcut
menu for capturing selected files in an Explorer window.
Note: This help describes how to configure the AutoCapture client. To configure the AutoCapture server, you
can refer to help for the AutoCapture component in an AutoStore workflow.
127
Installing the AutoCapture Client

The topics in this section include procedures to install either the AutoStore Client by using either
AutoCaptureClientPack.exe or AutoCaptureClientPack.msi. Administrative permissions are required to run either
setup program.
You install and configure the AutoCapture Client component on the workstation where a user needs to capture files
from the desktop into a workflow. After you configure the AutoCapture Client, it communicates with the server to
retrieve menus, forms, and actions for presentation on the user's desktop.
The AutoCapture Client executable file is located within the following directory in the product installation directory:
AutoStore_installation_directory\Distributable\AutoCapture
You can install AutoCapture Client by using AutoCaptureClientPack.exe or through the command-line.
How to install AutoCapture Client by using AutoCaptureClientPack.exe
Provides a step-by-step procedure for installing the AutoCapture Client by using the AutoCaptureClientPack.exe
program.
How to install AutoCapture Client from the command line
Provides information for enterprise-wide deployments by using AutoCapture Client Pack.msi program.
How to Install AutoCapture client by using AutoCaptureClientPack.exe

This procedure provides a step-by-step procedure for installing the AutoCapture client by using
AutoCaptureClientPack.exe.
Before you begin this procedure, ask your AutoStore administrator for the AutoCaptureClientPack.exe
installation file. This executable file installs the AutoCapture Client, the AutoCapture Explorer add-in, and the
Microsoft Office AutoCapture add-in.
When you install the AutoCapture Client using the AutoCaptureClientPack.exe, you install and configure the
AutoCapture Client component on the workstation where a user needs to capture files from the desktop into a
workflow. The installation wizard steps you through configuring the AutoCapture client, and then AutoCapture Client
communicates with the server to retrieve menus, forms, and actions for presentation on the user's desktop.
1. Save the AutoCaptureClientPack.exe installation executable to the desktop or other location on your
workstation.
2. Execute AutoCaptureClientPack.exe.
3. If Windows prompts whether to allow changes to the computer, click Yes.
4. If the Installation Wizard prompts to install prerequisite software, click Yes.
5. On the Welcome page, click Next.
6. On the License Agreement page, click I accept the terms in the license agreement, then click Next.
Note: Installation will end if you choose not to accept the terms in the license agreement.
7. On the Customer Information page, type your User Name and Organization, then click Next.
8. On the Setup Type page, click Complete, then click Next.
Click Custom only if you need to change the install location or specify individual features.
Feature
Description
AutoCapture Client
Allows you to choose and capture files in the

AutoCapture client application interface using menus,
forms, and actions defined by an AutoStore workflow.
AutoCapture Explorer Add-in
Adds the AutoCapture Send to command to the

Windows Explorer shortcut menu, which allows you to
capture files to an AutoStore workflow using Windows
Explorer.
128
Feature
Description
Note: If you are running the 64-bit version
of Windows, click This feature will not be
available. You can install the 64-bit Explorer
add-in after you complete this procedure .
AutoCapture MS Office Add-in
Adds the AutoCapture add-in to Office applications

to capture the current document to an AutoStore
workflow in Microsoft Word or selected email
messages in Microsoft Outlook.
9. On the Ready to Install page, click Install.

10. On the InstallShield Wizard Completed page, click Finish.
After you complete this procedure, you must configure the AutoCapture client to communicate with the AutoCapture
server. To do this, see Configuring AutoCapture Client. For information about how to use the AutoCapture client, see
Using AutoCapture Client.
How to install AutoCapture Client from the command line
For enterprise-wide deployments, you can install AutoCapture Client from the command-line using the AutoCapture
Client Pack.msi program.
1. Make sure you are logged on with an account that has administrator rights on the computer.
2. Open a Command Prompt window by using elevated rights, and then change the directory to the folder that
contains the setup files.
3. Enter the install command string at the command prompt.
Alternatively, you can create a command file and run it from the command prompt. You can also use a scripting
language such as VBScript or Windows PowerShell to run the command.
4. The following command line show how setup.msi can be used with a number of optional parameters.
For more information about these parameters, see AutoCapture Client installer command-line parameters.
C:\>msiexec /i "AutoCapture Client Pack.msi" INSTALLDIR="C:\INSTALL"
ACACT="1" ACFILETYPE="*.doc" ACPORT="8085" ACSERVER="12.123.1.123" /q"
Important:
The Windows installer switch /i installs the product.

The installer switch /q is used to make this a silent installation.
AutoCapture Client installer command-line parameters

This topic lists all available AutoCapture Client installer command-line parameters, their values, and a brief
description of each parameter.
Parameters are case-sensitive and must be entered as all-uppercase letters. All parameter values must be enclosed in
double quotes.
msiexec /i "AutoCapture Client Pack.msi" INSTALLDIR = path
ACFILETYPE = filetypes ACPORT = port ACSERVER = address /q
Parameter
INSTALLDIR
Values
path
ACACT = boolean
Description
Enter the installation directory.

The default installation directory
used by the installer is "C:
\Program Files\NSI
\AutoCapture Client".
129
Parameter
ACACT
Values
1 or 0
Description
Activates or disables the Explorer
client.
ACFILETYPE
filetypes
"1" activates the Explorer client.

This is the default value.
"0" disables the Explorer client.
Sets the file types for the Explorer

Client. Specify "*.ext", such as
"*.doc". Separate multiple file types
with a comma (,) or semicolon (;).
The default setting used by the
installer is for all file types ("*.*").
ACPORT
port
The port number that AutoCapture

uses to connect to clients.
The default port number used by the
installer is "8085". This should be
changed only if AutoCapture has
been configured to use a different
port.
ACSERVER
address
The IP address for the AutoCapture

server.
The default address used by the
installer is "localhost". This should
only be used if the client is running
on the same machine as the server.
Examples
C:\>msiexec /i "AutoCapture Client Pack.msi" INSTALLDIR="C:
\INSTALL" ACACT="1" ACFILETYPE="*.DOC" ACPORT="8085"
ACSERVER="12.123.1.123" /q"
Important:
The Windows installer switch /i installs the product.

The Windows installer switch /q is used to make this a silent installation.
To use the default parameter values for the installer, run the MSI package using the following
command:
C:\>msiexec /i "AutoCapture Client Pack.msi" /q
Using the AutoCapture Client application

The AutoCapture client opens in Windows as a separate application window. You can use the client window to access
AutoCapture menu commands, populate AutoCapture forms, specify and capture files, and configure settings for the
client. Use the following procedures to start the AutoCapture client and capture documents.
Starting AutoCapture Client

Capturing Documents with AutoCapture Client
130
How to start the AutoCapture client application

Before you perform this procedure, you must first install the AutoCapture client application on your workstation. To
do this, see Installing AutoCapture Client.
Double-click the AutoCapture icon

on the desktop, or click AutoCapture on the Windows Start menu.
Completing this step opens the AutoCapture client window.
If this is the first time you have run AutoCapture client after installing it, or the status bar displays Error
connecting and getting license from server, see Configuring AutoCapture Client Settings to
configure the client after starting it.
How to capture documents
1. In the Files pane, click the add file button to specify files you want to capture.
You can add a single file each time you click the add file button. Files are captured in the order they show on the
list.
2. In the Menus pane, expand menus to access AutoCapture forms and actions.
3. In the Form pane, populate fields in a form.
Required fields are marked with an asterisk (*).
4. To perform the capture, you can either click the workflow button
on the toolbar or click Send on the File
menu.
5. Click OK in any capture confirmation dialogs that appear.
6. If prompted whether to clear the list, click Yes to clear the Files list or No to retain the files in the list.
7. If prompted whether to delete captured files, click Yes to delete files listed in the Files pane or No to keep the
files.
Capturing Microsoft Office documents or messages

When the AutoCapture Office feature is installed on a workstation, you can capture the active document in Microsoft
Word or selected messages in Microsoft Outlook. To use this feature, click the AutoCapture tab on the ribbon in
either application, and click the Workflows button to open the AutoCapture client window. The Word document or
Outlook messages then automatically populate the Files pane. Any capture operation acts on these files.
Using AutoCapture Explorer client

AutoCapture Explorer client allows you to quickly capture selected files in Windows Explorer. You capture files
by right-clicking one or more selected files in Windows Explorer and using AutoCapture menus that open from the
AutoCapture shortcut command. Use the following procedures to configure and use AutoCapture Explorer client and
capture documents.
Configuring AutoCapture Explorer Client

Capturing Files in Windows Explorer
How to configure AutoCapture Explorer client

The first time that you use AutoCapture Explorer client you have to activate and configure it to communicate with an
AutoCapture server. You can repeat the configuration procedure at any time to change existing settings.
1. In Windows Explorer, right-click a file and click AutoCapture > Configuration on the shortcut menu.
2. In the AutoCapture Configuration dialog box, configure the options.
To see descriptions of the options, see Explorer Client Settings.
3. Click OK to save your changes.
4. Successfully completing this procedure adds menus, forms, or actions defined on the AutoCapture server to the
AutoCapture shortcut menu.
131
Tip: You can also activate and configure AutoCapture from the AutoCapture client application in the
AutoCapture Configuration dialog box. See Configuring AutoCapture Client Settings.
How to capture files in Windows Explorer
After the AutoCapture Explorer client has been successfully activated and configured to communicate with an
AutoCapture server, you can use the AutoCapture Send to shortcut menu
to capture selected files in
Windows Explorer.
1. In Windows Explorer, right-click one or more selected files.
2. On the shortcut menu, point to the AutoCapture Send to menu
, then click an AutoCapture menu
command to open an AutoCapture form.
3. On the AutoCapture form, enter values for fields, making sure to populate required fields.
Required fields on a form are marked by the asterisk (*).
4. At the bottom of the form window, click the capture button.
5. Click OK in any capture confirmation dialogs that appear.
6. If prompted whether to delete selected files, click Yes to delete the files No to keep them.
How to configure settings for AutoCapture client

Use this procedure to change existing settings for the AutoCapture client.
Use the AutoCapture Configuration dialog box to configure settings for the AutoCapture client. You can configure
connection settings, preferences, and Explorer Client settings. The connection settings initially specify "localhost"
for the server, so unless you are running AutoCapture client on the server, you must first configure the connection
settings to specify the AutoCapture server.
1. If AutoCapture client is not already open, double-click the AutoCapture icon
on the desktop, or click
AutoCapture on the Windows Start menu.
2. Click Options > Configuration to open the AutoCapture Configuration dialog box.
3. In the left pane of the dialog box, click to configure various settings:
a) Click Connection to configure Connection Settings.
You must configure these settings to communicate with an AutoCapture server.
b) Click Preferences to configure Preferences.
Preference options specify whether to confirm captures, delete items, and force MSG format for Outlook
emails.
c) Click Explorer Client to activate the Explorer Client.
d) Click Log Settings to configure Log Settings for AutoCapture.
4. After you finish making changes in the AutoCapture Configuration dialog box, click OK.
How to configure settings for AutoCapture client
Use this procedure to change existing settings for the AutoCapture client.
1. If AutoCapture client is not already open, double-click the AutoCapture icon
on the desktop, or click
AutoCapture on the Windows Start menu.
2. Click Options > Configuration to open the AutoCapture Configuration dialog box.
3. In the left pane of the dialog box, click to configure various settings:
Click
Connection
To
Configure Connection Settings.
You must configure these settings to communicate with
an AutoCapture server.
Preferences
Configure Preferences.
132
Click
Explorer Client
Log Settings
To
Preference options specify whether to confirm captures,
delete items, and force MSG format for Outlook
emails.
Activate Explorer Client.
Configure Log Settings for AutoCapture
4. After you finish making changes in the AutoCapture Configuration dialog box, click OK.
Connection Settings
Prior to working with AutoCapture, you have to configure the AutoCapture server options and make sure that
AutoCapture server is running. You can configure server options in the Connection settings in the AutoCapture
Configuration settings dialog box.
The Connection settings can be opened by clicking Options > Configuration, and then clicking Connection in the
left pane of the AutoCapture Configuration dialog box. You can also open the AutoCapture Configuration dialog
box by clicking the Configuration button on the AutoCapture client toolbar.
Option
Description
Server
Specifies the IP address or host name of the computer

running the AutoCapture server. The default setting is
localhost.
Port
The port number used by the AutoCapture server to

communicate with clients. This should match the port
number configured on the AutoCapture server. The
default setting is 8085.
Preferences Settings
The Preferences settings allow you to specify whether to display confirmation messages for captures, to delete
captured items, or to force MSG format for Outlook emails. You can configure preferences in the Preferences settings
in the AutoCapture Configuration settings dialog box.
The Preferences settings can be opened by clicking Options > Configuration, and then clicking Preferences in the
box by clicking the Configuration button on the AutoCapture client toolbar.
Option
Description
Display confirmation messages
Select this check box to display confirmation messages

before and after capturing documents to the AutoCapture
server.
Delete captured items
Select this check box to delete files after they have been
captured to the AutoCapture server.
Force MSG format for Outlook emails
Select this check box to specify that Outlook MSG

format must be used for Outlook emails captured by
AutoCapture.
Note: MSG files are Outlook messages saved
as files. They are saved as COM structured
storage OLE2 compound documents, or
"DocFile", which is the same technique used by
Word, Excel, and many other applications.
133
Explorer Client Settings

The Explorer Client settings allow you to activate the Explorer client for AutoCapture. The AutoCapture Explorer
client enables you to right-click and capture specified file types in Windows Explorer.
The Explorer Client settings can be opened by right-clicking a file in a Windows Explorer window, and on the
shortcut menu, clicking AutoCapture > Configuration to display the AutoCapture Configuration dialog box. The
following table describes options for configuring the AutoCapture Explorer client.
Option
Description
Activate
Select this check box to activate the AutoCapture

Explorer client. The remaining options are only available
when this check box is selected.
Server
Type the IP address or host name of the computer

running the AutoCapture server. Type "localhost" if
you are using the AutoCapture Explorer client on the
AutoCapture server.
Port
Type the port number used by the AutoCapture server

to communicate with clients. This should match the
port number configured on the AutoCapture server. The
default setting is 8085.
File types
List extensions in the format *.ext to be captured in

Windows Explorer. The default setting is "*.*" for any
file type. To specify multiple types, separate extensions
using either a comma (,) or a semicolon (;).
Example: *.* *.txt *.txt,*.doc,*.csv
Display confirmation messages
Select this check box to display messages confirming

captures. This check box is selected by default.
Delete captured messages
Select this check box to delete files after they have been
captured. This check box is selected by default.
Note: The AutoCapture shortcut menu command changes to a Send to command when the Explorer client
is configured to communicate with a valid server. To change existing settings, right-click a file and click Send
to > Configuration. The AutoCapture Send to menu is distinguished from the standard Windows Send to
command by the AutoCapture icon
.
Log Settings
The Log Settings allow you to configure event log settings and log file settings for an AutoCapture client. You can
configure log settings in the Log Settings in the AutoCapture Configuration settings dialog box.
The Log Settings settings can be opened by clicking Options > Configuration, and then clicking Log Settings in the
box by clicking the configuration button on the AutoCapture client toolbar.
Option
Description
Log path
Specifies the directory location for saving log files.
Add trace
Select this check box to turn on trace logging for the

AutoCapture client.
Maximum log size
Specifies the maximum size for the log file. Older log
entries will be deleted to make room for new entries.
134
Option
Description
Log history days
Specifies the maximum number of days that logs will be

saved to the log file. Log entries older than the specified
number of days will be deleted.
How to customize the AutoCapture client window

Use the Customize dialog box to customize the AutoCapture client window.
1. On the AutoCapture client toolbar, click the menu button .
2. On the toolbar menu, click Add or Remove Buttons > Customize.
This displays the Customize dialog box.

3. Click one of the four tabs to customize features of the AutoCapture client window.
Tab
Description
Toolbars
Show/hide, add/delete, reset toolbars. See Customize

Toolbars.
Commands
Add menu commands to a toolbar. See Customizing

Commands.
Keyboard
Assign shortcut keys to menu commands. See

Customizing Keyboard Shortcuts.
Options
Personalize display of menus, icons, ScreenTips, and

shortcut keys. See Customizing Window Options.
Customize toolbars
Click the Toolbars tab in the Customize dialog box to create and remove toolbars, or to hide or display toolbars.
Option
Description
Toolbars
This box lists toolbars that can be displayed in the

AutoCapture client window. Select or clear a check box
next to a toolbar display or hide it.
New
Click this button to create a custom toolbar.
In the New Toolbar dialog box, type a name for the

toolbar and click OK.
After you create a custom toolbar, click the Commands

tab to add command buttons.
Rename
Click this button to rename a selected toolbar.
Select a custom toolbar in the Toolbars list, then

click this button to rename it.
You cannot rename the default Menu Bar and Standard

toolbars.
135
Option
Description
Delete
Click this button to delete a selected toolbar.
Select a custom toolbar in the Toolbars list, then

click this button to delete it.
You cannot delete the default Menu Bar and Standard

toolbars.
Reset
Removes changes that have been applied to one of the

default toolbars.
Select either default toolbarMenu Bar or

Standardin the Toolbars list, then click this
button to remove any changes.
Customize commands
Click the Commands tab in the Customize dialog box to add or remove commands on the toolbars.
Option
Description
Categories
Click one of the categories to display commands or

menus in the Commands box. The categories listed here
correspond to commands on one of the menus (File,
View, Options, or Help or All Commands) or menus
(Built-In Menus or New Menu).
Commands
To add a command or menu shown in this box to a

toolbar, drag it to the toolbar. A vertical line appears to
let you position the command or menu on the toolbar.
To remove a command button from a toolbar, click the toolbar button while the Commands tab is selected, and drag
it off of the toolbar to remove it or drag it to another toolbar to position it there.
You can also edit buttons and menu commands by right-clicking a button on a toolbar or a command on a menu and
then clicking a command on the shortcut menu.
Customize keyboard shortcuts
Click the Keyboard tab in the Customize dialog box to assign shortcut keys to commands.
Option
Description
Category
Click one of the menu names in this list to display

commands on that menu in the Commands box.
Commands
Click a command shown in this box to assign a shortcut

key to it.
Key assignments
Displays existing shortcut key assignment for the

command that is currently selected in the Commands
box.
Press new shortcut key
Press a key combination to create a shortcut

key combination. For example, press Ctrl and S
simultaneously on the keyboard to create the "Ctrl+S"
shortcut key combination.
Assign
Click this button to assign the keyboard shortcut shown

in the Press new shortcut key box to the command
136
Option
Description
selected in the Commands box. You can assign more
than one keyboard shortcut to any single command. If
a keyboard shortcut is already assigned to a different
command, you will be prompted whether to reassign the
shortcut.
Remove
Click this button to remove the keyboard shortcut

currently selected in the Key assignments box from the
command that is currently selected in the Commands
box.
Reset All
Click this button to remove all changes to keyboard

shortcuts and leave only the default assignments.
Description
Shows the description for the command that is currently

selected in the Commands box.
Customize window options

Click the Options tab in the Customize dialog box to customize miscellaneous options.
Option
Description
Always show full menus
Select this check box to always show all commands on

the menus. You can clear this check box to only show
commonly used commands.
Show full menus after a short delay
Select this check box to show full menus after a short

delay if the Always show full menus check box is
cleared. Full menus are always displayed if there is no
usage data.
Reset menu and toolbar usage data
Click this button to clear the historical usage data for

menu commands.
Large icons
Select this check box to display large icons on toolbars.

Clear this check box to use small icons.
Show ScreenTips on toolbars
Select or clear this check box to show or hide tooltips

displayed for toolbar commands.
Show shortcut keys in ScreenTips
Select or clear this check box to show or hide shortcut

keys in tooltips displayed for toolbar commands.
Menu
Select a menu animation type in this list box. Choose

from the same menu animation types available in
Microsoft Office Random, Unfold, Slide, Fade, or None.
The System Default selection uses the animation type
currently configured for the operating system.
137
AutoStore Components
Activate Control
Conditional Field overview
Conditional Field enables you to configure workflow components that are activated only if certain conditions are met.
The components that implement Conditional Field have a three-state activation check-box. The three states of the
field are:
Active (checkbox ON)The component is active for all workflow jobs.

Inactive (checkbox OFF)The component is inactive for all workflow jobs.
Conditionally Active (Checkbox CONDITIONAL)The component is active only if the conditional statement is
True.
What is Conditional Field

Complex workflows may require conditional processing of files or meta-data.
The conditional Field provides a flexible way to enable design and implementation of conditional statements that
relate to the job being processed and allows the workflow administrator to create a dynamic processing capability to
control workflow processing based on the job attributes.
To achieve this, the conditional field setting is decided by the outcome of a conditional statement that uses the RRT
values. These values and conditional statements can then by dynamically evaluated per job basis.
Using Conditional Field
Here are sample workflow use cases with conditional Field:
Conditional ActivationThis feature is available within Workflow Tracker to Activate tracking of jobs using the
Workflow Tracker component only on certain type of jobs.
Conditional Field evaluates the defined if statement" prior to invoking the component for a particular job. If the
conditional statement is True then the Check box is turned ON, otherwise the check box is turned OFF.
Usage Guidelines:
Conditional statements consist of two variables and one condition evaluated within one if statement.
The variables are treated as strings when:
= (equal) is used within the "if statement".

!= (not equal) is used within the statement.
Examples of string evaluation of conditional statement:
Checkbox ON, if (1 = 01)Result is False

Checkbox ON, if (01 = 01)Result is True (Component is Activated)
Checkbox ON, if (Invoice = Invoice)Result is True
The variables are treated as integers when:
<= (Smaller or equal) is used

>= (Larger or equal) is used
Examples of integer evaluation of conditional statement:
Checkbox ON, if (1 <= 02 )Result is True
138
Checkbox ON, if (05>= 2 )Result is True

RRT in place of variablesYou can use RRT values to build conditional statements that are driven from the Job
attributes. Each time a job is submitted to the workflow, the conditional execution allows the value of the variable
be set based on the values of RRTs related to that job. Examples of RRT use with Conditional Field are:
Checkbox ON, if (~ACC::%DocumentType%~ = Invoice) is True, if the DocumentType variable value

is Invoice, or invoice.
Checkbox ON, if (~ACC::%DocumentType%~ = ~L1B::<1,1>~) is True, (Component will be
activated), if the DocumentType field matches the first barcode on the first page otherwise the conditional
statement value is False (the component will not be activated)
Note: The string comparison is not case sensitive. In other words "Invoice" and "invoice" and "INVOICE" are
treated the same. The spaces and tabs are trimmed prior to the conditional check. Symbol characters such as * ? /
are treated as literal characters and have no special meaning within the conditional statement.
Alchemy
Welcome to the OpenText Document Server, Alchemy component
OpenText Document Server, Alchemy route and eConnector components provide the full capability for routing
documents with their associated metadata to OpenText Document Server, Alchemy document management system.
This system is used in many organizations for archiving, access, and distribution of fixed content including images
and electronic documents.
The component can be used both as a route component or process (eConnector) component. The eConnector has two
additional options:
Activate check box makes the component active. If this check box is cleared, the component will not perform any
actions during file processing.
Pass-through check box makes documents available to the subsequent components, when selected.
Getting started
Feature highlights
The component provide the following features:
Automatic document routing into OpenText Document Server, Alchemy document management system.
User access control to databases, folders and documents.
Support for properties and fields of documents.
Automatic index update after a document is stored on the server.
How to use the OpenText Document Server, Alchemy component

Use this component to route documents to OpenText Document Server, Alchemy document management system.
This procedure steps through an example of using the component.
1. Create a new workflow with the FRP Poll capture component, the Barcode component, the OCR component and
the OpenText Document Server, Alchemy route component.
2. Configure the capture and process components.
3. Set the metadata of the routed documents on the Fields tab of the OpentText Document Server, Alchemy
component.
4. Start the process.
The FTP Poll capture component polls the scanned documents with a predefined schedule. Then the Barcode
component reads the barcode value out of the cover page while splitting the scanned batch into separate
documents. The OCR converts the scanned documents into searchable PDF. The OpenText
Document Server, Alchemy route component delivers the searchable documents to Alchemy DMS along with the
corresponding metadata.
139
Configuring OpenText Document Server, Alchemy component

The component configuration window has three tabs:
Tab
Description
General
Specify general connection parameters for logging

into OpenText Document Server, Alchemy document
management system on this tab.
Document
On this tab specify the destination folder, title and file

name of the routed document and set the security groups
of the users that will have access to the document.
Fields
Use this tab to assign properties or fields to the routed

documents.
General tab
Specify general connection parameters for logging into OpenText Document Server, Alchemy document management
system on this tab. The configuration properties dialog box is the same for the Alchemy eConnector and Alchemy
components, although some options can only be configured from the Alchemy eConnector component.
Option
Description
Activate
Select this check box to activate the component. If this

box is not checked, the component does not perform
any actions during file processing. This option is only
available in the eConnector component.
Pass-through
Select this check box if you want document to be passed

to the subsequent components in the workflow. This
option is only present in the eConnector component.
Options file
Enter the path to the options file that contains parameters

for connection to the server or select it using the
browse button (...). By default, this file is located in C:
\Documents and Settings\%User%\ Local
Settings\Aplication Data\imr\alchemy\
where %User% is the Windows user name. If this field
is left empty, the currently configured parameters will be
used. You can use RRTs in this field.
Database
Enter the database you want to connect to or click the

browse button (...) to open the Select Database dialog,
which allows you to select a databasefrom all available
databases in Alchemy DMS. You can use RRTs in this
field to determine database dynamically.
Security group
Enter the security group you want to connect to or click

browse button (...) to open the Security Group dialog,
which allows you to select a security group from the list
of security groups for the selected database. You can use
RRTs in this field.
Note: The Security Group dialog will show
the list of security groups only if you are already
connected to a database. For the first time, you
have to enter the security group manually in
order to connect to the database.
140
Option
Description
Group password
Enter a valid password to connect to the selected security

group. This field is only enabled if the Security group is
specified.
Database password
Enter a valid password to connect to the selected

database. This field is disabled if the Security group is
specified.
URL schema
Enter a schema for the simplified URL through which

you can access the file in the Alchemy Web interface.
You can use RRTs in this field. The default value
for the schema is http://~IMR::Server~/
AlchemyWeb/viewitempage.aspx?
Database=~IMR::Database~&ID=~IMR::FileId~.
Rebuild database
Select this check box to make the component update the

index, which is a full-text index resource file containing
every word that was extracted from every document. The
document can be found in the database by searching only
after the index is updated. Without an update of the index
you can only find the document by browsing.
Document tab
On this tab specify the destination folder, title and file name of the routed document and set the security groups of the
users that will have access to the document.
Option
Folder
Description
Select a valid folder for the database specified on the
General tab using the browse button (...). Clicking
the browse button opens the Select Folder dialog box,
which allows you to select a folder from the list of all
folders for the database (see Select Folder).
Note: If this field is left empty, the documents
will be sent to the root folder of the database.
Additional path
Enter the path relative to the folder where documents

will be routed. The value of this field will be added to
the folder to define the destination. If the resulting folder
does not exist, the component will make a request to
Alchemy to create this folder dynamically. You can use
RRTs in this field.
Rename title
Select this check box to set the rename schema for

the title of the document. Enter the title in the box
next to this check box. You can use RRTs in this
field. The default renaming schema for the title is
~IMR::FileName~_~IMR::Counter~~IMR::FileExt~.
Note: If this option is not selected, the file
name of the document will be assigned to the
title.
Rename file
This group allows you to set the filename property of the

document. You may select one option.
141
Option
Description
Rename with document titleSelect this option

if you want to assign the document title to the file
name.
Using this schemaSelect this option to set the
renaming schema for the file name. Enter the file
name in the rename field next to this check box. You
can use one or several available RRTs in this field.
The default renaming schema for the file name is
~IMR::FileName~_~IMR::Timestamp~~IMR::FileExt~
Note: If the Rename with document title option
is OFF and the RRT ~IMR::Title~ is used
in renaming schema for the file name, this RRT
will be replaced by the original file name, since
new name is not given to the file yet. However,
the external RRT ~IMR::Title~ will be
replaced by the resulting file name.
Security groups
This group allows you to specify the security groups of

the users that will have access to the document.
AddClick this button to add a security group using

the Security Group dialog box. Select from the drop
down list of security groups for the selected database.
EditClick this button to edit a selected security
group using the Security Group dialog box. Select
from the drop down list of security groups for the
selected database.
RemoveSelect one or several security groups from
the list and click this button to remove the selected
items from the list.
Select a folder
This dialog box allows you to select a folder for the database selected in the General tab.
Click the Root button to save the document in the root of the database. The following warning message will appear:
Are you sure you do not want to store in a folder, rather the root of the
database?
Click Yes. You will browse to the folder tree.
Fields tab
Use this tab to assign properties or fields to the routed documents.
Option
Description
Add
Click this button to add a new field to the fields list using
the Add a Property dialog box (see Add a Property).
Modify
Click this button to modify the selected field properties

using the Modify a Property dialog box (see Modify a
Property).
Remove
Select one or more fields, and then click this button to

remove the selected fields from the list.
142
Add/Modify a Property dialog box

Use this dialog box to add a property to the document properties list or to modify a selected property.
Option
Description
Property
Enter the name of the property or select it from the drop

down list of the available properties for the selected
database. You can use one or several available RRTs in
this field.
Note: You can specify only the properties that
are in the list. If the entered property name is
not specific to the database, it will be ignored
and the file will be stored without this field.
Value
Enter the property value or select it using the browse

button (...), if it is available. For example, if the selected
property has Data type, the browse button is available
and opens the Select a Date dialog box, which allows
selecting a date from a calendar. You can use RRTs in
this field.
Note: If the field you selected has a predefined
list of values, only a value from this list can be
accepted. If you specify a value that is not in
the list or incorrect, it will not be stored in the
database and a warning message will appear.
Type
This field displays the type of the selected field.
Alchemy component RRTs

Component RRT ID
The RRT ID for this component is IMR.
The following table describes the reserved RTN values for this component.
Name
Description
FileName
The original file name.
FileExt
The original file extension.
Counter
An incremental counter based on the duplicate titles of

the documents found within the destination folder. This
RRT can be only used in the Rename title field on the
Document tab (see Document Tab).
Server
The name or address of the Alchemy IMR server.
Database
The Alchemy database title.
FileID
The identifier of the document sent to the Alchemy

server.
GUID
A global unique identifier (GUID) generated for the each

input file.
Title
The resulting title of the exported document.
143
Name
Description
URL
The URL for access to the document sent to the Alchemy

server. This RRTN is only applicable to the eConnector
component and can be used in subsequent components.
Example usage of the RRTN:

The RRT schema ~IMR::FileName~~IMR::Counter~~IMR::FileExt~, when used in the Rename title
field on the Document tab, is replaced with "MyDocument2.doc" if the original file name is "MyDocument.doc" and
"MyDocument1.doc" file already exists in the destination folder.
This component does not support any FRTN values.
This component supports the Date/Time tag names listed below:
SSRTN
Description
%a
Abbreviated English weekday name (SunSat)
%A
Full English weekday name (SundaySaturday)
%b
Abbreviated English month name (JanDec)
%B
Full English month name (JanuaryDecember)
%d
Day of month as 2-digit decimal number (0131)
%D
Day of month as decimal number (131)
%H
Hour in 24-hour format (0023)
%I
%j
Day of year as decimal number (001366)
%m
Month as decimal number (0112)
%M
Minute as decimal number (0059)
%p
Current locale's A.M./P.M. indicator for 12-hour clock
%S
Second as decimal number (0059)
%U
Week of year as decimal number, with Sunday as first

day of week (0053)
%w
Weekday as decimal number (06; Sunday is 0)
%W
Week of year as decimal number, with Monday as first

day of week (0053)
%y
Year without century, as decimal number (0099)
%Y
Year with century, as decimal number
Timestamp
Composed date time stamp (YYYYMMDDhhmmss)
Example usage of the SSRTN include:
~IMR::%Y~-~IMR::%m~ will be replaced with "2011-02".
144
~IMR::Timestamp~ will be replaced with "20110217163500".
Alchemy Client has to be installed on the machine that is running this component.
The component is certified to work with the server versions 8.2 and 8.3.
Problem description
Solution
If you send two different files with the same names, they There are two ways of solving this problem:
overwrite each other.
1. Select the Rebuild database check box on the
General tab.
2. Use Rename file option on the Document tab to set
the unique file name for each document.
If you connect to the server using the Security group that This is the feature of the Alchemy client: the security
is not Administrator (for example, User), and send the
groups can be set only by administrator. Please use the
files to the server, the Status Monitor gives the following administrator security group to connect to the server.
error message:
Failed to setup security groups (Error
code 0x80070005: Access is denied.)
When you use multiple processes with the component,
some files (near 1% from the total amount) are rejected
and not routed to the Alchemy.
To solve this problem, use the File Options component

in the workflow process and configure it to move the
rejected files to the folder that is used as the input folder
by the OpenText Document Server, Alchemy component.
The rejected files will be routed to the Alchemy after
some time.
Alfresco
Welcome to the Alfresco component
The Alfresco component is used to route documents into Alfresco, an open source enterprise content management
system. The component allows you to set most of the parameters that can be set when you add a new content to the
system via the web interface.
The component can be used both as a process or route component.
Getting started
Features highlights
The primary function of the Alfresco component is to send documents to the Alfresco system.
The Alfresco component includes the following features:
Support for various properties of a document: encoding, content type, document type, title, description, author,
summary.
Rename schema.
Support for categories, tags, and fields.
How to use the Alfresco component

Use this component in your process to route documents into the Alfresco system.
An example of using the component to send documents from an MFP device.
1. Create a new workflow and add a capture component to specify the type of MFP used for scanning.
145
2. Select the desired process components if you need the documents to be processed before routing them to Alfresco.
3. Add the Alfresco component as the route component for the workflow.
4. Configure the connection parameters, the destination and general properties of the documents.
Add any necessary categories, tags and fields for Alfresco on the Attributes tab.
5. Save the configured workflow, and start the process.
After being scanned, a document gets captured and processed. After being processed, the document is routed to
storage on the Alfresco server.
Configuring the Alfresco component
The Alfresco configuration window contains tabs on which you can configure settings for Alfresco.
Tab
Description
General
Set general connection parameters on this tab.
Document
Use this tab to set general attributes of the routed

documents.
Attributes
On this tab you can add categories, tags and fields to the
routed documents.
Aspects
Use this tab to add aspects to the routed documents.
General tab
Set general connection parameters on this tab. The configuration properties dialog box is the same for the Alfresco
eConnector and Alfresco components, although some options can only be configured from the Alfresco eConnector
component.
Option
Activate
Description
Activate the component according to a condition. This
option is only present in the eConnector component.
For more information about conditions, see Conditional
Activation.
Pass through
Select this check box if you want the document to be

passed to the subsequent components in the workflow.
This option is only present in the eConnector component.
Server address
Enter the address of the Alfresco server.

For example, http://server_name:8080/
Alfresco where server_name is the hostname for the
machine running Alfresco..
Ignore invalid certificate
Select this check box to ignore errors when the user

connects to the server using an invalid SSL server
certificate.
If the user does not select this check box and uses an
invalid SSL server certificate, the following message is
displayed:
"The underlying connection was closed:
Could not establish trust relationship
for the SSL/TLS secure channel."
When this option is selected, the error is ignored so that
the user can connect to the server.
146
Option
Description
Note: This check box can be selected only if
you enter an HTTPS server address.
User name
Enter a user name that is authorized to access the server.
Obtain password via RRT
Select this check box if you want to specify the password

via RRTs.
Password
Enter the password for the user name entered in the

field above. This value is only used when the Obtain
password via RRT check box is not selected.
Password RRT
Enter an expression consisting of RRTs that will be

replaced by the actual password at run time. This value
will be only used when the Obtain password via
RRT check box is selected.
Timeout
Specify the connection timeout in seconds.
Note: You can drag and drop the internal RRTs into all options into fields on the General tab, but this will
cause an error. Use of internal RRTs is prohibited in all options on the General tab.
Conditional activation
Use the Activate option in the General options for a component to enable the component. Choose one of the
following states for the Active option to enable or disable the component:
Yes enables the component.

No disables the component.
While a component is disabled it does not perform any actions during file processing.
Enter a custom condition. The condition should be specified in the form of the expression which is interpreted as
common Boolean value: TRUE, YES, ON, 1 or FALSE, NO, OFF, 0.
The expression has C-like syntax and is evaluated based on operators and operands. The expression is caseinsensitive. If you enter invalid condition, the component becomes inactive by default.
Examples of simple expressions:

Expression
Description
YES
The component is always active.
NO
The component is never active.
~CMP::SomeRrt~
The component is active if some component replaces the

RRT ~CMP::SomeRrt~ with one of TRUE, YES, ON,
or 1.
Examples of complex expressions:

Expression
Description
~FRO::PagesNumber~ < 50
The component is active if number of pages in the input

file of the OCR component is less than 50.
"Y" + "e" + "S"
The component is always active, because the result of

this expression is string "YeS". This string is interpreted
as Boolean YES (TRUE).
147
Expression
("~PCF::FileName~" >="a") &
("~PCF::FileName~" < "e")
Description
The component is active if input file name starts from
"a", "b", "c" or "d" (case-sensitive).
Note: When you enter one of the Boolean constants FALSE, NO, OFF, 0, all the options in the component
configuration become disabled. If you enter any other expression which is interpreted as Boolean NO
(FALSE) or as an invalid condition, the component configuration allows you to manipulate the settings, but
the component remains inactive at run time
Expression syntax
The expression syntax is similar to the C language expressions. The main difference is that the expressions operate
with Boolean type, so there is no need to distinguish Boolean and bitwise operators (&& and &, || and |, and so forth).
There are also no assignment operations. The operations priority is the same as in C language.
Complete formal syntax definitions follow:
selector_expression ::logic_expression ? first_expression : second_expression
logic_expression
logic_expression ::logic_expression | logic_expression_and
logic_expression_and
logic_expression_and ::logic_expression_and & logic_expression_cmp
logic_expression_cmp
logic_expression_cmp ::logic_expression_cmp operation_cmp math_expression
math_expression
math_expression ::math_expression operation_add math_expression_mul
math_expression_mul
math_expression_mul ::math_expression_mul operation_mul unary_expression
unary_expression
unary_expression ::unary_operator unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
constant ::integer_constant // regular_expression: [0123456789]+
string_constant
// regular_expression:".*"
148
// case_insensitive:TRUE, FALSE, ON, OFF

// case_insensitive:YES, NO, OFF
identifier ::- [a-zA-Z_][0-9a-zA-Z_]*
boolean_constant
Expression evaluation
Expression evaluation is based on operators and operands. All binary operators take operands of the same type.
The result type of arithmetic operations is the same as the operand type. The result type of comparison and logic
operations is a Boolean value (True or False).
Arithmetic operations
The binary + operator supports integer and string operands. For string operands the resulting string value is a
concatenation of two operands.
The binary operators -, * and / support integer operands.
The unary operators + and - support integer operands. The + operand is complementary to the - operand and does
nothing over its operand. The purpose of the unary + operand is in an expression like the following: (~CMP::rrt~
+ 0). If a component replaces RRT ~CMP::rrt~ with a numeric value, the result of the expression will be the
value. If a component replaces this RRT with an empty string, the expression will be still valid and the result is 0.
The result of an integer arithmetic operation must fit into a 32-bit signed integer, from -2147483648 to 2147483647.
Logic (Boolean) operations
The unary operator ! (NOT) supports a Boolean operand. The resulting Boolean value is the logical negation.
The binary operators & (AND) and | (OR) support Boolean operands only. The resulting Boolean value is a
conjunction (disjunction) of the operands. The operands are evaluated from left to right. If the result of the first
operand of an AND operation is False, then the second operand is not evaluated, and the result of the expression is
False. If the result of the first operand of OR operation is true then the second operand is not evaluated, and the result
of the expression is True.
This means that when an unevaluated operand contains semantic errors, such as a type mismatch or unknown
identifiers, the expression will still be evaluated successfully.
Comparison operations
The binary operators =, ==, and != (not equal) support string, integer and Boolean operands. The = operand is
equivalent to == for integer and Boolean operands. For string operands, the = operator performs a case-insensitive
comparison while the == operator performs a case-sensitive comparison.
The binary operators <=, >=, <, and > support string and integer operands only. These operators perform a casesensitive comparison on strings.
Result type of all of these comparison operators is a Boolean value.
Conditional selection operation
The ternary operator ? takes three operators in the form exp_condition ? exp_result1 :
exp_result2. The exp_condition must return a Boolean value. The two result operands exp_result1 and
exp_result2 can be different types.
If exp_condition evaluates to True, then the operation evaluates exp_result1.

When exp_condition evaluates to False, then the operation returns exp_result2.
Note: This ternary operation is similar to the C language ? : operator, with the difference that this
implementation does not require the two result operands to be the same type.
149
Constants
An integer constant must be decimal numeric value from 0 to 2147483647 (32-bit signed integer). The unary minus
operator - should be used specify a negative integer value from a positive integer constant.
A string constant must begin and end with the double quotes character ". Special characters inside of string body
must be "escaped" with the backslash \ character. The following escape sequences are valid within a string constant:
\" (quote), \\ (backslash), \t (tab), \v (vertical tab), \r (carriage return), \n (new line).
Boolean constant must be one of the following: ON, YES, TRUE for True and OFF, NO, FALSE for False. These
constants are case-insensitive.
Examples:
"YES"Is a string constant.

YESIs a Boolean constant.
"10"Is a string constant
10Is an integer constant.
Expression (10 > 9)Is True.
Expression ("10" > "9")Is False.
Expression ("YES"!= TRUE)Is invalid, because it compares operands of different types (string against
Boolean).
Expression (FALSE == OFF)Is true, because both Boolean constants FALSE and OFF have same Boolean
value False.
Expression (FALSE == 0)Is invalid, because a Boolean is compared against an integer.
Expression (FALSE == ((3 + 4) != 0))Is False.
Identifiers
Only Boolean constants are supported. Other identifiers are undefined. For example, the expression ("ABCD" ==
ABCD) is invalid, since the ABCD identifier is undefined.
Operators
The following operators can be used in the expression syntax (in ascending order of priority):
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Greater than or equal to
Boolean
Integer or string
<=
Less than or equal to
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
1Boolean
2, 3Any
150
Symbol
Description
Result type
Operands type
Multiply
Integer
Integer
Divide
Integer
Integer
Logical NOT (negation)
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Document tab
Use this tab to set general attributes of the routed documents.
Option
Description
Destination
Select or enter a space on the Alfresco server where

the documents will be stored. In Alfresco, a space is a
container for storing and organizing content and other
spaces. The space will be created if doesn't exist. The
root space must be "Company Home", otherwise the
document will be rejected. You can select an existing
space by clicking the browse button (...).
Note: If the destination name contains invalid
characters (/ \ | : < > * ? .), it will not be
created and the documents will not be routed.
Rename file
Select this check box to rename the uploaded file. Enter

the rename scheme into the text field.
The default scheme is
~ALF::FileName~_~ALF::Counter,3~~ALF::FileExt~,
which means that the documents will be renamed as
follows:
Replace invalid characters with "_"
The first document saved to the destination using the

specified file name will be appended by _001. For
example Document_001.doc.
For each subsequent document with the same
name, the count is incremented by 1. For example,
Document_002.doc and Document_003.doc.
Select this check box to replace invalid characters (/

\ | : < > * ? .) in the file names with the underscore
symbol (_).
Note: If you don't select this check box and
the file name contains one of the prohibited
symbols, the file will be rejected.
If file exists
Select the component behavior in case the file already

exists in the destination folder. The following options are
available:
Save input file as new versionThe file will be

saved as the next major version of the existing file.
151
Option
Description
Note: It is not recommended to use this

option with aspects. This situation may lead
to the multiplying of versions.
Overwrite existing fileThe existing file will be
overwritten.
Reject input fileThe file will be rejected and will
no longer pass through the workflow.
Append index number to input file nameAn
index number incremented by 1 will be added to the
file name.
You can use RRTs in this field. The RRT must take one
of the following values:
NEW_VERSIONSave input file as a new version.

OVERWRITEOverwrite existing file.
IGNOREReject input file.
APPEND_INDEXAppend index number to input
file name.
Content type
Select the content type of the uploaded file. If you

select "<AutoDetect>", the content type will be detected
automatically based on the file extension.
Document type
Select the document type.

Note: If the uploaded document already exists
on the server and the Save new file as next
version check box is selected, the document
type of the existing file will be kept.
Title
Enter the title of the document.
Description
Enter the description of the document.
Author
Enter the name of the author of the uploaded file.
Encoding
Enter or select the encoding of the uploaded files. If

the entered encoding does not exist on the server, the
document will be rejected.
Note: For some types of content (like images,
video, or audio) the encoding parameter is
irrelevant.
Summary
Enter the summary for the document. If no summary

is entered, the document will have no "summarizable"
aspect.
Attributes tab
On this tab you can add categories, tags and fields to the routed documents.
This tab contains three sections for managing categories, tags, and fields. Add any of these items by clicking the
corresponding Add button.
152
Option
Description
Categories
Specifies the list of categories that will be added to

the uploaded document. A category can be set using a
Runtime Replacement Tag (RRT). If at runtime an RRT
is replaced with an empty value, the category will be
ignored.
Note: Only those categories can be added
that already exist on the server, if a specified
category doesn't exist, the document will be
rejected.
Tags
Specifies the list of tags that will be assigned to the

routed documents. You can select tags from the list of
tags that are specified on the server, or you can enter tags
either manually or using RRTs. If the value of the tag
defined via RRTs takes and empty value at runtime, the
tag will be ignored.
Note: Only the tags from the list of existing
tags are accepted. If you specify a non-existing
tag, the document will be rejected.
Fields
Fields are a complementary set of properties that depend

on a document type. Fields are configured on the server
by the administrator. A field can be configured to have
a predefined set of values. If a selection is not made
from the predefined set of values, the document will be
rejected and a warning message will be written to the
log. The Add button opens the Add Field dialog box,
in which you can define a field and specify its values.
Required fields are marked with *.
Tip: Required fields are not actually
mandatory. If a required field is not set or is
empty, the document will still be routed and a
warning message will be written to the log. The
date, date/time, float and double values should
be entered in the format defined by the system
locale.
Aspects tab
Use this tab to add aspects to the routed documents.
Option
Description
Available Aspects
This scroll box contains a list of available aspects on the

server.
Selected Aspects
A list of selected aspects.
Activate
This element shows whether the aspect is activated

or not. It the selected aspect is not activated, then its
properties will be ignored at run time.
Add >>
Select an aspect in the Available Aspects scroll box and

click this button to add it into Selected Aspects list. By
default, the newly selected aspects have "Yes" value in
the Activate column.
153
Option
Description
Note: There is no restricted number of aspects
that can be added to a routed document, but
every aspect can be added only one time.
<< Remove
Select an aspect in the Selected Aspects scroll box

and click this button to move it back to the Available
Aspects list.
Ignore invalid properties
Check this box if you want the component to ignore the

invalid values of the aspect fields. If this check box is not
selected and the specified property of aspect has invalid
value, then at run time the component will behave as
follows:
The document will be uploaded to the server with the

properties specified before verifying aspects as well
as some aspect properties already verified.
At the same time, the component will reject a
document from the workflow and write an error
message into the log.
Functionality of Ignore invalid properties check box is

only applicable for the complex property types: content,
qname, category, noderef, period, childassociation,
encrypted, assocref, childassocref. Properties of other
types will not be ignored.
This functionality is not applicable for the required
properties and simple property types (for example,
int, boolean, float, double, date). If such types have
invalid values, documents will be rejected and will not
be uploaded into the server.
Aspect Settings dialog box
Configure the aspect properties in this dialog box.
Option
Description
Name
This text field contains the name of the aspect.
Activate
Activate the aspect in this combo box. If the aspect is not

activated, then its properties will be ignored at run time
and it will not be added to the routed documents.
Note: You can use RRTs in this combo box.
They should be replaced only with "Yes" value;
otherwise, the aspect will be inactive.
Edit
Select the property in the table and click this button to

enter or edit its value in the Property dialog box.
List of aspect properties

Element
Property
Description
A name of the property.
154
Element
Description
Required
An element that shows if this property is mandatory or

not.
Type
A type of the property. This defines what kind of value

the property requires.
Value
A value of the property. Double click the property in

order to enter the value in the open Property dialog.
Property dialog box

Use this dialog box to enter/edit the value of the selected property of aspect.
Option
Description
Name
A name of the property being edited. This field is not

editable.
Type
A type of the property. The type of properties defines

what kind of values the property requires. This field is
not editable.
Value
Enter the value of the property.
Alfresco component RRTs

Component RRT ID
The RRT ID for this component is ALF.
RRTN
Description
FileName
The original name of the file.
FileExt
The original extension of the file.
Counter,3
An automatically generated number that provides the

uniqueness of the file name when used in the rename
scheme.
The value 3 indicates the number of digit positions
that will be used for the counter. For example,
~ALF::Counter,3~ will be replaced with 001. You
can change the number "3" to any other number from 1
to 99.
GUID
A unique identifier.
URL,*
The URL of the uploaded file, where * is the index of

the uploaded file. This RRT can be only used in the
subsequent components in the process.
URL
The URL of the uploaded files. If the component

receives the batch of several documents, this RRT
represents the string containing URLs of all uploaded
155
RRTN
Description
files separated by semicolon. This RRT can be only used
in the subsequent components in the process.
FinalName,*
The final name of the uploaded file, where * represents

the index of the uploaded file. This RRT can only be
used in the subsequent components in the process.
FilesCount
The number of the uploaded files. This RRT can only be

Special Set Replacement Tag Names(SSRTN)

Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
Current locales A.M./P.M. indicator for 12-hour clock
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
And example for the above SSRTN:

~DBR::%Y~-~DBR::%m~ will be replaced by 2011-02.
The component supports the Alfresco server version 4.0.0.

The component cannot create files or folders which have names that are more than 100 characters in length.
Alfresco and Workflow servers should be on separate machines, if they are used in a high document volume
environment, in order to avoid the processor overload. The Alfresco server uses Tomcat that overloads the
156
processor by itself, while processing work; when you run the workflow server on the same machine this slows
down work and overloads the processor.
The components does not support entering multi values for aspects properties.
Some properties can be added to a document twice: through the text fields or boxes on the Document tab (for
example, Summary, Author) and on the Attributes tab (Categories and Tags), or through the special aspects on
Aspects Tab. At the case when the same property is specified twice, the component behavior is as follows: it reads
all specified values, but applies only those ones which were specified as aspect properties. For example, if you
specify a category in the categories field on the Attributes tab as simple, and then specify a property value for the
Classifiable aspect (that is of the same meaning as categories) as complex, then the complex value will be applied
to a routed document and will appear as category on the server. Note, that if you specify the invalid value for the
aspect, then the component will use the value, specified in the text field on the Document or Attributes tab. In the
previous example there is the following possible situation: if the complex category does not exist on the server,
then the component will use the simple as category.
Problem
When the component routes documents, the following
error message appears:
"Could not upload file"
Solution
This error appears when the component routes
documents with the high frequency to a folder with
more than 1000 files. This can happen if the existing
file was just added, and the full-text search engine did
not have enough time to index this file, thus making the
component unable to find the file by name.
To avoid this problem, increase the time interval at
which the task runs.
The component fails to connect to the server with the

following error messages:
"WSE910"
"The timestamp could not be validated"
This happens in instances where the system time

between the machine where workflow server is installed
and the machine where Alfresco is installed differs by
more than 5 minutes.
If the system time for the workflow server is ahead of
the system time for Alfresco, the following message
is displayed: "WSE910: An error happened during
the processing of a response message, and you can
find the error in the inner exception. You can also find
the response message in the Response property." If
the system time for the workflow server is behind the
system time for Alfresco, the following message is
displayed: "WSDoAllReceiver: The timestamp could not
be validated" or "WSDoAllReceiver: security processing
failed".
To avoid this problem, synchronize the time on server
and component: when the difference in time is less than
5 minutes, the problem will disappear.
When using the component the following error message

appears: Query failed
This error may appear in various occasions; for example,

when you try to configure the server settings, or when
the component tries to route a document into the server.
This happens because of the server error and does not
depend on the component itself.
To try to solve this problem, make the following
configuration of the processor designer task:
157
Problem
Solution
1. Click the right mouse button on the processor
designer task and select Properties.
2. Select the Retry check box in the If the task fails
section on the General tab.
3. Increase the number of times the current task will be
done if it fails (set to 2 or more times).
4. Click OK to save the configuration.
ApplicationXtender Component
Welcome to ApplicationXtender component
The purpose of this component is to store documents into Documentum ApplicationXtender, a content management
software package that brings large amounts of data online in a cost-effective manner.
ApplicationXtender has robust and comprehensive security to protect sensitive business information. Access to
information within applications can be limited, which can further protect confidential information. In addition, user
privilege security is provided so that users can be restricted from performing specific functions.
ApplicationXtender provides comprehensive electronic file management capabilities and supports a wide range of
electronic content, which provides users of this component the opportunity to use content creatively and flexibly to
enhance core business activities.
Getting started
Feature highlights
The following is a list of features that this component provides:
Secure your user name and password.

Select an application that you will store the documents into.
Set the Title/Subject/Author/Keywords/Comments associated with your documents.
Place the document into a queue for further processing.
Set the Field Values of the application that you selected.
This component is mostly used with the Digital Sender or Poll Directory capture components. Capture the files using
a capture component and then process them through the ApplicationXtender component.
This component can process any file type such as TIFF, BMP, RTF, PDF, HTML.
Using the ApplicationXtender component
Digital Sender device captures content data once and routes it to SharePoint Portal Server
- Create your process with Digital Sender capture component. Use the application Xtender process component to
manipulate the captured data within ApplicationXtender repository, and save the data to SharePoint Server. This
process provides a uniform capture capability across the enterprise and storage to the desired application/media.
Licensing the Application Extender component
Three types of licenses are available for this component:
Evaluation
Licensed
Expired
158
Configuring the ApplicationXtender component

General tab
In order to manage a document file using ApplicationXtender, you have to first enter a valid DSN, username and
password.
Option
Description
DSN
Enter the Data Source Name to which you would like to

connect.
User name
Enter a user name that is appropriate for the selected data

source.
If the Application Xtender system is using the Windows
NT security provider, you must precede the user name
with a domain and a slash. For example, documentation
\rfrost indicates rfrost is a user on the documentation
domain.
Password
Enter the password that coincides with the user name

that you entered.
Application
An application is the highest level of organization in

ApplicationXtender. Use application for storing and
retrieving documents.
Every time you store a document in an application,
you must enter index information for that particular
document into the index fields. The ApplicationXtender
component stores the index information in a database so
that you can search it later to retrieve documents.
Batch
When enabled, documents are held until further

processing begins. Documents can be scanned
immediately but processed at a later time.
If this option is selected, Name and Memo attributes do
not need to be entered. If Name is not entered, a unique
identifier will be generated and used. Using the same
Name will append additional scanned documents.
Pass-through
This option is available on the ApplicationXtender

eConnector (process) component.
If enabled, the documents are passed on to the next
component in the process.
Attributes tab
If your ApplicationXtender workstation has been configured to allow searching by ODMA attributes, you can search
for documents by title, subject, author, keywords, comments, and the user name under which the document was
created.
Use the Attributes tab to set the values for:
Title
Subject
Author
159
Keywords
Comments
When Batch is selected, the following attributes may be entered:

Name
Memo
Option
Description
Title
Enter the title of the document.
Subject
Enter the subject of the document.
Author
Enter the author of the document.
Keywords
Enter the keywords for the document. Make sure the

keywords are separated by a comma.
Comments
Enter the comments for the document.
Queue tab
A document can be placed into a queue for further processing. The processing queues are used for batch OCR, fulltext indexing, and printing.
Option
Description
Submit document to queue
Select whether or not a document should be placed into a

queue. If you decide to place the document into a queue,
you need to provide a queue name.
Queue Name
Select the name of the queue that you would like

to place the document into, after storing it into
ApplicationXtender.
Description
Enter a description for the job in which the document

will be submitted to a specified queue.
Field Values tab

When a document is added to an ApplicationXtender application, enter data for each of the index fields in the
application. Each index field defined will be used to hold descriptive information about the documents stored in the
application.
Option
Description
Field
Enter the field name.
Type
Enter the field type. The field type should be a valid

type, such as Text, Integer, Date, or Boolean.
Required
Enter whether or not the field is required. Four possible

situations exist:
Yesa value must be entered.

Yes (Data Ref.)A value may be entered. If
the field references a key within the AppXtender
application, and the value entered for the field
160
Option
Description
Value
matches a value found in that key, then associated

fields will be automatically populated with data that
is referenced by that key. If the field references a
key within the AppXtender application and the value
entered for the field does NOT match a value within
that key, then the job request will fail.
No (Data Ref.)A value does not have to be
entered.
NoA value does not have to be entered.
Enter the value of the field.
For more information, refer to AppXtender Application Generator documentation.

ApplicationXtender component RRTs
The ApplicationXtender route component does not generate a RRT.
Component RRT ID
The RRT ID for ApplicationXtender process component is APX.
Name
Description
ID
Identifier of the document stored in ApplicationXtender.
The RRT ~APX::ID~ replaces the identifier value referring to a particular document stored in ApplicationXtender.
Example
Consider a workflow process with the MFP component as the capture component, followed by the
ApplicationXtender process component and the Send to Mail Recipient route component. In the Send to Mail
Recipient component, place ~APX::ID~ as the subject of the email.
This workflow sends email to the designated recipient with the ID of the document just stored into
ApplicationXtender as its subject. This email and all other emails sent from this process can later be used as an
inventory of sorts, of the documents successfully stored into ApplicationXtender. Later, if you want to reference the
document, you can search ApplicationXtender for the document with this specific ID.
Problem Description
Solution
No applications appear in the Application field dropdown list.
Make sure the user name and password are valid. Also,
make sure that in the Application Generator, you created
an application with corresponding user rights.
An error message pops up that you have to enter a value

for all required fields.
Make sure that all fields that have the value YES under
required has a field value.
This component is compatible with ApplicationXtender Version 5.x and 6.x.
161
Autonomy WorkSite
Welcome to Autonomy WorkSite component
Autonomy WorkSite is a Document Management System that offers out-of-the-box, tight integration with popular
Windows applications such as Microsoft Office, WordPerfect, Microsoft Outlook, Lotus Notes and Novell
GroupWise. Users can create a new document, open an existing document, save a document as a new version, change
profile information and perform many other document management functions all without ever leaving their
familiar application interface.
The Autonomy WorkSite Route and eConnector components allow organizations to further take advantage of their
Autonomy WorkSite Systems, by sending documents directly from different sources such as Digital Senders, Multifunctional devices, Scanners or a POP3 Email account into Autonomy WorkSite, offering enough flexibility to layout
this process in a manner that adjusts to the business rules of the organization.
The only difference between the Autonomy WorkSite Route and eConnector components is that the Autonomy
WorkSite Route component solely stores the files and doesn't pass the files on, as it is the last component in the
process. The Autonomy WorkSite eConnector passes the files to the next component in the process.
This component supports Autonomy WorkSite server versions 8.5 and 9.
Getting started
Feature Highlights
The Autonomy WorkSite component allows you to store a document and all the profile information associated
with it, such as Name, Description, Comments, Security, Type, Class, Author, Operator and custom profile
fields that are particular to the WorkSite implementation such as Client and Matter.
This component will also allow you to specify Users and Groups that will have access to the document, as well as
level of access they will have.
Use this component to import any kind of document into Autonomy WorkSite, as long as you set up valid Type
and Class associations for all the documents.
Using Autonomy WorkSite

Use the Autonomy WorkSite component to extend the capabilities of an Autonomy WorkSite system and provide
users with alternate means to store documents. This component, when used in combination with other Capture and
Process components will allow an organization to implement very complex work flows, either involving interactive
participation of the users or unattended environment.
Use SMTP Capture component with Autonomy WorkSite Route component in a workflow scenario where users email
documents to a general-purpose Public folder in Autonomy WorkSite. Assume the business process is that we are
only interested in knowing who sent the document along with a brief description of the document. The following
provides a step-by-step description of what need to take place:
1. An email, with a document attached and a Subject of "Transactions" and a Body of "Transactions from the past
month", is captured through the SMTP Gateway that was configured in the SMTP Capture component.
2. SMTP Capture captures the email and proceeds to detach the document and create Runtime Replacement tags
based on the email headers that can be used by Autonomy WorkSite.
3. The system will proceed to route the document to Autonomy WorkSite component.
The administrator has configured Autonomy WorkSite with fixed values for each one of the required parameters,
except for the Author field, Document Description and Document Comments. Instead of using fixed values,
RRTs from the SMTP capture component are used. Specifically:
~SMP::From~ (representing the From field of the captured email) will be assigned to the Author.
~SMP::Body~ (representing the message body of the captured email) will be assigned to the Comments.
~SMP::Subject~ (representing the subject of the captured email) will be assigned to the document
Description.
162
Configuring Autonomy WorkSite

General tab
Enter the server and access attributes in this tab.
Option
Description
Activate
Activate the component according to a condition

entered in this combo box. (For more information, see
Conditional Activation ).
Pass through
Select this check box to pass documents to subsequent

components in your process.
This option is only available with the eConnector
component.
Server
Enter the name of the WorkSite server for the

connection.
User Name
Enter the user name used for logging on to the WorkSite

server.

via RRTs.
Password
Enter the password that is associated with the user name.
Password RRT

will be only used in case of Obtain password via RRT
check box is selected.
Timeout
Specify the connection timeout in seconds. The default

value is 100 seconds.
Database
Enter the name of an existing database on the server.

You can click the browse button (...) to browse for
a database after you specify a valid Server and user
credentials.


Expression
Description
YES
NO
163
Expression
Description
or 1.
~CMP::SomeRrt~

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
164
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
boolean_constant // case_insensitive:TRUE, FALSE, ON, OFF
165


Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
1Boolean
2, 3Any
166
Symbol
Description
Result type
Operands type
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Destination tab
Enter the destination folder attributes in this tab. You can either browse for the destination folder or manually specify
the destination folder attributes.
Option
Description
Import new document to folder
Select this option if you want to upload a new document

to the server.
Existing element ID
Specify the unique element identifier number that will be

used for document storage. You can select the destination
element (workspace, tab or document folder) from the
element tree using the browse button (...).
Note:
When you specify the element ID manually,
you can click Refresh info to update the
Element type and Element path information;
the Destination elements text boxes will be
updated if they exist for the specified element.
Selecting existing element from the element tree
updates the Element type and Element path
automatically; the Destination elements text
boxes will be updated as follows:
If the selected element is a workspace,

then the Workspace field will contain this
workspace name; the Tab field is blank.
If the selected element is a tab, then the
Tab field will contain this tab name; the
Workspace field is empty.
If the selected element is a folder, then all
the fields are empty.
167
Option
Element type
Description
The type of the specified element. There are three types
possible:
Workspace. It can contain any number of Tabs and

Document folders.
Tab. It can contain any number of Document folders.
Document folder. It can contain only documents and
folders.
Note: This field is not editable.
Element path
The path to the specified element on the server.

Note: This field is not editable.
Refresh info
Click this button to update the information in the

Element type and Element path text boxes after manual
specifying the Existing element ID. The Workspace
and Tab text boxes will be updated only if they exist for
the specified existing element.
Destination elements
The text boxes of this group contain information about

the destination folder.
Workplace
This text box contains the workspace name where you

will store the routed documents. It is enabled only when
Existing element ID text box is left blank.
Tab
This text box contains the tab name where you will
store the routed documents. If the tab name exists for
the specified element ID or if the specified element ID
represents a folder existing in a workspace, then this text
box is disabled; otherwise, you can create a new tab by
specifying the desired name in this text box. You can
also specify the existing tab name in this field.
Folder path
Enter the destination folder path in this text box. You

cannot use the "\" symbol in the folder names, because it
is used by the component as a path delimiter.
Note: For a proper search of the destination
folder you can only fill out the Folder path text
box, if it is known.
Set folder properties
Click this button to set properties for the folder that will
be created at run time. For more information, see Folder
Properties Dialog Box.
Update existing document
Select this option if you want to update the existing

document.
Document ID
Specify the document ID of the already existing

document, where you want to send your documents.
You can specify the document ID manually, or click the
browse button (...) and navigate to the desired document
in the database.
168
Option
Description
Use versioning
Select this check box to enable document versioning,

which increments the version number each time a
document is replaced.
Folder Properties dialog box

Use this dialog box to set properties for folders that will be created at run time.
Folder properties can only be set for folders that have not yet been created. To open this dialog box, click the Set
Properties button on the Destination tab of the Autonomy WorkSite component configuration dialog box.
Option
Description
Description
Enter a description for the folder if the folder does not

yet exist.
Inherit folder's profile information fields from parent If a folder is a subfolder of another folder, then checking
folder
this box will copy the parent folder's fields onto this new
folder. This will only happen if a parent folder exists.
Note: A document/folder can have several
parent folders; therefore, it will inherit the
properties from the first found parent folder on
the server.
Profile Information for Document Folder
Select the profile fields you wish to set for the folder.
Name is the property field name.

Value is the value associated with the Name.
For some names, a list of values are specified in the

database, and the Value setting is then limited to the
database values. You can choose from those values after
you provide a name click the browse button (...) next
to the Value box. If you then enter a value that is not
associated with the name, the component will display an
error message when it tries to create the folder. You can
enter any Value when the Name entry is not associated
with a lookup list.
The lookup option for the Name is only available when
Server, User Name, Password and Database are all
specified on the General tab. The lookup option for
the value is only available when Server, User Name,
Password and Database are all specified on the General
tab and a valid property field Name has been specified in
this dialog box.
Note: The custom21custom24 fields can
only accept a date value, as these fields have
been specifically designated as date fields
within Autonomy WorkSite. The custom25
custom28 fields can only accept a Boolean
(True or False) value, as these fields have been
specifically designated as Boolean fields within
Autonomy WorkSite.
Note: If the Inherit Folder's Profile Information Fields from Parent Folder check box is selected and
the fields are specified in the profile information field list, then the folder will first inherit the parent folder's
169
fields and then set the fields given in the list. Any fields in the profile information field list will therefore
overwrite the folder's fields if they were inherited.
Document tab
Enter the document attributes in this tab.
Option
Description
Rename
Select this check box to rename the document. Enter the

name in the box. You can use RRTs to define a name.
Type
Click the browse button (...) to locate the desired

extension type for the file. You can look up the available
application extensions by providing the Server name,
User name, Password, and Database on the General
tab.
The type must be a valid extension that is set up under
Type in the WorkSite Database Management.
Class
Click the browse button (...) to locate the desired class

for the file. You can look up the available classes by
providing the Server name, User name, Password, and
Database on the General tab.
Classes are custom-defined categories for identifying and
differentiating documents in the database. This must be
a valid/existing Class that was created in the WorkSite
Database Management.
Subclass
Click the browse button (...) to locate the desired

subclass or the selected Class.
Note: A subclass may or may not be required
depending on the Class that you entered. This
should be checked for in the WorkSite Database
Management.
Operator
Enter the name of an existing user which will be marked

as the operator on all documents that will be stored.
You can click the browse button (...) to browse for an
operator after you specify a valid Server, User Name,
Password, and Database on the General tab.
Author

as the Author on all documents that will be stored.
author after you specify a valid Server, User Name,
Password, and Database on the General tab.
Description
Enter a description to be assigned to the documents.
Comment
Enter comments to be given to the documents.
Keep checked out
Select this check box if you want to keep the uploaded

documents checked out on the server.
Set advanced properties
Click this button to set properties for the documents. For

more information, see Document Properties dialog box.
170
Document Properties dialog box

Use this dialog box to set security options and Profile information fields for a document.
Option
Description
Inherit security from parent folder
Select this check box to allow the document to inherit the

parent folder's security settings.
the server.
Shared as
Set the level for sharing the document as Private, Public

or View.
PrivateSelect to have only specified users view

the document.
PublicSelect to have all users access and modify
the document.
View Select to have users see the document but
not modify the document.
Note: When Inherit security from parent
folder check box is selected, this field is
disabled.
Document Security table
Specifies users and groups and sets permissions to access

documents.
The following permissions may be assigned to a user or
group:
Add
No AccessUser cannot access a document.

ReadUser can view or read a document.
Read/WriteUser can read and write to a
document.
Full AccessUser can read, write, and remove a
document.
Click this button to add a new entry into the table. You
can add a Group or a User by selecting them in the list:
GroupIn the Group Access dialog box, click

the browse button (...) to locate the group names and
specify the document access level you want to grant
to groups.
UserIn the User Access dialog box, click the
browse button (...) to locate user names and specify
the document access level you want to grant to users.
Edit
Select a user or a group in the list and click this button to

edit their permissions to access documents in the opened
User Access or Group Access dialog boxes respectively.
Remove
Click this button to remove a selected user or group from

the list.
Profile Information Fields for Document
Setup and modify Field information for the document.
171
Option
Description
with a lookup list.
this dialog box.
Note: The custom21custom24 fields can
only accept a date value, as these fields have
been specifically designated as date fields
within Autonomy WorkSite. The custom25
custom28 fields can only accept a Boolean
(True or False) value, as these fields have been
Autonomy WorkSite.
Inherit profile information fields from parent folder
Check this option to allow the document to inherit the

folder's field values.
the server.
Add
Click this button to add a new field into the list. In the
Custom Field click the browse button (...) to look up
the fields that have been set up in the WorkSite Database
Manager.
Note: When adding fields, an exclamation
mark on the left of the field indicates that the
field is mandatory. If a document requires
a field and the field is not entered, then the
document will not be stored.
Edit
Select a field in the list and click this button to edit its
settings.
Remove
Select a field in the list and click this button to remove it

from the component configuration.
Component RRTs
Component RRT ID
The RRT ID for this component is IM8.
172

Name
Description
Internal RRTNs
Document Name
The original document name value (without extension).
Document Extension
The original document extension.
Document Counter
An incremental counter based on the duplicate file names

found within a directory. The counter concatenated with
a name provides a unique file name.
Full Document Name
The original document name (with extension).

External RRTNs
Folder Id
The unique ID associated with the Document Folder

Worksite where the document is imported to.
File Id
The ID of the document that is imported into the

Autonomy WorkSite database
Name
The name of the document that is imported into the

File Extension
The extension of the document that is imported into the

Autonomy WorkSite database.
Class
The class associated with the document that is imported

into Autonomy Worksite database.
Subclass
The subclass associated with the document that is

imported into the Autonomy WorkSite database
File Description
The description of the document that is imported into the

File Comment
The comments of the document that is imported into the

File Size
The size of the document that is imported into the

File Version
The version of the document placed into the Autonomy

WorkSite database. If the document is being created for
the first time, the version will always be 1. However,
if the document is being replaced and versioning is
enabled, then the new version will be 1 version higher
than the original.
CUSTOM1
The Custom1 Profile field associated with the document

that is imported into the Autonomy WorkSite database.
CUSTOM2
The Custom2Profile field associated with the document

CUSTOM3

CUSTOM4

173
Name
Description
CUSTOM5

CUSTOM6

CUSTOM7

CUSTOM8

CUSTOM9

CUSTOM10
The Custom10 Profile field associated with the

document that is imported into the Autonomy WorkSite
database.
CUSTOM11

CUSTOM12

database.
CUSTOM13

database.
CUSTOM14

database.
CUSTOM15

database.
CUSTOM16

database.
CUSTOM17

database.
CUSTOM18

database.
CUSTOM19

database.
CUSTOM20

database.
CUSTOM21

database.
174
Name
Description
CUSTOM22

database.
CUSTOM23

database.
CUSTOM24

database.
CUSTOM25

database.
CUSTOM26

database.
CUSTOM27

database.
CUSTOM28

database.
CUSTOM29

database.
CUSTOM30

database.
Day Created
The day the document is imported into the Autonomy

WorkSite database.
Day Of Week Created
The day of week the document is imported into the

Autonomy WorkSite database.
Day Of Year Created
The day of year the document is imported into the

Hour Created
The hour of the day the document is imported into the

Minute Created
The minute of the hour the document is imported into the

Month Created
The month of the year the document is imported into the

Year Created
The year the document is imported into the Autonomy

WorkSite database.
Operator Name
The name of the Operator that is configured to import

documents into the Autonomy WorkSite database
175
Name
Description
Operator Domain
The domain of the Operator that is configured to import

Operator Email
The email address of the Operator that is configured to

import documents into the Autonomy WorkSite database.
Operator Phone
The phone number of the Operator that is configured to

Operator Extension
The extension of the Operator that is configured to

Operator Fax
The fax number of the Operator that is configured to

Operator Location
The location of the Operator that is configured to import

Author Name
The name of the Author that is configured to import

Author Domain
The domain of the Author that is configured to import

Author Email
The email address of the Author that is configured to

Author Phone
The phone number of the Author that is configured to

Author Extension
The extension of the Author that is configured to import

documents into the Autonomy WorkSite database.
Author Fax
The fax number of the Author that is configured to

Author Location
The location of the Author that is configured to import

The following example provides some sample usage:

~IM8::FileName~ is replaced with the value Accounting if the original file name was Accounting.
This component does not any FRTNs.
Special Set Replacement Tag Names(SSRTN)
Name
Description
%a
%A
%b
%B
%d
176
Name
Description
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
And example for the above SSRTN:

~IM8::%Y~-~IM8::%m~ will be replaced by 2014-03.
The component supports Autonomy WorkSite server versions 8.5 and 9.
Problem Description
Solution
Autonomy WorkSite Error (Document profile is invalid.

The field is invalid: ______ ).
Check that an invalid field value was not given for the
associated Field Name. Several of the fields are customdefined categories that have a table associated with a
field of document profile information. Document profile
information fields are configured as lookup fields, which
means that the only information users can enter in these
fields comes from their associated tables.
In addition, The Client/Matter and Practice/Subpractice
tables are special custom tables that allow further
creation of custom categories by which users can identify
and differentiate documents in the databases. The Client/
Matter and Practice/Subpractice tables are distinct from
the other custom tables in one important way: each item
listed in the Client and Practice tables is the parent of a
unique set of Matter or Subpractice table entries. When
a user makes a selection in the Client or Practice fields,
the user should select only the choices available for the
Matter and Subpractice fields that are associated with
the Client or Practice that the user has selected. Refer to
the setup of these tables within the WorkSite Database
Manager.
177
AutoSafe
Welcome to AutoSafe
Use AutoSafe to decrypt encrypted files. Run AutoSafe to decrypt files that have been previously encrypted and have
a .cry extension.
Getting started
Feature highlights
Decrypt secured files to their normal format.

Support for the following decryption algorithms:
ECB
RC2
RC4
Using AutoSafe
Use AutoSafe to decrypt your encrypted files. For files to be correctly decrypted, the files must have been encrypted
using one of the supported encryption algorithms, with a static encryption key.
Note: To decrypt a file, it is expected that the input stream is encrypted (all files must end with .cry
extension and be encrypted). AutoSafe does not support a mix of secured and unsecured files in a single
process.
The following are common uses of AutoSafe:
Apply AutoSafe to decrypt files that have been archived as encrypted files.
Transfer secured encrypted files to an ftp server and apply AutoSafe to decrypt the file combined with Encryption
component.
Warning: If encryption keys are lost, the data cannot be opened by any means. It is critical to maintain a
thorough and secure track of encryption keys. The decryption algorithm must match the encryption algorithm.
AutoSafe options
The AutoSafe dialog box appears when you run AutoSafe and specifies options for decrypting a file.
AutoSafe decryption options
Option
Encrypted File
Description
Specifies the full path to the encrypted file. You can click
to browse for the file.
The encrypted file must have a .cry extension. For
example if the original file is abc.pfd, the encrypted
file name must be named abc.pdf.cry.
Decrypted Folder
Specifies the location to store the decrypted file. You can

click
to browse for the folder.
If the encrypted file is abc.pdf.cry, AutoSafe

decrypts he file back to abc.pdf in this location.
Algorithm
Specifies the encryption algorithm to use for the

decryption. AutoSafe supports the following symmetric
encryption algorithms:
ECB
178
Option
Description
RC2
RC4
Note: All files must have the same encryption
key and encryption algorithm. Currently support
for variable encryption methods, or variable
encryption keys is not available with AutoSafe.
Key
Specifies ASCII character string that is used to encrypt

or decrypt the files. The decryption key must match the
encryption key for a file.
Reenter Key
Repeat the encryption key to prevent typing errors.
Key File
Specifies the complete path to a key file. You can click

to browse for the file.
You can use any file or any file type as a key file
for encryption and decryption. The file content
during decryption must match the file content during
encryption.
Only the defined encryption algorithms are certified for use.

If you are planning to apply AutoSafe for decryption, use of Rename File option with your workflow component
is not recommended.
Problem Description
The .cry files are not properly decrypted.
Solution
Check that the decryption method matches the

encryption method.
Check that the decryption key or key file matches the
encryption key or key file.
Barcode
Welcome to the Barcode component
Barcode process component is used to read 1-dimensional and 2-dimensional barcodes from image files. The data
read from barcodes is used by subsequent components within the configuration and can serve as document splitting
criteria. The values read from barcodes may also be mapped into fields that can be automatically used by subsequent
components.
The most common input types are black-and-white raster images generated from a scanning device.
Barcode uses LeadTools technologies as the base for barcode detection.
Getting started
Feature highlights
This component offers the following features:
Recognitions of 1-dimensional and 2-dimensional barcodes from image files. Autodetection of barcode type and
direction.
179
Enhanced barcode detection by applying a number of preprocessing methods to low-quality images.

Zoned recognition allows narrowing the search area to increase performance. Also you can configure the options
specifically for every zone: specify pages, validation criteria, mandatory presence of a single barcode. Barcodes
found within a zone can be added to a named set to retrieve their values through a special type of RRTs.
Support for custom fields that are passed to the subsequent components as RRTs.
Support for PDF processing-related settings for output documents such as PDF color and compression and PDF
rasterization quality.
Splitting the original document into several documents on a barcode whose value matches a specified criterion.
The supported validation methods: wildcards, regular expressions, external scripts.
How to use the Barcode component

The Barcode component is used as part of business processes that rely on barcode cover sheets or barcode information
in document content.
The Barcode component is used to process barcodes in captured documents. For example, Barcode is often used to
read the invoice number in an invoice document. Another common use of this component is to decrease the time
required to scan large number of documents. Scanned images can be split into several files when a barcode satisfying
a defined pattern is found. Barcode component can also be used to read the values of barcodes and then store such
information together with the document in one of the supported Document management systems.
The following example describes how to use the Barcode component in a hypothetical workflow. Scan documents
from a variety of MFP devices, split the scanned batch into separate documents and send the documents into a
specified folder
1. Design a workflow process with an MFP component for scanning of the documents, Barcode as a process
component, and Send to Folder as a route component.
2. Activate the Barcode component.
3. On the General tab, select the Page Split option and define a pattern for splitting pages.
4. On the Field Values tab, specify fields for the output files as the value of the barcode on a cover page.
5. Pass the field value as RRT for the Send to Folder component that will use it in the document rename schema.
When the walk-up MFP user enters a preconfigured function key on the control panel of the MFP device, the image
document with the corresponding title as a name is routed directly into the specified folder.
Configuring the Barcode component
The Barcode component configuration window has three tabs: General, Field Values, and Advanced.
General tab
Configure the general Barcode processing attributes on this tab.
Barcode
Option
Description
Activate
Select this check box to activate the Barcode component

in a workflow.
Maximum number of barcodes on a page or a zone
Specify the maximum number of barcodes that the

component should try to read from a page. Set this value
to 0 if you want the component to look for all barcodes
in a page or a zone. Specifying a maximum number
of barcodes can improve the performance since the
component will stop searching the page for barcodes
once it has read the maximum number of barcodes
specified.
Minimum barcode length
Enter the minimum number of characters in the barcode.

The component will skip the barcodes whose length is
180
Option
Description
less than the specified minimum length. By default, the
value of this field is 4.
Type
Specify the barcode type that is going to be read from the

image. If you are not sure about the barcode types on the
images, select one of the auto detection modes and the
component will recognize any of the supported barcodes:
AutodetectAuto detection of any barcode type.

Autodetect 1D barcodeAuto detection of 1D
barcode types.
Autodetect 2D barcodeAuto detection of 2D
barcode types.
You can also select a specific barcode type. the

supported barcode types are listed below:
1D barcode types:
Australian Post 4 State bar state

Australian Post 4 State C table
Australian Post 4 State N table
CODABAR
Code 11(USD-8) C check
Code 11(USD-8) K check
Code 128
Code 93
Code 3 of 9 (Code 39)
EAN 13
EAN 8
EAN EXT 2-digit supplemental
EAN EXT 5-digit supplemental
GS1 Databar (formerly RSS14) Expanded
GS1 Databar (formerly RSS14) Expanded Stacked
GS1 Databar (formerly RSS14) Limited
GS1 Databar (formerly RSS14) Stacked / Stacked
Omnidirectional
GS1 Databar (formerly RSS14) standard and
truncated
Interleaved 2 of 5
MSI (Modified Plessey) 2MOD10
MSI (Modified Plessey) MOD10
MSI (Modified Plessey) MOD11
MSI (Modified Plessey) MOD11MOD10
Patch Code
Planet
PostNet
Royal Mail (RM4SCC) 4State
Standard 2 of 5 (Industrial 2 of 5)
UCC EAN 128
UPC version A
UPC version E
USPS OneCode 4-State (4BC)
181
Option
Description
2D-barcode types:
Direction
DataMatrix
PDF 417 Mode 0
PDF 417 Mode 1
PDF 417 Mode 2
PDF 417 Mode 3
PDF 417 Mode 3 Extended
MicroPDF 417 Code 128 Emulation Basic
MicroPDF 417 Code 128 Emulation Extended
MicroPDF 417 Mode 0
MicroPDF 417 Mode 1
MicroPDF 417 Mode 2
MicroPDF 417 Mode 3
MicroPDF 417 Mode3 Extended
QR
Select the barcode direction for 1D barcodes or 2D

barcodes of PDF417 and MicroPDF417 types. This
value is ignored for other 2D types.
AutodetectDetects the barcode direction

automatically. This should be used when the image
scan orientation can vary and the barcodes can appear
upside down.
Bottom to Top
Diagonal
Horizontal
Left to Right
Right to Left
Skew
Top to Bottom
Vertical
Note: Selection of a specific direction leads to
faster processing since all barcodes are assumed
to be aligned uniformly and there will be no
direction detection.
Search zones
This group allows you to specify search areas more exactly. Instead of searching barcodes through all pages you can
define one or several zones and select the pages on which to search. Barcodes outside the specified zones will be
ignored. This will improve the performance of the component.
Zone search allows faster processing and creating Fields and RRTs of special type. This group contains the list of
zones and the buttons for managing the zones. Information about all zones (name of the set the zone is added to,
coordinates of the zone, units) is displayed in the list of zones.
Option
Description
Search barcodes only in the following zones
Select this option to restrict search area to the specified

zones. The zones are displayed in the table below this
option.
182
Option
Description
To add zones, click on the Add button. This opens the
Setup Zoned Barcodes dialog box. To remove a zone,
select the zone from the table and click Remove.
Page Split
These options allow you to set the criteria of splitting the document into pages. The component will split the
document every time it finds a barcode that satisfies the chosen criterion.
Option
Description
Split on barcode
Select this option to enable document splitting

functionality.
Using
Select the method. The following options are available:
Regular expressionThe component will split

the document when it finds a barcode with a value
matching a regular expression. The expression must
follow the ECMAScript grammar. For details, see the
description of the syntax.
WildcardThe component will split the document
when it finds a barcode with the value matching a
wildcard pattern.
Table 12: Wildcards
Wildcard
Description
Any value of any length

(this is a default value)
Any single character
[A]
Any single alphabetic

character
[]
Any single numeric

character
[A], [A]
Any letter or number
For example, *.??? means any string that ends

with . followed by three symbols; [#]* means any
string that begins with a numeric character; and
*Data* means any string that contains a "Data"
substring.
Note: If you want symbols like * ? [ ] \ to

be recognized as literal characters instead of
wildcards, use the slash escape character: \* ,
\?, \[ , \], \\. For example, if a string [a*b]*c
is desired to be found, use the following
expression: \[a\*b\]\*c.
External scriptThe component will split the
document according to the value returned by an
external Visual Basic script. See the example of
183
Option
Description
the Visual Basic script usage. When you select this
alternative, the Scripts button becomes enabled and
the Pattern text box, the Keep barcode page and the
Preseparator check boxes become disabled.
Scripts
Click this button if you want to use Visual Basic scripts

to define the splitting criteria. Clicking this button opens
the Scripts List dialog box.
Pattern
Specify the barcode pattern that is to be found in order to

split the document. It is mandatory to fill out this field,
if the Split on barcode check box is selected and you
select "Wildcard" or "Regular expression" in the Using
box.
Keep barcode page
Select this check box if you want to keep the barcode

page. If this check box is not selected, the barcode page
will be discarded in the output document.
Pre-separator
Select this check box if you are using the barcode page
as a separator, and you want the barcode page to be
kept at the beginning of the document. If this box is not
checked, the component will assume that the barcode
separator is the last page of the split document and will
start a new file after it. This check box is only enabled
when the Keep barcode page check box is selected.
Setup Zoned Barcodes dialog box

This dialog box allows you to set up zones in which the Barcode component will search for barcodes.
To open the Setup Zoned Barcodes dialog box, click the Add or Setup button on the General tab of the Barcode
configuration dialog box. In the Setup Zoned Barcodes dialog box, you can load an image file, navigate through
multiple page image file, draw zones around barcodes in images and set options for each zone. When you define
zones, the Barcode component ignores barcodes outside of the zones. This allows documents to be processed more
efficiently. While you work in this dialog box, the status area at the right-top of the dialog box shows the number of
zones applied to the image, the number of zones on the selected page.
Preview buttons
Buttons on the zone editor toolbar are used for previewing input images in the image pane.
Button
Description
This zoom controls may be used for zooming the image
in/out.
Use these buttons to set up image alignment: fit to
screen, fit to width, fit to height.
Use this button to enter selection mode, in which you can
select one or more zones.
Use this button to enter creation mode, in which you can
create new zones.
Use this button to remove selected zones.
184
Preview Pane
The image pane displays the image for preview. Click and drag to draw zones around barcodes. You can include one
or more barcodes in a scan. A zone should be at least slightly larger than barcode images that you want to include
in it. You want to be careful to allow sufficient space for variation in positioning that can occur between images.
Deskewing and preprocessing can also shift barcodes a little. To be detected by the Barcode component during
processing, barcodes should fit completely into a zone.
Image
The options in this group allow you to select an image and a page for displaying in the preview pane.
Option
Description
Image file
The path to the image file. Click the browse button (...)
to locate an image.
Page
Enter a page number to a page in a multipage image file.

You can use backward
and forward
buttons to
navigate between pages. These buttons are enabled only
if a document contains more than one page.
Note:
The color depth for displaying the PDF image
in the preview pane is the maximum from the
OCR color depth and the Split color depth
values that are set on the Advanced tab (see
Advanced tab).
When an 8 bit gray scaled JPEG document is
used, the image is opened in 24bpp mode to
eliminate dithering.
Zone
This group contains the options for a selected zone.
Option
Description
Zone
This box specifies the index number for the zone you
want to configure. You can enter the index number of a
zone in this box or click the zone in the image pane to
select it.
Require exactly one barcode in the zone
If this check box is selected, the component tries to

detect exactly one barcode in the zone. This option can
be useful if the quality of printed barcodes is low, or if
the Barcode Type option is set to "Autodetect". If there
are either no barcodes in a zone or more that one barcode
in a zone, the zone will be skipped.
Add barcodes to global set
Add barcodes found within the zone to the global set.

The values of the barcodes from the global set can be
retrieved using global set RRTs (see Global Set RRTs).
Add barcodes to set
Select this check box to add barcodes found in the zone

to a named set of barcodes. A named set can contain
barcodes found in one or several zones. The barcode
values found in the set can be retrieved using named set
RRTs (see Named Set RRTs). If no name is provided,
185
Option
Description
then the barcodes found within the zone are added to the
global set.
Note: If neither the Add barcodes to global
set nor the Add barcodes to set option is
selected, then zone barcodes are not added
to either named or unnamed (global) RRT,
although they are still recognized and validated.
Pages Tab
This tab contains options to specify on which pages the component should search for the specified zone.
Option
Description
Recognize zone on all pages
The component will look for barcodes in the zone on all

pages of the document. This option is set by default.
Recognize zone on odd pages only
Barcodes in the zone will be looked for only on odd

pages of the document.
Recognize zone on even pages only
The zone will be recognized only on even pages of the

document.
Recognize zone on pages with numbers
The component will recognize the zone on particular

pages of the document. When this property is selected,
the text field is enabled and the user should specify the
numbers of pages to recognize. It can be, for example,
2,4,6..9,11.. To specify a range the ".." is used. When
the ".." stands at the end, it means "and till the last
page". The value "none" means that the zone will not be
recognized; "all" means that the zone will be recognized
on all pages of documents.
And on the last page
This check box is enabled only if the Recognize zone on

pages with numbers option is chosen. If this check box
is selected, the zone will be recognized on the defined
pages and on the last page of the document.
Validation Tab
Use options on this tab to require validation of the values of the found barcodes. The barcodes whose values do not
satisfy the validation criteria will be ignored.
Select the type of validation from the drop down list:
No validation - This option is set by default. Barcode values are not validated.
Wildcard - this option allows using wildcards to validate barcode values.
Wildcard
Description
any value of any length
any single character
[A]
any single alphabetic character
[]
any single numeric character
[A], [A]
any letter or number
186
Note: If you want such symbols like * ? [ ] \ to be recognized as characters (not as wildcards), use
combinations with slash: \*, \?, \[, \], \\. For example, if a string [a*b]*c is desired to be found, use the
following expression: \[a\*b\]\*c.
Regular expressionThis option requires barcode values to match a regular expression. For matching regular
expressions, the component uses the ECMAScript grammar. For details, see the description of the syntax.
External scriptZones will be verified using a VB script. Enter the path to the script in the Script file name box
or click the browse button (...) to locate the script file. The script receives the following data:
sValueThe Zone value

sFileNameThe input file name
nPageNumberThe page number
If the zone is successfully validated, the script must return the "TRUE" or "YES" value in the string variable RRV. If
validation fails, the script returns "FALSE" for RRV.
Option
Description
Zone is required
Select this check box to reject a document if no value is

found within this zone (or no value matches validation
criteria when validation is on), or if the external script
returns "FALSE".
Use default value if not found or invalid
Select this check box to specify a default value for a

barcode when its value is not valid according to the
chosen validation method.
Location Tab
On this tab you can modify the selected zone coordinates and preferable measure unit.
Option
Description
Left
Modify the left coordinate of the zone.
Top
Modify the top coordinate of the zone.
Right
Modify the right coordinate of the zone.
Bottom
Modify the bottom coordinate of the zone.
Units type
Set the units which are used to represent the coordinates

of the zone. If you specify the type of units, the
coordinates are recalculated and the zone is stored in the
same place. You can select one of the following values:
Millimeters
Inches/100
Scripts List dialog box

This dialog box lists scripts that determine the splitting criteria. A document will be split into pages according to the
result returned by these scripts.
Button
Add
Description
Click this button to add a new script to the list. This
button opens the Script Properties dialog (see Script
Properties).
187
Button
Description
Edit
Select a script and click this button to edit settings of the

selected script. This button opens the Script Properties
dialog box.
Remove
Select a script and click this button to remove the script

from the list.
Script Execution Order

The algorithm of execution of the scripts is as follows. For every page of the document the component executes the
scripts after the page is processed, in the following order, depending on the Condition parameters:
1. First, for every barcode found on a page, in succession, the scripts with "Each barcode" condition are executed in
the order as they are listed in the table until some script returns a valid value of the Split variable. After this, the
remaining scripts for this group are not executed.
2. The scripts with "Barcodes from set" condition are executed for every barcode found within specified zones on the
current page. The scripts are executed for every barcode in succession in the order they are listed in the list until
some script returns a valid value of the "Split" variable.
3. The scripts with "Each page" condition are executed in the order they are listed in the list until some script returns
a valid value of the Split variable.
4. The scripts with "Following pages" condition are executed if the current page belongs to the list of pages set for
this option.
After execution of all scripts, the component takes the value of the last executed script to determine whether and
how(BEFORE, REMOVE, AFTER) the document should be split on the current page.
After this procedure is applied for every page, you will have several documents at the output.
Then the scripts with "Each Document" condition are executed in the order they are listed. After that, the document is
split once again according to the value of the OutputPages variable, if it is defined at all and contains a valid value.
Script Properties dialog box
This dialog allows you to configure properties of a script.
To open the Script Properties dialog box, click the Add or Edit button in the Scripts List dialog box.
Option
Script file
Description
Enter the path to a script or click the browse button (...)
to choose an existing script. If you want to create a new
script, enter a name of a script into this field and click
Edit create the script.
Note: Entering the name for a nonexistent file
and clicking Edit displays an error prompt.
Click OK in the error prompt to open the Script
Editor. The new script will be saved in the
default directory.
Edit
Click this button to edit the script in the Script Editor.

Note:
The Edit button is unavailable if the Script file
box is empty.
Run condition
Select the condition when the script will be executed.

You can select one of the following conditions:
188
Option
Description
Each barcodeThe script will be executed for every

barcode on a page after the page is processed, and so
on for each page.
Barcode from setThe script will be executed for
every barcode from a selected set of barcodes. When
you select this condition, there appears the Set box
with a list of sets, which can be configured in the
Setup Zoned Barcodes dialog box.
Each pageThe script will be executed after each
page of the document is processed.
Following pagesThe script will be executed
after each of the specified pages of the document
is processed. Enter the page numbers separated by
comma. You can also define a page range using the
hyphen. For example, 1-3,5,7 specifies the first
three pages, the fifth page, and the seventh page.
Each documentThe script will be executed after
the document is processed.
Script variables
This list displays variables that will be used in the script.
Add
Click this button to add a variable to the list. This button

opens the Script Variable dialog box.
Edit
Select a variable from the list and click this button to edit
properties for the selected variable. This button opens the
Script Variable dialog.
Remove
Select a variable from the list and click this button to

remove the selected variable.
Script Editor
The script editor window allows you to create, open, edit, compile, print and save a VB script.
The scripts used for definition of the splitting criteria should return the values in the form of special string variable
RRV. This variable value has the following structure:
Name=value&chr(10)&name=value&chr(10)&name=value&...
where name and value are the name and the value of some variable, chr(10) is the EOL character for VBScript.
Note: The variable values cannot contain EOL characters.
Two special variables can be used in RRV:
1. SplitThis variable gets the value that instructs the component whether the document should be split on the
current page. The variants of this variable are as follows:
RRV = "Split=BEFORE"The component will split the document on the current page and this page will
be the first page of the next document. This is equivalent to using the Pre-separator option when wildcard or
regular expression is used.
RRV = "Split=REMOVE"The component will split the document on the current page and delete the
current page. This is equivalent to the situation when the Keep barcode page option is OFF.
RRV="Split=AFTER"The component will split the document on the current page and this page will be
the last page of the current document. This is equivalent to the situation when the Keep barcode page option is
ON and the Pre-separator option is OFF.
If the Split variable has any other value, the component will not split the document on the current page.
189
2. OutputPagesThis variable gets the value that instructs the component how to create the output documents
that contain the specified pages of the original document. The value of this variable should have the following
structure: pages(i);...;pages(n), where pages(i) is a comma-separated list of original document's
page numbers that will form the i-th output document, for example, 1,4,2. You can also use ranges of pages, for
example, 1..5 means pages from 1 to 5 of the original document.
Example of this variable usage:
RRV = "OutputPages=1,2,3;5,2;1..3"Means that the component should create three documents.
The first document will contain 3 pages (1st, 2nd and 3rd pages of the original document). The second document
will contain 2 pages (5th and 2nd pages of the original document). The third document will contain pages 1,2,3 of
the original document.
The variables listed in the RRV structure may be used by other scripts. For this purpose, you should add them to the
list of variables of those scripts as global variables. The script may change the value of the global variable that has
been already initialized by returning its value in the RRV list.
The component verifies the value of the OutputPages variable after processing all pages of the document and after
executing all other scripts.
See the examples of the VB script usage.
Script Variable dialog box
This dialog box allows you to configure settings of a script variable. Only the String variables can be used in the
splitting scripts.
Option
Description
Variable name
Enter name of the variable manually or select from the

drop down list of the script variables. You can use RRT
from previous components in this text box. The RRTs
from the Barcode component are not replaced in this text
box.
Variable scope
Select if the variable is local or global:
Initial value
Local variableA variable used in this script.

Global variableA variable used in several scripts
in the Script List.
Enter the value to initialize the variable. The variable

initialization depends on the kind of the variable. The
Local variable is initialized by the specified value
directly before the script is executed. The Global
variable can be initialized in two cases (depending on
which case will take place earlier):
1. During the first running of the script that uses this
variable - by the specified value;
2. When some script returns the value of this variable by the returned value.
You can use RRTs from the previous components in the
Initial value text box. You can also use the following
sets of Barcode component in the Initial value text box:
~LTB::Barcode~
~LTB::PageBarcodes~
~LTB::PageNumber~
~LTB::PagesCount~
190
Option
Description
~LTB::#,#~ (specific barcode or comma-separated

list of barcodes)
~LTB::ZoneName,#,#~ (specific barcode or
comma-separated list of barcodes from the specific
set of zones)
The scripts are executed after the whole page is

completely processed, therefore if the script variables
values contain global set RRTs or named set RRTs, they
can get the values of the barcodes from the current page
and the previous pages. If you do not initialize variables
used in the script, they are initialized by the empty string
by default when the script starts running.
Script examples
Examples of the splitting scripts usage.
Splitting example 1
Split documents on the page that contains a barcode with a defined RRT.
1. Create a workflow with the AutoCapture and Barcode components that allows users to enter the city name in the
'City' field of the form.
2. On the General tab of the Barcode configuration dialog box, select the Split on barcode check box, and choose
"External Script" in the Using box.
3. Click the Scripts button, click Add, and enter a file name with the .vbs extension.
4. Click the Edit button, and in the Script Editor window create the following script:
If sBarcode = sSplitValue Then
RRV ="Split=BEFORE"
End If
5. Click Compile, save the script, and close the Script Editor.
6. In the Script Properties dialog box, for Run condition choose "Each barcode".
7. In Script Variables, click the Add button to configure the script variables:
Variable
Description
sBarcode
Local variable initialized by the ~LTB::Barcode~

RRT.
sSplitValue
Local variable initialized by ~ACC::%City%~ RRT.
8. Save the configuration and run the process.

When sending files, the user specifies a city in the AutoCapture form. The script is executed for each barcode on the
page after the page is processed. If the value of some barcode on the page is equal to the city name entered by the
user, the script will return the value RRV = "Split=BEFORE" and the component will split the document on the
current page and this page will be the first page of the next document.
If the user entered London in the 'City' field, and the component detects a barcode with the value
London on the third page of the document, the component will split the document on the third page
and this page will be the first page of the next document.
Splitting example 2
Split documents and create output files depending on the number of pages.
1. Create a workflow with the AutoCapture and Barcode components.
191
3. Click the Scripts button, click Add, and enter a file name with the .vbs extension.
4. Click the Edit button, and in the Script Editor window create the following script:
RRV="OutputPages=1..5"
If sPagesCount = sSplitValue Then
RRV="OutputPages=2,4;1"
End If
6. In the Script Properties dialog box, for Run condition choose "Each document".
7. In Script Variables, click the Add button to configure the script variables:
Variable
sPagesCount
sSplitValue
Description
Local variable initialized by the
~LTB::PagesCount~ RRT.
Local variable initialized by the value 7.

This script is executed for the entire document when all pages are processed. If a document contains 7 pages, the
Barcode component creates two documents, one with two pages (pages 2 and 4 of the original document) and a
second with one page (the first page of the original document). If the page count is not equal to 7, the component
creates one output document that contain pages 1 to 5 from the original document.
Splitting example 3
Split documents using several scripts with global variables.
1. Create a workflow with the AutoCapture and Barcode components.
3. Click the Scripts button
4. Click Add, and enter a file name with the .vbs extension for the first script file.
5. Click the Edit button, and in the Script Editor window create the first script:
If Len(AllValues) > 0 Then
AllValues = AllValues & ";" & CurValue
Else
AllValues = CurValue
End If
RRV ="AllValues="& AllValues
7. In the Script Properties dialog box, for Run condition choose "Each page".
8. In Script Variables, click the Add button to configure script variables:
Variable
Description
AllValues
Global variable used by all the scripts that defines how

a document should be split.
CurValue
Local variable initialized by the

~LTB::PageBarcodes~ RRT.
9. For the second script, repeat steps 4 on page 192 through 8 on page 192 using the following script and
variable settings.
192
Script:
Dim values
Dim sSplitting
Dim bDoSplit
values = Split(AllValues,";")
sSplitting =" "
For i = LBound(values) To UBound(values)
bDoSplit = False
If Len( values(i)) > 0 Then
If InStr ( values(i),"5") > 0 Then
bDoSplit = True
End If
End If
If Len( sSplitting ) > 0 Then
If bDoSplit Then
sSplitting = sSplitting &";"
Else
sSplitting = sSplitting &","
End If
End If
sSplitting = sSplitting & CStr(i - LBound(values) + 1)
Next
RRV ="OutputPages="& sSplitting
Set the Run condition to "Each document" and configure the following script variable:
Variable
AllValues
Description
Value assigned by the first script to define how
documents should be split.
The second script will be executed for each document and use the AllValues value to define how a document
should be split.
The document will be split on each page with the barcode that contains the "5" character.
Field Values tab
Use this tab to add or remove fields that will be transferred to the subsequent components in the workflow as RRTs.
Option
Description
Field name
Enter the field name. Use a name to identify the barcode,

for example, "InvoiceCode" or "CustomerID".
Field value
Enter the field value. This is a component RRT definition

identifying a barcode or barcodes on document pages.
Click the browse button (...) to open the Barcode
Location dialog box, which you can use to specify the
barcode value that should be applied to a field.
Modify
Select a field in the list, edit the Field value, and click
this button to apply changes to the selected field. This
button is enabled only when the selected field name or
value is changed.
Add
Specify a new Field name and Field value, and click

this button to add the new field to the fields list. This
193
Option
Description
button is enabled only after you enter a new field name
along with a field value.
Delete
Select a field and click this button to remove the selected

entry from the list of fields.
Barcode Location dialog box

This dialog box allows you to specify the location parameters for the barcodes that should be assigned to the field.
Option
Description
Named barcodes set
Select this check box if you want to take a barcode from

a named barcodes set.
Set name
Select the name of a barcodes set. This field is enabled

only when the Named barcodes set check box is
selected.
Page number
Enter the number of the page on which the bar code is

expected to be found.
Barcode number
Enter the number of the barcode on the page or in the

named barcodes set.
Note: RRTs should not be used in the fields of this dialog box, since they will not be replaced.
Advanced tab
Use this tab to edit the advanced settings for barcode recognition.
All fields of this tab can contain RRTs from other components.
Note: If the specified value of some field does not belong to the list of possible values, the default value will
be assigned to this field.
The Advanced tab contains the four groups of options.
PDF Color and Compression
This group allows you to set color depth of the input file for barcode recognition and color depth and compression of
the output files.
Option
Description
OCR color depth
Enter color depth in bits per pixel (bbp) used for

barcode recognition of the input PDF files. For barcode
recognition the component creates a raster image from
every page of the PDF document. This option specifies
the color depth of the generated raster image. The default
value is 1 (black and white image). It is reasonable to
increase this value in case the original image is colored
in such a way that rasterization it to black and white can
affect the quality of barcodes.
Split color depth
Enter color depth used to save the output PDF document

representing the part of the input document. It can have
one of the following possible values: 1, 4, 8 or 24 bpp.
The default value is 24 bpp. This option is enabled only
when the Split on barcode check box is selected on the
General tab.
194
Option
Description
Note: The color depth for displaying the
image in the preview pane of the Setup Zoned
Barcodes dialog box is the maximum from the
OCR color depth and the Split color depth
values.
Split compression type
Select compression type of the output PDF document

representing the part of the input document. This option
is enabled only when the Split on barcode check box is
selected on the General tab. The Split color depth value
determines the list of possible compression types:
Table 13: Compression types
Split color depth
1 bpp images
Supported
compression types
4 bpp images
8 bpp images
24 bpp images
CCITT Group3 1D
(default)
CCITT Group3 2D
CCITT Group4
LZW
Uncompressed
(default)
LZW
Uncompressed
(default)
Lossless JPEG
LZW
Uncompressed
JPEG YUV 4:4:4
(default)
JPEG YUV 4:2:2
JPEG YUV 4:1:1
LZW
When the Split compression type is set by an RRT, the

RRT should be replaced by one of the following values:
Color depth
for 1 bpp images
RRT value
for 4 bpp images
GROUP3 (corresponds
to CCITT Group3 1D)
GROUP3 2D
(corresponds to CCITT
Group3 2D)
GROUP4 (corresponds
to CCITT Group4)
UNCOMPRESSED
195
Option
Description
Color depth
RRT value
for 8 bpp images
UNCOMPRESSED
JPEG 400
(corresponds to
Lossless JPEG)
for 24 bpp images
UNCOMPRESSED
JPEG 444
(corresponds to JPEG
YUV 4:4:4)
JPEG 422
YUV 4:2:2)
JPEG 411
YUV 4:1:1)
PDF Rasterization Quality

Use these settings to configure image resolution.
Option
OCR page resolution
Description
Select the resolution used in creating a raster image out
of input pdf documents for further barcode recognition.
Resolution can be any positive integer value from the
range 2...65535. You can select a value from the list or
enter it manually. The default value is 150 dots per inch
(dpi).
Note: When you use a high resolution (more
than 1200 dpi) there may be not enough
memory for processing PDF documents.
Split page resolution
Select the resolution of the documents that result from

splitting the original document. Resolution can be any
positive integer value from the range 2...65535. You
can select a value from the list or enter it manually. The
default value is 300 dpi (normal for A4 or Letter page
size).
Note: When you use a large resolution (more
than 1200 dpi) there may be not enough
memory for processing PDF documents.
Text anti-aliasing
Select number of bits used for text anti-aliasing when

input PDF pages are rendered. It can have one of the
following possible values: 1, 2, or 4 bits. The default
value is 4 bits.
Graphics anti-aliasing
Number of bits used to implement anti-aliasing of vector

graphics objects when input PDF pages are rendered. It
can have one of the following possible values: 1, 2, or 4
bits. The default value is 1 bit.
196
Additional Options of Document Splitting

These options allow you to include information about separator pages when you the Split on barcode check box is
selected and the Keep barcode page check box is not selected on the General tab of the Barcode options dialog box.
Option
Description
Generate RRTs for barcodes from separator pages
When this check box is selected, the information about

barcodes from separator pages will be referenced by
RRTs. This check box is selected by default.
Enhance Barcodes Detection

Use these options to set preprocessing filters to enhance barcode detection.
Preprocessing helps to detect barcodes on the defected or low-resolution images.
Note: The output documents will not be affected by the preprocessing filters: the preprocessed images are
temporary and used only for recognition.
Option
Enhance image
Description
Select this check box to enable this group of settings. If
this check box is not selected, the component performs
only the minimum preprocessing: aligns the skewed
image by rotating it on a small angle.
If this check box is selected, the following preprocessing
filters are available:
DeskewWhen this check box is selected, the

component will try to detect the angle of the skew of
the image and then rotate it to correct the skew.
DespeckleRemove small noise from the image
before OCR. See Despeckle.
OCR resolutionIncrease image resolution before
OCR. See OCR resolution.
Fill gaps less thanRemove black objects which
have length along the bars direction less than defined
(for 1D barcodes only). See Fill gaps less than.
Dilate black pixelsDilate black objects (like bars)
along the bars direction by the specified amount of
pixels. See Dilate black pixels.
Dilate white pixelsDecrease each black object
on the image (like bar) to horizontal and vertical
directions by the specified number of pixels. See
Dilate white pixels.
When the Enhance image check box is selected the

Barcode component performs multiple attempts to
preprocess and recognize input images. The component
preprocesses input images by using every value for
every specified range of values for the filters that hold
minimum and maximum values (Fill gaps less than,
Dilate black pixels, and Dilate white pixels).
The set of filters applied during preprocessing depends
on barcode Type and Direction specified in the General
tab. The Fill gaps less than filter is applied only if
1D barcodes are searched for. The Dilate black pixels
filter is applied only if 2D barcodes are searched for,
or if the specified barcode direction differs from one of
197
Option
Description
possible vertical or horizontal values. In case barcode
type or direction is unknown, the component attempts all
applicable combinations.
After applying the combination of preprocessing filters,
the component attempts to recognize barcodes on the
resulting image. After all recognition attempts are done,
the component combines found barcode values from
different attempts as if these values were found by
a single recognition attempt. During this process of
combining barcode values, if two or more directional
barcodes of the same direction overlap, then some of
these barcodes can be discarded.
Detect best settings
Click this button to open the Detect Best Settings dialog

box that allows you to test how the component detects
barcodes using the specified filters and to detect the
optimal preprocessing options.
Despeckle filter
Use this filter to remove small noise from the image before recognition.
Select one of the following variants:
Try original then despeckled imagesThe component first tries to detect barcodes in the original image, then
removes speckles from the image and tries to detect barcodes in the despeckled image.
OCR original image onlyThe component tries to detect barcodes in the original image only. This is a default
value.
OCR despeckled image onlyThe component removes speckles from the image and tries to detect barcodes in
the despeckled image.
You can use an RRT in this combo box. The RRT must have one of the following values (case-insensitive):
YESThe OCR despeckled image only option will be selected.
NOThis corresponds to OCR original image only.
BOTHThis corresponds to Try original then despeckled images.
If the RRT has a different value, the default option will be selected.
The two figures illustrate this preprocessing method.
Figure 3: Image before preprocessing
Figure 4: Image after preprocessing
198
OCR Resolution filter

Use this filter to increase image resolution before OCR recognition.
This filter does not really affect image appearance, but improves barcode recognition in some conditions.
Select one of the following variants:
Try original then increased resolutionThe component first tries to detect barcodes using the original
resolution of the image, then it tries to detect barcodes once again using increased resolution.
OCR in original resolutionThe component detects barcodes in the original resolution of the image.
Increase image resolutionThe component detects barcodes using increased resolution of the image. This is a
default value.
You can use RRTs in this box. The RRT must have one of the following values (case-insensitive):
IncreaseIn this case the Increase image resolution option will be selected.
OriginalOCR in original resolution.
BOTHTry original then increased resolution.
If the RRT has a different value, the default option will be selected.
Fill Gaps Less Than
Use this option to improve barcode recognition by filling the gaps between bars if the gaps have the width less than a
particular value.
This option regulates the method in which the component tries to improve barcode recognition by filling the gaps
between bars if the gaps have the width less than a particular value, which may be a result of scanning defects. For
every value from the specified interval(beginning with the smallest), the component fills all the gaps between bars
of the width less than this value and tries to recognize the barcode. Than the component fills the gaps of the width
less than the next value from the intervals and tries to recognize the barcode, and so on. For example, if the specified
interval is from 2 to 5, the component first fills the gaps 1 pixel wide and tries to recognize the barcode, then the gaps
2 pixels wide, then 3 pixels wide and so on. If at some point the component succeeds in recognizing the barcode, it
keeps the recognized value as the value of the barcode. The method is applied to all barcodes on a page or zone.
The picture below illustrates several steps of this preprocessing method:
Thus, if the maximal value differs from the minimal value, this allows more variations of barcodes detection.
However, this may slow down the recognition as the number of recognition attempts increases.
The maximal allowable value of this option is 31 pixels. If the entered value is more than 31, the component will
reduce this value to 31 pixels.
This preprocessing option depends on the barcode Direction setting, which is specified on General tab of the
Barcode configuration dialog box. If the direction is not specified (for instance, Autodetect is used), the component
first assumes horizontal orientation for image preprocessing (Left to Right or Right to Left), then assumes vertical
199
orientation (Bottom to Top or Top to Bottom). This doubles the number of recognition attempts and therefore slows
down the recognition. Therefore it is recommended to specify the Direction setting when you use this preprocessing
option.
Dilate Black Pixels filter
Use this filter to dilate black objects (like bars) to horizontal and vertical directions by the specified number of pixels
(dilation depth).
This can enhance recognition of barcode images which are distorted by big amounts of white pixels due to scanning
defects. However, barcodes may be surrounded by frames or other black objects, and barcode elements may become
merged with these objects after being processed with this method. This may impede recognition. To prevent this, the
specified dilation depth should be less than the half of the width of the white boundary between the barcode and the
frame.
Enter minimum and maximum values for the dilation depth.
If the maximum value differs from the minimum value, the component tries to recognize barcodes for every value
from the specified interval. For example, if the minimum value is 1 and the maximum value is 2, at the first attempt
the component does not dilate black objects (as if this preprocessing method was not used), on the second attempt the
component dilates black objects of 1 pixel, and finally, on the third attempt, the component dilates black objects of 2
pixels.
Thus, specifying different values for the maximum and minimum values allows more variations of image
preprocessing before barcodes detection. However, this may slow down the recognition as the number of recognition
attempts increases.
The figures illustrate this preprocessing method.
Dilate White Pixels filter

This filter allows decreasing each black object on the image (like bar) to horizontal and vertical directions by the
specified number of pixels.
This filter allows decreasing each black object on the image (like bar) to horizontal and vertical directions by the
specified number of pixels. The purpose of this preprocessing filter is to decrease or eliminate small black objects.
This may be useful when the barcodes have textured background. For example, this takes place if the colored image
was converted to the black and white.
Enter minimum and maximum amounts of pixels by which the component will decrease each black object on the
image (like bar) to horizontal and vertical directions. You can use RRTs in these fields.
If the maximum value differs from the minimum value, the component tries to recognize barcodes in several attempts,
for every value from the specified interval. For example, if the minimum value is 1 and the maximum value is 3, at
the first attempt the component decreases each black object on the image by 1 black pixel , at the second attempt - by
200
2 black pixels, and finally, at the third attempt- by 3 black pixels. The default value is 0 for both values - this means
that this preprocessing filter is not used by default. Thus, if the maximum value differs from the minimum value,
this allows more variations of barcodes detection. However, this may slow down the recognition as the number of
recognition attempts increases.
The figures illustrate this preprocessing method.
Detect Best Settings dialog box

This dialog allows you to test how the component detects barcodes using the specified options and to detect the
optimal preprocessing options. The dialog contains a preview pane where the image is displayed. You can draw
blocks around each barcode on the displayed image or get these blocks automatically.
Buttons at the top-left of this dialog are used for previewing input images.
This section is used for zooming the image in/out.
Use these buttons to set up image alignment: fit to screen, fit to width, fit to height.
Use this button to enter selection mode in which you can select one or more blocks.
Use this button to enter creation mode in which you can create new blocks. This button is selected by default
when the dialog is opened.
Use this button to remove the selected blocks.
ImageThis group allows you to select an image and a page for displaying in the preview pane.
Image fileEnter the path to the image file manually or select the file using the
button.
PageEnter the page number in this text box manually or select from the drop down list. You can also use
and
navigation buttons for page selection. These buttons are enabled only if the document contains more than one
page.
PreviewThis group of setting allows you to set how the image will be displayed in the preview pane. Select one of
the options:
Original imageThe original image is previewed. When this option is selected, the Detect barcodes button is
disabled because the barcodes are always detected by the component after deskewing of the image and conversion
to Black&White. Therefore this option is used mainly for reference, for example, to compare the original image
201
with the deskewed image to see how much the barcodes are shifted from the original position after preprocessing
and how much the zone bound should be adjusted.
Deskewed B&W imageThe original image will be displayed with applied deskewing and conversion to
Black&White. These changes are applied to any image by default prior to the barcode detection when the
preprocessing is not used.
Preprocessed imageThe image is displayed with the enhancement filters applied, which are specified in
the Advanced tab. If you specified different minimum and maximum values for some enhancement filter, the
component will display image with the minimum value used for preprocessing. The set of enhancement filters
applied during preprocessing and the direction in which they are applied depends on selection made between
the sub-options: 1) Horizontally oriented barcodes, 2) Vertically oriented barcodes, 3) 2D barcodes. If
the selection is Horizontally or Vertically oriented barcodes, then directional enhancement filters (specified in
the Advanced tab) are applied in the corresponding direction. If the selection is 2D barcodes, then undirected
enhancement filters are applied.
Detect barcodesClick this button to detect barcodes on the displayed image. The component will draw a block
around each recognized barcode on the preview pane and assign number for each block automatically. If some
barcode is not recognized by the component, you can draw a block around this barcode manually.
BlockSelect one of the blocks from the drop down list to see the detected value of the corresponding barcode.
Detected valueThis text box displays the value of a barcode from the selected block.
Detected typeThis text box displays the type of a barcode from the selected block.
Expected valueEnter the expected value of a barcode in this text box if the barcode was recognized improperly.
Detect preprocessing optionsClick this button to detect the best combination of preprocessing filters for the
barcode recognition. The component will compare the Detected value and the Expected value and select the best
preprocessing options to get the Expected value as a recognition result. The search is made within all possible
combinations corresponding to the configured Enhanced barcode detection settings.
When you click this button, the component displays the progress bar which shows the progress of preprocessing
options detection.
If the component does not find any combination that result in recognizing all selected barcodes on those levels, the
component will display the corresponding message.
When the component detects the best preprocessing options, the Detected Preprocessing Options dialog opens.
The Cancel button allows you to cancel the detection of preprocessing options. This may be reasonable in case when
the barcodes are hardly readable and the component spends too much time for detection of the best preprocessing
options.
Detected Preprocessing Options dialog box
This dialog displays the result of detection of the best preprocessing options for barcode recognition.
The dialog shows the values of Enhance barcode detection options on the Advanced tab:
Fill gaps less than

Dilate black pixels
Dilate white pixels
DespeckleThe value of this option is displayed as "yes" (corresponds to OCR despeckled image only), no
(corresponds to OCR original image only) or both (corresponds to Try original then despeckled images).
Increase resolutionThe value of this option is displayed as yes (corresponds to Increase image resolution), no
(corresponds to OCR in original resolution) or both (corresponds to Try original then increased resolution).
CurrentThis column shows the current value of each option which is set in the Advanced tab. If some option has
different minimum and maximum values, the value of this option is shown in the form of an interval, for example,
0-2.
DetectedThis column shows the best value of each option that was detected by the component.
ResultThis column shows the resultant value of each option.
202
Each option has the buttons that allow setting the resultant value of the option that will be displayed in the Result
column:
Set>Click this button to set the detected value of the option.
Merge>Click this button to merge the current and the detected value of the option. For example, if the current
value of Fill gaps less than is 0-1 and the detected value is 2, then the merged value of Fill gaps less than will be
0-2. If the current value of Despeckle is "yes" and the detected value is "no", then the merged value of this option
will be "both".
Set allClick this button to set the detected values for all the options.
Merge allClick this button to merge the current and the detected values of all options.
When you click OK in this dialog, the component automatically changes the values of the Enhance barcode
detection options from the Advanced tab to the values displayed in the Result column if these values are not empty.
Runtime Replacement Tags
Barcode component RRTs
Component RRT ID
The RRT ID for this component is LTB.
Name
Description
PagesCount
The count of pages in the original document.
BarcodePages
The list of page numbers on which barcodes are present.
BarcodePagesCount
The count of pages containing barcodes.
SplitSeparatorsCount
The number of pages in the original document

considered as split separators.
SplitSeparatorsPages
Comma-separated list of pages considered as split

separators.
SplittedPartsCount
The number of output documents (parts of the split

document).
The following examples provide sample usage for your reference:

~LTB::PagesCount is replaced by 21
~LTB::BarcodePages~ is replaced by 3.
Additional RRTNs of two types: global set RRTs and named set RRTs.
Fields set on the Field Values tab of the Barcode component settings can be used as RRTs. The syntax used to refer
to field values in this case is as follows:
Name
~LTB::%FieldName%~
Description
Note: When the Split on barcode check box is selected on the General tab of the Barcode settings, every
output document, representing the part of the input document, has its own page numbering and its own set
of barcodes. Therefore, when you select the Split on barcode function, the component's RRTs are replaced
separately for each of the output documents (parts of the split document).
203
Global set RRTs

The component generates a global set RRT.
~LTB::PageNumber,BarcodePosition~Value of the specific barcode found inside the entire

document or inside of zones with the Add barcodes to global set property turned ON. Here PageNumber is the
image page where the barcode is located and BarcodePosition is the number of the barcode found on the page
counting from left to right and from top to bottom.
Note: When Search Zones is switched on, "found" barcodes exclude those which are not located in defined
zones, not located in defined pages, or those ones which do not satisfy validation criteria if default value is not
specified. Note that BarcodePosition may not match the number of the zone where the barcode was found.
There are some special characters that can be used instead of a specific PageNumber or BarcodePosition, these are:
* - all Page Numbers or all Barcode Positions.

-1 - last Page Number or last Barcode Position.
0 - last Barcode Position.
For example, the possible combinations are:

RRT
Description
~LTB::*,BarcodePosition~
This returns the concatenation of all barcode values in

BarcodePosition found in any page of the image file.
~LTB::PageNumber,*~
This returns the concatenation of all barcode values for

any position found in the PageNumber page of the image
file.
~LTB::-1,-1~
This returns the barcode value of the last barcode in the

last page of the image file.
~LTB::-1,BarcodePosition~
This returns the barcode value in BarcodePosition found

in the last page of the image file.
~LTB::PageNumber,0~

PageNumber page of the image file.
~LTB::*,0~
This returns the concatenation of barcode values of the

last barcodes found in any page of the image file.
~LTB::*,*~

any position found in any page of the image file.
Named set RRTs

If barcodes of the zone are added to a named set, then barcode values found in the zone can be retrieved using RRTs
of a special type. The syntax of the named set RRTs are as follows:
~LTB::SetName,PageNumber,BarcodePosition~ where SetName is the name of the set, PageNumber

is the image page on which the barcode is located, and BarcodePosition is the number of the barcode within the
named set counting from left to right and from top to bottom.
Note: "Found" barcodes exclude those which are not located in defined set, not located in defined
pages, or those ones which do not satisfy validation criteria if default value is not specified. Therefore,
BarcodePosition may not match the number of the zone where the barcode was found.
There are some special characters that can be used instead of a specific PageNumber or BarcodePosition, these
are:
*All Page Numbers or all Barcode Positions.

-1Last Page Number or last Barcode Position.
0Last Barcode Position.
204
For example, the possible combinations are:

RRT
Description
~LTB::SetName,*, BarcodePosition~

BarcodePosition found in the set on any page of the
image file.
~LTB::SetName,PageNumber,*~

any position found in the set on the PageNumber page
of the image file.
~LTB::SetName,-1,-1~

set in the last page of the image file.
~LTB::SetName-1,BarcodePosition~
This returns the barcode value in BarcodePosition

found in the set on the last page of the image file.
~LTB::SetName,PageNumber,0~

PageNumber page of the image file.
~LTB::SetName*, 0~
This returns the concatenation of barcode values of the

last barcodes found in any page of the image file.
~LTB::SetName,*,*~

the set for any position found in any page of the image
file.
~LTB::SetName,*,*~A comma-separated list of all barcodes found on all pages in the zones from the
SetName set.
~LTB::SetName.pages~A comma-separated list of pages on which barcodes in zones from the SetName
set are found and validated.
Script RRTs
The following RRTs can be used in the values of the variables of the splitting script:
Name
Description
~LTB::Barcode~
Value of the barcode to check by the splitting script.
~LTB::PageNumber~
Number of page checked by the splitting script.
~LTB::PageBarcodes~
comma-separated list of barcodes located on the page to

check by the splitting script.
These RRTs are available only for the Barcode component and are not available for the subsequent components.
These RRTs are replaced during the splitting script execution.
Fields RRTs
You can use RRTs to access Barcode field values.
Fields are defined on the Field Values tab of the Barcode settings. The syntax used to refer to field values is as
follows:
Name
~LTB::%FieldName%~
Description
The RRT specifies the name of a field defined on the
Field Values tab.
The splitting functionality is only available when reading multi-page TIFF and PDF images.
The complete list of supported file formats by the Barcode component is as follows:
205
File format
PDF
Comment
Files in PDF format (Versions 1.2, 1.3, 1.4, 1.5, 1.6,
and 1.7)
PDF/A
BMP
1-bit - uncompressed black and white

2-, 4- and 8-bit - uncompressed Palette
16-bit - uncompressed Mask
24-bit - uncompressed Palette and TrueColor
32-bit - uncompressed Mask
PCX, DCX
1-bit - black and white

4- and 8-bit - gray
TrueColor
JPEG
gray, color
JPEG 2000
gray - Part 1
color - Part 1
TIFF
black and white - uncompressed, CCITT3,

CCITT3FAX, CCITT4, Packbits, ZIP, LZW
gray - uncompressed, Packbits, JPEG, ZIP, LZW
TrueColor - uncompressed, JPEG, ZIP, LZW
Palette - uncompressed, Packbits, ZIP
multi image TIFF
GIF
black and white - LZW-compressed

gray - LZW-compressed
TrueColor - LZW-compressed
PNG
black and white, gray, color
JBIG
When splitting documents on barcodes is used for TIFF images with CCITT RLE compression, output images
may not be readable by other components or applications. You might need to convert such images to another
format, for example, with the use of the VIP component.
The B/W images must be created with at least 200 dpi resolution for reading barcodes.
The maximum image size is limited by approximately 23000x32000 pixels (about 2700 dpi for A4 page). If input
images contain more pixels than this limit, the workflow service may hang on while opening a file, or report an
error.
If barcodes of PostNet type have different width of bars, it is possible that they will be recognized incorrectly.
Please use generator which produces bars with equal width.
Not all modifications of Code 128 barcodes are recognized correctly. The recognition may depend on the barcode
generator.
When you use big resolution (more than 1200 dpi) there may be not enough memory for processing file.
206
When the component splits the document, it exports only rasterized images of the input document pages to the
output documents. Therefore, if the original PDF document has bookmarks, hyperlinks, interactive elements,
annotations, etc., the component will not export these elements to the output document.
The component cannot process PDF files the size of more than 2 GB. This is the restriction of the LeadTools
technologies used by this component. It is recommended to use compression when processing large PDF
documents.
Since the LeadTools rasterizes output PDF file, the output PDF files after splitting can be rather big in size.
When recognizing barcodes of UPC-E type, which is a reduced representation of UPC-A type, the component
inserts extra zeros so that the resulting value has UPC-A structure. Make sure that wherever you need to enter the
value or a pattern of a barcode (in pattern field and the like), you enter the 12-digit UPC-A value.
If the image has a high pixel resolution (high value of dpi).
Problem
The Barcode component cannot read one of the
supported barcode types.
Solution
This can happen in one of the following cases:
Insufficient quality of barcode recognition.
The search zone does not include the area where the
barcode is located. Using the image that contains
the barcode as a sample, change the search zone so
that it includes the barcode. If you are not sure that
this location is always going to be the same for all
images, then increase the zone or add another zone
or do not use a search region, and the component will
try to find the barcode on the entire page.
The search zone includes barcode area, but the page
where the barcode is located is excluded from page
recognition. If you use images in which barcodes are
located on the same pages, then configure recognition
for all necessary page numbers. If you are not sure
if this location is always going to be the same for
all images then select option Recognize zone on all
pages.
The barcode is read but does not satisfy validation
criteria. In this case set more flexible criteria or set
No validation option.
For better recognition results specify as much barcode

information as possible. In particular it is recommended
to specify exact orientation, to select zone more precisely
and to select the Require exactly one barcode in the
zone check box.
Batch Importer
Welcome to the Batch Importer component
Batch Importer is a Capture component which processes imported CSV (*.csv) or ASCII delimited (*.txt) index
files. The imported index fields could also contain one or more file path names for importing associated image files.
The component allows for definition of delimiter, field orders, field names and image file field designation.
Getting started
Feature highlights
Support for importing ASCII delimited index files
207
Support for importing comma separated values (CSV) files

Support for importing one or multiple image files
Field value replacement support
Using Batch Importer
Importing of CDs generated by scanning centers. These CDs generally are ASCII delimited text files that contain
index information and scanned image file path. Using Batch importer these files and corresponding index
information can be imported into all applications.
Importing application generated files such as form recognition, check reading, or other similar data extraction
applications. These applications generally are capable of exporting their data into ASCII delimited text files.
Using Batch Importer all the data output of these applications can now be connected to the server.
Importing comma separated values (CSV) files. The CSV file format does not require a specific character
encoding, byte order, or line terminator format. The CSV file format uses the comma delimiter between fields in a
record and the newline character to separate records. Fields that contain reserved characters (comma, newline, or
double quotation mark) must be enclosed between double quotation marks. A double quotation mark in a field is
escaped by preceding it with another double quotation mark. An empty field is delimited by two quotation marks.
ConversionA great tool for converting and migrating records from one application to another application
though use of batch text files. Use Batch Importer to migrate records from an existing system to another back-end
application.
Custom Build InterfacesThe VB Scripting, Java Scripting, VB, or VC++ component development interface
allows for building any type of custom application around Batch Importer.
Configuring Batch Importer

Workspace tab
Enter the workspace attributes on this tab.
Name
Description
File type
Enter the extension for the file type (*.csv or *.txt)

of CSV or ASCII delimited index files that will be polled
from the inbox directory.
Input directory
The path for the directory that this component searches

to find index files. Type the directory only (for example,
C:\SampleInputDir\).
Working directory
The path for the directory that files move to for

processing. Type the directory name only (for example,
C:\SampleWorkDir\).
Processed Batch File
After a batch file has been completely processed the

file can either be permanently removed or moved to a
designated directory.
Rejected Record File
Each row in the batch index file represents a record

that is processed separately. When processing fails a
record, the row of index data can be saved to a file in a
designated directory.
Field Setting tab

Set field attributes on this tab.
Name
Export all fields
Description
Select this check box to add the fields from records in
the batch index file to the fields collection in the job
208
Name
Description
object. Selecting this option allows the index field values
to be transferred to the next component.
Field delimiter
Select the character (, or ;) that separates the fields in the

batch index file.
First row contains field names
Select this option if the batch index file contains column

headings.
External files
These settings configure how Batch Importer processes

fields that specify external files.
Contains External FileSelect this option if index

fields contain file paths for importing files.
External file fieldsA comma-delimited list of
index fields that contain file paths. Each field is
specified by Fn, where n is the field number (for
example: F2, F3, F7).
When the first row contains field names and the First
row contains field names check box is selected, you
may optionally specify the names of the fields that
contain file paths instead of Fn.
External files must existSelect this option if
processing should fail for a record that contains an
incorrect file path. Other fields in a failed record that
contain valid paths will not be processed.
On SuccessAfter a record is successfully
processed, external files specified by fields in the
record can be left in the source folder, permanently
removed from the source folder, or moved to a
designated folder.
On FailureIf processing fails for a record,
external files specified by fields in the record can be
left in the source folder, permanently removed from
the source folder, or be moved to a designated folder.
Component Settings tab

Use this tab to configure the components that follow the Batch Importer in the process. You can configure the
necessary field value replacement through this tab.
Batch Importer Component RRTs
Use RRT strings when your attribute setting requires dynamic values from the data being processed.
RRT ID
This components Runtime Replacement ID is IBI.
Usage Notes
Use either the Field Name (for example, ~IBI::%Field1%~) or the Field Number (for example, ~IBI::F1~) to
perform field value replacement.
209
Problem Description
Server reports errors in the log while accessing the input
directory.
Solution
Server reports Batch Importer Error:

External file ("file path") does not
exist
Check the service user permission and make sure

the user ID has access to the input and the working
directories.
Check the path name for the input directory and make
sure the input folder path is available to the server.
Make sure service has full control over the path
(including write and delete permissions) for input and
working directories.
Make sure that path values in delimited fields are not
enclosed between double quotation marks.
.
This component reads one file at a time. Once the entire batch index file is processed, then the component will
read the next file that matches the polling criteria in the input directory.
Each row in the batch index file is considered a separate record and is processed as a single job.
Bates Stamp
Welcome to Bates Stamp
Bates stamping implies a process of placing Bates Stamps on document pages. The term itself originates from the
hand-held automatic numbering machine invented by Bates Manufacturing Company in the 1890s in New York
State. Bates stamping machines are still used by lots of companies around the globe for tedious manual document
stamping operations.
Bates Stamp component performs bates stamping on PDF and TIFF documents.
Stamps are provided by Bates Stamp Server, which is a web service the component accesses remotely.
Getting Started
Feature Highlights
Bates Stamp is a filter (Process) component that provides you with the following features.
Administration of Bates Stamp Server
Create, delete and modify custom stamps and stamp groups.

Add or remove Bates Stamp Server users and provide them with rights to different groups of stamps.
Preview stamp values.
Stamping TIFF and PDF Documents
Input a stamp name or select the name from the list of available stamps provided by the service.
Add prefix and postfix to stamps.
Set font and position for stamps.
Embed stamps into copies of original TIFF and PDF files.
Save stamps in separate files.
210
Add stamp values as tags into TIFF documents.

Configure stamp properties such as text color, transparency of stamps' background and others.
How to use Bates Stamp

This topic outlines using the Bates Stamp component to stamp documents and send them to a predefined folder.
Bates Stamp is used for work with stamps generated by Bates Stamp Server. Stamps can be embedded into PDF and
TIFF images, saved in a separate file, or added to TIFF documents as tags.
1. Configure a workflow with the AutoCapture component, Bates Stamp component and Send to Folder component.
2. Configure connection parameters to connect to the Bates Stamp server and select necessary stamp, and define
settings for the stamp, such as prefix, postfix, font, and position.
3. Configure the other components in the workflow.
4. Run the process.
When the user sends documents to the process, the documents are stamped and sent to the predefined folder.
Configuring Bates Stamp
General Tab
Use this tab to set general options of the component and to configure interaction with Bates Stamp Server.
Option
Description
Activate
Select this check box if using stamps is planned. If this

box is not checked, the component won't perform any
actions during files processing.
Server
Input IP address or host name of the machine where

Bates Stamp Server is running.
Port
Define interaction port.
Administer server
Click this button if you have administrators access

to Bates Stamp Server and want to configure
stamps and users. In the opened dialog box, specify
your administrator certificate and click OK. The
component will connect to the specified server, and the
Administration dialog box will open.
Certificate
Specify the file name of your Bates Stamp Server user's

certificate manually or click the Browse button to
browse for the certificate. This file gives your users
access to the service.
Stamp
Enter the name of the stamp which you plan to use, or

click the Select button to select it from the drop-down
list of available stamps provided by the service.
Delete original image
Select this check box if you want the images to be

deleted after processing.
Process only PDF and TIFF
Use this check box to handle the situation when the

component receives a file of an unsupported format
on input. If this check box is selected and an input file
extension differs from .pdf, .tif, and .tiff, the
component ignores this file. At run time, the component
will display an information message saying that the
document has been skipped. If this check box is not
selected, then a component rejects non-PDF and nonTIFF documents and the error message will appear at run
time.
211
Option
Description
Note: Regardless of this option, a TIFF file
of an unsupported format will be rejected and
the component will display an error message.
See the list of supported TIFF formats in
Restrictions and limitations.
Reject on failure
Select this check box to reject a job when the component

fails to process input files. All the documents in the job
will be rejected if the component fails to process any
input file. If this check box is not selected the component
will skip the failed file and continue the job. This check
box is selected by default.
Apply
Click this button to save settings. Incorrect data cannot

be saved.
Preview
Use this button to generate a preview of the image with

stamp in the opened Preview window. This button is
enabled only when the Embed stamps into image
documents option in Stamp tab is selected.
Administration Dialog Box

This dialog box displays the Administrator window.
Administrator is a special type of Bates Stamp servers client interacting with the service remotely.
Administrators responsibility is to create service users and to provide them with stamps. Administrator manages
stamps and users information on the server.
Stamps Tab
Use this tab to create, remove, edit and preview custom stamps as administrator.
Every stamp consists of elements separated with predefined delimiter.
Option
Description
Add
Click this button to create a new stamp. You may double

click on the empty space to perform the same operation.
Delete
Choose the stamp from the list and click this button
to delete it. You may press the "Delete" key on your
keyboard to perform the same operation.
Properties
Click this button to modify of to view a stamp. You may

use the double click on the name of a stamp to perform
the same operation.
Elements
Click this button to see or to edit stamp's elements list.
Preview
Click this button to preview stamp values.
Reset
When you click this button, all counters of all stamp

elements take First value (read more about counters in
Stamp Elements Properties chapter).
Stamp Properties
Use this window to configure stamp properties.
Stamp is a set of parameters and rules for creating text strings - stamp values. Stamp consists of elements separated
with predefined delimiter.
212
Every stamp must have a unique Name. You can type a Description of the stamp (optional).
Set dates of stamp's availability: starting date From and expiration date Up to. The stamp will not be available for
users before and after this period.
If you set stamp to be Frozen, then no users will have access to this stamp.
You can check if the stamp is already Exhausted or not. This option cannot be configured. If stamp is exhausted, it
means that one or several of its elements have reached their last counter value and no stamp values can be given to
users.
Fields delimiter is a symbol or a set of symbols used to separate stamp elements.
To see or to edit the stamp's elements list, click Elements. To preview stamp values, use Preview.
Stamp Elements
Every stamp can contain several elements separated with a predefined delimiter. Elements in output stamp value have
the same order as in the list in this dialog. To change the order, use Move up and Move down buttons in bottom-right
corner of Stamp Elements dialog box.
To create a new stamp element, click Add. To remove an existing element, use Delete. To view or change element's
settings, click Properties to open the Stamp Element Properties dialog box. To preview the stamp values, use
Preview button.
Stamp Element Properties
Stamp elements are parts of stamp divided by predefined delimiter.
Option
Type
Description
Enter stamp element type. 7 types of elements are
supported:
Literal. This type represents integer numbers as

sequences of Latin letters AZ and has 26-based
notation. Each letter corresponds to a number
(example: "A" = 0, "L" = 11, "Z" = 25, "BA" =
26 etc.). Minimal legal value is -2147483848 and
maximal is 2147483647.
Literal-Numeric. This type is based on 36-based
notation. Integer numbers are represented as
Latin letters AZ and decimal digits 09. Each
combination of letters and digits corresponds to a
number (example: "A" = 0, "Z" = 25, "0" = 26, "9" =
35, "BA" = 36, "B" = 62 etc.). Minimal legal value is
-2147483848 and maximal is 2147483647.
Numeric. This type represents integer numbers.
Minimal legal value is -2147483848 and maximal is
2147483647.
Numeric-Literal. This type is based on 36-based
notation. Integer numbers are represented as decimal
digits 09 and Latin letters AZ. Each combination
of digits and letters corresponds to a number
(example: "0" = 0, "9" = 9, "A" = 10, "Z" = 35,
"11" = 36, "1B" = 46 etc.). Minimal legal value is
-2147483848 and maximal is 2147483647.
Roman. Positive integers represented as Roman
numbers. Minimal legal value is 1 and maximal is
3999.
Text. Static text string.
213
Option
Description
Time. This type represents time and date according

to specified format. Minimal value is 00:00:00
01.01.1970 and maximal value is 03:14:07
19.01.2038.
Leading symbol
A symbol, that fills up unused cells in element length.

For example, if the type is Numeric, length is 3, leading
symbol is 0, and the counter is 1, then the element
value will be "001". When this string is empty, unused
characters are not filled.
Character case
Select one of three available options: as is, uppercase and

lowercase.
Length
Specify how many characters are allocated for this stamp

element.
Note: If the length is too short for the element,
an error will occur while using the stamp.
Format
Attention: This setting is available only for

Numeric, Text and Time types.
For Numeric type, format of number can be set to Space
separated, Comma separated or No separator.
For Time and Text types, static text or tags can be
used. For example, %.9L-%.2D, %Y format string
represents date as: <English name of a month>-<Twodigit day of month>, <Full year>.
The following Time tags are supported for Time type
format:
%YFull year (19702038)

%.2YLast two digits of year (7038)
%MOne or two digit month (112)
%.2MTwo digit month (0112)
%.9LEnglish name of a month
%.9WEnglish name of day of week
%DOne or two digit day of month (131)
%.2DTwo digit day of month (0131)
%HOne or two digit hours (023)
%.2HTwo digit hours (0023)
%hOne or two digit hours (012)
%.2hTwo digit hours (0112)
%mOne or two digit minutes (059)
%.2mTwo digit minutes (0059)
%SOne or two digit seconds (059)
%.2STwo digit seconds (0059)
%TOne digit Ante/Post Meridiem (A/P)
%.2TTwo digit Ante/Post Meridiem (AM/PM)
%%Single percent symbol
For Text type, a number of text macros are supported.
214
Option
Counter range
Description
Specify range for the counter. Counter is the current
value of the element, except for elements of Text type.
Text is always static and counters are not applicable to it.
Counter settings
First value is the starting value for the counter.

Last value is the last legal value for the counter. For
example, if you want to set page numbers and your
documents contain not greater than 560 pages, set
First value = 1 and Last value = 560. (Note that
Length of the element must correspond to the values;
in this case it should be set to 3 or greater).
CyclicSelect this check box to make the counter
looped. This means that the First value is the next
legal value of the counter after the Last value. When
the counter value exceeds Last value the next value
will be taken from the range just like if First value
follows the Last value. If the option is off, then the
element takes no value after the last one and the
stamp is exhausted in this case. The users cannot
take values of the stamp in this case.
Current value is the current value of the counter.
This value must belong to the range from First value
to Last value.
Configure setting for the counter behavior.
Increment byEnter a value of counter increment

on each generation of a stamp value. This means that
next counter value will exceed the previous one by
this value. Increment can also be negative, but in this
case First value must be greater than Last value,
and the counter will decrease. If you set Increment
counter to 0, the counter will remain changeless. For
Time type, increment has two positions: time units
(Seconds, Minutes, Hours, Days, Weeks, Months,
Years) and number of chosen units (for example, 3
hours).
Every option shows how often the counter
increases. You can select increase condition: number
of generated stamp values or number of requests.
Note: The number defined in Every must
be positive (1 or greater).
If you select Stamp values, then counter will
increase by Increment value after every set of stamp
values which quantity is defined in Every. In other
words, the defined number of equal stamp values
will be created and only after that the counter will
increase. See examples below.
If you select Requests, then the counter will increase
in every N'th requests where N is the defined number
in Every, regardless of the number of stamps in each
request.
Number of used stamp values/Number of used
requests is the current number of stamp values or
215
Option
Description
requests created for the current value of counter
(must be nonnegative integer less than Every). This
value is updated automatically when users make
requests for the stamp.
For example, you set to create 5 stamp values for
every counter value (Every is set to 5 stamp values),
but for current counter 3 stamps have already been
received by users. Therefore Number of used stamp
values will be 3.
Some examples to illustrate how it works:
Reset counter after request
Type is Numeric, First value is 9, Last value is 0,

Cyclic is on, Increment by is -1 and Every is set to
1 stamp value. In this situation counter will change
from 9 to 0 taking all intermediate integer values,
then it will be 9 again and the process will repeat.
Type is Numeric, First value is 0, Last value is 9,
Cyclic is on, Increment by is 4, Every is set to 1
stamp value. The values of the element will be the
following: 0, 4, 8, then 2 (as 8+4>9), 6, 0 etc.
Type is Time, First value is 00:00:01 01.01.2000,
Last value is 23:59:59 31.12.2000, Cyclic is off,
Increment by is 1 day, Every is set to 3 requests.
The counter will change from January,1,2000 to
December,31,2000 taking all intermediate dates and
every 3 requests will have equal stamp values not
depending on number of stamps in each request.
The last generated stamp value will be 00:00:01
31.12.2000 and then the stamp will be exhausted.
This can be useful, for instance, if a user needs to
stamp daily all pages of 3 documents with different
number of pages, and he wants to see dates of year
2000 as stamp values.
Select this check box if you need the counter to take

First value after each request. Number of used stamp
values/requests will also be reset (to 0).
For example, a user first needs to number pages in
current document and asks for the same number of
pages. Next time he asks for another quantity of pages,
but the counter must still start from 1 (assuming
that First value is 1) again. Set First value to 1 and
Reset counter after request set to ON.
Text Macros
The following macros are supported for Text type:
Macros name
%(TIME(<time format>))
Description
Current GM time where <time format> is a format string
similar to the format string of Time type. All time tags
described in Stamp Element Properties are supported,
but they are static and always return current GM time.
216
Macros name
Description
%(USERNAME)
The name of the user who obtains the stamp.
%(USERDESCRIPTION)
The description of the user who obtains the stamp.
%(NAME)
The name of the stamp.
%(DESCRIPTION)
The description of the stamp.
Note: This feature does not support user-created macros.

Preview Stamp
Use this window to preview stamp values as they will be received by users.
Current counters values do not depend on preview requests.
Click the Add button to add a request. This action simulates a situation as if a user sends a request for several values
of the stamp. To view the corresponding stamp values, click Preview.
You can change the number of values in existing request. To do this, click Properties and input a new number.
To delete a request, use the Delete button.
Request Properties
Input Number of stamps in request. This will allow you to receive a desired number of stamp values.
Stamp Groups Tab
Use this tab to define stamp groups
Stamps can be united into groups. User who has the rights for a group can use all stamps of this group. Group
properties are configured on this tab.
To create a new stamp group, click Add or double-click on an empty space. To remove an existing group, click Delete
or press the Delete key. To view or change groups settings, click Properties or double-click on the group's name, and
Stamp Group Properties dialog box will open. To view stamps in groups, use Stamps button.
Stamp Group Properties Dialog Box
Use this dialog box to configure stamp group settings
Every stamp group must have a unique Name. You can type a Description of the group (optional).
Use Stamps button to add or delete group stamps.
Group Stamps Dialog Box
You can select any stamp from Available stamps list and add it to the group with Add button or double click on
the stamp name. If you need to remove a stamp from the group, select the stamp in Stamps in group list and click
Remove button or use double click on the stamp name. Note that the stamp is not deleted, it just returns to the list of
available stamps.
Users Tab
Use this tab to configure user properties
Users are the service's clients of a special type. They can use stamps values but cannot configure them.
Bates Stamp Server administrator can create users and provide them with stamps. Access to stamps is granted by
whole groups, that is, administrator grants access to a stamp group to a user, after that the user can request values
of any stamp from the group. Granting access to individual stamps is not supported (to provide it, create a group
including a single stamp and grant access to this group). Stamps not included in any group are available for any user.
To create a new user, click Add or use double click on empty space. To remove an existing user, click Delete or press
keyboard "Delete" key. To view or change user's settings, click Properties or double click on the user's name, and
User Properties dialog box will open. To view available stamp groups, use Stamps button.
217
A user needs a certificate to get access rights to Bates Stamp Server. Certificate is a file created by Bates Stamp
server. To save a certificate for particular user, select a user in the list and click Save certificate. The file should be
sent to the user.
User Properties Dialog Box
Use this dialog box to set user properties
Every user must have a unique Name. You can type a Description of the user (optional).
Set user's Expiration time and date. The user will not be able to work with the service when he becomes expired.
You can postpone user's expiration date. You can also disable the user by setting expiration date earlier than current.
To view the user's stamp groups, click Groups to open the User Groups dialog box. To grant a certificate to the user,
click Save certificate.
User Groups Dialog Box
Use this dialog box to manage user groups.
You can select a group from Available groups list and add it to the user with Add button or double click. If you need
to remove a group from the use's list, select the group in User groups and click Remove button or use double click on
the group's name in the list. Note that the group is not deleted, it just gets not available for the user.
Stamp Tab
Configure stamp settings on this tab.
Option
Description
Stamp
This text box displays the stamp that you have selected
in General tab. To select another stamp, you need to go
back to the General tab.
Prefix
Enter the string that will be printed before the stamp

value.
Postfix
Enter the string that will be printed after the stamp value.
Stamping
This group allows configuring methods of stamping.
Embed stamps into image documents
If this check box is selected, the component will put

stamps in the copies of the input documents. In this case,
you can select a mode of stamping:
Put stamps in separate files
Overlay mode means that Bates stamps will be

simply placed over original images with transparent
or opaque background. Background settings are
configured in the Font tab.
Shrink and apply mode means that the image will
be resized so that one page of original size can hold
the resized image and the stamp. The resized image
will be centered horizontally within the page and
aligned vertically to top or bottom, depending on
stamps alignment. This option is enabled only for
Predefined position in the Position tab. If margin
values require image resizing to less than 25% of
original size, it causes an error message: "Invalid
stamping area.
If this check box is selected, the component will generate

a new text file for each input document. It will have the
same name as the original file, but the file extension will
be ".ftm" (for example, if the original file is Example.tiff
then the output file will be Example.ftm). Each line of
218
Option
Description
this file will contain page number and the corresponding
stamp value delimited with a comma, for example:
Put stamps in TIFF files as tags
1,stamp1
2,stamp2
This setting is only applicable to TIFF input files, it

is ignored during PDF documents processing. If this
check box is selected, the component will generate a new
TIFF file with the same images, but each page will have
additional TIFF tag containing the stamp value.
The number of the tag to use is input in the Tag
field. Tag number may be from the "reusable" range
65000-65534.
PDF files
This group allows configuring settings for PDF files.

Bates Stamp opens PDFs as pictures.
PDF resolution (DPI)
Set the resolution (dots per inch) for the opened pictures.
The horizontal resolution is equal to vertical resolution.
Color depth (BPP)
Set the color depth (bits per pixel) for the opened
pictures. Valid values are 1, 4, 8 and 24.
Note: The component may change PDF image
colors when processing/previewing/selecting
stamp zones if the Color depth parameter is not
set to 24 BPP.
Compression type
Select an appropriate compression type for output PDF

documents (available values depend on the selected color
depth).
Font Tab
Set up stamps font properties on this tab.
Select Font, Font style and Size from the corresponding lists. You can specify RRTs for these fields.
Note: If you specify RRTs for any of these fields, the preview will be shown with the default value for this
field.
Option
Description
Effects group
Underline
Select this check box to underline a text of the stamp.
Strikeout
Select this check box to strike out a text of the stamp.

Color group
Foreground
Set up the foreground color for the stamp.
Background
Set up the background color for the stamp.
Transparent
Select this option to make the stamp with transparent

background.
219
Position Tab
Use this tab to specify stamps position on pages and size of stamps.
Option
Description
Unit
Set up measure unit (Centimeters or Inches) that you

want to use for stamps position definition. When the
unit is changed, values that depend on the unit are
recalculated.
Predefined position
If this option is selected, the component will locate

stamp in one line without wrapping so that stamps fit
to page margins. If a stamp does not fit to width, stamp
text will be wrapped. A stamp will never exceed page
margins.
Alignment group
Define Horizontal and Vertical alignment for stamps.
Margins
This group allows you to set page margins - minimum

distances of stamps from page borders.
Note: You can specify RRTs for margin fields.
In this case the preview will be shown with the
default values.
If margin values make desirable stamp area incorrect, it
causes an error message "Invalid stamping area".
Custom position
If this option is selected, a stamp will be located in a

rectangle with given coordinates.
Click the browse button (...) to select a zone directly on
an image in the opened Select Zone dialog box.
Boundaries
This group allows you to manually set up coordinates of

Upper Left corner and of Lower Right corner.
Note: You can specify RRTs for these fields.
In this case the preview will be shown with the
default values.
Select Zone Dialog Box

This dialog box allows selecting a zone on images where stamps will be placed.
When a TIFF or PDF file is chosen, currently defined zone is displayed over the image (only first successfully opened
page of the file can be displayed). You can change its size or draw zone in another place of the image.
If the stamping area is too small in height to enclose the minimum acceptable part of a stamp (in current version, this
value is 50% of stamp height), it causes an error message "Stamping area is too small".
If the stamping area is too small in width even to enclose one symbol of the stamp, it causes an error message
"Stamping area is too narrow".
Preview
This window allows you to preview a document with the embedded stamp. Browse the document by clicking the
browse button (...).
The component requests stamps from the Bates Stamp Server (in preview mode, that is without changing actual data
on the server), and embeds them to the image using the defined stamp settings (font, position, background an so on).
To change the stamp, close the preview window and configure stamp settings.
220
Component RRTs
Component RRT ID
The RRT ID for Bates Stamp component is BSC.
The following table describes the RRTN values for Schema field of this component.
Name
Description
FileName
The original file name value.
FileExt
Input file extension.
Day
The day of month (131) when the input file was

stamped.
YearDay
The day of year (1366) when the input file was

stamped.
Hour12
The 12-based hour (112) when the input file was

stamped.
Hour24
The 24-based hour (023) when the input file was

stamped.
Locales
AM/PM indicator for 12-hour clock when the input file

was stamped.
Minute
The minute (059) when the input file was stamped.
Month
Full (JanuaryDecember) month when the input file

was stamped.
MonthAbbr
Abbreviated (JanDec) month when the input file was

stamped.
MonthDigital
Digital (112) month when the input file was stamped.
Second
The second (059) when the input file was stamped.
WeekSunday
The number of the week in year (153) when the input

file was stamped (Sunday is the first day of week).
WeekMonday
The number of the week in year (153) when the input

file was stamped (Monday is the first day of week).
WeekDay
Full (SundaySaturday) week day when the input file

was stamped.
WeekDayAbbr
Abbreviated (SunSat) week day when the input file

was stamped.
WeekDayDigital
Digital (06) week day when the input file was stamped
(0Sunday).
Year
Full 4-digit year when the input file was stamped.
Year2Digit
2-digit (0099) year when the input file was stamped.
<PageNumber>
Stamp value on a certain page (see samples below)).
The following example provides some sample usage for your reference:
221
~BSC::FileName~_~BSC::Year~-~BSC::MonthDigital~-~BSC::Day~~BSC::FileExt~ is
replaced with the value Document_2011-01-25.tif if the original file name was Document.tif and current date is
January 25, 2011
~BSC::3~ is replaced with the value of stamp on the third page.
Note: If there are fewer than 3 pages in a document, this sample RRT will not be replaced.
This component does not have any FRTNs and replacement of field names with metadata values.
This component does not have any SSRTNs and replacement of field names with metadata values.
Restrictions and Limitations
The component works only with TIFF and PDF images. The following TIFF formats are supported:
Tagged Image File Format, with LZW Compression and RGB color space
Tagged Image File Format, with LZW Compression and CMYK color space
Tagged Image File Format, with LZW Compression and YCbCr color space
Tagged Image File with JPEG compression and YUV 4:4:4 color space and Lossless
Tagged Image File with JPEG compression and YUV 4:2:2 color space
Tagged Image File with JPEG compression and YUV 4:1:1 color space
Tagged Image File Format, with no compression and with RGB color space and 8-bit grayscale
Tagged Image File, with no compression and with CMYK color space
Tagged Image File, with no compression and with YCbCr color space
Tagged Image File with PackBits Compression and RGB color space
Tagged Image File with PackBits Compression and CMYK color space
Tagged Image File with PackBits Compression and color YCbCr space
Tagged Image File with CMP Compression
Tagged Image File with JBIG Compression
Tagged Image File with a vector image saved as a DXF Release 12, Release 13
Tagged Image File with JPEG 2000 Compression
Tagged Image File Format, 1-Bit FAX, compressed using CCITT
Tagged Image File Format, 1-Bit FAX, compressed using CCITT, group 3, 1 dimension
Tagged Image File Format, 1-Bit FAX, compressed using CCITT, group 3, 2 dimensions
Tagged Image File Format, 1-Bit FAX, compressed using CCITT, group 4
TIFF-FX format, compressed using CCITT group 3, 1 dimension
TIFF-FX format, compressed using CCITT group 3, 2 dimensions
TIFF-FX format, compressed using CCITT group 4
TIFF-FX format, JBIG compressed.
TIFF-FX format, JPEG compressed.
222
Exif file containing a TIFF image, with no compression and with RGB color space
Exif file containing a TIFF image, with no compression and with YCbCr color space.
The component does not support gray-scale images with color depth more than 8 bits per pixel.
Bates Stamp Server web service interacts with users through secure SSL channel. The security level used
provides only encryption of all the data transferred between client (user) and server sides, and does not provide
authentication of web service to users.
This component cannot process PDF files with the size more than 2 GB. This is the restriction of the LeadTools
technologies used by this component. It is recommended to use compression when you process PDF documents.
Since the LeadTools rasterizes output PDF file, the output PDF file can be much bigger in size than the input
file.
The component may change PDF image colors when processing/previewing/selecting stamp zones if the color
depth parameter is not set to 24 BPP.
If color depth is set to 24 BPP, the colors of PDF image may change a little, as the LeadTools fades such images
slightly. This effect is especially visible when an image is processed in a cycle for several times.
Note: The color depth is specified by the Color depth setting on the Stamp tab of the component settings.
For more information, see Stamp Tab.
Troubleshooting Tips
Problem
The component cannot process file and the Status
Monitor gives the following error message:
Solution
Check that your machine is connected to local net.
"Cannot load stamp values: No Data"

"Cannot load stamp values: Host not found"
Check that your Bates Stamp Server login options

(server IP or host name and interaction port) are
correctly specified.
Check that the certificate file is present and valid (not
expired).
"Cannot load stamp values: Authentication error: invalid

certificate"
"Cannot save stamp, group or user (administration)."
The following message will appear when you are trying

to save the configuration:
This can happen if connection with the web service

is lost. Check that the web service is started on server
machine. Check that you can connect to the server
machine.
Stamps, groups and users, which contain incorrect
data, cannot be saved. Check the settings and correct
them if necessary.
This happens if configuration contains incorrect data.

Verify all settings of the component.
"Cannot save configuration."

The following error message is displayed:
This error appears in the following cases:
"Invalid stamping area."
For Predefined position, margin values make stamp

area incorrect;
In Shrink and apply mode, margin values require
image resizing to less than 25% of original size.
223
Problem
"Stamping area is too small."
"Stamping area is too narrow."
The component changes PDF image colors when
processing/previewing/selecting stamp zones.
Solution
This error occurs if the stamping area is too small in
height to enclose the minimum acceptable part of a
stamp (in current version, this value is 50% of stamp
height).
This error occurs if the stamping area is too small in
width even to enclose one symbol of the stamp.
This may happen if the Color depth parameter is not
set to 24 BPP. Try to set 24 BPP color depth when
processing the document or previewing/selecting stamp
zone. If the generated stamped image has a big size,
configure the Compression type parameter to compress
the image.
Note: The colors of PDF image with 24 BPP
color depth may also change a little, as the
LeadTools fades such images slightly. This
effect is especially visible when an image is
processed in a cycle for several times.
When processing 4-bit TIFF images, the component can

produce the stamps of an incorrect color.
This may happen if the palette in the image does

not include the color specified for the stamps. The
component chooses the image palette color that is closest
to the specified one. Use images with higher color-depth
if you want to preserve the original color.
Bates Stamp Server Administrator

Welcome to Bates Stamp Server Administrator
hand-held numbering machine invented by Bates Manufacturing Co. in 1890s in New York State. Bates stamping
machines are still used by lots of companies around the globe for tedious manual document stamping operations.
Bates Stamp Server is a software which provides manipulation operations (adding, editing, and requesting values)
with a set of stamps. Here "stamp" is a set of parameters and rules for creating text strings - stamp values.
Bates Stamp Server works as a web service which interacts with its clients - administrators and users - through secure
SSL channel.
Note: The security level used provides only encryption of all the data transferred between client and server
sides, and does not provide authentication of web service to its clients.
Administrator is a special type of the services client interacting with the service remotely. To connect to the service,
he/she needs an administrators certificate file. Administrators responsibility is to create service users and to provide
them with stamps. He manages stamps and users information on the server.
User is a client who requests values of any stamp he/she has access to, as well as the information about all stamps
is available for him. In order to have access to the service, user has to present a users certificate file granted by
administrator.
The following scheme presents the architecture of Bates Stamps Server software:
224
Getting started
Feature highlights
Bates Stamp Server Administrator application provides you with the following features:
Create, delete and modify custom stamps and stamp groups;

Add/remove Bates Stamp Server users and provide them with rights to different groups of stamps;
Preview stamp values.
Using Bates Stamp Server Administrator

Quick overview of the Bates Stamp server administration.
1. Connect to Bates Stamp Server. Select the same port number as Bates Stamp Server web service uses for
interaction.
2. Add users as it is required by your business process.
3. Create stamp groups and provide corresponding users with rights for the groups.
4. Create stamps and configure them.
5. Add stamps to corresponding stamp groups. Note that stamps which do not belong to any group will be available
for all your users.
6. Save certificate for every user in a separate file and provide the corresponding user with this file in preferably safe
way.
Configuring
Login
Input IP address or host name of the machine where BSS service is running. Set interaction Port used by BSS.
Browse the file with your Bates Stamp Server administrator's certificate. This file gives you access to the service. If
you have no certificate, apply to your Bates Stamp Server Supervisor.
Click OK to connect to the service.
Stamps
Within Administrator application, you can create, remove, edit and preview custom stamps. Stamps' properties can be
configured in Stamps tab.
225
Every stamp consists of elements separated with predefined delimiter.

To create a new stamp, click Add or use double click on empty space. To delete an existing stamp, choose the stamp
from the list and press Delete button or Delete key on your keyboard. To modify or to view a stamp, click Properties
or use double click on the stamp's name. To see or to edit stamp's elements list, click Elements. To preview stamp
values, use Preview.
When you click Reset button, all counters of all stamp elements take First counter value (read more about counters in
Stamp Elements Properties chapter).
Stamp properties
Stamp is a set of parameters and rules for creating text strings - stamp values. Stamp consists of elements separated by
defined delimiter.
Every stamp must have a unique Name. You can type a Description of the stamp (optional).
Set dates of stamp's availability: starting date From and expiration date Up to. The stamp will not be available for
users before and after this period.
If you set stamp to be Frozen, then no users will have access to this stamp.
You can check if the stamp is already Exhausted or not. This option cannot be configured. If stamp is exhausted, it
means that one or several of its elements have reached their last counter value and no stamp values can be given to
users.
Fields delimiter is a symbol or a set of symbols which is used to separate stamp elements.
To see or to edit stamp's elements list, click Elements. To preview stamp values, use Preview.
Stamp elements
Every stamp can contain several elements separated by defined delimiter. Elements in output stamp value have the
same order as in the list in this dialog. To change order, use Move up and Move down buttons in bottom-right corner
of Stamp Elements dialog.
To create a new stamp element, click Add. To remove an existing element, use Delete. To view or change element's
settings, click Properties, and Stamp Element Properties dialog will open. To preview the stamp values, use Preview
button.
Stamp element properties
Stamp elements are parts of stamp divided by predefined delimiter.
Type - enter stamp element type. 7 types of elements are supported:
Literal. This type represents integer numbers as sequences of Latin letters A-Z and has 26-based notation. Each
letter corresponds to a number (example: "A" = 0, "L" = 11, "Z" = 25, "BA" = 26 etc.). Minimal legal value is
-2147483848 and maximal is 2147483647.
Literal-Numeric. This type is based on 36-based notation. Integer numbers are represented as Latin letters A-Z and
decimal digits 0-9. Each combination of letters and digits corresponds to a number (example: "A" = 0, "Z" = 25,
"0" = 26, "9" = 35, "BA" = 36, "B" = 62 etc.). Minimal legal value is -2147483848 and maximal is 2147483647.
Numeric. This type represents integer numbers. Minimal legal value is -2147483848 and maximal is 2147483647.
Numeric-Literal. This type is based on 36-based notation. Integer numbers are represented as decimal digits 0-9
and Latin letters A-Z. Each combination of digits and letters corresponds to a number (example: "0" = 0, "9" = 9,
"A" = 10, "Z" = 35, "11" = 36, "1B" = 46 etc.). Minimal legal value is -2147483848 and maximal is 2147483647.
Roman. Positive integers represented as Roman numbers. Minimal legal value is 1 and maximal is 3999.
Text. Static text string.
Time. This type represents time and date according to specified format. Minimal value is 00:00:00 01.01.1970 and
maximal value is 03:14:07 19.01.2038.
For every type, configure the following settings.
226
Leading symbol - a symbol, that fills up unused cells in element's length. For example, if the type is Numeric, length
is 3, leading symbol is 0, and the counter is 1, then the element's value will be "001". When this string is empty,
unused characters are not filled.
Character case - select one of three available options: as is, uppercase and lowercase.
Length - specify how many characters are allocated for this stamp element.
Note: If the length is too short for the element, an error will occur while using the stamp.
Format - this setting is available only for Numeric, Text and Time types.
For Numeric type, format of number can be set to Space separated, Comma separated or No separator.
For Time and Text types, static text or tags can be used. For example, %.9L-%.2D, %Y format string represents date
as: <English name of a month>-<Two-digit day of month>,<Full year>.
The following Time tags are supported for Time type format:
Tag
Meaning
%Y
Full year (1970-2038)
%.2Y
Last two digits of year (70-38)
%M
One or two digit month (1-12)
%.2M
Two digit month (01-12)
%.9L
English name of a month
%.9W
English name of day of week
%D
One or two digit day of month (1-31)
%.2D
Two digit day of month (01-31)
%H
One or two digit hours (0-23)
%.2H
Two digit hours (00-23)
%h
One or two digit hours (0-12)
%.2h
Two digit hours (01-12)
%m
One or two digit minutes (0-59)
%.2m
Two digit minutes (00-59)
%S
One or two digit seconds (0-59)
%.2S
Two digit seconds (00-59)
%T
One digit Ante/Post Meridiem (A/P)
%.2T
Two digit Ante/Post Meridiem (AM/PM)
%%
Single percent symbol
For Text type, a number of text macros are supported.

Counter range - specify range for the counter. Counter is the current value of the element, except for elements of
Text type. Text is always static and counters are not applicable to it.
First value is the starting value for the counter.
Last value is the last legal value for the counter.
227
For example, if you want to set page numbers and your documents contain not
greater than 560 pages, set First value = 1 and Last value = 560. (Note that
Length of the element must correspond to the values; in this case it should be
set to 3 or greater).
Cyclic - select this check box to make the counter looped. This means that the
First value is the next legal value of the counter after the Last value. When
the counter value exceeds Last value the next value will be taken from the
range just like if First value follows the Last value. If the option is off, then
the element takes no value after the last one and the stamp is exhausted in this
case. The users cannot take values of the stamp in this case.
Current value is the current value of the counter. This value must belong to
the range from First value to Last value.
Counter settings - configure setting for the counter behavior.
Increment by - enter a value of counter increment on each generation of
a stamp value. This means that next counter value will exceed the previous
one by this value. Increment can also be negative, but in this case First value
must be greater than Last value, and the counter will decrease. If you set
Increment counter to 0, the counter will remain changeless.
For Time type, increment has two positions: time units (Seconds, Minutes,
Hours, Days, Weeks, Months, Years) and number of chosen units (e.g. 3
hours).
Every option shows how often the counter increases. You can select increase
condition: number of generated stamp values or number of requests.
If you choose Stamp values, then counter will increase by Increment value
after every set of stamp values which quantity is defined in Every. In other
words, the defined number of equal stamp values will be created and only
after that the counter will increase. See examples below.
If you select Requests, then the counter will increase in every N'th requests
where N is the defined number in Every, regardless of the number of stamps
in each request.
Note: Number defined in Every must be
positive (1 or greater).
Some examples to explain how it works
Type is Numeric, First value is 9, Last value is 0, Cyclic is on,

Increment by is -1 and Every is set to 1 stamp value. In this situation
counter will change from 9 to 0 taking all intermediate integer values, then
it will be 9 again and the process will repeat.
Type is Numeric, First value is 0, Last value is 9, Cyclic is
on, Increment by is 4, Every is set to 1 stamp value. The values of the
element will be the following: 0, 4, 8, then 2 (as 8+4>9), 6, 0 etc.
Type is Time, First value is 00:00:01 01.01.2000, Last value is
23:59:59 31.12.2000, Cyclic is off, Increment by is 1 day, Every
is set to 3 requests. The counter will change from January,1,2000 to
December,31,2000 taking all intermediate dates and every 3 requests
will have equal stamp values not depending on number of stamps in each
request. The last generated stamp value will be 00:00:01 31.12.2000 and
then the stamp will be exhausted. This can be useful, for instance, if a user
228
needs to stamp daily all pages of 3 documents with different number of

pages, and he wants to see dates of year 2000 as stamp values.
Number of used stamp values /Number of used requests is the current
number of stamp values or requests created for the current value of counter
(must be nonnegative integer less than Every). This value is updated
automatically when users make requests for the stamp.
For example, you set to create 5 stamp values for every counter value (Every
is set to 5 stamp values), but for current counter 3 stamps have already been
received by users. Therefore Number of used stamp values will be 3.
Reset counter after request - check on this option if you need the counter to take First value after each request.
Number of used stamp values / requests will also be reset (to 0).
For example, a user needs to number pages in current document and asks for the same number of pages. Next time
he asks for another quantity of pages, but the counter must still start from 1 (assuming that First value is 1) again. Set
First value to 1 and Reset counter after request set to ON.
Text macros
The following macros are supported for Text type:
%(TIME(<time format>))
Current GM time where <time format> is a format string

similar to the format string of Time type. All time tags
described in Stamp element properties are supported, but
they are static and always return current GM time.
%(USERNAME)
The name of the user who obtains the stamp.
>%(USERDESCRIPTION)
>The description of the user who obtains the stamp.
%(NAME)
The name of the stamp.
%(DESCRIPTION)
The description of the stamp.
There is no possibility to create your own macros.

Preview stamp
This window helps to preview stamp values as they will be received by users. Current counters values do not depend
on preview requests.
Click Add button to add a request. This action simulates a situation as if a user sends a request for several values of
the stamp. To view the corresponding stamp values, click Preview.
You can change the number of values in existing request. To do this, click Properties and input a new number.
To delete a request, use Delete button.
Request properties
Input Number of stamps in request. This will allow you to receive a desired number of stamp values.
Stamp groups
Stamps can be united into groups. User who has the rights for a group can use all stamps of this group. Group
properties are configured in Stamp Groups tab.
To create a new stamp group, click Add or use double click on empty space. To remove an existing group, use Delete
button or keyboard Delete key. To view or change groups settings, click Properties or use double click on the group's
name, and Stamp Group Properties dialog will open. To view stamps in groups, use Stamps button.
Stamp group properties
Every stamp group must have a unique Name. You can type a Description of the group (optional).
229
Use Stamps button to add or delete Group stamps.

Group stamps
You can select any stamp from Available stamps list and add it to the group with Add button or double click on
the stamp name. If you need to remove a stamp from the group, select the stamp in Stamps in group list and click
Remove button or use double click on the stamp name. Note that the stamp is not deleted, it just returns to the list of
available stamps.
Users
Users are the service's clients of a special type. They can use stamps values but cannot configure them.
Bates Stamp Server administrator can create users and provide them with stamps. Access to stamps is granted by
whole groups, that is, administrator grants access to a stamp group to a user, after that the user can request values
of any stamp from the group. Granting access to individual stamps is not supported (to provide it, create a group
including a single stamp and grant access to this group). Stamps not included in any group are available for any user.
Users' properties are configured in Users tab.
To create a new user, click Add or use double click on empty space. To remove an existing user, use Delete or
keyboard "Delete" key. To view or change user's settings, click Properties or double click on the user's name, and
User Properties dialog will open. To view available stamp groups, use Stamps button.
A user needs a certificate to get access rights to Bates Stamp Server. Certificate is a file created by Bates Stamp
server. To save a certificate for particular user, select a user in the list and click Save certificate. The file should be
sent to the user.
User properties
Every user must have a unique Name. You can type a Description of the user (optional).
Set user's Expiration time and date. The user will not be able to work with the service when he becomes expired.
You can postpone user's expiration date. You can also disable the user by setting expiration date earlier than current.
To view the user's stamp groups, click Groups. To grant a certificate to the user, press Save certificate.
User groups
You can select a group from Available groups list and add it to the user with Add button or double click. If you need
to remove a group from the use's list, select the group in User groups and click Remove button or use double click on
the group's name in the list.
Note: The group is not deleted, it just gets not available for the user.
The web service interacts with its clients - administrators and users - through secure SSL channel. The security
level used provides only encryption of all the data transferred between client and server sides, and does not
provide authentication of web service to its clients.
Problem description
Cannot connect to Bates Stamp Server.
Solution
Check the following:
230
Problem description
Solution
Your machine is connected to local net;

BSS login options (server IP address and interaction
port) are correctly specified;
The certificate file is present and valid (not expired).
Note: Note that while connecting via Internet
some ports can be blocked, for example, by
proxy-servers. In this case contact your BSS
Supervisor.
Cannot save stamp, group or user.
1. This can happen if connection with the web service

is lost. Check that the web service is started on server
machine. Check that you can connect to the server
machine.
2. Stamps, groups and users, which contain incorrect
data, cannot be saved. Check the settings and correct
them if necessary.
Bates Stamp Server Supervisor

Welcome to Bates Stamp Server Supervisor
hand-held numbering machine invented by Bates Manufacturing Co. in 1890s in New York State. Bates stamping
machines are still used by lots of companies around the globe for tedious manual document stamping operations.
Bates Stamp Server is a software which provides manipulation with a set of stamps. The software works as a web
service and can be used by clients remotely. The web service interacts with its clients through secure SSL channel.
Bates Stamp Server Supervisor configures the software parameters and grants access to the server to Bates Stamp
Server Administrators (special type of clients) by generating special certificate files. Supervisor can prohibit
administrator from access to the server at any time.
The following scheme presents the architecture of Bates Stamps Server software:
231
The security level used provides only encryption of all the data transferred between client and server sides, and does
not provide authentication of web service to its clients.
Getting started
Feature highlights
Within Bates Stamp Server Supervisor application, the following features are provided:
Configuring web service options (interaction port and log content)

Restarting web service
Creating and deleting Bates Stamp Server administrators and providing them with certificates
Extending administrators' "lifetime"
Using Bates Stamp Server Supervisor

1. Set correct interaction port number. Selected port must not be used by another application. Note that while
connecting via Internet some ports can be blocked, for example, by proxy-servers.
2. Configure log file options.
3. To apply all the settings, you must restart service or start it if it has not been started yet.
4. Add administrators as it is required by your business process.
5. Save certificate for every administrator in a separate file and send it to corresponding administrator in a safe way.
Configuring
General
Enter Port number which will be used for interaction with the Bates Stamp Server web service.
Set Log file directory - a folder where Bates Stamp Server log must be generated. You can set to Create log file
daily or weekly. Enter the number of days you want to Keep log file - after this period the log will be deleted by the
service.
Select Log operations and Log objects; the log will contain information about chosen parameters. Switch on Log
network events and/or Log service events if necessary.
To save service settings, click Apply. The changes will be applied to the service after restart.
To restart service, click Restart service button.
232
Use Administrators button to configure Bates Stamp Server administrators.

Administrators
Bates Stamp Server administrators are the service's clients of a special type.
Bates Stamp Server supervisor can add administrators and provide them with certificates. All administrators are listed
in Administrators dialog.
To add a new administrator, click Add or use double click on empty space. To remove an existing administrator, use
Delete button or keyboard "Delete" key. To view or change administrator's settings, click Properties or use double
click on the administrator in the list, and Administrator Properties dialog box will open.
An administrator needs a certificate to get access rights to Bates Stamp Server. Certificate is a file generated by
the service. Select an administrator from the list, create a separate file for him clicking Save certificate button and
provide the corresponding administrator with the file in preferable safe way.
Note: Note that you must support confidentiality of the certificates.
Administrator properties
Every administrator must have a unique Name. You can type a Description of the administrator (optional).
Set administrator's Expiration time and date. The administrator will not be able to work with the service when he/
she becomes expired. You can extend the administrator's "lifetime" by changing the expiration date. You can also
disable the administrator by setting expiration date earlier than current.
To save a certificate for the administrator, press Save certificate.
You do not need to restart service to apply changes made in this dialog.
The web service interacts with its clients, for example, administrators, through secure SSL channel. The security
level used provides only encryption of all the data transferred between client and server sides, and does not provide
authentication of web service to its clients.
Binder
Welcome to Binder Component
Binder process component allows you to bind multiple TIFF documents into one TIFF document, when, for example,
you want to process a document consisting of more pages than an MFP device automatic document feeder can handle
at one time. The pages are accumulated into one document and passed into the workflow according to a specified
condition, such as for recognition or for conversion to a searchable format as a whole document. The condition can be
based on the number of pages in the document, its size or any other information received via RRT from the previous
components.
Getting Started
Feature Highlights
The component provides the following features:
Accumulate the pages of the input TIFF documents in one document;

Pass the resultant TIFF document to further components in the process;
Release the resultant document according to a condition evaluated at run time.
How to Use the Binder Component

An example of the component usage.
1. Scan document pages from an MFP device, bind them altogether, convert the resultant document to the searchable
format, and send it to a local folder.
233
2. Design a workflow process by selecting the MFP component according to the device type, the Binder component,
the OCR component and the Send to Folder component.
3. Configure the MFP component to allow users to specify the value of the release condition when scanning batches
of documents.
4. Configure the Binder component to get the release condition) value as an RRT. Configure the other components in
the process.
5. Save changes to the workflow and start the process.
6. At the control panel of the MFP device, the user enters a preconfigured function key, specifies the release
condition value as 0, and begins scanning the document.
7. To complete the binding of the scans, the user specifies another value of the Flag (for example 1) when scanning
the last batch of pages for that document.
The document generated by the process is sent to the OCR component, converted to the searchable format,
and sent to the predefined folder.
Now it is possible to perform a search through the whole document, which is bound from all the scanned pages.
Configing the Binder Component
Binder Dialog Box
Use options in this dialog box to activate and configure the Binder component in a workflow.
Note: You can use RRTs to configure all of the options of this dialog box.
Option
Description
Activate
Activate the component according to a condition . The

condition is evaluated at run time. For more information,
see Conditional Activation.
Pass through
Select this check box to pass the documents to

subsequent components in the workflow. If this check
box is selected and the release condition is evaluated
to be FALSE, the document is added to the specified
volume and passed for additional processing.
Working directory
Enter the path to the working directory that the

component uses to keep temporary files into which the
input documents are added until the release condition is
satisfied.
Add to volume
Enter the identifier of the document which will

accumulate the pages of the input documents. When the
component starts to process input documents, it creates
a temporary directory named by the specified ID within
the working directory. In this directory, the component
creates the AsBinder.tif file, which binds all the
pages of the input documents. Input documents are
added to this file as long as the release condition remains
FALSE. The invalid symbols (\ / " : < > | * ?) will be
replaced by the underscore symbol (_).
Output file name
Enter the name of the file that will be passed to

subsequent components in the workflow for further
processing. Invalid symbols (\ / " : < > |* ?) will be
replaced by the underscore symbol (_).
Release condition
Enter the condition that determines when the component

releases documents into the process. As long as the
condition is evaluated to be FALSE, the component
234
Option
Description
accumulates input documents and adds them to a
temporary file. When the value of the condition changes
to TRUE, the resultant document is passed to the further
processing and the temporary directory is deleted.
The condition value can be obtained via RRT from
this or previous components. For example, when
the RRT scheme is ~BND::TotalCount~>=10,
the document will be released when the number of
pages in the document reaches or exceeds 10. If the
value of the condition is TRUE and the component
receives a document, it will be simply passed to the
next component rather than being bound to subsequent
documents. The syntax of the release condition is the
same as for activation (see Conditional Activation).
You can initially set the condition to FALSE and then
change it manually to TRUE after all documents are
accumulated.
Check after adding each page
The component will add the document page by page and

check the condition after adding each page. Otherwise
the condition will be evaluated after the whole input
document is added to the temporary file. For example,
if you have input documents with different number of
pages and want the output documents to have the same
number of pages, you can select this option and set the
release condition like this ~BND::TotalCount~=10.
Note: If you do not select this option, the
release condition might never be satisfied.
Reject Binder on error
Select this check box to reject a document when the

component fails to save processed pages into the
temporary file. If this check box is not selected the
component will skip the failed page and continue
processing input documents. This check box is selected
by default.
Limits on volume
This group contains additional restrictions on the output

file. This is a preventive measure to avoid the situation
of an incorrect release condition (which cannot be
satisfied, for example, or which is too specific), in which
the output file will grow indefinitely. If these options
are used the document will be released when one of
the limits is reached regardless of whether the release
condition is met or not.
Release file if limit is exceededSelect this check

box to turn on additional restrictions.
Max page countThe maximum page count.
Max file sizeThe limit on the file size.
Note: The minimum value for Max page count
and Max file size is 1, and the maximum value
is 2147483646.
Output file options
This group defines whether to save and where to save

processed and rejected files.
235
Option
Description
Keep processedSelect this check box to save

successfully processed files into a specified directory.
Keep rejectedSelect this check box to save
rejected documents into a specified directory.
Note: If you process several documents
with condition value FALSE and then stop
the process, the AsBinder.tif file stays
in the temporary directory. If you start the
process again and send several documents
with condition value FALSE, the component
continues to accumulate documents pages in this
file.
Release Condition Examples

Release the document
when its size exceeds 1MB
Release the document when its

number of pages reaches 10
The condition should be "greater or equal" and not

simply "equal", because file size is rarely equal to
a specified number. In this case, you could use the
condition ~BND::FileSize~>=1073741824.
Make sure that the number of pages can be reached. For
instance, if you add only 2-page documents, every 5 files
will amount to one 10-page document. If you have only
3-page documents, then they will never attain 10 pages.
To split documents by pages, you can use the

condition ~BND::TotalCount~=10 and select
the Check after adding each page option.
To avoid splitting documents, you can use the
condition ~BND::TotalCount~>=10 to assure
that documents do not get stuck.
Release the document on a specific date
To release a document on Christmas day, you could

use the condition (~BND::%m~=12) & (~BND::
%d~=25).
Use RRTs of preceding components
When the FTP Poll component captures files

from an FTP location, you can use the condition
~FTP::FileName~=="last.tiff" to release a
captured file.

236
Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
237
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
238

Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
1Boolean
2, 3Any
239
Symbol
Description
Result type
Operands type
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Binder Component RRTs

Component RRT ID
The RRT ID for this component is BND.
RRTN
Description
~BND::TotalCount~
The number of pages in the document that is specified by

the Release condition or the Output file name option
in the Binder configuration dialog box. This RRT can be
used as an external RRT as well.
~BND::FileSize~
The size of the document that is specified in that is

specified by the Release condition or the Output file
name option in the Binder configuration dialog box.
This is an internal RRT.

Name
Description
%a
%A
%b
240
Name
Description
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Example of usage of the SSRTN:

~BND::%Y~-~BND::%m~ will be replaced with "2009-04".
The component binds only the TIFF image documents. If the component receives the document of unsupported
format, it gives the warning message in the Status Monitor and passes the document to the next component in the
workflow. If you try to bind several documents including one document of the unsupported format and then to
send the resultant document for further processing, the documents will be bound except for the document of the
unsupported format and the resultant document will be sent for further processing. The supported formats are:
Tagged Image File Format (TIFF)

TIFF files ABIC compression
TIFF no compression, CMYK data
TIFF YCbCr color space, no compression
TIFF PackBits compression, RGB data
TIFF PackBits compression, CMYK data
TIFF YCbCr color space, PackBits compression
TIFF Format with LZW compression
TIFF LZW compression, CMYK data
TIFF YCbCr color space, LZW compression
Jpeg Tag Image File Format (JPEG TIFF)
JPEG 4:2:2 color space
JPEG 4:1:1 color space
TIFF CMP
TIFF JBIG
TIFF files with JBIG2 compression
TIFF DXF R12
241
TIFF DXF R13

TIFF Wavelet CMP
TIFF Jpeg2000 stream
GeoTIFF files
uncompressed RGB Exif file
uncompressed YCbCr Exif file
JPEG 4:2:2 compressed Exif file
JPEG 4:1:1 compressed Exif file
TIFF CCITT
CCITT Group3 one dimension
CCITT Group3 two dimensions
CCITT Group4 two dimensions
TIFF file with unknown compression
LEAD ABC 1 bit, lossless compression
TIFF files with MRC compression
TIFF LEAD MRC
The component saves the documents in the following formats:
Binary images are saved in CCITT G4 format.
Other types are saved as TIFF with LZW compression.
The component deletes the tags in the input document when converting it into the output document if they are not
supported by the output format.
The component is not designed for delayed or scheduled document binding. Document binding occurs as soon as
documents appear in the input, and documents are released and passed for further processing as soon as the release
condition is satisfied.
No information is currently available.
Box
Welcome to Box
Box route and eConnector components are designed to send documents from a workflow to Box, an online service for
storing, managing and sharing documents. The component utilizes an existing account to access the service.
The component can be used both as a route and a process component.
Getting Started
Feature Highlights
The component provides the following features:
Uploading documents to the Box service.

Tagging support.
Sharing of the uploaded files.
How to Use the Box Component

Use the Box route component to route processed files to the Box service.
This procedure describes how to configure a workflow to route files from an FTP site to a Box folder.
1. Create a new AutoStore task and add the FTP Poll capture and Box route components to create a workflow.
2. Configure the FTP Poll componenent to capture documents from an FTP site.
242
3. On the Components tab of the Add FTP Site dialog box, click the Box component and then click the Configure
button.
4. Configure options for logging into the Box service.
Captured documents will be sent to the Box service as soon as they appear on the FTP site.
Configuring Box
Box Component Settings Dialog Box
Set options in the Box or Box eConnector dialog box to log into the Box system.
Option
Description
Activate
This check box activates the component according to a

condition (see Conditional Activation). This option is
available only for the eConnector.
Pass through
Select this option to pass the document to the subsequent

components in the workflow. This option is available
only in eConnector.
Login
This field contains the account name and email of the

logged on user. This field is read-only.
Log in
Click this button to log in to the box service. This opens

a Box Login window for the Box service that allows you
to log on to the service (for more information, see How
to log in to the Box service).
After your loggin in is completed, the user name and
email are displayed in the Login field.
Log out
Click this button to log out. This closes the current token.
Destination
Specify the folder in the Box account into which the

documents will be uploaded. If the specified folder does
not exist, it will be created at run time. Click browse
button (...) locate an existing folder in the Box Directory
window. If you leave this field blank, documents will be
uploaded to the root folder in the box directory. You can
use RRTs in this field.
The length of the folder name is limited to 100
characters. The name of the folder can contain neither
of the following characters: / \ ". The back slash and
forward slash characters (\ and /) can be used as folder
separators. The root folder is indicated by the back slash
(\).
Rename file
Select this check box to enter a rename scheme for

routed files.
For example, if the original document name is
Mythology, Madness and Laughter: Subjectivity
in German Idealism. Slavoj iek.pdf, then
~BXR::FileName~_~BXR::Counter,3~~BXR::FileExt~
will be replaced by Mythology, Madness and Laughter:
Subjectivity in German Idealism. Slavoj iek_001.pdf.
Select this check box to replace invalid characters in the

filenames with the underscore character (_). If this check
box is not selected and the file name contains the invalid
243
Option
Description
characters / \ ", then the file will not be uploaded to
the server.
Overwrite existing file by adding new version
Select this check box if you want that the components

adds a new version of the file into the Box repository.
Description
Provide a description for the files that are uploaded to

this location.
Tags
Enter a list of comma separated tags that will be added to

the uploaded files.
Share
Click Yes in this box to share uploaded files with other

users. This functionality is provided by the Box service.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



244
Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
245

Constants
Examples:
246

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
247
How to log in to the Box service

Perform the following steps to log in to the Box service.
1. In the main configuration window of the Box component, click Log in button.
This will open Box login window.
2. In the Box login window enter the valid Email/User name and Password for the Box account, to which you want
to connect, and click the Authorize button to log in to the Box service.
3. Click Grant access to Box button.
After logging in you will be returned to the main component configuration window. If your logging in is successful,
the user profile information will be written in Login text box and the component will save the token, received from
the service. This token will be used for further access to the server.
Remember: The Box service establishes a connection timeout for logging in; the timeout is 30 seconds. If
you exceed the connection timeout, your logging in will fail.
Box Component RRTs
Component RRT ID
The RRT ID for this component is BXR.
The component replaces the following RRTNs:
Name
Description
~BXR::FileName~
Original name of the file that is being uploaded.
~BXR::FileExt~
Original extension of file that is being uploaded (with

dot-symbol).
~BXR::Counter,3~
An automatically generated number which provides

a unique name for the file that is being uploaded
and renamed with the use of a rename schema
containing this RRT, where 3 is the number of digit
positions that will be used for the counter; for example,
~BXR::Counter,3~ will be replaced with 001.
The counter value replaced within the rename schema
provides a unique file name. You can change the number
"3" to any other number from range of 1 to 99 that will
be used for the counter.
~BXR::GUID~
Replaced by a globally unique identifier generated at

run-time, contains only upper-case hexadecimal letters
and digits. It can be used for generating a unique file
name.
~BXR::FileId,*~
The identifier of the uploaded file, where * wildcard

character matches the number of an uploaded file
(1, 2, ). This RRT can be used only in following
components.
~BXR::URL,*~
URL of the uploaded file, where the * wildcard character

matches the number of an uploaded file (1, 2, ). This
RRT is available only for the shared files. Otherwise it
will be replaced with an empty string. It can be used only
in following components.
~BXR::URL~
URL of uploaded files. If the component receives a batch

of several documents, this RRT represents the string,
248
Name
Description
containing URLs for all uploaded files corresponding to
the documents inside of the batch delimited by space.
This RRT can be used only in following components.
~BXR::FinalName,*~
The final name of uploaded file, where * wildcard

character matches the number of an uploaded file
(1, 2, ). This RRT can be used only in following
components.
~BXR::FileCount~
The number of all uploaded files. This RRT can be used

only in following components.

The component supports the following SSRTNs:
Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

No information available.
No information available.
249
Content Management Queue

Welcome to Content Management Queue
Documents from all sourcessuch as an MFD, digital copier, or fax servercan be routed to a Queue component
for post-capture functions such as indexing and validation, document conversion, and document form recognition.
This component utilizes ODBC compliant databases for storing and/or retrieving documents in/from queues. This
provides flexibility to users in their choice of platform for small to large projects.
Getting started
Feature highlights
Use this component to:
Select the Data Source of your choice.

Provide access protection by specifying user name and password credentials of the database.
Identify the queue into which you are placing the files.
Specify status of these file as "reviewed," "pending," and so forth.
Set the priority of the files within the queue.
Using Content Management Queue

Use this versatile component to setup processes that provide Indexing and Validation, Workflow management,
Distributed processing benefits.
Documents captured from several sources can be routed to designated queues based on the type of document.
Multiple queues can be monitored and documents can be manually indexed and validated using split-screen
image/form display.
Any document process can be performed in distributed and cluster mode using the queue method
250
Queues can be used for simple and complex Workflow by setting the document status to various configurable
values such as "Reviewed", "Approved", and so forth.
Queues can be setup for distributed processing and load balancing.
The example below shows how load balancing and distributed processing may be achieved using Content
Management Queue component. Consider a process where scanned documents require post capture OCR processing
and storage in SharePoint Portal 2003. One way of storing OCRed documents into SharePoint Portal is to do so, by
defining one process as shown in the first box below.
A distributed model of this is depicted by the second box, where one process is broken down to two stages. First
process stage, places the XML wrapped object into temporary queues with relevant status and priority designations.
The second stage of the process is where the documents are picked up from the Queues created by the first stage,
placed in to appropriate queue(s) for OCR processing and final storage to SharePoint Portal. The advantage offered
by the second method is that you can have multiple second stage processes defined on multiple servers to achieve
distributed processing, and scalability.
Configuring Content Management Queue

Content Management Queue options
The component options determine the data source, user credentials, queue name, and status for the Content
Management Queue component in a workflow.
To configure options for the Content Management Queue component, double-click the component icon in the
workflow. To configure a processing or routing component in the same workflow, click the icon for the processing or
routing component.
Option
Description
Data Source
Select the data source to which you want to queue the

files to. Make sure you have the data source attributes
correctly, as you will not be able to select the Queue
name or Status otherwise.
User Name
If the data source has user access privileges, enter the

user name to use for the data source connection.
Password
Enter the password that corresponds to the user name.
251
Option
Description
Queue Name
Specify the queue name to which to queue files. You

may add new queues by selecting the Add button and
entering a new name for a new queue.
Status
Specify the status of the files. You may add a new status
by selecting the Add button and entering a new name,
such as "pending" or "approved".
Priority
The priority determines the order that files will be

serviced out of the queue. You can select Low, Normal,
or High. High priority files are serviced first, normal
priority files are serviced second, and low priority files
are serviced last.
Termination Script
Shows when a job in a queue has completed its

workflow. The termination script lets an administrator
decide what to do with a record after it has been
processed by the workflow. For example: Send to email.
Clicking this button opens the Termination Script
dialog box. There are three Termination Script options :
FileSpecifies the script file name.

NameSpecifies the name of the entry point for the
script.
LanguageSpecifies the script type. Choose either
JScript (for JavaScript) or VBScript.
Content Management Queue Component RRTs

This component does not generate Runtime Replacement Tags (RRTs), however all the parameters can contain RRT
strings. For example, when POP3Email is the capture (source) component, the Queue Name parameter can be set to
"~POP::Subject~" to set the Queue Name dynamically using the Subject.
Problem Description
Solution
Cannot add a new queue name or status.
Make sure that your data source is valid, and it is

configured correctly.
The queue items keep increasing and do not get deleted.
This component does not delete any queue items. You

need to use a VBScript to implement a proper deletion of
documents based on your business process requirements.
The user cannot select multiple queues to place files into.

If all the files have a Low Priority, then they are processed in the order they come in.
The queue items are not deleted. Use VBScripts to delete items from the queue.
252
Data Filter
Welcome to Data Filter
Data Filter process component allows generation of useful metadata for a given workflow based on input metadata
received via RRTs from the preceding components. It is meant for performing various string operations such as:
concatenation, splitting, capitalizing, and validation operations: starts with, equals to, match regular expression. The
results of these operations are passed to the subsequent components in the workflow.
The component allows specifying a number of filters that are applied to the input data, which can be an RRT from a
previous component or from a previous filter. The filters are applied in the order they are listed in the configuration.
The component provides data filters of the following types:
Replace
Match Regular Expression
Starts With
Ends With
Equals To
Contains
Make Upper Case
Make Lower Case
Trim
Clean Up
Format Date
Format Time
Concatenate
Lookup in DB
Split
Parse CSV
Validate
Evaluate Expression
Getting started
Feature highlights
This component provides the following features:
Performing string operations to the input data using the following filters:
Clean Up
Concatenate
Contains
Ends With
Equals To
Evaluate Expression
Format Date
Format Time
Make Lower Case
Make Upper Case
Replace
Starts With
Trim
253
Splitting the input string using the Split filter.

Parsing CSV string using the Parse CSV filter.
Retrieving data from a database using the Lookup in DB filter.
Rejecting the current job if the input\output of a filter is invalid. The situation of invalid input\output depends on a
particular filter.
Additional validation of the filter's result using the Validate filter and rejecting the current job with the configured
error message if validation fails.
Generation of RRTs with the filters' results and passing them to the subsequent components.
How to Use Data Filter

The below scenario is an example of the component usage.
A user sends documents to Workflow Server via an AutoCapture form. Each document describes a product, and the
products Part Number is entered into the form. Workflow Server should rename the document to another form of a
Part Number using the Manufacturer information and send it to a folder named by the products delivery date in the
format MM-DD-YYYY. Manufacturer and delivery date should be retrieved from a database using the Part Number
as a key. For example, if the part number is TSR.1002, products manufacturer is Philips, and the delivery date is
05/18/2010, then the input document should be renamed to PHILIPS-TSR-1002 and sent to the folder 05-18-2010.
For this purpose, perform the following steps:
1. Build the workflow with AutoCapture, Data Filter and Send to Folder components.
2. Configure AutoCapture component to receive Part Number information.
Configure the following sequence of filters in the Data Filter:
3. Split filter to split the string by . delimiter.
4. Lookup in DB filter, to retrieve the Manufacturer name and the delivery date from a database using the input data
in the SQL query.
5. Format Date filter, to convert the delivery date into the MM-DD-YYYY format.
6. Make Upper Case filter, to convert the Manufacturer name into upper case.
7. Concatenate filter, to concatenate the data to build new Part Number.
8. Configure the Send to Folder component to send the document to the folder named by the delivery date using the
RRT generated by the Format Date filter and to rename the document using the RRT generated by the Concatenate
filter.
When the process is running and the user enters TSR.1002 value in the AutoCapture form, the document will be
sent into the "05-18-2010" folder and renamed to "PHILIPS-TSR-1002".
Configuring Data Filter
Data Filter main configuration window contains the option of activation of the component and the list of filters.
Option
Description
Activate
Use this combo box to activate the component according

to a condition. For more information, see Conditional
Activation.
Filters
This table displays the list of the filters that will be

employed in processing. Each filter receives input data
in the form of RRTs from other components or from the
preceding filters and generates the result also in the form
of RRT. The filters will be applied one after another in
order in which they appear in the list. The type of filter
and field name are displayed in the table.
The list of filters can contain several filters of the same
type. You can move a filter up or down using Up and
Down buttons on the right of the table. To add, edit
254
Option
Description
or delete a filter click the Add, Edit or Delete button
respectively.
The following filters are available:

Filter
Description
Clean Up
This filter transforms the input string by replacing

all characters that are prohibited from appearing in
filenames in Windows with a specified string.
Concatenate
This filter is intended for joining several RRTs with

another RRTs or with text strings.
Contains
This filter checks if the input string contains a specified

substring.
Ends With
This filter checks if the input string ends with a specified

suffix.
Equals To
This filter checks if the input string equals to a specified

string.
Evaluate Expression
This filter calculates the value of a given expression.
Format Date
This filter converts a string containing date in the system

date format into a string containing date in a custom date
format.
Format Time
This filter converts a string containing time in the system

time format into a string containing time in a custom
time format.
Lookup in DB
This filter retrieves data from a database.
Make Lower Case
This filter converts the input string to lower case.
Make Upper Case
This filter converts the input string to upper case.
This filter checks if the input string contains a substring

that matches a specified regular expression.
Parse CSV
This filter retrieves the CSV records field values from

the input string and generates RRT for each field value.
Replace
This filter replaces a specified substring within the input

string with a given text.
Split
This filter splits the input string around specified singlecharacter delimiters and generates RRT for each split
parts.
Starts With
This filter checks if the input string starts with a

specified substring.
Trim
This filter removes all leading and trailing white space

symbols from the input string.
Validate
This filter is intended for validating metadata generated

by other filters.
255
The Field name column contains the name that will be used as the name of the RRT generated by a particular filter.
The field name parameter should be configured in the configuration window of a particular filter.
Note: The "Field name" value must be unique for each filter, except for the Validate filter. The Validate filter
does not generate field RRT, so the Field name column value will be empty for this filter type.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
256

math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
257

Constants
Examples:

Boolean).
258
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
Clean Up Filter Dialog Box

This filter transforms the input string by replacing all characters that are prohibited from appearing in filenames in
Windows with a specified string.
By default, illegal symbols are replaced with '_'.
Option
Description
Field name
Enter the field name, which will be used as the name of

RRT containing the result of this filter.
Input
Enter an input string to be processed by this filter.
259
Option
Description
Replace with
Enter the string that will replace the illegal characters.

By default, the underscore symbol '_' is used.
Fail job if input/output is invalid
If this check box is selected, the current job will be

rejected if input or output is empty.
This filter generates the following boolean RRT that can be used in the Validate filter for metadata validation:
~DFT::%field name#IsEmpty%~. It is replaced with TRUE if the filter result is empty. Otherwise, it is
replaced with FALSE.
Result RRT:
~DFT::%field name%~ is replaced with the input string after the transformation.
The examples of the filter usage:
Input: invoice<<<MKH125067>>>
Replace with: _
The generated RRT will be replaced with: invoice___MKH125067___
Concatenate Filter Dialog Box
This filter is intended for joining several RRTs with another RRTs or with text strings.
For example, it may be used to concatenate several RRTs generated by other filters into one string.
Option
Description
Field name
Enter the field name of the FRTN generated by the filter.
Input
Enter the input string. Commonly, this string contains

several RRTs to be concatenated into one string . This
text box may contain multiline text.
If this check box is selected, the component will reject

the current job if input or output is empty.
Result RRT:
The RRT ~DFT::%field name%~ is replaced with the concatenation result.
Input: ~ACC::%First name%~ ~ACC::%Last name%~
Assuming that ~ACC::%First name%~ is replaced with "William" and ~ACC::%Last name%~ is replaced
with "Shakespeare", the generated RRT will be replaced with "William Shakespeare".
Contains Filter Dialog Box
This filter checks if the input string contains a specified substring.
Option
Description
Field name
Input
Enter a string to be tested for containing a specified

substring.
Contains
Enter the substring that will be looked for in the input

string.
260
Option
Description
Note: The filter generates an error if Contains
parameter is an empty string.
Match case
If this check box is selected, then the comparison is casesensitive. Otherwise it is case-insensitive.

the current job if either the input string or filter's result is
empty.
Result
This group of settings specifies the value of the

generated RRT.
On success
Specify a value for replacement of the generated RRT

in case the input string contains the specified value.
You can select a value from the predefined alternatives
(TRUE, YES, ON, 1) from the drop-down list or enter
any other value manually. The default value is TRUE.
On failure
Specify a value for replacement of the generated RRT in

case the input string does not contain the specified value.
You can select one from the predefined alternatives
(FALSE, NO, OFF, 0 ) from the drop-down list or enter
any other value manually. The default value is FALSE.
Result RRT:
~DFT::%field name%~ is replaced with the value configured as a success result if the input string contains the
specified substring and with the value configured as a failure result otherwise.
This filter generates the following boolean RRTs, which can be used in the Validate filter for metadata validation:
~DFT::%field name#IsSuccess%~ is replaced with TRUE if the filter operation ends with success.
Otherwise, it is replaced with FALSE.
~DFT::%field name#IsFailure%~ is replaced with TRUE if the filter operation ends with failure.
The example of the filter usage:

Input: Is there the digit two (2) in this string?
Contains: 2
Match case: unselected
On Success: TRUE
On Failure: FALSE
The generated RRT will be replaced with: TRUE.
Ends With Filter Dialog Box
This filter checks if the input string ends with a specified suffix.
Option
Description
Field name
Input
Enter a string to be tested. Commonly, RRT is used in

this text box.
Ends with
Enter the suffix.

261
Option
Description
Note: The filter generates an error if the Ends
with parameter is an empty string.
Match case
If this check box is selected, then the comparison is casesensitive. Otherwise it is case-insensitive.

empty.
Result
This group of settings specifies the value of the

generated RRT depending on the result of matching
operation.
On success

case the input string ends with the specified value. You
can select one from the predefined alternatives (TRUE,
YES, ON, 1) from the drop-down list or enter any other
value manually. The default value is TRUE.
On failure

case the input string doesn't end with the specified value.
You can select one from the predefined alternatives
(FALSE, NO, OFF, 0) from the drop-down list or enter
any other value manually. The default value is FALSE.
This filter generates the following boolean RRTs that can be used in the Validate filter for metadata validation:
Result RRT:
~DFT::%field name%~ is replaced with the value configured as a success result if the input string ends with a
specified substring, and is replaced with the value configured as a failure result.
Input: Is it a question?
Ends with: ?
On Success: TRUE
On Failure: FALSE
Equals To Filter Dialog Box
This filter checks if the input string equals to a specified string.
Option
Description
Field name
Input
Enter the string to be tested. Usually, RRT is used in this

text box.
262
Option
Description
Equals to
Enter the string to be compared against the input string.
Match case
If this check box is selected, then the comparison is casesensitive. Otherwise, it is case-insensitive.

empty.
Result
This group of settings specifies the generated RRT

depending on the result of matching operation.
On success

case the strings are equal. You can select one from the
predefined alternatives (TRUE, YES, ON, 1) from the
drop-down list or enter any other value manually. The
default value is TRUE.
On failure

case the strings are not equal. You can select one from
the predefined alternatives (FALSE, OFF, NO, 0) from
the drop-down list or enter any other value manually.
The default value is FALSE.
Result RRT:
~DFT::%field name%~ is replaced with the value configured as a success result if the input string equals to a
specified string and is replaced with the value configured as a failure result otherwise.
Input: EXACT MATCH
Equals To: exact match
Match case: selected
On Success: TRUE
On Failure: FALSE
The generated RRT will be replaced with: FALSE.
Format Date Filter Dialog Box
This filter converts a string containing date in the system date format into a string containing date in a custom date
format.
The input string should have a system date format of the machine on which the Workflow Server is installed. The
custom format may contain ordinary characters and format specifications.
Option
Field name
Description
263
Option
Description
Input
Enter the input string containing date in the system date

format to be converted into a custom format. Commonly,
RRT is used in this text box.
Format
Enter a custom date format for the output string. This

custom format may contain ordinary characters and
format specifications. The format specification is a
special character that represents a part of date string(day,
month, year, or day of week) or time string(hours,
seconds, minutes and so on), preceded by "%" sign. The
following characters for format specifications may be
used:
Insert
a - abbreviated weekday name,

A - full weekday name,
b - month abbreviation,
B - full month name,
c - date and time in the form defined by the locale,
d - day of month as a decimal number (01-31),
H - hour in 24-hour format (00-23),
I - hour in 12-hour format (01-12),
j - day of year as a decimal number (001-366),
m - month as a decimal number (01-12),
M - minute as a decimal number (00-59),
p - current locales A.M./P.M. indicator for 12 hour
clock,
S - seconds as a decimal number (00-59),
U - week of year as a decimal number with Sunday as
a first day of week (00-53),
w - weekday as a decimal number (0-6; Sunday is 0),
W - week of year as a decimal number, with Monday
as a first day of week (00-53),
x - date representation for the current locale,
X - time representation for the current locale,
y - year without century,
Y - year with century,
z - time zone name,
Z - time zone abbreviation.
Click this button to select a part of the custom format to

be inserted into the Format text box. When you click
this button, it displays the context menu of standard date
formats (for English and German localization) and the
list of main date format specifications. The top section
of the context menu contains the standard short date
formats; for example, "MM/dd/yy", "dd.MM.yyyy", and
so on. The middle section of the context menu contains
the standard long date formats; for example, "dddd,
MMMM dd, yyyy". The bottom section contains the
main format specifications.
When an item is selected in the list, it is inserted into the
cursor position in the Format text box in the form of
264
Option
Description
format specifications. For example, if you select "yyyyMM-dd", it will be inserted as "%Y-%m-%d".
Note: The date format does not support
the format specifications whose decimal
representation does not have a leading zero for a
single-digit day/month.

the current job if either an input date is invalid or an
output is empty. If this option is not selected and input
string contains invalid date, the component returns the
original value.
~DFT::%field name#IsInvalidDate%~. It is replaced with TRUE if the input string is not a valid date.
Result RRT:
~DFT::%field name%~ is replaced with the input string after the conversion.
Input: 5/18/2010
Format: %b %d, %Y
The generated RRT will be replaced with: May 18, 2010.
Format Time Filter Dialog Box
This filter converts a string containing time in the system time format into a string containing time in a custom time
format.
The input string should have a system time format of the machine where the Workflow Server is installed. The custom
format may contain ordinary characters and format specifications.
Option
Description
Field name
Input
Enter the input string containing time in the system time

format to be converted into a custom format. Commonly,
Format
Enter a custom time format for the output string. This

custom format may contain ordinary characters and
format specifications. The format specification is a
character that represents a part of time string(hours,
minutes, seconds, indicator for 12 - hour clock),
preceded by "%" sign. The following characters for
format specifications can be used:
H - hour in 24-hour format (00 - 23),

I - hour in 12-hour format (01 - 12),
M - minute as decimal number (00 - 59),
p - current locales A.M./P.M. indicator for 12-hour
clock,
S - second as decimal number (00 - 59),
265
Option
Description
Insert
X - time representation for current locale.
Click this button to select a part of custom format to be

inserted into the Format text box (as an alternative to
manual input). When you click this button, it displays
a context menu of standard time formats (for English
and German localization) and a list of time format
specifications. The top section of the context menu
contains the standard time formats; for example,
HH:mm:ss. The bottom section of the context menu
contains the list of main format specifications: %H, %I,
%M, %p, %S.
When an item is selected in the list, it is inserted into
the cursor position in the Format text box in the form
of format specifications. For example, if you select
"HH:mm:ss", it will be inserted as "%H:%M:%S".
Note: The time format does not support
the format specifications whose decimal
representation does not have a leading zero for a
single-digit hour/minute/second.

the current job if either the input string is invalid or
output is empty. If this option is not selected and the
input string is invalid, it will be returned at the output.
~DFT::%field name#IsInvalidtime%~. It is replaced with TRUE if the input string is not a valid time
string. Otherwise, it is replaced with FALSE.
Result RRT:
~DFT::%field name%~ is replaced with the input date transformed into the selected format.
Input: 2:46:49 PM
Format: %l:%M %p
The generated RRT will be replaced with: 2:46 PM.
Make Lower Case Filter Dialog Box
This filter converts the input string to lower case.
Option
Description
Field name
Input
Enter a string to be converted to lower case. Commonly,


empty.
266
Result RRT:
~DFT::%field name%~ is replaced with the string converted to lower case.
Input: lOwEr CaSe
The generated RRT will be replaced with: lower case.
Make Upper Case Filter Dialog Box
This filter converts the input string to upper case.
Option
Description
Field name
Input
Enter a string to be converted to upper case. Commonly,


empty.
Result RRT:
~DFT::%field name%~ is replaced with the string converted to upper case.
Input: UpPeR CaSe
The generated RRT will be replaced with: UPPER CASE.
Match Regular Expression Filter Dialog Box
This filter checks if the input string contains a substring that matches a specified regular expression.
Note: The component uses the ECMAScript grammar to evaluate regular expressions. For more information
about ECMAScript grammar, see TR1 Regular Expressions in the MSDN Library.
Option
Description
Field name
Input
Enter a string to be checked for inclusion of a substring

matching regular expression. Commonly, RRT is used in
this text box.
Match
Enter a regular expression.

Note: The filter generates an error if the regular
expression specified by the Match parameter is
invalid.
Match case
If this check box is selected, then matching operation is

case-sensitive. Otherwise it is case-insensitive.

the current job if the input is empty.
Result
This group of settings allows configuring values that will

replace the generated RRT in case of success and in case
of failure.
267
Option
Description
On success

in case if the matching is successful. You can select the
value from the predefined alternatives (TRUE, YES,
ON, 1) from the drop-down list or enter any other value
manually. The default value is TRUE.
On failure

case if the matching fails. You can select the value from
the predefined alternatives (FALSE, NO, OFF, 0) from
the drop-down list or enter another value manually. The
default value is FALSE.
Test
Click this button to check the correctness of the specified

regular expression in the Test Regular Expression
dialog box.
This filter generates the following boolean RRTs:
~DFT::%field name#IsSuccess%~ is replaced with TRUE if the filter operation ends with success;
otherwise, it is replaced with FALSE.
~DFT::%field name#IsFailure%~ is replaced with TRUE if the filter operation ends with failure;
otherwise, it is replaced with FALSE.
Result RRT:
~DFT::%field name%~ is replaced with the value configured as a success result if the input string contains a
sub-string that matches the specified regular expression, and is replaced with the value configured as a failure result
otherwise.
This filter generates the following RRTs to represent results of matching capture groups and sub-strings:
~DFT::%field name#Result%~ is replaced with the value of the sub-string that matches the specified
regular expression in the input string.
~DFT::%field name#Result,Index%~ is replaced with the value of the capture group of index number
Index.
Examples of the filter usage:

Example 1:
Input: Are there digits (1, 2, ...) in this string?
Match: [0-9]
On Success: TRUE
On Failure: FALSE
Example 2:
Input: fat gfoot fot
Match: (f)(o*)t
The generated result RRTs will be replaced as follows:
~DFT::%field name#Result%~: foot
~DFT::%field name#Result,0%~: foot
268
~DFT::%field name#Result,1%~: f
~DFT::%field name#Result,2%~: oo
~DFT::%field name#Result,3%~ and all RRTs with the following indexes will be replaced with the empty
value.
Test Regular Expression dialog box
In this dialog box you can test a regular expression against an entered string.
Option
Description
Input
Enter a string to be tested.
Match
Match case
Select this check box to perform case-sensitive matching.
Match
Click this button to see if any matches can be found.
Accept
Click this button to set test parameters as main

parameters for matching.
Replace Filter Dialog Box

This filter replaces a specified substring within the input string with a given text.
The substring to be replaced can be defined by a regular expression.
Note: The component uses the ECMA Script grammar to evaluate regular expressions. For more information,
see TR1 Regular Expressions in the MSDN Library.
Option
Description
Field name
Input
Enter an input string whose substrings are supposed to be

replaced. Commonly, RRT is used in this text box.
Find
Enter the substring to search and replace in the input

string. If Use regular expression option is selected, then
the entered value should be a regular expression.
Note: In the case of using regular expression,
the filter generates an error if a regular
expression specified in the Find text box is
invalid. If the value specified in the Find text
box is empty, the filter generates an error in any
case of the filter usage.
Replace with
Enter a value that will replace found substrings. If

Use regular expression option is selected, then the
entered value should be a replacement expression. A
replacement expression consists of text combined with
replace operators, like "$1" or "$2" (which are evaluated
as texts that match the capture groups at positions 1 and
2), "$&" (text that matches the entire regular expression),
"$$" (the '$' character) and so on.
Match case
If this check box is selected, then searching for a

substring (or matching a regular expression) is casesensitive. Otherwise, it is case-insensitive.
Use regular expression
If this check box is selected, then the component will

consider the text entered in the Find text box as a regular
269
Option
Description
expression and consider text entered in the Replace with
text box as a replacement expression. If this check box
is not selected, the component will consider the text
entered in these text boxes as text strings.
Test
Click this button to test the specified regular expression

in the Test Regular Expression dialog box. This button
is enabled only if the Use regular expression check box
is selected.
If this check box is selected the component will reject the

current job if either the input string or the replacement
result is empty.
This filter generates a special boolean RRT ~DFT::%field name#IsEmpty%~. This RRT is replaced with
TRUE if the filter's result is empty. Otherwise, it is replaced with FALSE.
Result RRT:
~DFT::%field name%~ contains the replacement result.
Example 1
Input: Press <key> to run help. <key> is a function key.
Find: <key>
Replace with: F1
Use regular expression: unselected
The generated RRT will be replaced with: Press F1 to run help. F1 is a function key.
Example 2
Input: Password is 123. User name is 567.
Find: ([^0-9]+)[0-9]+([^0-9]+)[0-9]+([^0-9]+)
Replace with: $1$2$3
Use regular expression: selected
The generated RRT will be replaced with: Password is . User name is .
Test Regular Expression Dialog Box
This dialog box allows verification of the specified regular expression.
Enter an input text and a regular expression you want to test and click Replace, the result of replacement will be
displayed in the Result text field.
Option
Description
Input
Enter an input string.
Find
Replace with
Enter a pattern for replacement.
270
Option
Description
Result
When you click the Replace button, this text box

displays the result of applying the Replace filter to the
Input value using the specified regular expression.
Match case
If this check box is selected, then searching for a

substring (or matching a regular expression) is casesensitive. Otherwise, it is case-insensitive.
Replace
Click this button to display the replacement result in the

Result text box.
Accept
Click this button to accept test parameters as main

parameters for the Replace filter.
Starts With Filter Dialog Box

This filter checks if the input string starts with a specified substring.
Option
Description
Field name
Input
Enter a string to be checked for starting with a specified

substring. Commonly, RRT is used in this text box.
Starts with
Enter the substring, the input string should start with.

Note: The filter generates an error if the Starts
with parameter is an empty string.
Match case
If this check box is selected, then the comparison is casesensitive. Otherwise, it is case-insensitive.

the current job if input is empty.
Result
This group of settings specifies the generated RRT

depending on the matching result.
On success

case the input string ends with the given substring. You
can select one from the predefined alternatives (TRUE,
YES, ON, 1) from the drop-down list or enter any other
value manually. The default value is TRUE.
On failure

in case the input string doesn't end with the specified
substring. You can select one from the predefined
alternatives (FALSE, NO, OFF, 0) from the drop-down
list or enter any other value manually. The default value
is FALSE.
271
Result RRT
~DFT::%field name%~ is replaced with the value configured as a success result if the input string starts with a
specified substring, and with the value configured as a failure result otherwise.
Input: Is it a question?
Starts with: IS
On Success: TRUE
On Failure: FALSE
Trim Filter Dialog Box
This filter removes all leading and trailing white space symbols from the input string.
Option
Description
Field name
Input
Enter the string to be trimmed. Commonly, RRT is used

in this text box.

empty
~DFT::%field name#IsEmpty%~. It is replaced with TRUE if a filter result is empty. Otherwise, it is replaced
with FALSE.
Result RRT:
~DFT::%field name%~is replaced with the string after trimming.
Lookup in DB Filter Dialog Box
This filter retrieves data from a database.
The filter executes an SQL query in a database to select the information from the specified columns of a specified
table and generates RRT replaced by the list of the output values both for each column of the query result and for the
entire query result.
Note: The user specified for work with databases should have all necessary permissions for the following list
of actions:
To run a SQL query.

To read the database table, including listing all the columns of the database table and getting their names
and types.
If the user has no necessary permissions listed above, an attempt to work with the database will lead to an
error.
Filter configuration
The filter configuration window consists of four tabs:
272
Tab
Description
General Tab
This tab allows configuring the field name of FRTNs

generated by the filter and the delimiters used in the
RRT values. This tab also allows specifying the data
source, the database accounts credentials, and a table for
retrieving data.
Output Columns Tab
This tab allows specifying the output columns that will

be used in the SQL query.
Conditions Tab
This tab allows you to specify the conditions that will be

used in the SQL query.
Result Tab
This tab allows configuring settings for the query

execution results.
Generated errors and warnings

The filter generates an error in the following situations:
The filter fails to connect to the specified data source.

The specified table name is incorrect or is not present in the table list requested by the component.
The configured table does not contain one or more specified output columns.
The configured table does not contain the column by which a query result is ordered.
The specified limit result number is incorrect.
The configured table does not contain one or more conditions columns.
ODBC driver generates an error during query execution.
One of the conditions columns has an unsupported type. The only types allowed in the conditions columns are:
Char
VarChar
LongVarChar
nVarChar
Decimal
Numeric
TinyInt
SmallInt
Integer
BigInt
Real
Float
Double
Date
Time
TimeStamp
The filter generates a warning in the following situation:
If the conditions value cannot be converted to the type of the condition column.
Generated RRTs
The filter generates two types of RRTs:
273
RRT Name
Description
The filter generates the following two types of RRTs with the result of a SQL query.
The list of all the query results output values.
~DFT::%field name%~
The RRT value is: [<Column 1>, <1>]<C> [<Column

2>, <1>]<C>...[<Column N>, <1>]<R>[<Column 1>,
<2>]<C> [<Column 2>, <2>]<C>...[<Column N>,
<2>]<R>...[<Column 1>, <M>]<C> [<Column 2>,
<M>]<C>...[<Column N>, <M>]
Note:
The parts of the above value schemes mean the
following:
~DFT::%field name,<Column name>%~
<Column N> is a name of output column

with number N;
[<Column N>, <M>] is an output value
of record with number M of <Column N>
column;
<Column name> is a column name
portion of RRT tag;
[<Column name>, <M>] is an output
value of M-th record of <Column name>
column;
<R> is the record value delimiter;
<C> is the column value delimiter.
The list of the output values for a "<Column name>"

column.
The RRT value is: [<Column name>, <1>]<R>
[<Column name>, <2>]<R>...[<Column name>, <M>].
Note: See the note for the ~DFT::%field
name%~ RRT.
This filter generates the following boolean RRTs that can be used in the Validate filter for metadata validation.
~DFT::%field name#DoesNotExist%~
Replaced with TRUE if there are no records in the result

set.Otherwise, it is replaced with FALSE.
~DFT::%field name#Exists%~
Replaced with TRUE if the result set contains one or

more records. Otherwise, it is replaced with FALSE.
The example of this filter usage:

The content of USERS table:
LOGIN
PASSWORD
PERMISSION
John
123
Admin
Albert
321
User
Christian
231
Guest
Carlos
213
User
The filter parameters:
274
Table: USERS
Columns: LOGIN, PASSWORD, PERMISSION
Condition 1: LOGIN like "C%"
Condition 2: PERMISSION = "User"
Condition option: ANY
Field name: User data
Record value delimiter: ;
Column value delimiter: ,
Result of the query will be:
LOGIN
PASSWORD
PERMISSION
Albert
321
User
Christian
231
Guest
Carlos
213
User
~DFT::%User data%~ will be replaced by "Albert,321,User;Christian,231,Guest;Carlos,213,User"

~DFT::%User data, LOGIN%~ will be replaced by "Albert,Christian,Carlos"
General Tab
This tab allows configuring the field name of FRTNs generated by the filter and the delimiters used in the RRT
values. This tab also allows specifying the data source, the database accounts credentials, and a table for retrieving
data.
Option
Description
Field name
Record delimiter
Enter record delimiter used in the RRT value. For

example, ",".
Column delimiter
Enter column delimiter used in the RRT value. For

example, ";".
Data source
This text box displays the data source through which the
component accesses the database . To specify the data
source and the database accounts credentials, click
This button opens the Data Source dialog box.
Table name
Specify the name of the table from which the filter

retrieves data. You can enter the table name manually or
click
to select a table in the Select Table dialog box.

the current job if there are no records in the result set.
SQL Syntax group:
Default
Select this check box if you want to make query to a

database other than Oracle or Informix.
Oracle
Select this check box if you want to make query to an

Oracle database. In this case the component will modify
275
Option
Description
SQL query so that the Oracle database will consider it to
be valid.
Informix
Select this check box if you want to make query to an

Informix database.
Data Source Dialog Box

This dialog box allows you to specify the data source and the credentials that will be used for getting data from the
database and to test the connection at configuration stage.
Option
Data source
Description
Enter the ODBC data source manually or select the
source using
. This button opens the Select Data
Source dialog box that allows you to select one of the
available data sources.
User name
Enter the user name to connect to the selected data

source.
Password
Enter the password to connect to the selected data

source.
Note: If the User name text box is empty,
then the component will use the credentials of
the process which runs the configuration. At
configuration stage this process will be apd.exe
(by default, it uses current user account), at run
time - batch.exe (by default, it uses local system
account).
Test
Click this button to check the connection to the data

source. If the User name text box is empty, the
component shows the warning message: User name
is empty. The component will use login and password
of the account which is used to run the application
(Process Designer or Batch). Do you want to continue
the connection test? Click OK to continue.
If the connection is established successfully, the
component shows the following message: "Data
source connection is OK". If the connection cannot be
established, the component shows an error message.
Select Data Source Dialog Box

This dialog box allows selection of one of the available data sources.
The table displays the names and drivers of the available data sources that are configured in ODBC. Select a data
source and click OK.
Select Table Dialog Box
This dialog box allows you to select a table from the database.
Option
Tables
Description
This field displays the list of the database tables.
Name is the name of the table in the data source.
276
Option
Description
Type is the type of the table ("SYSTEM TABLE,

"TABLE or "VIEW).
You can select a table from this list.

Hide system tables from the list
If this option is selected, then system tables are not

displayed in the list.
Table name
This text box displays the selected table name. You can
enter this name manually if there is no access to database
or use RRT in this text box.
Output Columns Tab

This tab allows specifying the output columns that will be used in the SQL query.
There is only the Name column in the output columns list that contains the name of an output column.
Option
Description
Add
Click this button to add a new item to the list. This

button opens the Select Column dialog box.
Edit
Select an item in the columns list and click this button

to edit the selected column. This button opens the Select
Column dialog box.
Remove
Select an item in the columns list and click this button to

remove the selected item.
Select Column Dialog Box

This dialog box allows you to select a column from the table.
Option
Description
Columns
This field displays names and types of the table columns.

You can select a column from this list.
Column name
This text box displays the selected column name. You

can enter this name manually if there is no access to
database or use RRT in this text box.
Conditions Tab
This tab allows you to specify the conditions that will be used in the SQL query.
The tab contains the conditions list with two columns:
ConditionA simple condition. For example, [PERMISSION] = ~ACC::%PERMISSION%~.
Match caseContains Yes if the condition comparison is case-sensitive, and No otherwise.
Option
Description
Add
Click this button to add a new condition to the list. This

button opens the Condition dialog box.
Edit
Select a condition and click this button to edit the

selected condition in the Condition dialog box.
Remove
Select a condition and click this button to remove the

selected condition from the list.
277
Option
Description
ALL
If this option is selected, the SQL query will return only

the records that satisfy all the specified conditions.
ANY
If this option is selected, the SQL query will return

the records that satisfy at least one of the specified
conditions.
Condition Dialog Box

This dialog box allows configuring a condition that will be used in the SQL query.
Option
Column
Description
Enter a condition column manually or click
and
select it from the list in the opened Select Column
dialog box.
Match
Enter the match value that will be used for constructing

the condition.
Operator
Select an operator that will be used in the condition:

EQUAL or LIKE.
Match Case
Specify case sensitivity of the SQL query. If Data

Source specific is selected, then case sensitivity is
defined by the selected ODBC data source.

Option
Description
Columns

Column name

Result Tab
This tab allows configuring settings for the query execution results.
Option
Order by
Description
Enter a column for sorting the query results. You can
open the Select Column dialog box by clicking
Sort order
Select one of the options: Ascending or Descending.
Select distinct values
Select this option if you want only distinct values to be

included in the result.
Limit results number
Enter the limit to the number of records in the result.
278
Option
Description
Columns

Column name

Parse CSV Filter Dialog Box

This filter retrieves the CSV records field values from the input string and generates RRT for each field value.
The input string should be in CSV format. The filter uses specified delimiter and text qualifier.
Option
Description
Field name
Input
Enter input string to be split into parts. Commonly,

RRT is used in this text box. This text box may contain
multiline text.
Delimiter
Enter field values delimiter of the input strings CSV

format. For example, ";" (semicolon) or "," (comma).
Text qualifier
Enter text qualifier. All characters of text enclosed within

text qualifiers are considered as usual text symbols, not
as delimiters.

the current job if all of the output values are empty.
Note:
The filter generates an error in the following situations:
A delimiter value is not a single-character string.

A text qualifier value is not a single-character string.
The filter generates a warning in the following situation:

There are some data after the first record in the input string. In this case the filter processes only the data of
the first record, ignores the rest and warns about it.
If the input string contains invalid CSV data then the output is unpredictable.
Result RRT:
~DFT::%field name, N%~ is replaced with a N-th CSV field.
Input: 1997,Ford,E350,"ac, abs, moon",3000.00.
Delimiter: ,
Text qualifier: "
The generated RRTs will be replaced with the following five values:
1997
Ford
279
E350
ac, abs, moon
3000.00
Split Filter Dialog Box

This filter splits the input string around specified single-character delimiters and generates RRT for each split parts.
Option
Description
Field name
Input
Enter the input string to be split into parts. Commonly,

Delimiters
Specify the single-character delimiters. The delimiters

should be entered in this text box one after another
without spaces; for example, ;|,. You can use RRT in
this text box. If no delimiter is specified, then the result
of splitting will consist of only one part that is a whole
input string.
Match case
If this check box is selected, then the comparison of the

input string characters with the delimiter characters is
case-sensitive. Otherwise, it is case-insensitive.

the current job if the input is empty.
Result RRT:
~DFT::%field name, N%~ is replaced with the N-th part of the input string after splitting.
Example 1
Input: ~ACC::UserName~_~ACC::%ClientID%.
Delimiters: 1
Assuming that ~ACC::UserName~ is replaced with "User1", and ~ACC::CompanyName~ is replaced with
"Company1", the string will be split into three parts and the generated RRTs will be replaced with the following
values:
User
_Company
empty string
Example 2
Input: 123abc456abc789.
Delimiters: aBc
Match case: selected
The string will be split into five parts and the generated RRTs will be replaced with the following values:
123
b
456
b
280
789
Validate Filter Dialog Box

This filter is intended for validating metadata generated by other filters.
If validation fails, the component rejects a current job and outputs a specified error message into Status Monitor (or
the log).
To validate the result of execution of a particular filter, you can use filter's RRTs that have boolean values depending
on filter's result. You can check if the RRTs have expected values. For example, the Replace filter has ~DFT::
%field name#IsEmpty%~ boolean RRT, where field name is a field name specified in the Replace filter.
This boolean RRT is replaced with TRUE if filter result is empty. Otherwise, it is replaced with FALSE. You can
specify Fail job if condition in the following way ~DFT::%field name#IsEmpty%~=TRUE, which means the
filter result is empty. In this case the message specified in the Message field will be output to the log file.
Fail job if
Specify an input string that is to be checked. Commonly,

a boolean RRT of some other filter is used in this text
box. Select TRUE or FALSE or enter any other value.
Message
Specify an error message that replaces the components

validation RRT ~DFT::ValidationResult~ if an
input string equals the specified value in the = combo
box.

Fail job if: ~DFT::%PathToInvoice#IsEmpty%~
=:TRUE
Message: Invalid path to invoice specified
If the Replace filter generates ~DFT::%PathToInvoice%~ FRTN and it is replaced with an empty value at run
time, then the component will reject the current job and the error message "Invalid path to invoice specified" will be
displayed in the Status Monitor.
Evaluate Expression Filter Dialog Box
This filter calculates the value of a given expression.
The expression must be entered with valid syntax and can contain logical operators & (AND), | (OR), algebraic
operators +, -, / and operators of comparison <, >, !=, and so on. To view the complete list of operators, see
Operators.
The syntax of expressions is identical with that of conditional expressions. For more information, see Conditional
Activation.
The expression can contain numbers, strings, boolean constants (TRUE, FALSE) and RRTs from another components
or previous filters.
Option
Description
Field name
Enter the name of the FRTN generated by the filter.
Expression
Enter the expression in this field.

the current job if input or output is empty.
Test
Click this button to evaluate the expression; the result

will be displayed in a separate dialog box.
281
Result RRT
~DFT::%field name%~ is replaced with the value of the expression.
Examples of filter usage
Note: Note that some expressions use RRTs from the components preceding Data Filter in the workflow.
Here are examples of expressions.
1. Algebraic operations:
"1 + 1" evaluates to 2
"(2 * 100 + 300) / 50" evaluates to 10
2. Logical operations produce TRUE or FALSE values:
~RRT::FileExt~ = PDF is true if the file has PDF extension.

~RRT::FileSize~ > 10485760 is true when the size of the file exceeds 10485760 bytes.
(~RRT::FileExt~ = PDF) & (~RRT::FileSize~ > 10485760) is true if both of the above
conditions are true.
(~IMA::FromName~ = "John" | ~IMA::FromName~ = "Jane") & ~IMA::Subject~
= "report" evaluates to true if, when using the IMAP Capture component, the sender name is "John" or
"Jane" and the subject is "report".
~FTP::SiteIP~ = "10.16.16.95" is true when the IP address of the FTP server from which the file is
captured equals to 10.16.16.95.
3. Complex expressions:
~DFT::FileSize~ > 10000 ? ~DFT::FileName~ + "_large" + ~DFT::FileExt~ :

~DFT::FileName~ + "_small" + ~DFT::FileExt~ is an example of a ternary operator that
uses conditional selection. The result will be the name of the file with appended string, "_large" or "_small",
depending on whether the size of the file is greater or less than 10000 bytes.
Component RRTs
Component RRT ID
The RRT ID for this component is DFT.
This component generates the following RTN values.
Name
Description
FileCount
The number of documents in the job.
FileSize
The size of the first file in the batch.
FileSize,Index
The size of the file of index "Index".
FileSize,*
The sizes of all files concatenated into one string,

separated by comma.
FileName
The name of the first input file.
FileName,Index
The name of the file by index.
FileName,*
The names of all files concatenated into one string,

separated by comma.
FileExt
The extension of the first input file.
282
Name
Description
FileExt,Index
The extension of the file, by index.
FileExt,*
All the extensions of the input files concatenated into

one string, separated by comma.
ValidationResult
If the Validate filter detects invalid metadata, this RRT

is replaced by the error message configured in this filter.
If any other error occurs at runtime, this RRT is also
replaced with an error message corresponding to this
error. If no errors occur at runtime, this RRT is replaced
with the "Success" value.
This RRT may be used in the components like Workflow
Tracker or Notification Options to get the information
about processing result.

This component generates the following FRTN values.
Name
Description
%field name%
This RRT is replaced with the value generated by a

particular filter. "Field name" is the value of the Field
name parameter specified in the filter's configuration.
The description of this RRT replacement for a particular
filter can be found in the chapters describing the filters.
%field name%,<N>
This RRT is replaced with the value generated by Split or

Parse CSV filters. "Field name" is the value of the Field
name parameter specified in the filter's configuration,
"<N>" index is replaced with the position number of a
split part or a CSV field correspondingly.
%field name,<Column name>%
This RRT is generated by the Lookup in DB filter and is

replaced with the list of the output values for a <Column
name> column. "Field name" is the value of the Field
name parameter specified in the filter's configuration.
%field nameIsSuccess%
This boolean RRT is used in the Validate filter for

validation of the result of Match Regular Expression,
Starts With, Ends With, Equals To, or Contains filter. It
is replaced with TRUE if the filter operation ends with
success. Otherwise, it is replaced with FALSE.
%field nameIsFailure%

validation of the result of Match Regular Expression,
Starts With, Ends With, Equals To, or Contains filter. It
is replaced with TRUE if the filter operation ends with
failure. Otherwise it is replaced with FALSE.
%field nameIsInvalidDate%

validation of the result of the Format Date filter. It is
replaced with TRUE if the input string is not a valid date.
Otherwise, it is replaced with FALSE. "Field name" is
the value of the Field name parameter specified in the
Format Date filter's configuration.
283
Name
Description
%field nameIsInvalidtime%

validation of the result of the Format Time filter. It
is replaced with TRUE if the input string is not a
valid time. Otherwise, it is replaced with FALSE.
"Field name" is the value of the Field name parameter
specified in the Format Time filter's configuration.
%field nameDoesNotExist%

validation of the result of the Lookup in DB filter. It is
replaced with TRUE if there are no records in the result
set. Otherwise, it is replaced with FALSE. "Field name"
is the value of the Field name parameter specified in the
Lookup in DB filter's configuration.
%field nameExists%

validation of the result of the Lookup in DB filter. It
is replaced with TRUE if the result set contains one or
more records. Otherwise, it is replaced with FALSE.
"Field name" is the value of the Field name parameter
specified in the Lookup in DB filter's configuration.
See the examples of the RRT usage in the descriptions of the certain filters.
This component does not support any SSRTN values.
The date format in the Format Date filter does not support the format specifications whose decimal representation
does not have a leading zero for a single-digit day/month.
The time format in the Format Time filter does not support the format specifications whose decimal representation
does not have a leading zero for a single-digit hour/minute/second.
The component can retrieve data from MS SQL 2000, MS SQL 2005, MS SQL 2008, MS SQL 2008 R2, MS
Access 2010, Oracle and Informix databases.
For a proper operation of the component, the user specified for work with databases should have necessary
permissions to run a desired SQL query and to list all columns of the database table and get their names and types.
Problem
When the component tries to establish connection with
Informix server the following error message appears:
"COM subsystem detected an error while performing
a query execution within the Lookup in DB filter's
operation. Report: IDispatch error 3092. Details:
[Informix][Informix ODBC Driver][Informix]A syntax
error has occurred. Error code: 0x80040E14."
Solution
This error appears when one system variables is absent
or has invalid value. To solve this problem, perform the
following steps:
Open Advanced tab of the System properties on the

machine, where workflow server is running.
Open Environment variables at the bottom of the
Advanced tab.
Add or edit DELIMIDENT variable in the System
variables group. This variable should contain "n"
value.
284
Problem
Solution
See more about meaning of this variable for the work
with Informix in the IBM Informix 11.70 information
center.
Data Interchange
Welcome to the Data Interchange component
This component is used to enable interchange of data between components when there are no mapping components
(components appearing within the blocking list on APD) is present within your process definition.
When your process does not include any mapping components, then process is not capable of sharing information
such as RRT values. In order to enable the process with data interchange capabilities you must include the Data
Interchange component early on within the process.
Notice that this component cannot be used when other mapping components are used within the same process. For
example use of Data Interchange component with MFP Component does not provide any additional capabilities since
MFP component is a mapping component.
Use Data Interchange component for processes that start with Poll Directory and gain ability to interchange data
between your components through this component.
Datacap
Welcome to Datacap
Datacap is a component designed to be an entry point for the IBM Datacap Taskmaster Capture, a complete solution
for document and data capture provided by IBM. The Datacap component sends documents captured from an MFP to
the Datacap Taskmaster Capture, assigning values to the variables of different DCO levels.
The component can be used both as a route component or process (eConnector) component. The eConnector has two
additional options: Activate and Pass-through. Activate makes the component active. If this option is not selected, the
component will not perform any actions during the processing of files. Pass-through makes the document available to
subsequent components when enabled.
Getting started
Feature highlights
Route documents to a Datacap application through Taskmaster Web Services (wTM).

Ability to dynamically set through RRTs the Datacap application that will receive capture documents.
Ability to dynamically set through RRTs the page type of the captured documents.
Ability to dynamically set through RRTs values to Datacap variables at the following Datacap object (DCO)
levels: Batch, Page & Field.
Provide support for multiple Taskmaster servers by specifying different web service endpoints within multiple
AutoStore workflows.
Display the available Datacap application and page types when the Datacap Application Management File is
specified in the configuration window.
How to use the Datacap component

Use the Datacap component to send scanned documents to the Datacap Taskmaster Capture server workflows.
An example of using the component to send documents from an MFP device.
285
1. Create a new workflow and add a capture component to specify the type of MFP used for scanning.
2. Select the desired process components if you need the documents to be processed before routing them to Datacap
workflow.
3. Add the Datacap component as the route component for the workflow.
4. Configure web application settings and the variables of the Datacap component through the RRTs, passed from the
capture component.
5. Save the configured workflow, and start the process.
After being scanned, a document gets captured and processed. After being processed, a document is routed to a
Datacap Taskmaster Capture process.
Configuring Datacap
The Datacap component has only one configuration window, which allows you to configure all the necessary settings
for proper operation of the component.
Main window
Main configuration window allows you to configure all necessary setting for the component.
Option
Activate
Description
Use this box to activate the component. Select Yes to
activate the component.
If you select No, the component will be inactive during
file processing.
Conditional activation and Pass through are only
available in the Datacap eConnector settings. They
are absent in the Datacap route settings. Conditional
activates the component according to a condition.
Pass through Set this option to Yes to pass the original
document to subsequent components in a workflow. You
can use conditions in this field. If you enter an invalid
condition into the Pass through box, the activation will
be Yes by default.
Web Service Settings
Service Endpoint
Enter the full path to the service endpoint file.

Note: The endpoint file name should be always
ServicewTM.svc
The full address should contain the following elements:
protocol://server:port/endpoint-file
protocol: http://
server: The name or IP address for the Datacap
server, for example, datacapserver1.
port: The port that the server uses to communicate
with clients, for example, 888.
Note: If no port number is provided, the
default port number 80 will be used.
endpoint-file: The service endpoint SVC file, for
example, ServicewTM.svc.
286
Option
Description
The full path using the example values would be
as follows: http://datacapserver1:888/
ServicewTM.svc
User name
Enter the domain and user name for the web service.
Note: The user name entered can be the domain
user or a local user. If user credentials are not
specified, authentication data from Credentials
Manager is used. Credentials Manager has
specific settings for different users. The
credentials of the user currently logged into the
system will be used during configuring, and the
credentials of the user who runs the workflow
server will be used at run time. In either case,
the user must have read and write permission to
the web service and the datacap.xml file.
Password
Enter the password for the User name.

Datacap Application Settings
Application Management File
Select the datacap.xml file that contains information

about available Datacap applications. Use the browse
button (...) to navigate to the application XML file. The
path should be entered in standard UNC format. For
example:
\\Shared1_server\Shared1\Appinfo
\datacap.xml.
Tip: Typically, the main application settings
file is found on the Taskmaster Server.
Send to Application
Select the Datacap application where the files will be

sent from the list of available applications.
Job Name
Documents will be routed to the selected job for the

application specified by Send to Application.
Data Settings
Set Page Type
Select this check box if you want to set a page type to

the routed documents. When this check box is selected,
you should specify the page type in the combo box. The
routed documents will be associated with the selected
page type. You may use RRTs in the combo box to set
page type dynamically.
Metadata
The following table contains the list of variables that will

be assigned to the routed documents.
The table contains the following information:
NameThe name of the variable in the Datacap

server.
Note: If the variable with the specified
name does not exist on the Datacap server,
then it will be created dynamically.
287
Option
Description
ValueThe value of the specified variable.

DCO LevelSelect a level, which the specified
variable will be created for. There are three levels
available for every variable:
Batch level
Page level
Fields level
Note: DCO Level is a Datacap object level.
Every level has its own number of variables,
which can be predefined by the Datacap
workflow administrator.
Add
Click this button to add a new variable into the list.
Remove
Click this button to remove a selected variable from the

list.
Component RRTs
Component RRT ID
The RRT ID for this component is DTC
This component generates the following Reserved RTN values.
Name
Tag
Description
Application Name
~DTC::ApplicationName~
The Datacap application where the

files will be sent.
Job Name
~DTC::JobName~
The Datacap job where the files will

be sent.
Page Type
~DTC::PageType~
The page type of the routed

document.
Metadata
~DTC::Metadata,*~
The name of the variable specified

to the routed document, where *
represents the index of the variable
name. When * is used the RRT
~DTC::Metadata,*~ will be
replaced with a list of all variables
in the following format: <DCO
level>:<name> = <value>;.
Metadata Name
~DTC::MetadataName,*~
The name of the variable specified

to the routed document, where *
represents the index of the variable
name. When * is used the RRT
~DTC::MetadataName,*~ will be
replaced with a list of names of all
fields delimited by semicolon.
288
Name
Tag
Description
Metadata Value
~DTC::MetadataValue,*~
The value of the specified variable,

where * represents the index of the
variable.
Metadata DCO Level
~DTC::MetadataDcoLevel,*~
The name of the DCO Level in

Datacap server, where * represents
the index of the selected DCO level
that will be assigned to the variable.
Metadata Count
~DTC::MetadataCount~
The count of variables that will be

assigned to the routed document.
File Path
~DTC::FilePath,*~
The full path to the file in the

AutoStore workflow, where
* represents the index of the
file. When * is used the RRT
~DTC::FilePath,*~ will be replaced
with a list of all filepaths.
File Name
~DTC::FileName,*~
The original name of the uploaded

file, where * represents the index of
the uploaded file.
File Extension
~DTC::FileExt,*~
The extension of the uploaded file,

where * represents the index of the
uploaded file.
File Count
~DTC::FileCount~
The number of routed documents.

This component does not support any SSRTN values.
The component supports the Datacap Taskmaster Capture server version 8.1.
There is no information available at this time.
Directory Services
Welcome to Directory Services component
Directory Services component connects to the specified Directory Server using LDAP (Lightweight Directory Access
Protocol), searches for the specified objects (like users or groups) and receives the specified attributes of them. The
received information is used to replace RRTs in the workflow configuration.
The component can work with Microsoft Active Directory server and Novell eDirectory server via LDAP
(Lightweight Directory Access Protocol) version 3.
Getting started
Feature highlights
Directory Services component provides the following features:
Connects to the Directory Server using LDAP (Lightweight Directory Access Protocol).
289
Uses custom LDAP filters to search for the specified objects and to receive specified attributes of them.
Works with both Microsoft Active Directory server and NovelleDirectory server.
Using Directory Services

Set up Directory Services component as a workflow component. Set up connection properties and create the sequence
of requests. Depending on these settings the component connects to the Directory Server using LDAP, searches for
the specified objects and receives specified attributes of them. The received information is used to replace RRTs.
Directory Services basic concepts
Directory Server
Directory Server is a store of organized information (the directory) about various objects (users, network shares,
resources, and so forth). Lightweight Directory Access Protocol (LDAP) is used to connect to Directory Server.
Directory
The directory is the hierarchy of the objects. Each object has a set of attributes and can have a number of child
objects. The set of the object's attributes is determined by the object class. The object class is determined by the value
of the attribute "objectClass". An object can have several values of an attribute. An object can belong to several object
classes. In this case the object has several values of the attribute "objectClass" and the object has attributes of the all
object classes.
Each object has a naming attribute. This attribute is used to collate the object's distinguished name.
Full distinguished name (FDN) of the object is unique identifier of the object and completely determines its placement
within the directory.
Attributes
Each object stored in the directory has a number of attributes. The set of the object's attributes is determined by the
object class. Object class determines names of all object's attributes and type of their values (text value or binary
data). The object class is determined by the value of the attribute "objectClass". An object can have several values of
an attribute.
FDN
Full Distinguished Name (FDN) is a comma-separated list of the naming attributes and their values which identifies
an object inside the directory. For example, user "David Green" of the Active Directory domain "nsius.com" has the
following FDN: CN=David Green, CN=Users, DC=nsius, DC=com.
LDAP search request
Directory Server search request should be created. The following parameters should be specified in the search request:
LDAP can provide information about objects stored in the directory. To find a particular object a
Search baseFDN of an entry within the directory. Depending on the specified scope this item can be a search
target item or a root item of the subtree where the target items are located.
Search scope can be one of:
Base onlyIn this case search base is the only target item to search for.
One level children onlyIn this case the search will be performed among all immediate children of the base
entry. The base entry itself is not included. Deeper levels of entries are not included as well.
All entries entire subtreeIn this case the search will be performed among all entries in the subtree starting
from base entry (including base itself, its children and their children recursively).
Search filterA specially formed text which specifies what entries within the search scope should be found.
The result of the search request is the list of entries (directory objects) from the specified scope which satisfy to the
search filter.
290
Configuring Directory Services

Main configuration window
The main configuration window of the Directory Services component includes two tabs:
Tab
Description
Connection Tab
Use this tab to input default logon parameters: Directory

Server host name or IP address, port, user name and
password.
Search Requests Tab
This window contains search requests sequence and the

properties of the requests.
Connection tab
Use this tab to input default logon parameters: Directory Server host name or IP address, port, user name and
password.
The settings, specified on this tab, can be overridden (using the Alternate logon dialog box) by any search request
if it requires connection to another server or using other credentials. These parameters are used by default for
connection and authentication to Directory Server both during configuration and at run time.
Option
Activate
Description
Activate the component according to a condition.
Directory server group
Host name
Enter a server host name or IP-address of the Directory

Server. Active Directory server address is usually the
same as the Domain Controller address.
Port
Enter port number for non-secure LDAP connection.

Default LDAP port number is 389.
Use SSL
Select this check box to use secure LDAP connection via

SSL (Secure Sockets Layer).
SSL-port
Enter a Directory Server port number to use for secure

(SSL) connection. Default secure port number is 636.
User authentication group
Anonymous logon
Select this check box to use anonymous connection to

the LDAP server. Anonymous authorization does not
require a password. This option should be switched
off in most cases, because the Directory Server does
not usually allow an anonymous client to obtain user's
information.
User name
Enter user name in any form suitable for the certain

Directory Server authorization. For example, the Active
Directory server accepts user name in the form "Domain
\login name". Any Directory Server also accepts FDN of
the directory user object.
Click the browse button (...) to find a directory user by
choosing the user from the list in the Select User from
Directory dialog box. This dialog box displays all user
objects returned by the Directory Server
.
291
Option
Description
Select this check box to obtain password at run time

from another component via RRT replacement. This field
is ignored when the component connects to the Directory
Server during the configuration. The Password RRT
field becomes enabled and the Password field becomes
disabled.
Password
Enter the fixed password which the component uses for

authorization at run time and during the configuration
process. This password is stored encrypted. When the
component connects to the Directory Server during
the configuration it uses this field, even if the Obtain
password via RRT check box is selected.
Password RRT
Enter the RRT which the component should use at

run time to get the password for the authorization.
Previous component should replace this RRT for
the actual password. This field is ignored when the
component connects to the Directory Server during the
configuration, even if the Obtain password via RRT
check box is selected, because RRT replacement cannot
be performed.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description
292
Expression
Description
"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
293
!
constant ::integer_constant
string_constant
boolean_constant
// regular_expression: [0123456789]+
// case_insensitive:TRUE, FALSE, ON, OFF

294
Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
1Boolean
2, 3Any
295
Symbol
Description
Result type
Operands type
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Select User From Directory dialog box

Options in this dialog box allow selection of Directory Services uses.
You may search directory tree for all users and select FDN of the user whose credentials you want to use in the
connection properties.
The component uses the user name and the password specified in the parent dialog (Connection tab or Alternate
Logon dialog box) to connect to the Directory Server. If there is no user name provided then the component uses
the current Windows user workflow process Administrator) credentials to connect to an Active Directory server or
anonymous credentials to connect to an eDirectory server. The eDirectory by default allows obtaining the users list to
an anonymous user. The Directory Server type (Active Directory/ eDirectory) is determined automatically from the
root (nameless) directory entry.
Option
Description
Search base FDN
Specify root of the subtree to search. The

default value of this field is the value of the
"rootDomainNamingContext" attribute in the
case of Active Directory or the first domain entry
(objectClass=domain) in the case of eDirectory.
Search filter
Specify which objects the Directory Server considers as

the users. You may choose one of two presets (for Active
Directory or eDirectory server) or specify LDAP search
filter manually.
Microsoft Active Directory usersThis preset

is chosen by default if the Active Directory has
been detected. The search filter for the Active
Directory users is "(&(objectCategory=person)
(objectClass=user))".
Novell eDirectory usersThis preset is chosen
by default if the eDirectory has been detected.
The search filter for the eDirectory users is
"objectClass=inetOrgPerson)".
Custom filterEnables the edit box where the user
may specify a custom search filter.
Start search
Click this button to begin the LDAP search process.
Search results
This group represents the search process results.
Directory entries found
This field displays the tree which contains all found

entries. This tree does not display empty branches, that
is, branches that do not contain any found entries.
296
Option
Description
Selected entrys attributes
This list displays attributes of the entry (user) currently

selected in the results tree. The attributes set depends on
the permissions of the authorized person.
Selected user FDN
this field displays FDN of the entry (user) currently

selected in the results tree. This field contains the result
of the browsing (selection).
Search Requests tab

This window contains search requests sequence and the properties of the requests.
Option
Description
Requests sequence
This field represents requests sequence as an ordered

list of items. Each item describes a single LDAP
(Lightweight Directory Access Protocol) search request.
A single request has many properties, all of them cannot
be shown in the list, therefore this list contains only three
fields with brief information.
Name
A user-defined name that will be used to generate RRTs

for the search output values.
Search object
A list of the target attribute values. All result entries

returned by this search contain these values of attributes.
The attribute names are not displayed here. If a complex
filter is used for the search, this list contains all specified
values regardless of a filter operation.
Result attributes
A list of the resulting attributes. These attribute names

will be used to generate RRTs of the output values along
with the search name.
Sequence management buttons

Click this button to move selected items one row upper.
Click this button to move selected items one row lower.
Click this button to add new search request. It opens
Add New Search Request dialog box, which allows
specifying the information for the new search request.
The created request will be placed at the end of the list.
Click this button to remove all selected items from the
list.
Request properties
This group displays the detailed properties of the

selected request:
Scope
This field displays the search base FDN and the search
scope ("base only", "one level children only" or "all
entries entire subtree").
Filter
This field displays the LDAP search filter. The result

of the search will contain all entries from the specified
scope satisfying to the filter conditions.
297
Option
Description
Result
This field displays the attributes of the result entries

specified by user for retrieval. If the user has specified an
alias for an RRT of attribute it is displayed as well.
Misc.
This field displays miscellaneous information about

the search request: result entries number limit, logon
properties and so on.
Search requests management buttons
Edit
Click this button to edit the request properties. This

button opens Edit Search Request Properties dialog
box that displays settings of the currently selected
request.
Export
Click this button to export all selected requests into

external file. This file can be loaded into another
configuration of the Directory Services component using
the Import button. If no requests are selected then all
sequence will be exported.
Import
Click this button to import previously exported requests

sequence from the external file into the configuration.
The requests will be added into the end of the current
sequence.
Test all
Click this button to perform testing of the configuration.

All requests in the sequence will be processed, including
RRTreplacement. The results of this process will be
displayed in the Test Results dialog box.
Requests
The component executes several LDAP search requests one after another. Each request can use information retrieved
from the Directory Server by the previous requests in the sequence.
On each request, the component establishes an LDAP connection with the specified directory server using specified
user credentials. Then it performs LDAP search for the specified entries within the directory and retrieve their
attributes. Retrieved values of the attributes are used for replacement of the RRTs.
For each request, in the Alternate Logon dialog box, you can configure LDAP connection parameters, search base
and scope, search filter and specify the attributes you want to retrieve from the found entries.
Add/Edit Request dialog box
Use this dialog box to add a new request or to edit an existing request.
Option
Request name
Description
Enter name of the request.
Note: All RRTs produced by this request will
be built based on this name.
Alternate logon
Select this check box, if you want to choose special

connection parameters (different from Connection tab).
Click the browse button (...) to configure the connection
properties in the opened Alternate Logon Properties
dialog box.
298
Option
Description
Note: This altered logon is used only by
this single request. Subsequent requests will
use default connection parameters until they
alternate logon for themselves.
Search scope
This group allows specifying the scope for searching

data.
Base FDN
Enter FDN of the directory entry to search from. Entries

located above this one within the directory will not be
included into the search.
Domain button
Click this button to set the base FDN of the directory

root domain entry.
For the Active Directory server the domain FDN is the
value of the "rootDomainNamingContext" attribute in
the root (nameless) directory entry.
For the eDirectory server the domain FDN is the FDN
of the first (topmost) entry in the directory tree with
objectClass=domain.
To determine this information the component establishes
LDAP connection using parameters of the current
request.
Scope
Determine the subset of directory entries below the base

entry to search within. Can be one of:
Base onlySingle entry defined by Base FDN.

One level children onlyAll immediate children of
the base entry. The base entry itself is not included.
Deeper levels of entries are not included as well.
All entries entire subtreeAll entries in the subtree
including Base FDN, its children and their children
recursively.
Note: The scope combo-box allows specifying
of an RRT as the search scope. The RRT should
be replaced at run time with one of: "BASE
ONLY", "ONE LEVEL" or "SUBTREE".
Click the browse button (...) to open the Search Scope

Properties dialog box that allows browsing the directory
tree to choose entry as the base FDN.
Search filter
This group allows specifying of the conditions to select

subset of entries from the search scope. Even if "Base
only" is specified as the search scope, this filter will be
applied and the search result may be empty.
Filter text
This field contains text of the LDAP search filter. This

text can be edited by a user to specify any arbitrary
LDAP search filter. If this field is empty then all entries
in the search scope are returned by the search.
Build simple filter
Click this button to open the Build Simple Filter dialog

box to create the LDAP search filter. Such filter will
299
Option
Description
have only intersection operations however this is enough
in most cases. To build more complex filters user should
specify their syntax manually in the Filter text edit box.
Search results group:

Limit results count
Select this check box if you want to limit maximum

number of found entries to return. Enter the maximum
number of the entries in the field that is next to this
check box.
All attributes
select this check box to retrieve all attributes of the result

entries. If this option is unchecked then only specified
attributes will be retrieved.
Attributes
Click this button to add/edit attributes for request. This

button is always enabled. It opens Attributes list dialog
box. Even if the All attributes check box is selected, the
user can specify aliases for some of the attributes.
Test this request
Click this button to perform testing of the current request

only. Do not use this function if the request settings
contain RRTs of other requests. Results of this test will
be displayed in Test Results dialog box.
Test this and all previous
Click this button to perform testing of the start of the

requests sequence from the first request till current one.
This button is useful when the current request settings
contain RRTs of other requests. Results of this process
will be displayed in the Test Results dialog box.
Test all sequence
Click this button to perform testing of the configuration.

All requests in the sequence will be processed, including
the component RRT replacement. The results of this
process will be displayed in the Test Results dialog box.
Alternate Logon dialog box

This dialog box allows you to define alternate logon for each request creation.
If you do not apply this function, default connection parameters specified in the main configuration window on the
Connection tab will be used to connect to the LDAP server.
The form of this dialog is the same as in the Connection tab settings.
Option
Activate
Description
Activate the component according to a condition.
Directory server group
Host name
Enter a server host name or IP-address of the Directory

Server. Active Directory server address is usually the
same as the Domain Controller address.
Port
Enter port number for non-secure LDAP connection.

Default LDAP port number is 389.
Use SSL
Select this check box to use secure LDAP connection via

SSL (Secure Sockets Layer).
300
Option
SSL-port
Description
Enter a Directory Server port number to use for secure
(SSL) connection. Default secure port number is 636.
User authentication group
Anonymous logon
Select this check box to use anonymous connection to

the LDAP server. Anonymous authorization does not
require a password. This option should be switched
off in most cases, because the Directory Server does
not usually allow an anonymous client to obtain user's
information.
User name
Enter user name in any form suitable for the certain

Directory Server authorization. For example, the Active
Directory server accepts user name in the form "Domain
\login name". Any Directory Server also accepts FDN of
the directory user object.
Click the browse button (...) to find a directory user by
choosing the user from the list in the Select User from
Directory dialog box. This dialog box displays all user
objects returned by the Directory Server
.
Select this check box to obtain password at run time

from another component via RRT replacement. This field
is ignored when the component connects to the Directory
Server during the configuration. The Password RRT
field becomes enabled and the Password field becomes
disabled.
Password
Enter the fixed password which the component uses for

authorization at run time and during the configuration
process. This password is stored encrypted. When the
component connects to the Directory Server during
the configuration it uses this field, even if the Obtain
password via RRT check box is selected.
Password RRT
Enter the RRT which the component should use at

run time to get the password for the authorization.
Previous component should replace this RRT for
the actual password. This field is ignored when the
component connects to the Directory Server during the
configuration, even if the Obtain password via RRT
check box is selected, because RRT replacement cannot
be performed.
Attributes
Attributes List dialog box
This dialog box contains the list of attributes and aliases and allows you to specify which attributes of the resulting
entries should be retrieved.
Also you can specify aliases for some of the attributes. To specify several aliases for some attribute you should add
several entries for the same attribute.
301
Option
Description
Attributes and aliases
This field displays the list of attributes and aliases.
Add selected
Click this button to add currently selected attributes from

the lower list to the upper list.
New
Click this button to create new list entry in the opened

Add New Attribute dialog box.
Edit
Click this button to edit selected list entry in the opened

Edit Attribute Properties dialog box.
Directory entries
This field displays the directory tree that allows you

to select the entry. This tree is displayed only if the
Directory Server connection is successfully established.
The lower list contains attributes of the directory entry selected in the directory tree that is displayed in Directory
entries.
The component establishes the LDAP connections using the request connection settings configured on the
Connection tab in the main configuration window.
Add New Attribute/Edit Attribute Properties dialog box
Add/edit attribute properties in this dialog box.
Option
Description
Attribute name
Enter the name of the attribute.
Default RRT for the attribute values
This field displays the name of the RRT that should be

used in the configuration to retrieve the attributes value.
This field is read-only.
Use alias RRT
Select this check box if you want to specify an alias for

the attributes value.
RRT alias name
Enter the name of the alias. The alias RRT is based on

this name instead of the request name and the attribute
name (the default RRTs are based on these two).
Alias RRT
This field displays the name of the RRT. It should be

used in the configuration to retrieve the attributes value.
The attributes value can be obtained via both alias RRT
and default RRT. The corresponding default RRT is
displayed in the Default RRT the alias stands for edit
box. This field is read-only.
Alias value properties group:
Concatenate values for all result entries
Select this check box if you want that the value of the
alias RRT will be formed from the attribute's values of
the all returned entries (the search request may return
several entries). The concatenation is performed via the
semicolon character (;). If not checked then the user
should enter the order number (1-based) of the result
entry. In this case the attribute of the single specified
entry will be used as the value of the alias RRT.
Concatenate all values of the result entry
Select this check box if you want that the value of the
alias RRT will be formed from all values of the attribute
of the result entry (the result entry's attribute may have
302
Option
Description
several values). The concatenation is performed via the
semicolon character (;). If not checked then the user
should enter the order number (1-based) of the result
value. In this case only specified value of the attribute
will be used as the value of the alias RRT.
Default RRT the alias stands for
This field displays the name of the default RRT

that corresponds to the specified alias and its value
properties. The user may use any of the RRTs: default
one and the alias one. Since the alias is specified for this
RRT the user can prefer to use the alias RRT instead.
This field is purposed for the information only.
Use default value if not found
Select this check box if you want to specify the default

value of the alias RRT. It will be replaced in the case
when Directory Sever does not return the specified
entries or returned entries do not contain such attribute.
If not checked then the alias RRT will not be replaced in
this case.
LDAP search filters

Search filters
LDAP search filter is a specially formed text. It is used to search for the entries within the directory. LDAP search
request returns directory entries from the specified search scope satisfying to the filter.
The following table lists some examples of LDAP search filters:
Search filter
Description
"(objectClass=*)"
All objects.
"(&(objectCategory=person)
(objectClass=user)(!cn=john))"
All user objects but "john".
"(sn=sm*)"
All objects with a surname that starts with "sm".
"(&(objectCategory=person)
(objectClass=contact)(|(sn=Smith)
(sn=Johnson)))"
All contacts with a surname equal to "Smith" or

"Johnson".
These search filters use one of the following formats:
(<attribute><operator><value>)
(<operator><filter1><filter2>...<filterN>)
Operators
The following table lists frequently used search filter operators.
Logical operator
Description
Equal to
~=
Approximately equal to
<=
Lexicographically less than or equal to
>=
Lexicographically greater than or equal to
303
Logical operator
Description
&
AND
OR
NOT
Wildcards
You can also add wildcards and conditions to an LDAP search filter. The following examples show substrings that can
be used to search the directory:
Example
Description
(objectClass=*)
Get all entries.
(cn=*bob*)
Get entries containing "bob" somewhere in the common

name.
(cn>='bob')
Get entries with a common name greater than or equal to

"bob".
(&(objectClass=user)(email=*))
Get all users with an e-mail attribute.
(&(sn=smith)(objectClass=user)
(email=*))
Get all user entries with an e-mail attribute and a

surname equal to "smith".
(&(objectClass=user)(|(cn=andy*)
(cn=steve*)(cn=margaret*)))
Get all user entries with a common name that starts with
"andy","steve", or "margaret".
(!(email=*))
Get all entries without an e-mail attribute.
Build Simple Filter dialog box

In this dialog box you can create simple LDAP search filter.
Resulting simple filter contains set of attributes and their values to search for. The result of the search is the set of the
directory entries that has the specified values of the attributes.
Option
Description
No filter
This check box should be selected if all the entries from

the LDAP search scope should be returned by the search
request. The search filter text is empty in this case.
Filter entries with all of these attribute values
This field contains filter items. Each filter item is

an attributes name-value pair that includes into the
resulting filter text as "(attribute=value)".
Filter text
This read-only field displays the resulting LDAP filter

syntax.
Add
Click this button to create a new filter item in the opened

Add New Filter Item dialog box.
Edit
Click this button to change the selected item's properties

in the opened Edit Filter Item Properties dialog box.
Delete
Click this button to remove the selected item.
(browse button)
Click this button to browse through directory entries for

an existing attribute. This button opens Select Attribute
Name and Value dialog box. The selected attributes
304
Option
Description
name and value from this dialog will be added to the list
as a new filter item.
Add/Edit Filter Item dialog box

Option
Description
Attribute name
Enter attribute name.
Value equals to
Enter value of the attribute to search for. Click the

browse button (...) to choose the existing attribute name
and value from the directory specified in the Select
Attribute Name and Value dialog box.
Filter item syntax
This read-only field contains the following record:

(Attribute Name = Value).
Select Attribute Name and Value dialog box

This dialog box allows you to choose attribute name and value.
Option
Description
Directory entries
This field displays the directory tree obtained from

the Directory Server. To retrieve the directory the
component establishes LDAP connection using
connection parameters of the current request. Select a
directory entry to display its attributes.
Entry attributes
This field displays the attributes of the selected directory

entry. Select the entry attribute to display its values list.
Attribute value list
This field displays the values list of the selected attribute.
Attribute name
Enter the name of the entry attribute. If you have

selected the attribute in the Entry attributes field, this
field displays the name of the selected attribute.
Attribute value
Enter a value of the entry attribute. The value should be

selected from the attribute values list.
LDAP filters formal definition

Note: Before reading this topic, you may want to review simple LDAP search filters shown in LDAP Filters.
This topic describes the formal definition of LDAP search filters and is intended for advanced users.
Formal definition
The formal definition of the search filter is as follows (from RFC 1960):
<filter> ::= '(' <filtercomp> ')'

<filtercomp> ::= <and> | <or> | <not> | <item>
<and> ::= '&' <filterlist>
<or> ::= '|' <filterlist>
<not> ::= '!' <filter>
<filterlist> ::= <filter> | <filter> <filterlist>
<item> ::= <simple> | <present> | <substring>
<simple> ::= <attr> <filtertype> <value>
<filtertype> ::= <equal> | <approx> | <ge> | <le>
305
<equal> ::= '='

<approx> ::= '~='
<ge> ::= '>='
<le> ::= '<='
<present> ::= <attr> '=*'
<substring> ::= <attr> '=' <initial> <any> <final>
<initial> ::= NULL | <value>
<any> ::= '*' <starval>
<starval> ::= NULL | <value> '*' <starval>
<final> ::= NULL | <value>
The token <attr> is a string that represents a name of an attribute. The token <value> is a string that represents a value
of an attribute whose format is defined by the underlying directory service.
Special Characters
If any of the following special characters must appear in the search filter as literals, they must be replaced by the
listed escape sequence:
ASCII character
Escape sequence substitute
\2a
\28
\29
\5c
NUL
\00
\2f
In addition, arbitrary binary data may be represented using the escape sequence syntax by encoding each byte of
binary data with the backslash (\) followed by two hexadecimal digits. For example, the four-byte value 0x00000004
is encoded as \00\00\00\04 in a filter string.
Special operators
In addition to the logical operators, LDAP defines two matching rule object identifiers (OIDs) that can be used to
perform bitwise comparisons of numeric values. Matching rules have the following syntax:
<attribute name>:<matching rule OID>:=<value>
where: "<attribute name>" is the name of the attribute, "<rule OID>" is the OID for the matching rule,
and "<value>" is the value to use for comparison. Be aware that spaces cannot be used in this string.
"<value>" must be a decimal number; it cannot be a hexadecimal number or a constant name such as
ADS_GROUP_TYPE_SECURITY_ENABLED.
The following table lists the matching rule OIDs implemented by LDAP.
Matching rule OID
Description
1.2.840.113556.1.4.803
A match is found only if all bits from the attribute match

the value. This rule is equivalent to a bitwise AND
operator.
1.2.840.113556.1.4.804
A match is found if any bits from the attribute match the

value. This rule is equivalent to a bitwise OR operator.
306
The following example query string searches Active Directory for group objects that have the
ADS_GROUP_TYPE_SECURITY_ENABLED flag set. Be aware that the decimal value of
ADS_GROUP_TYPE_SECURITY_ENABLED (0x80000000 = 2147483648) is used for the comparison value.
(&(objectCategory=group)(groupType:1.2.840.113556.1.4.803:=2147483648))
Search Scope Properties dialog box
In this dialog box you can choose Search base FDN from the directory tree and specify the search scope.
Option
Description
Search base FDN
Choose Search base FDN from the directory tree.
Search scope
Specify the search scope. The search scope can be one

of:
Base onlySingle entry defined by Base FDN.

One level children onlyAll immediate children of
the base entry. The base entry itself is not included.
Deeper levels of entries are not included as well.
All entire subtreeAll entries in the subtree
including Base FDN, its children and their children
recursively.
Note: The scope combo-box allows specifying
of an RRT as the search scope. The RRT should
be replaced at run time with one of: "BASE
ONLY", "ONE LEVEL" or "SUBTREE".
Test Results dialog box

In this dialog box you can see the results of the search request test.
Option
Description
Search results
This field displays entries and values returned by the

Directory Server for all of the tested requests.
Entry attributes
This field displays the attributes of the entry that you

select in the Search results field.
Attribute values list
This field displays the values list for the attribute that
you select in the Entry attributes field.
RRTs
This field display RRTs replaced by the component

during the requests handling.
Show result RRTs for
This box allows you to filter the displayed RRTs by

selecting one of the following:
All entries: no filter - display all replaced RRTs. Each

RRT replaced after each request in the test sequence
will be displayed.
Last request only: display all RRTs produced by the
last request only. RRTs replaced on previous requests
will not be displayed.
All aliases: display only alias RRTs replaced after
each request. No default RRTs will be displayed.
307
Runtime Replacement Tags (RRTs)

Directory Services Component RRTs
Component RRT ID
The RRT ID for this component is DSC.
Name
Scheme
Default RRTs: found attribute values
Comment
The RRTs value is a value of the

~DSC::request_name:entry_number:attribute_name:value_number~
entry attribute.
Where
Examples:
Default RRTs: specified attribute

values
request_nameUser-defined
request name.
entry_numberReturned entry
number (1-based).
attribute_nameResult entrys
attribute name.
value_numberAttributes
value number (1-based) or
asterisk ("*") sign.
~DSC::users:5:mail:2~
~DSC::users:3:mail:*~
The asterisk used in value_number to

replace all attributes of entry_number
of the request.
The RRT value is a value of the entry

~DSC::request_name:*:attribute_name:value_number~
attribute.
Where:
Examples:
Default RRTs: Full Distinguished

Name
request_nameUser-defined
request name.
entry_numberReturned
attribute_nameResult entrys
attribute name.
value_numberAttributes
value number (1-based) or
~DSC::users:*:objectClass:2~
~DSC::users:*:displayName:*~
The asterisk used in value_number

to replace all attributes from the
attributes list for the request (even
"All attributes" check-box in Search
Requests dialog box is switched on).
The RRT value is the FDN of the

~DSC::request_name:entry_number:
specified entry of the specified
%fdn%~
request.
Where:
Alias RRTs
request_nameThe userdefined request name.

entry_numberThe returned
entry number (1-based).
~DSC::%alias_name%~
Where:
For each alias RRT there is a default

RRT. The configuration can always
refer to the same target value via
both alias RRT and default RRT.
alias_nameThe user-defined
name of the alias.
308
Directory Server should support LDAP (Lightweight Directory Access Protocol) version 3.
Directory Server should support paged-results search with at least 50 entries per page.
Currently there are no known problems with the component.
Document Writer
Welcome to the Document Writer component
The Document Writer component is an additional component which allows creation of text documents out of data
received from other components or entered manually.
The component can be used for handing data over to a third party application not supported out of the box by the
service or to generate any document required by the end user (containing indexing information).
Getting started
Feature highlights
The Document Writer component has the following features:
Making text documents with the specified name, encoding and content.
Support for RRTs in the document content or in the rename schema.
Using an existing file as a template.
How to use the Document Writer component

Perform these steps to archive received emails in PDF format.
1. Build the process that contains the AutoCapture component, the Outlook MSG loader, the Document Writer
component, the PDF converter component and the Send to Folder component.
2. Use AutoCapture to automatically capture emails from the Microsoft Outlook.
3. Configure the Outlook MSG loader to create new job for each message, load attachments and remove messages
after loading.
4. Configure the Document Writer to generate a text (.txt) file with the following content:
Archived Email
From: ~MSG::From~
To:~MSG::To~
BCC: ~MSG::BCC~
Date: ~MSG::Date~
Subject: ~MSG::Subject~
__________________________________________
~MSG::Body~
5. Configure the PDF converter component to convert text files to PDF format. Configure the Send to Folder
component.
Completing this procedure allows you to easily capture every email from the Microsoft Outlook, disassemble the
message information and make it available as RRTs, create a document containing message information, and send the
PDF document together with the message attachment into the specified folder.
309
Configuring the Document Writer component

Configure the component settings in this window.
The component configuration window contains the following settings:
Option
Description
Activate component
Select this check box to make the component active. If

this check box is not selected, then the component will
not take part in the process.
Text template
This group of settings contains the window for entering

the desired text to the generated document and the
controls for managing the generated document.
Use this button to insert the separate line in the document
text.
Import file as template
Click this button to load a template file. It will be

inserted into the text window.
Encoding
Select the encoding of the output file.
File name
Enter the name of the output file.
File extension
Enter the extension of the output file.
Document Writer component RRTs

This component does not generate any RRTs.
Documentum (6.x)
Welcome to the Documentum (6.x) component
Documentum (6.x) route and eConnector component can be used to store information of any kind (including text,
graphics, scanned images, and so forth) into company repositories called Docbases within the Documentum server.
Each Docbase stores two kinds of information for each document:
Document contentThe file you create using applications such as word processors or spreadsheets.
Metadata or propertiesDescriptive characteristics, such as the document type, format, title.
The Documentum component allows you to specify permissions that users or groups will have to the document stored
on the Documentum server, to apply a workflow to the document and to assign attributes to the document.
The component can be used both as a process component or route component.
Getting started
Feature Highlights
Sending documents to the Documentum server versions 6.5, 6.6, 6.7 and 7.0.
Creating folder path dynamically. This enables the path to be set at run time and if the folder does not exist then it
will be created.
310
Configuring document specific properties, such as type, format, name, title, subject, keyword, authors and
permissions.
Using the Documentum (6.x) Component

The following provides an example of common usage scenario.
Scan documents from a variety of MFP devices directly into Documentum server.
1. Design a workflow process by selecting the type of MFP used in scanning of the documents. From the component
tray, select the desired process components and select the Documentum (6.x) route component.
2. In the General tab of the Documentum (6.x) configuration, define the connection parameters to log into the
Documentum server.
3. In the Document tab, configure document specific properties and set the permissions that the users or groups will
have for the routed document.
4. In the Attributes tab, configure the fields that will be assigned to the routed document.
5. Run the process.
With the server running, the walk-up MFP user enters a preconfigured function key on the control panel of the MFP
device, the document with the set attributes is routed directly into Documentum server.
Configuring the Documentum (6.x) component
The Documentum (6.x) configuration window consists of three tabs.
General tab
On this tab, enter general attributes of the repository where the documents will be stored. You can use RRTs in the text
boxes on this tab.
Option
Description
Activate

this check box is not selected, the component just passes
the input document to the subsequent components.
This check box is available only in the Documentum
eConnector configuration dialog.
Use DFC
Select this check box if you want to use EMC

Documentum Foundation Classes (DFC) for connection
to the Documentum server. In this case, you should
specify the address of Documentum Primary Connection
Broker in the Server box. By default, Documentum
Primary Connection Broker uses port 1489, however you
can specify another port number.
Note: If you use DFC for connection to the
server, then do not specify the protocol (http://
or https://) in the Server box.
By default, this check box is not selected and the
component uses EMC Documentum Foundation Services
(DFS) for connection to the Documentum server. In this
case, the Server means the address of the web services
on the Documentum server side.
Note: To use DFC for connection,
Documentum DFC Runtime Environment has to
be installed in the system.
Server
Enter the URL of the server where documents

will be archived, in the following form:
http://server_address:port number/,
311
Option
Description
where server_address is the name of a computer in a
local network or the address of a web server. The form
https://server_address:port number/
can also be used for the server URL if the Documentum
server supports SSL connection and the client has a valid
certificate.
The Documentum 7.0 server has its particularities: the
user should specify the folder with DFC web service
on the server, so the Server field should be filled out in
the following form: http://server_address:
port number /site folder name , where site
folder name is the name of the folder containing DFS
web service for Documentum in Java Application Server.
Examples:
http://localhost:9080/ (for Documentum 6.x)
https://Documentum:9080/ (for Documentum 6.x)
http://www.documentum.myserver.com:9080/ (for
Documentum 6.x)
http://localhost:9080/emc-dfs (for Documentum 7.0)
http://www.documentum.myserver.com:9080/emcdfs (for Documentum 7.0)
Note: Do not specify protocol (http:// or
https://) if you use DFC for communications
with the server.
By default, the component uses EMC Documentum
Foundation Services (DFS) for connection to the
Documentum server, and the Server value means the
address of the web services on the Documentum server
side.
If the Use DFC check box is selected, the component
will use EMC Documentum Foundation Classes
(DFC) for connection to the Documentum server,
and the Server value means the address of the
Documentum Primary Connection Broker. By default,
the Documentum Primary Connection Broker uses port
1489, however you can specify another port number.
Docbase
Enter the name of the Documentum database where

document content and metadata will be stored. You can
select a database by clicking the browse button (...). This
option is required.
Note: When you work with the Documentum
server version 6.5 SP1, the list of docbases
cannot be displayed without authentication. To
display the docbases list in this case, you should
enter the correct docbase name, user name and
password.
312
Option
Description
User Name
Enter the user name that will be used to connect to

the Docbase. The user has to be registered in the
Documentum server. This option is required.
Password
Enter the password for the specified user name. This

option is required.
Domain
If required, enter the domain for the specified user name.
Path
Enter the location within the Docbase at which incoming

documents will be stored. You can select a folder by
clicking the browse button (...). If the folder path does
not exist then it will be created dynamically at run time.
Note: The component can create new folder
path only if the user has such permissions on the
server.
Run
Enter the name of the workflow that will be started for

routed documents. Click the browse button (...) to select
a workflow from available ones for the specified path. If
the path is not specified, this dialog displays all available
workflow templates stored in the docbase.
Timeout
Specify upload timeout, in minutes. If any problems

occur while uploading, or a very big file is being
uploaded, the component waits for this time for response
from the server and when the timeout expires, the
component aborts uploading and rejects the document.
It is recommended to increase timeout value when
sending big documents or when sending documents
into the cabinets that already contain a large number of
documents.
Pass through
If this check box is selected, the component will pass

documents to the next component in the process. If a
document fails to be routed, it is rejected regardless of
the value of this option. This check box is available only
in the Documentum eConnector configuration dialog.
Document tab
Enter the document specific information on this tab. You can use RRTs in text boxes on this tab.
Option
Type
Description
Enter the document type of routed documents. This
component supports the following document types:
dm_document
dm_email_message
insurance_claim
The component also supports all the custom types whose

parent type is one of those types. It is mandatory to fill
out this text box.
Format
Enter the format of routed documents. It is mandatory to

fill out this text box.
313
Option
Name
Description
Enter the name of documents. It is mandatory to fill out
this text box.
You can achieve flexibility in naming
documents by using RRTs in this field. For
example, to preserve the original name of the
document, enter the following combination:
~DFS::FileName~~DFS::FileExt~.
Title
Enter the title of routed documents.
Subject
Enter the subject of documents.
Keywords
Enter comma-separated list of the keywords associated

with documents. This is used mainly for searching.
Authors
Enter comma-separated list of the authors of the

document.
Permission set
Specify permission set associated with routed

documents. Permission set is a named Access Control
List (ACL), that is, a set of permissions that can be
assigned to users or groups for routed documents. Each
user or group can have basic permissions and extended
permissions that are available on the Documentum
server.
You can type the name of the permission set or click the
browse button (...), which opens the Select Permission
Set dialog box. This dialog box allows you to select one
of the available permission sets or to configure a new
permission set. When a permission set is not specified,
routed documents will have a default permission set,
which is configured on the Documentum server. A
default permission set may be associated with a folder,
user, or document type.
Select Permission Set dialog box

This dialog allows you to specify the permission set for a routed document.
All permission sets in Documentum are either external or internal sets, depending on whether they are created and
managed externally by a user or internally by Content Server. External sets are created explicitly by users. Typically,
they are created using Documentum Administrator. In addition, every set of permissions is either a public set or a
private set. Public sets are sets that are available to use for anyone in the repository , and the private sets that are
available only to the users who create them.
Option
Permission sets list
Description
The list in this dialog displays only the following
permission sets:
New defined sets (by default external)

External public sets
External private sets of current user
To specify a permission set, select one of the permission

sets from the list and click OK.
314
Option
Description
When a permission set is not specified, the routed
document will have a default permission set, which is
configured on the Documentum server. This default
permission set may be associated with a folder, user, or
document type.
New set
Click this button to specify a new permission set in the

New Permission Set dialog box.
Properties
Select a permission set and click this button to view or

modify the properties of the selected permission set.
Click this button to open the Permission Set Properties
dialog box.
Note: You can modify only the properties of
a new permission set that was added using the
New Permission Set dialog box and has not
been created on the server yet. If the selected
permission set already exists on the server, you
cannot modify its properties.
Delete
Select a permission set and click this button to delete

the selected permission set from the list. This button is
enabled only for new permission sets that have not been
created on the server yet.
New Permission Set dialog box

This dialog allows you to create a custom permission set.
Option
Description
Name
Enter the name of a new permission set.
Permissions
This box displays the list of users and groups with the
permissions they have. The following information is
displayed for each user/group:
NameName of a user or a group that has

permissions.
TypeUser or group.
Basic permissionsThe basic permissions given to
the user or the group.
Extended permissionsComma-separated list of
the extended permissions given to the user or the
group.
Add
Click this button to add an item to the Permissions list.

This button opens the Set Access Permissions dialog
box.
Edit
Select an item in the Permissions list and click this

button to edit the selected item in the opened Set Access
Permissions dialog box.
Remove

button to delete the selected item.
315
Note: The Permissions list contains two default users that should be present in each permission set:
dm_owner with the default basic permissions Delete and default extended permissions Execute procedure
and Change location.
dm_world with the default basic permissions Read and default extended permissions Execute procedure
and Change location.
You can modify permissions of these users but you cannot remove these users from the list.
Permission Set Properties dialog box
This dialog box allows you to view and/or modify properties of a selected permission set.
Note: You can modify only the properties of a new permission set that has been added using the New
Permission Set dialog box and has not been created on the server yet. If the selected permission set already
exists on the server, you cannot modify its properties. In this case, the controls of this dialog are disabled.
Option
Description
Name
This box displays the permission set name. This value

cannot be edited.
Permissions
This box displays the list of users and groups with the
permissions they have. The following information is
displayed for each user/group:
NameName of a user or a group that has

permissions.
TypeUser or group.
Basic permissionsThe basic permissions given to
the user or the group.
Extended permissionsComma-separated list of
extended permissions.
Add
Click this button to add an item to the Permissions list.

This button opens the Set Access Permissions dialog
box.
Edit

button to edit the selected item in the Set Access
Remove

button to delete the selected item.
The Permissions list contains two default users that should be present in each permission set:
dm_owner with the default basic permissions Delete and default extended permissions Execute procedure, and
Change location.
dm_world with the default basic permissions Read and default extended permissions Execute procedure, and
Change location
You can modify permissions of those users but you cannot remove these users from the list.
Set Access Permissions dialog box
This dialog allows you to specify the permissions that will be given to a user or a group.
Description
Accessor name
Option
Enter the name of a user or a group or click the browse
button (...) to select a user or a group from the list of
Documentum server users or groups.
316
Description
Option
Basic permissions
Select basic permissions that will be given to the

specified user or group.
Extended permissions
Check one or several check boxes to select extended

permissions that will be given to the specified user or
group.
Basic permissions
This table describe the available basic permissions.
Permission
Description
None
No access is permitted to the item.
Browse
Users can view the item properties but not the item
content.
Read
User can view both the properties and content of

the item. No update privileges. It includes Browse
permission.
Relate
User can add annotations to the item. It includes Browse

and Read permissions.
Version
User can modify the item content and they can check in
a new version of the item (with a new version number).
The user cannot overwrite an existing version or edit the
item properties. It includes Browse, Read, and Relate
permissions.
Write
User can edit item properties and check in the item as

the same version. It includes Browse, Read, Relate, and
Version permissions.
Delete
User can delete items. It includes Browse, Read, Relate,

Version, and Write permissions.
Extended permissions
This table describe the available extended permissions.
Permission
Description
Execute Procedure
Users can change the owner of an item and can run

external procedures on certain item types.
Change Location
Users can move the item.
Change State
Users can change the item life cycle state.
Change Permission
Users can modify the item permissions.
Change Ownership
Users can change the owner of the item
Extended Delete
Users can only delete the item.
Change Folder Links
Users can link an item to a folder or unlink an item from

a folder.
317
Attributes tab
Use this tab to assign attributes to routed documents. This tab displays the attributes associated with a docbase and a
document type.
Option
For docbase
Description
Enter the docbase for which the component displays
attributes in the Attribute list. The default value of
this text box is the Docbase defined on the General
tab. You can select a docbase from a list by clicking
the browse button (...). The list displays values only if
the component is able to establish connection with the
Documentum server and retrieve the information about
existing docbases.
Note: You cannot use RRTs in this field.
For type
Enter the document type for which the component

displays attributes in the Attribute list. The default value
of this text box is the Type defined on the Document
tab. You can click the browse button (...) to open the
Select Type dialog box to select a document type from a
document list. The list of document types displays values
only if the component is able to establish connection
with the Documentum server and retrieve information
about existing types.
Note: You cannot use RRTs in this field.
Attribute list
This list displays the attributes(or properties) that

will be assigned to routed documents. The following
information is displayed for each attribute:
NameAttribute name
TypeAttribute type
ValueAttribute value
DocbaseDocbase membership
Document typeDocument type
The component keeps all attributes received from the

server and added by user in its configuration. When
the list of attributes is requested, the component tries
to retrieve the list from the server, if connection can't
be established, the list of attributes is taken from the
configuration.
The list of attributes is filtered according to the values of
For docbase and For type fields. If one of the fields(or
both) is empty, the list is not filtered according to it.
The attributes that don't have docbase or type are also
included in the list and not affected by the specified
values. If RRTs are used in For docbase and For type
text boxes, the component regards them as empty values.
Note: If some attribute value is set via RRT and
is replaced by an empty value at run time, it will
be silently ignored.
318
Option
Description
The values of attributes should be defined
unambiguously. If two attributes with the same names
are used, it is recommended that they belong to different
docbases and/or different document types.
Add
click this button to add a new attribute to the list. This

button opens the Add Attribute dialog box.
Note: When For docbase or For type is empty
or defined using an RRT, the added attribute
will have a corresponding empty Docbase or
Document type value.
Edit
Select an attribute in the list and click this button to edit

the selected attribute in the Edit Attribute dialog box.
Remove
Select an attribute in the list and click this button to

remove the selected attribute.
Add/Edit Attribute dialog box

This dialog box allows you to add an attribute to the Attribute list or to edit settings of a selected attribute. You can
use RRT in all settings of this dialog.
Option
Description
Name
Enter the attribute name.
Type
Enter an attribute type or select the type from the dropdown list. The attribute types are described in the
Attribute Types table (see below).
The Type box allows selection of a type display name.
However, the component stores internal name in the
configuration, since the display name can be translated
into another language in a localized version of the
component.
Value
Enter the attribute value. When specifying an attribute

value, take into account the following:
Time typeThe localized system format should be

used.
Numeric typeA number can be represented with
a simple record using the "." or "," character as a
decimal point symbol according to the localized
system format.
ID typeThe correct values of the identifiers used
in the Documentum server should be used. If the
identifier is not allowed by the server, this value will
be changed to the value recognized by the server.
Therefore the assigned value may differ from the
initially specified.
319
Table 14: Attribute types

Display name (English)
Internal name
Documentum
type name
Format
Boolean
Boolean
Boolean
False or True
Double
Double
Double
123,45
ID
ID
ID
16 hex digit
Integer
Integer
Integer
Any integer
String
String
String
Any string
Time
Time
Time
10/31/2009
or
10/31/2009 12:34:56
Documentum component RRTs

Component RRT ID
The RRT ID for this component is DFS.
Name
Description
FileName
FileExt
DocumentName
The name of the document stored in Documentum

server. This is only applicable to the Documentum
eConnector component and can be used in subsequent
components.
Counter
An incremental counter based on the duplicate file

names found within the directory. The counter value
concatenated with a name provides a unique file name.
DocumentURL
The URL of the document stored in Documentum server.

This is only applicable to the Documentum eConnector
Note: The component retrieves URL from
ACS (Accelerated Content Server) only if it
is allowed by the ACS settings. Otherwise the
DocumentURL is empty and a warning message
will appear at run time.
The generated URL works for several hours
after generation and then becomes invalid.
The following example provides sample usage for your reference:
The RRTN ~DFS::FileName~~DFS::FileExt~ is replaced by the value the value "MyDocument.doc".
320

SSRTN
Description
%a
%A
%b
%B
%d
%D
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Examples of usage of the above SSRTN include:
The SSRTN ~DFS::%Y~-~DFS::%m~ is replaced by the value "2011-01".
This component supports the Documentum server versions 6.5 SP1, 6.5 SP2, 6.5 SP3, 6.6, 6.7 and 7.0.
To use DFC for connection, you have to have Documentum DFC Runtime Environment installed in the system.
This component may have problems when storing documents of 80 MB and larger. It is not recommended to route
such documents with this component.
The Documentum server may have restrictions on the length of some settings (such as document name, permission
or set name). Please check this with the server administrator.
When you use the ~DFS::DocumentURL~ RRT, the generated URL works for several hours after generation
and then becomes invalid.
When you try to get information from the Documentum server at configuration stage, the component tries to
connect to the server with a two-minute timeout. If the component fails to connect to the server during this time, it
321
displays the Connection is impossible error message until the connection parameters are changed or the
configuration is reopened.
When you work with the Documentum server version 6.5 SP1, the list of docbases cannot be displayed without
authentication. To display the docbases list in this case, you should enter the correct docbase name, user name and
password.
The component can create new folder path only if the user has permissions to do so on the server.
Problem Description
When you are sending documents continuously into a
docbase, after some time the component fails to store a
current document, and the Status Monitor writes one of
the following error messages:
Solution
These error messages may appear if the machine with the
Documentum server has not enough memory. Contact
your Documentum server administrator to check the
memory available.
1. CountDocument: _com_error: "QUERY"

action failed.
2. The request channel timed out
while waiting for a reply after
00:30:00. Increase the timeout
value passed to the call to Request
or increase the SendTimeout value
on the Binding. The time allotted
to this operation may have been a
portion of a longer timeout.
When the component uses Documentum Foundation
Classes (DFC) for connection to the Documentum
server, the following error message appears:
When DFC is used, make sure that the server address

does not contain protocol specification (http:// or
https://).
Dokbroker fails
When you try to configure some options that require
connection to the server, the following error message
appears:
Connection is impossible!
When connection to the server fails, the component

remembers that state and the next time when connection
is needed the component shows an error. Check your
connection settings and make sure the server can be
accessed, then close and reopen the configuration
window of the component.
DocuShare
Welcome to DocuShare
DocuShare component provides integration with DocuShare content management system developed by Xerox
Corporation. DocuShare users can efficiently store content from variety of sources into DocuShare repository.
Once the content is captured, it becomes available for retrieval and collaboration across the network within the
organization.
Now you can design and implement workflows that capture electronic documents from a variety of sources such as
MFPs, network/local folders, PC desktop, POP3 eMail servers to manage and store your documents into DocuShare.
The component can be used both as a route component or a process component.
Getting started
Feature Highlights
The DocuShare component provides the following features:
322
Route documents into DocuShare.

Set properties of routed documents: title, description, owner and specific properties.
Send mail messages into DocuShare server with an ability to attach routed document to a mail message.
Select collection or workspace (for DocuShare Server versions 6.0 CPX and higher).
Select a routing slip to be attached to routed documents.
Impersonation to change the owner of the routed document.
Maintain multiple versions of a document, track its revision history, and lock a document to prevent simultaneous
editing.
Using DocuShare
Main examples of using DocuShare component.
This component is used to route documents into DocuShare. You can route documents either from local/network
folder or from MFD directly into DocuShare.
The main examples of using this component are as follows:
Scan documents from a variety of MFD directly into DocuShare

Capture electronic documents from a local/network folder directly into DocuShare
How to Route Scanned Documents into DocuShare from MFD

Scan documents from a variety of MFD directly into DocuShare:
1. Design a workflow process by selecting the type of MFP used in scanning of the documents.
2. From the component tray, select the desired process components and select the DocuShare route component for
storing the scanned document into DocuShare.
3. Configure the DocuShare component to assign document attributes such as Title, Description, Keywords,
Expiration Date, that uniquely identify the document and to attach a routing slip to the document.
4. Run the process.
With the server running, the walk-up MFP user (with or without authentication), enters a pre-configured function key
on the control panel of the MFP device, the document with the set attributes is routed directly into DocuShare and
associated with a routing slip.
How to Route Documents to DocuShare from Local Folder
Capture electronic documents from a local/network folder directly into DocuShare:
1. Design a workflow process by selecting Multi-Poll capture component.
2. From the component tray, select the desired process components and select the DocuShare route component for
storing the document into DocuShare.
3. Configure the DocuShare component to assign document attributes such as Title, Description, Keywords,
Expiration Date, etc. that uniquely identify the document and to attach a routing slip to the document.
4. Run the process.
on the control panel of the MFP device, the document with the set attributes is routed directly into DocuShare and
associated with a routing slip.
Configuring DocuShare
The component configuration window consists of four tabs:
Tab
Description
General Tab
Use this tab to enter server connection settings for

logging on to the DocuShare server.
Document Tab
Use this tab to set the document attributes.
323
Tab
Description
Properties Tab
Use this tab to add properties to your document or mail

message.
Advanced Tab
Use this tab to set the options for the search of a

specified collection
General tab
Use this tab to enter server connection settings for logging on to the DocuShare server.
Note: You can use RRTs in all text boxes of this tab.
Option
Description
Activate
Select this check box to activate the component. If this

box is not checked, the component won't perform any
actions during files processing. This option is only
available to DocuShare eConnector component.
Server address
Enter the URL of the DocuShare Server. For example:

http://myserver:8080/docushare/.
Use proxy server
Select this check box to enable use of a Proxy

Server. Enter the address of the Proxy Server in
the text box next to this check box. The address
should be specified in the following form:
protocol_prefix://server:port, where
server can be the server name or IP address for the
server, and port is the port number that the server uses to
communicate with clients.
For example, http://ProxyServer:8080.
User name
Enter the DocuShare user name. This is a required value.
Password
Enter the password. This is a required value.
Domain
Enter the domain name if the DocuShare site uses the

LDAP (Lightweight Directory Access Protocol) add-on.
You can click
to select one of the available domains
in the opened Domains dialog box. This is a required
value.
Check
Click this button to validate the specified user

credentials. The component will try to connect to
the DocuShare server using the current connection
information. If the connection is successful, then the
component displays the message: The connection
parameters are valid. If the connection fails,
the component displays an error message with the
information about the reason of this failure.
Impersonate
Select this check box to change the owner of the

document. Enter the name of the new document owner
(impersonator) in the text box next to this check box.
Note: The Impersonate text box should
contain only the user name without domain. If
324
Option
Description
you specify the user name with a domain, the
impersonation will fail.
Pass-through
Select this check box to pass documents to the next

component in the process. This option is only available
to DocuShare eConnector component.
Document tab
Use this tab to set the document attributes.
Option
Rename title
Description
Select this check box to set the title of the document.
Enter the title in the text box next to this check box.
The title should be short but descriptive and can contain
spaces and punctuation marks. You can use one or
several available RRTs in this text box.
If this option is not selected, the original file
name of the document will be assigned to the
title. If this option is selected and the rename
schema text box is empty, the title will be
~XDS::FileName~_~XDS::Timestamp~~XDS::FileExt~.
For example, if the original file name
is Mydocument.doc, the title will be
Mydocument_20071026163500.doc.
Rename file
Select this check box to set the file name of the

document. Enter a file name in the text box next to this
check box. You can use any component RRT in this text
box. If this option is not selected, the original file name
of the document will be assigned to the file name. If this
option is selected and the rename schema text box is
empty, the title of the document will be assigned to the
file name.
Summary
Enter a short description of the document. The summary

appears below the document title. You can use one or
several available RRTs in this text box.
Description
Enter the description of the document in this text

box. Click the browse button (...) to open the Enter
Description dialog box, which allows entering a longer
and more detailed description. You can use one or
several available RRTs in this text box. You can include
HTML tags into the description of the document.
Keywords
Enter a comma-separated list of words that will be

associated with the document. You can use one or
several available RRTs in this text box. Keywords help to
categorize documents and can be used to find documents
in a search.
Expiration date
Enter the date and time after which the document is no

longer needed. You can use one or several available Date
\Time RRTs except for ~XDS::Timestamp~ in this
text box. Sent documents will be marked as expired on
the server after the specified date.
325
Option
Description
Note:
The default value for the date in the Select Date
dialog box is always a current date, even if you
have previously specified some other date.
This functionality is not applicable to the
MailMessage document type (specified by the
Document type option on the Properties tab).
Routing slip ID
Enter an identifier of a routing slip that will be attached

to the document. A Routing Slip is a form on the
DocuShare server in which you can indicate the user to
whom the document should be sent, the type of action
the user should take and a message describing the task.
Click the browse button (...) to open the Select Routing
Slip dialog box or enter an identifier of a routing slip
manually.
Note: For correct work of this functionality,
the administrator should copy the JSP script
DsNsiUtils.jsp into the DocuShare server
folder: C:\Xerox\Docushare\tomcat
\webapps\docushare\jsp\extension
\.
Collection ID
Enter an identifier of a collection. A DocuShare site

consists of a number of repositories called collections
in which documents and other objects are stored. The
administrator determines the initial set of containers/
collections that appear on the DocuShare home
page. Click the browse button (...) to open the Select
Collection dialog box, in which you can select the path
to the container or folder where the documents will be
stored or enter an identifier of a collection manually.
Note: When you work with DocuShare Server
versions 6.0 CPX and later, you can also
send documents to the workspaces or custom
collections, that is the collections created on the
DocuShare server by users.
Appended path
After you have selected the container/collection, you

can optionally set a path to be appended to the collection
path. If the collection in the appended path does not
exist, the component will create this collection at run
time. You can use one or several available RRTs in this
text box.
You must enter a value in the Collection box. In the case
when the Collection box is empty and Appended path
is specified, the configuration may be saved, but an error
will appear at run time.
Note: There might be an ambiguity in
the collection names (there is more than
one collection with the specified name, for
example), see the Check for ambiguous
326
Option
Description
collections names option on the Advanced tab
to find how the component can resolve this
conflict.
When you use this functionality, it is
recommended to set appropriate search options
in the Advanced tab to make the search of
collections more efficient.
Lock document
If you are a logged-on owner of the document or a

logged-on user with Write access to the document, you
can lock the document to keep other users from editing
the document.
Note: This functionality is not applicable to the
MailMessage document type.
Initial permissions
This group allows assigning access permissions to routed

documents. Select one of the options:
Same as containerAssigns the container access

permissions to the document.
Same as container except write restricted to owner
Assigns the users who have Reader access to the
container with Reader access to the document. The
document owner is the only user with Write access to
the object.
Restricted to ownerAssigns full access
permissions only for the document owner.
Enter Description dialog box

This dialog box allows you to enter a detailed description of the document that you send to the DocuShare.
Note: You can use RRTs in this dialog box.
Option
Description
Description box
Enter a detailed description of the document that you

want to send to DocuShare in the text box.
Enquoted multiline text
Select this check box to store the text of the description

in enquoted multiline format.
This format encloses each line of text between quotation
marks and delimits lines using \r\n. Because the slash
(\) is used as an escape character, it and the quotation
mark (") characters are changed to \\ and \. For example,
if description text consists of two lines: "First
line" and "Second line", it would be transformed
\"First line\"\r\n\"Second line\". The
text is not changed if this check box is not selected.
If you include line breaks in the text, the Enquoted
multiline text check box becomes selected and disabled.
Note: The Enquoted multiline text check
box should not be selected if the description
contains RRT that can be replaced by a value
327
Option
Description
that contains the \", \r, or \n symbols or quotes at
the beginning and end of lines of text. In other
words, text that is already in enquoted multiline
format.
Select Routing Slip dialog box

This dialog box allows you to select a routing slip that will be attached to the routed document.
Option
Description
Please select a routing slip
This box lists routing slips that are currently configured

on the DocuShare server. Select the routing slip that you
want to attach to the routed document and click OK.
Note: After you select a routing slip in this
dialog box, the Routing Slip ID option on the
Document tab will specify the identifier for the
selected routing slip.
Select Collection dialog box

This dialog box allows you to select a collection in which documents will be stored.
Option
Description
Please select a collection of documents
This box displays the collections of the DocuShare

server as a tree. Select a collection in which documents
will be stored.
After you select a collection in this dialog, the
Collection ID option on the Document tab will specify
the identifier of the collection.
Note: When you use DocuShare Server version
6.0 CPX or higher, this box also displays
workspaces and custom collections. That is, the
collections created on the DocuShare server by
users. This allows you to select a workspace or a
custom collection to which to send documents.
Properties tab
Use this tab to add properties to your document or mail message.
Option
Document type
Description
Enter the type of documents you want to store into the
server or click the browse button (...) to select the type
from the list of available types. This component supports
the following document types:
Document and its clones

MailMessage
If you select the MailMessage document type, the

component will send a mail message to the DocuShare
server. The mail messages have a predefined set of
properties that have to be specified on this tab. Add
necessary properties by clicking Add button. The
properties depend on server settings.
328
Option
Description
When you select the MailMessage type, you can attach
the routed document to the sent message by selecting the
Attach document to email check box.
Note: If an invalid document type is used
(a document type that does not exist on the
DocuShare server or is not supported by the
component), the configuration can be saved, but
at run time an error message will appear and the
process will fail.
Tip: You can create a super set of all (or some)
properties and associated values from the
list of available document types. To do this,
browse for the first documents type, for example
"Contracts", along with the desired properties.
Proceed to browse for the second document
type, for example "Proposals", and append the
desired properties, and so on. At this point you
have selected all the desired properties (from
multiple document types) and property values.
Now change the Document Type to an RRT
(Dynamically set document type), for example
~POP::Subject~. When you run the Server,
with POP3 eMail as your capture component,
e-mails with subject property label "Contracts"
will only have the "Contracts"-related property
values populated. E-mails with subject property
label "Proposals" will only have the "Proposal"related property values populated, and so on.
Save as
Specify the behavior of the component in the case when

a document with the same title and type already exists on
the server. Select one of the following alternatives:
New documentThe document will be saved as a

new document and will get version number 1.
New versionThe document will be saved as a new
version. If there are two or more documents with the
same title and type in the collection, the document
will be saved as a new version of the last uploaded
document of the same title and type which will be
found in the collection.
OverwriteThe document will overwrite the
existing document and will get version number 1.
All the previous versions of this document will be
deleted. If there are two or more documents with the
same title and type in the collection, the last uploaded
document will be overwritten.
AppendThe component will join a new image to
the already existing document; the new image will be
added at the end of the existing document.
PrependThe component will join a new image to
the already existing document; the new image will be
added at the beginning of the existing document.
329
Option
Description
InsertThe component will insert pages after the

specified page.
Note: The Append, Prepend and Insert options
are available only for image files. If you select
one of these options for a non-image file, then at
run time it will be rejected.
Note: There may be several documents with
the same title and type in the collection on the
DocuShare server. If append/prepend/insert
functionality is used and there are two or more
documents with the same title and type in the
collection, then the document will be rejected
with the corresponding error message.
Max versions
Enter the maximum number of versions of the document

that you can save in DocuShare. If the version number
of a document reaches its maximum, and you try to save
a new version of the document, the oldest version is
deleted.
Append/prepend
This group allows users to set additional parameters for

joining image files.
File type
Select a file type for the output image file from the list.
There are two available types: TIFF and PDF.
Insert after
Select the number of a page, after which the new pages

will be inserted to the document.
Attach document to E-mail
This check box is enabled only when the selected

document type is MailMessage. In this case the
component sends a mail message to the DocuShare
server and, if this option is selected, a routed document
will be attached to this message.
Add
Click this button to add a property to routed documents.

This button opens the Add Property dialog box. Each
document type has its own specific set of properties.
Modify
Click this button to modify the property value in the

opened Modify Property dialog box.
Remove
Click this button to remove a property value.
Refresh
Click this button to retrieve the most up-to-date list of

properties from DocuShare server.
Note: The list of properties is retrieved on
the first occasion it is needed and saved into
330
Option
Description
memory. If during configuration the list of
properties on the server is changed, the changes
are not displayed until you refresh the list.
Add/Modify Property dialog box

This dialog box allows selection of the properties to be assigned to the document.
The properties are subject to change depending on document type specified on the Properties tab. Each document
type has its own specific set of properties.
Option
Description
Property
Enter property name or select it from the drop-down list

of the properties that are specific to the currently selected
document type. You can use one or several available
RRTs in this text box.
Value
Enter property name. The browse button (...) is enabled

only if the set of specific values exists for the selected
property. The button opens the Select Property Value
dialog box, which allows selection of one of the specific
values for the property. You can use one or several
available RRTs in the Value text box.
Note: When you select a property, the Value
text box displays the default value of the
property configured on the DocuShare server.
Type
This text box displays the type of the selected property.
Required
This text box indicates if the selected property is

required or not.
Advanced tab
Use this tab to set the options for the search of a specified collection
When a document or mail massage is to be routed to the server using Appended path functionality, the component has
to find the specified location and check if a document with the same name already exists at this location. On this tab
you can configure the parameters of the search, which can improve component's performance and reliability. For most
users the default options are sufficient.
Option
Description
Search compatibility options
This group of settings allows you to specify the search

method for the component.
Scan through children list
When this option is selected, the component will get

the first level child collections and search for the first
collection specified in the additional path, then get the
list of child collections of the collections found at the
first step and search for the second collection and so on
until the last collection in the specified path.
Note: This option is recommended in the case
of a hierarchical structure of collections with
relatively small number of child collections
in each collection, for example, if you use the
following structure for the Appended path
setting on the Document tab: ~XDS::%Y~/
331
Option
Description
~XDS::%m~/~XDS::%D~/~XDS::%H~/
~XDS::%M~/~XDS::%S~.
Use indexed search
When this option is selected, the component will use

server indexed search to find a required collection.
Note: This option is recommended in the
situation of a non-hierarchical structure of
collections on the server. For example, if you
use the following structure for the Appended
path setting on the Document tab: ~XDS::
%Y~_~XDS::%m~_~XDS::%D~_~XDS::
%H~_~XDS::%M~_~XDS::%S~, there will
be only one level of collections and the number
of collections may be rather big. In this case,
indexed search requests will be performed faster
than direct search.
Check parent in search request
When you select this check box, the component makes

a search request and instructs the server to check if the
requested collection has the required parent.
Note: Old versions of DocuShare server (prior
to 6.5.3) have an issue with indexed search: the
search returns all collections with a specified
name that can be found on the server. To work
around, use Check parent in search results
option.
Check parent in search results
When you select this check box, the component first

executes the request and then verifies if the found
collection has the required parent.
Note: Old versions of the DocuShare server
(prior to 6.5.3) have an issue with indexed
search: the search returns all collections with a
specified name found on the server. You might
want to limit the number of search results if you
are absolutely sure that the restricted result will
include the collections you need.
Limit search results
Select this check box to limit the number of search

results when the component checks the parent.
Items limit
Enter the number of items in the search results that will

be checked for the parent. The minimum number of
items in the search results is 2. This is necessary for the
correct work of the Check for ambiguous collections
names functionality.
Use JSP search script
Select this option to use script-based search method.

This search method is preferable for any folder structure
as it works faster and more correctly than other search
methods. In order to make this search method work,
the administrator should deploy JSP script based on
the Xerox sample dsfind.jsp into the DocuShare server
332
Option
Description
folder: C:\Xerox\Docushare\tomcat\webapps
\docushare\jsp\extension\.
For DocuShare Server versions 4.0.1 and 5.0, use the
following script: dsfindas.jsp.
For DocuShare Server version 6.0 CPX, use the
following script: dsfindas.jsp.
Note: When append/prepend/insert
functionality is On, it is strongly recommended
to use JSP search script as a search
compatibility option. In case of using another
Search compatibility options there may appear
the following situation: any file may be
uploaded as a new document (because indexing
is not finished on the server) and all other
documents will be rejected since the component
will be unable to determine which document the
input file should be appended to.
Check for ambiguous collections names
If this check box is selected, the component will check if

there is more than one collection with the specified name
on the server. If there are and this option is selected,
the component will create a new collection with the
specified name and the suffix "_Ambiguous" appended
to it (or to the first collection in the path). The document
will be stored in this collection. If this option is not
selected and there is an ambiguity in the collection path,
the component will go through the path and at each level
select the collection that was created first. The document
will be stored in the selected path.
DocuShare component RRTs

Component RRT ID
The RRT ID for this component is XDS.
Name
Description
FileName
Returns the original file name value.
FileExt
Returns the original file extension value such

as .txt, .doc, etc.
Title
Returns the resulting title of the document. This RRT

can be used in all the fields of the component, besides
Rename title text box.
URL
Returns the URL of the document stored in DocuShare.

This is only applicable to the DocuShare eConnector
333

The RRT expression ~XDS::FileName~, when used in the Rename title box on the Document tab of the
component settings, is replaced with the value "MyDocument" if the original file name is "MyDocument.doc".
The RRT expression ~XDS::Title~, when used in the Rename file box on the Document tab of the
component settings, is replaced with the value "Report" if the value entered in the Rename title box is "Report".

SSRTN
Description
%a
%A
%b
%B
%d
%D
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Timestamp
Composed date time stamp (YYYYMMDDhhmmss)
Examples of usage of the SSRTN include:

~XDS::%Y~-~XDS::%m~ will be replaced by "2010-11".
~XDS::Timestamp~ will be replaced by "20101116163500".
This component works with DocuShare Server versions 4.0.1, 5.0, 6.0.1 update 3 CPX, 6.5.0 CPX, 6.5.3 CPX and
6.6.1.
334
This component is only storing documents, mail messages and is not capable of storing any other object types
such as bulletin, group, and so on.
When you change the Server Address, you have to update the Collection on the Document tab (even if the same
collection path exists on both servers) and the Document Type, since the component keeps the internal id of a
collection.
If you delete a collection and then create another collection with the same name, you have to select this collection
in the component configuration, since the component keeps the internal id of the collection and it needs to be
updated when changed.
When using indexed search and you are sending several documents in a short period of time, several files or
several collections with the same name may appear on the server. The server may not have enough time to index
new files and collections, as a result the component would not know the file with the same name already exists
and would add a new one.
For correct work of the component it is not recommended to change the specific sets of properties for document
types on the DocuShare server while the documents are being uploaded on the server.
When several (5-10 or more) concurrent processes with the component are working, some of the processes may
send files to DocuShare with a considerable time delay.
If you use the Appended path functionality on the Document tab and the collection name contains the '\' symbol,
the component will perform indexed search incorrectly. In this case please use the Scan through children list
option on the Advanced tab.
If you use the '<', '>' symbols in the Appended path, Rename file or Rename title text box on the Document
tab, the component creates folder or file replacing these symbols by '&x3C;' and '&x3E;'correspondingly.
For example, "test<step>test" will be replaced by "test&x3Cstep&x3Etest". In this case the DocuShare webinterface displays '<', '>' symbols.
The Lock document and Expiration date functionality on the Document tab, and Max versions functionality on
the Fields tab functionality are not applicable to the MailMessage Document type.
The component does not allow sending MS Outlook e-mails however it is possible to attach .msg files to the mail
message.
You can attach only one document to the mail message.
For correct work of the Routing slips functionality, the administrator should copy JSP script DsNsiUtils.jsp into
the DocuShare server folder: 'C:\Xerox\Docushare\tomcat\webapps\docushare\jsp\extension\'.
For sending documents to the DocuShare server, a user should not be a member of the "Read-Only Users" group
and should be a member of a group with permissions of reading and writing in the specified collection.
The component joins TIFF, PNG, EXIF, JPG, GIF and BMP image files into a TIFF output file and PNG, PDF,
JPG, GIF and BMP image files into a PDF output file. The component cannot join a TIFF file to a PDF file.
The components cannot handle iref streams.
Problem Description
The document is not sent to the DocuShare server and
the Status Monitor shows the following error message:
Cannot create file object for
document type #type#. The parameter
is incorrect , where #type# is the configured
Document type.
When you are sending a mail message to the DocuShare
server, it is not sent and the Status Monitor shows the
following error message:
Solution
This message means that an invalid Document type is
specified, that is a document type that does not exist
on the DocuShare server or is not supported by the
component. Please specify the correct Document type.
Make sure that you have specified values for all the
required properties of the MailMessage Document type.
An HTTP error was encountered

When the component is trying to upload documents to
DocuShare, the following error message appears:
The possible cause of this problem is that the component

tries to send the documents with incorrect metadata to
the server; for example, an incorrect date or number
335
Problem Description
Cannot upload.
System.Net.WebException: The remote
server returned an error: (400) Bad
Request.
Solution
format, or an integer value that is outside of allowed
bounds.
To resolve the problem, make sure that all the metadata
values specified in the component configuration are valid
and correspond to the expected format.
Make sure that all the required properties of the
Document type have default values specified on the
DocuShare server.
See more information on Document type properties on
Properties tab.
When you use the component the Status Monitor shows

the following error message:
The possible cause of this problem is that User/

DocuShare system is out of licenses.
Cannot upload. The remote server

To resolve this problem, perform the task with another
returned an error: (430). Check if the user or contact DocuShare to obtain an updated or new
license quota is exceeded.
license.
DocuWare
Welcome to the DocuWare component
Use DocuWare route and eConnector components for routing documents with their associated metadata into the
DocuWare document management system.
The only difference between the DocuWare route and eConnector components is that the eConnector component has
two additional options in the General tab:
Activate check box makes the component active. If this check box is not selected, the component will not perform
any actions during file processing.
Pass through check box makes documents available to the subsequent components, when selected.
These two options are absent in the DocuWare route component configuration.
Getting started
Feature highlights
The DocuWare route and eConnector components provide the following features:
Sending documents to the specified file cabinet and/or basket in DocuWare archive.
Creation of data records without sending documents.
Assignment of field values to a sent document or to a record.
Document version support.
Renaming of sent documents.
How to use the DocuWare component

The DocuWare component allows users to submit the documents and their associated metadata to the DocuWare
archives.
The following use-case describes a typical scenario for capturing documents and routing them to DocuWare .
Capture the scanned documents from the FTP server, convert to the searchable PDF and send the resultant PDF
documents to the DocuWare archive.
336
1. Create a workflow with the FTP Poll capture component, the Barcode component, the OCR component and
the DocuWare route component.
2. On the General tab of the DocuWare component, set the file cabinet and/or basket where you want to route the
document into.
3. On the Document tab, set the version field for the document, the start value and increment for the version and/or
the rename schema for the document.
4. Set the metadata of the routed documents on the Fields tab of the DocuWare component.
6. Run the process.
The user scans a batch of documents with barcode cover page that describes the field attribute for each document. The
documents are then placed in the folder that is accessed through FTP. Now, when you start a process:
FTP Capture component polls the scanned document with a pre-defined schedule.
Barcode component reads the barcode value out of the cover page while splitting the scanned batch
into separate documents.
OCR converts the scanned documents into searchable PDF.
DocuWare route component delivers the searchable PDF documents to the DocuWare archive along with the
corresponding metadata.
Configuring the DocuWare component

The DocuWare component configuration consists of the three tabs.
General tab
Use this tab to set general connection parameters for logging into the DocuWare server and to specify the destination
of the routed document.
Note: All text boxes in this tab can contain RRTs.
Option
Activate
Description
Select this check box to make the component active.
If this check box is not selected, the component won't
perform any actions during files processing.
Communication group
Type
Choose the type of connection to the sever in this combo

box. There are two possible options:
Windows client this type uses the desktop

DocuWare client for connection to the DocuWare
server. When this type is chosen, the Organization
and Server address text boxes are disabled, because
this information is stored in the DocuWare client.
Note: To use this type of connection, you
should install the DocuWare client on the
machine with the component service.
For a proper operation of the component

with windows client you should switch on
the Allow service to interact with desktop
option in the component service properties
and start the Interactive services detection
service in the Windows administrative tools.
Web services - this type uses DocuWare web services
for connection to the DocuWare server. When this
337
Option
Description
type is chosen, you should enter the Server address
and Organization manually.
Note: This type of connection has no
support for Baskets; hence, the component
routs documents only to the cabinets and
the File cabinet text box is mandatory to be
filled out.
Note: If you change the type of connection, the
component clears up the File cabinet text field;
hence, you should enter the File cabinet each
time when you change the type of connection.
You can use RRTs in this combo box, they should be
replaced with one of the predefined values.
Organization
Enter the name of your organization. This text box is

enabled only when Web services communication type is
chosen. This text box is not mandatory.
Server address
Enter the server address to this field. This text box is

enabled only when Web services communication type is
chosen. It is mandatory to fill out this text box, when it is
enabled. The server address should contain the machine
name, where the Server is hosted, and the port number;
for example, DocuWare6:9007. The default port number
is 9007.
Pass through
Select this check box to make the document(s) available

to the subsequent components.
Authentication group
User name
Enter the user name to connect to the DocuWare server.
Password
Enter the password for the user account specified in the

User name text field.
Note: If User name and Password text fields
contain RRTs or invalid data, an error message
will appear when you try to open another tab. At
this case, the component will switch to off-line
regime and will not check the conection to the
server.
Route group
File cabinet
Enter the name of the file cabinet where you want to

store documents. Or click the browse button (...) to select
one of the available file cabinets in the opened Select
File Cabinet dialog box.
Basket
Enter the name of the basket where you want to store

document or click the browse button (...) to select one of
the available baskets in the opened Select Basket dialog
box.
Note: It is mandatory to fill out either the File
cabinet text box or the Basket text box. If you
338
Option
Description
specify the File cabinet only, the component
will store document directly in the file cabinet.
If you specify the Basket only, the component
will store document directly in the basket.
If both the File cabinet and the Basket are
specified the component will store documents
into file cabinet through the basket, that is, the
document will be stored both in the file cabinet
and in the basket.
If you specify the File cabinet only, and the
component fails to save the document in the
specified file cabinet for some reason, the
document will be saved in the basket which
is active on the DocuWare server. This is the
DocuWare server's peculiarity that depends on
the server's settings.
Note:
If the DocuWare client is not running when you configure the component and you click the browse (...) button
to select the File cabinet or the Basket, or switch to another tab from this tab, the DocuWare client will be
started automatically.
If the DocuWare client is running under another user account, the component will restart the DocuWare client
using the specified User name and Password.
When the component service works on Windows Server 2008 or Windows Vista, the DocuWare client can
be started on a separate desktop, therefore the additional instance of the DocuWare client started by user will
not affect component's work. When the component service works on Windows Server 2003 or Windows XP,
the component will start the DocuWare client on the user's desktop or use the already running instance of the
DocuWare client. In this case you can start an additional instance of the DocuWare client under another user
account if it is necessary.
Document tab
Use this tab to set the options of storing documents.
Option
Description
Create document record without document
If this check box is selected, then the component stores

only the document fields in the DocuWare archive but
not the document itself. If you select this check box, all
other controls in this tab become disabled.
Note: A record can be created only in the file
cabinet and cannot be created in the basket.
Naming group
Name field
Enter the name of the field that will be used as the

document identifier. You can enter the name manually
or click the browse button (...) to select this field in the
opened Select Document Name Field dialog box; if you
use Web services connection type, the browse button
is disabled and you should enter the value manually.
This field should be defined by the administrator of
the DocuWare server for the specified file cabinet. The
document name field must have a text or key type. It is
339
Option
Description
used for version support and renaming of the document.
You can use RRTs in this text box.
Note: If the specified Name field differs
from the name field defined by the server
administrator and you use document version
support or renaming of the document, then the
component will give an error message at run
time. If document version support or renaming
of the document is not used, then this difference
will be ignored.
If you use Web services connection type this
error message does not appear.
Rename document
Select this check box if you want to rename the sent

document. This check box is enabled only if the Name
field is non-empty.
Schema
Enter the renaming schema for the document. This

field is enabled only if the Rename document check
box is selected. If the Name field is defined, this field
will get the value that you define in the Schema text
box. If the Name field is not defined, the renaming
will not work and the component will give an error
message at run time. The default renaming schema is
~XDW::FileName~_~XDW::Counter~~XDW::FileExt~.
Versioning group
Use document version support
If this check box is selected, the component will support

document versions automatically.
Tip: When you use document versions support,
the component will search for the different
versions of the document being uploaded on
the server. That is, if the Name field is defined
by the server administrator, the component
searches for the existing documents that have
the same value of the Name field. If the Name
field is not defined, the component searches
for the existing documents that have the same
values for all fields except for the Version
field (only non-empty field values of Text
or Keyword fields from the Fields list are
considered). The new document gets the version
number equal to the maximal version number
found during the search operation, increased by
the Increment. If no existing versions of the
document are found, the new document version
number will be equal to the Start value.
Note: The more versions of the document
are stored on the server, the more time it will
take to save the next version of the document.
Using document version support can slow down
component performance.
340
Option
Description
Version field
Enter the name of the field of the document which will

hold version number or click the browse button (...) to
select one of the available fields in the opened Select
Version Field dialog box. The entered field should have
the text type. You can use RRTs in this text box. This
text box is enabled only if the Use document version
support check box is selected.
Start value
Enter the start version number for new documents, that

is, for the documents that do not have other versions on
the server. The default value is 1.00. You can use RRTs
in this text box. This text box is enabled only if the Use
document version support check box is selected.
Increment
Enter the positive real value by which the version

number will increase. The default value is 0.01. You
can use RRTs in this text box. This text box is enabled
only if the Use document version support check box is
selected.
Note: The version support and renaming are applicable only for the documents but not for the records.
Fields tab
Use this tab to configure fields that will be assigned to the routed document.
Option
Description
For file cabinet
Enter the name of the file cabinet whose fields will be

displayed in the Fields list. The default value of this field
is the File cabinet defined in the General tab. You can
Fields
The list of the fields that can be assigned to the

document. This list displays Name, Type, Value, and
Cabinet settings for each field. There are two possible
situations:
If the For file cabinet text box is not empty, and

the component can establish connection with the
DocuWare server in order to retrieve information
about fields of the file cabinet, then the component
automatically displays all fields specific for the
defined file cabinet. In this situation the Cabinet
setting is the same for all fields. When you add a
new field, the component will display the defined file
cabinet name for this field in the Cabinet column.
If the For file cabinet text box is empty or contains
RRT or, for some reason, the component cannot
retrieve information about the file cabinet, then
it displays the fields that were specified earlier in
the component configuration. In this situation the
Cabinet setting may have different values because
there may be fields from different file cabinets. When
you add a new field in this case, the component will
display this field with empty value of the Cabinet.
341
Option
Description
Note:
A field will be assigned to the document only
if the Cabinet value corresponds to the file
cabinet where the document will be stored or the
Cabinet value is empty. If the Cabinet value is
empty, this field settings will be applied for all
available file cabinets on the DocuWare server.
A field can be specified by several methods in
the component configuration:
1. Field name is passed via RRT, displayed
Cabinet value is empty.
2. Field name is passed via RRT, displayed
Cabinet value is non-empty.
3. Field name is specified explicitly, displayed
Cabinet value is empty.
4. Field name is specified explicitly, displayed
Cabinet value is non-empty.
If a field is specified by several methods in one
configuration, this field will get the value which
is defined by the method of higher priority. The
sequence of methods' priorities in descending
order is the following: 1,2,3,4.
For example, if the fields list contains two
items: 1) Name="Number", Type="Text",
Value="1", Cabinet="MyCabinet";
2) Name=~CMP::SomeRRT~, Type="Text",
Value="5", Cabinet="MyCabinet", and the
~CMP::SomeRRT~ is replaced by "Number"
at run time, the field Number will get the value
"5".
Add
Click this button to add a new field to the Fields list.

This button opens the Add Field dialog box.
Note: Using this button makes sense mostly
if the For file cabinet text box is empty
or contains RRT or, for some reason, the
component cannot retrieve information about
the file cabinet.
Edit
Select a field from the Fields list and click this button to
edit the selected field. This button opens the Edit Field
dialog box.
Note: If the Fields list is empty or there is no
item selected in this list, then the Edit button is
disabled.
Remove
Select one or several fields from the Fields list and click
this button to remove the selected field(s).
342
Option
Description
Note: If the Fields list is empty or there is
no item selected in this list, then the Remove
button is disabled.
Note:
If you select the Rename document check box in the Document title and at the same time specify the value
of the name field in the Fields tab, the value specified in the Fields tab will be ignored and the document will
be renamed according to the renaming schema.
If you select the Use document version support check box in the Document tab and at the same time specify
the value of the version field in the Fields tab, the value specified in the Fields tab will be ignored and the
version field value will be set according to the version support parameters defined in the Document tab.
Add/Edit field
This dialog allows you to add/edit a document field.
Note: You can use RRTs in all settings in this dialog box.
Option
Description
Name
Enter the field name.
Type
Enter the field type manually or select from the list

of display names, represented in the Field types table
below.
Value
Enter the field value. This text box cannot be empty for
the fields of Dates and Numeric types. The following
representation should be used for specifying the field
value:
For Memo type, a value should be represented as a

multiline text.
For Text type, a value should be represented as a text
string.
For Keyword type, a value can be represented as a
multiline text in which every line is as certain key.
For Date type, the localized system format should be
used.
For Numeric type, a number can be represented with
a simple record using '.' or ',' character as decimal
point symbol according to the localized system
format. A decimal point is placed automatically
after closing the Add Field or Edit Field dialog box.
Number of digits after a decimal point is defined in
the special fields property on the server.
Field types
The following table describes the possible field types with their display names and Internal names:
Internal name
DocuWare type name
Memo
Memo
Edit field
Text
Text
Text 1...Text 255
343
Internal name
DocuWare type name
Keyword
Keyword
Headwords
Date
Date
Date
Numeric
Numeric
Numeric
Note: The component stores the internal name of the type in the configuration, since display name can be
translated to another language in a localized version of the component.
Note: The maximum number of characters for the Text type is 255. The DocuWare server administrator can
configure another maximum numer by reducing the predefined maximum. There are the following restrictions
about this text field:
When you exceed the maximum number of characters for the text type while using Web Services
connection type, routed documents will be uploaded to the DocuWare server at run time, but the value of
the text field will be cut up to the configured maximum number of characters.
When you exceed the maximum number of characters for the text type while using Windows client
connection type, routed documents will be rejected at run time and an error message will appear.
DocuWare component RRTs

Component RRT ID
The RRT ID for this component is XDW.
Name
Description
FileName
FileExt
The original file extension value.
Counter

found within a directory. The counter value concatenated
with a name provides a unique file name.
The following example provides sample usage for your reference:

The RRT phrase ~XDW::FileName~_~XDW::Counter~~XDW::FileExt~ when used in the Schema
field is replaced with the value "MyDocument_2.doc" if the original file name is "MyDocument.doc" and
"MyDocument_1.doc" already exists in the archive.
SSRTN
Description
%a
%A
%b
344
SSRTN
Description
%B
%d
%D
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

The RRT phrase ~XDW::%Y~-~XDW::%m~ will be replaced by "2011-02".
This component works with the DocuWare server version 5.1b, 5.1c, 6.
When the component service works on Windows Server 2008 or Windows Vista, the DocuWare client can be
started on the separate desktop, this additional instance of the DocuWare client started by user will not affect
the component functionality. When the component service works on Windows Server 2003 or Windows XP,
the component will start the DocuWare client on the user's desktop or use an already running instance of the
DocuWare client. In this case you can start an additional instance of the DocuWare client under another user
account if it is necessary.
For a proper operation of the component you should switch on the Allow service to interact with desktop option
in the component service properties.
The component does not support Version management functionality of the DocuWare server version 6. This
functionality, when switched on in the cabinet, adds Version number, Version status and Change comments
fields into a list of the cabinet fields. The component cannot work with these fields; hence, please do not use them.
When working with the fields of the numeric type, the component can proceed values of the integer type only; this
type has the following limits: from -2147483639 to 2147483639.
The Web services connection type does not support work with baskets.
The component supports only user-defined fields in the file cabinet.
The Windows client connection type does not support workflows, run as an user account. To use this type you
should run the workflow server as the LocalSystem account. If you want to use user accounts in your workflow,
please use Web services connection type.
For a proper operation of the component all DocuWare clients must be restarted on the system with the workflow
server, when the DocuWare server settings have been changed.
345
Problem
Solution
When you specify the File cabinet and do not specify

the Basket in the General tab, the document is saved in
the basket and is not saved in the file cabinet.
Possibly, the component fails to save the document in

the specified file cabinet for some reason. In this case
the document is saved in the basket which is active
on the DocuWare server. This is the DocuWare server
peculiarity that depends on the server settings.
When you create a configuration with the component,

open it and try to select file cabinet or basket using
Select File Cabinet dialog box or Select Basket dialog
box, the lists of file cabinets and baskets are empty.
This happens sometimes on Windows 2008 when you

open the new configuration for the first time. Try to close
the component configuration and open it once again.
Saving files into the DocuWare server becomes too slow. Possibly, there are already a number of versions of the
sent document on the server. The more versions of the
document are stored on the server, the more time it will
take to save the next version of the document. Using
document version support can slow down the component
work. Try to switch off the Use document version
support option.
When you try to send files to the basket the following
This error message appears, when you try to route

documents to the newly created basket.
"Error: "Required basket is invalid. Error:

"basketName",
To solve this problem, make sure that the baskets are

configured through the DocuWare Administration.
where basketName is a name of the basket on the server.
Send to Dropbox
Welcome to Send to Dropbox
The Dropbox Route and eConnector component provides full capabilities for routing all types of files to the Dropbox
service. Any type of file can be routed to Dropbox.
Three additional features are available with the Dropbox eConnector component:
ActivateAllows activation of the component using customizable conditions.

Pass-throughMakes the documents available to components further along in the workflow process.
Create linkProvides the ability to specify the availability of uploaded files for other users.
These three options are disabled for the Dropbox Route component.
Getting started
Feature highlights
Connection to the Dropbox service using existing user account.

Sending documents in the most popular formats to the Dropbox service.
How to Use Dropbox

You can scan documents from a variety of MFP devices, recognize text from the scanned images and send the
searchable PDF files into a specified Dropbox directory.
1. Design a workflow process by selecting the type of MFP that will be used.
2. Use the OCR as a process component and the Dropbox component as the route component.
346
3. Activate and configure the OCR component.

4. For Dropbox, specify the account to connect to the Dropbox service, specify the folder path and the rename
schema for the documents.
5. When the MFP user selects a pre-configured function key on the control panel of the MFP device, the scanned
images are recognized and the corresponding PDF documents are routed directly into the specified Dropbox
directory.
Configuring Dropbox
Dropbox component options
The configuration properties dialog box is the same for the Dropbox eConnector and Dropbox components, although
some options can only be configured from the Dropbox eConnector component.
Option
Activate
Description
This option is only enabled for the Dropbox eConnector
component. Activation of the component is determined
by a Boolean "true" or "false" value. You cannot
configure the remaining options in the configuration
dialog box while the component is deactivated. Any of
the following values determines the Boolean state:
YES, TRUE, ON, or 1 activates the component

NO, FALSE, OFF, or 0 deactivates the component
You can type one of these values or click YES or NO

to explicitly activate or deactivate the component in the
configuration dialog. These values are not case sensitive
TRUE, True, and true all create a "true" state, while
FALSE, False, and false will all create a "false" state.
You can use RRTs instead of an explicit Boolean value
to determine a Boolean state at run time. Entering an
RRT in this field allows you to configure the remaining
options without explicitly activating or deactivating the
component. The component is activated at run time only
if the setting resolves to one of the four "true" values
(YES, TRUE, ON, or 1).
Pass through
This option is only enabled for the Dropbox eConnector.

Pass through is determined by a Boolean "true" or "false"
value. Set this option to "true" to allow documents to be
available for subsequent components in the workflow
process. Any of the following values determines the
Boolean state:
YES, TRUE, ON, or 1 activates pass through

NO, FALSE, OFF, or 0 deactivates pass through
You can type one of these values or click YES or NO to

explicitly turn this feature on or off in the configuration
dialog box. These values are not case sensitiveTRUE,
True, and true all create a "true" state, while FALSE,
False, and false all create a "false" state.
to determine a Boolean state at run time. The feature is
activated at run time only if the setting resolves to one of
the four "true" values (YES, TRUE, ON, or 1).
347
Option
Description
Account
Enter the Dropbox account alias. An alias can contain

any combination of alphabetic or numeric characters.
RRTs may also be used to create an alias.
Manage Accounts
Click this button to add, remove and configure Dropbox

accounts.
Default Folder
Enter the directory path within the Dropbox account

where the documents will be routed. For example, you
could use "MyFolder1/SubFolder1". If no entry is made,
the directory Apps/NSi.Autostore for the Dropbox
account is used. You can manually enter the path or click
the browse button (...) to select the default folder. If the
specified directory does not exist, it will be created.
Use the slash symbol (/) as the delimiter between folder
names, but do not put it at the beginning or end of the
Dropbox directory value. Do not use the / as part of a
folder name.
Overwrite existing file
Select this check box to overwrite an existing file with

the same name as the routed document. If this option
is not selected, an error message is generated when a
file with the same name as the routed document already
exists in the destination folder.
Rename file
Select this check box if you want to change

the name of the routed document. In the box,
enter the schema for renaming the document.
If no rename schema is provided, the default
rename schema is ~DBR::FileName~_~
DBR::Counter~.~DBR::FileExt~.
Select this check box to replace characters that are not

allowed in file names with the underscore character.
Create link
This option is only enabled for the Dropbox eConnector.

Set this option to "true" to specify the availability of
uploaded files for other users. If this option is set to
"true", Sharable Link RRT to access to uploaded files
will be created and made available. Any of the following
values determines the Boolean state:
YES, TRUE, ON, or 1 makes turns on the feature

NO, FALSE, OFF, or 0 makes turns off the feature
You can type one of these values or click YES or NO to

explicitly turn the feature on or off in the configuration
dialog box. These values are not case sensitiveTRUE,
True, and true all create a "true" state, while FALSE,
False, and false all create a "false" state.
to determine a Boolean state at run time. The feature is
activated at run time only if the setting resolves to one of
the four "true" values (YES, TRUE, ON, or 1).
Separator
Enter the type of delimiter to be used between URLs.
348
Manage Accounts options

The Manage Accounts dialog box is used to configure Dropbox accounts. For each Authorization Cache Location,
the authorized account table lists aliases used to refer to the account in AutoStore and the Dropbox account name.
Option
Description
Authorize New
Click this button to authorize a new Dropbox account.

To step through authorizing an account, see Authorizing
a Dropbox Account.
Remove
Select an account and click this button to remove an

account from the authorized accounts list.
Refresh
Click this button to refresh authorized accounts list to

show authorizations stored in the directory specified by
Authorization Cache Location.
Authorization Cache Location
Specify a directory where the user authorization

information files will be stored. After you change this
setting, click the Refresh button to see authorizations
already stored to that location.
How to authorize a Dropbox account

The Dropbox component must be authorized to access a Dropbox account before it can send content to a Dropbox
folder.
The AutoStore Dropbox Web Authorization service must be started prior to adding an account. For more information
about configuring and starting the AutoStore Dropbox Web Authorization service, see Web Authorization
Configuration Tool.
1. In the Dropbox or Dropbox eConnector component settings, click the Manage Accounts button.
2. In the Manage Accounts dialog box, click the Authorize New button.
3. On the AutoStore Dropbox Authorization browser page, enter an account alias to label the account, and then
click Next.
4. On the Dropbox signin page, enter the email address and password for a Dropbox account, and click Sign in.
5. The next page prompts to allow NSi.AutoStore to connect to your Dropbox account. Click Allow.
The AutoStore Dropbox Authorization page reappears displaying the message: "The Dropbox authorization has
been completed successfully for alias: alias."
6. Close the web browser, and in the Dropbox Web Authorization dialog box, click Finish.
Completing these steps adds the account to the authorized cache location.
Web browser
When the web browser dialog opens, enter the login ID and password for the Dropbox user. You will be asked to
either Allow or Deny the connection between the app NSi.AutoStore and Dropbox.
Web Authorization Server Configuration Tool
To perform web authorization of the Dropbox component, you must first configure the AutoStore Dropbox Web
Authorization Server. You can do this using the Web Authorization Server Configuration Tool, which is located in the
AutoStore installation directory.
After you configure and start the server, you can open a web browser to authorize AutoStore to access to Dropbox
accounts as described in Perform web authorization of a Dropbox account.
For details about the General and Log On tab options, see Related Topics.
How to perform web authorization of a Dropbox account
The AutoStore Dropbox Web Authorization service must be started on the server for you to perform this task.
349
Context for the current task

1. Run the executable for the AutoStore Dropbox Web Authorization Server Configuration Tool,
NSi.AutoStore.DropboxWebAuthorizationConfigureTool.exe.
The AutoStore Dropbox Web Authorization Server Configuration Tool is located in the AutoStore installation
directory.
2. Configure settings on the General tab.
Tip: Make sure to record the Port setting. The default port number is 4560.
3. On the Log On tab, configure the service to run under the LocalSystem account or a domain account that is in the
Administrators group on the server.
4. On the General tab, click Start to start the service.
5. After the service starts, open one of the following URLs in a web browser:
http://server:port/NSi.Autostore.DropboxWebauthorization/default.aspx
https://server:port/NSi.Autostore.DropboxWebauthorization/default.aspx
Use the HTTPS path if SSL encryption is used by the Web Authorization Service to communicate with clients.
Note: For either URL, server is the IP address for the server running the Web Authorization Service and
port is the port number that the Web Authorization Server uses to communicate with clients.
You will be asked to confirm access to your Dropbox account through your Windows user name when Single Sign
On is selected, or through an account alias that has been setup when Single Sign On is not selected.
General tab
Configure connection and service startup settings on the General tab in the Web Authorization Server Configuration
Tool.
Option
Description
Port
Enter the port number that the Web Authorization Server

will use to communicate with clients. The default port
number for this service is 4560.
Use SSL
Enter information to use SSL encrypted communication

between the device and the web application:
In the Choose Certificate box, click to browse for

an existing certificate or to create a new self signed
certificate.
In the Certificate Password box, type the password
for the certificate.
For a self-signed certificate, the password is
automatically entered into the field based on
information you provided to create the certificate.
Note: When using the SSL option, you should
use "HTTPS" in the URL that accesses the web
application.
Windows Single Sign On
Select this check box to use a Windows user name as the

alias for the Dropbox account.
Authorization Cache Location
Enter the default location where user authorization

information files will be stored. The log on account for
the server must have permission to the location.
Tip: You can use different locations for
different groups of users.
350
Option
Description
Startup Type
Enter the startup type for the service. Automatic restarts

the service automatically when the server is restarted.
Manual requires the service to be restarted manually
every time the server is restarted. Disabled marks the
service as disabled so that it cannot be started.
Start
Click this button to start the service. The button is

unavailable when the service is started.
Stop
Click this button to start the service. The button is

unavailable when the service is stopped.
Log On tab
Configure service account settings on the Log On tab in the Web Authorization Server Configuration Tool.
Option
Description
Log on as
Select the account you want to use to log on to the

service:
Local System accountSelect this option to log

the service on to the Local System account.
This accountEnter the domain name followed by
the account name in the format domain name \ user
account to log the service on to a user account.
The specified account must be in the Administrator
group on the server. It must also have read/write
access to authorization cache locations used by the
service.
Password
Enter the user password. This field is enabled only if

This account is selected.
Confirm password
Enter the user password. This field is enabled only if

This account is selected.
Dropbox component RRTs

Component RRT ID
The RRT ID for this component is DBR.
Name
Description
Alias
The alias for the Dropbox account.
UploadFilename
The name of the uploaded file.
UploadFolder
The path of the uploaded file.
SharedLink
A Dropbox link to files or folders users can use to

view a preview of the file in a web browser . If the
component processes a batch of several documents,
this RRT is replaced by their URLs separated by
351
Name
Description
semicolon. This RRT is applicable only for the
Dropbox eConnector component and can be used in the
subsequent components.
DisplayName
The display name for the Dropbox account.
FileName
The name of the file without the extension.
FileExt
The file extension of the file including the dot (for

example, ".pdf").
Guid
The Globally Unique Identifier (GUID) for the

component.
Counter
Incremental count of duplicate file names in a directory.

~DBR::Alias is replaced by TestDropBoxAlias1
~DBR::SharedLink~ is replaced by http://db.tt/APqhX1.
This component does not support any FRTN values
352

Name
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U
%w
%W
%y
%Y
Description
day of week (0053)
day of week (0053)
353
An example of usage of the above SSRTN includes:

The RRT string ~DBR::%Y~-~DBR::%m~ will be replaced by 2011-02.
The component supports the routing of any type of file.

The slash mark (/) cannot be used as a folder name in the Dropbox directory text box as it is reserved for use as
a delimiter in a folder path. Also this symbol should not be used at the beginning or at the end of the Dropbox
directory value.
Troubleshooting
There are no issues at this time.
EFI SendMe
Welcome to the EFI SendMe component
This component captures documents that are scanned using SendMe into the workflow process. This component
works with any TWAIN compatible scanning device.
EFI SendMe comprises of a server software that runs on the server and a client software that runs on the user
machine. The EFI SendMe client communicates with the EFI SendMe server component to retrieve menu and form
information for presentation on the user's SendMe application. When fully configured, user simply clicks on the
AutoStore button, scan and edit the files, add additional index data to the document. The scanned document along
with the user-entered index data is then processed through the workflow and stored in the route component specified
in the workflow process definition.
This help file describes the configuration of the EFI SendMe component of the workflow server. To configure the
client, please refer to the EFI SendMe Client help file.
Getting started
Feature highlights
Select the NT groups and/or users that will be presented with EFI SendMe feature.
Define logical group names for the users/groups that will have access to specific workflows.
Create a menu hierarchy for ease of use
Using the EFI SendMe component

Use this component to capture documents that are scanned via the SendMe application into the workflow.
The user machine running EFI SendMe client communicates with the EFI SendMe component over a configured port
to retrieve group, menu, form, action displays for the client SendMe application.
Capture documents via EFI SendMe component Create a process with EFI SendMe component followed
by the Send To Folder component. Once the process is
and place the documents in a folder
started from the Service Manager interface, the SendMe
user selects AutoStore as the destination on the Main tab
of the SendMe application, scans the files, and selects the
Send tab. The user is then presented with the menu items
that were configured using the this component.
You can choose a form to fill out index data for a file. If there is no need for indexed data, the user selects an action
that would process the files into Folder Store route component for storage.
354
Configuring EFI SendMe

Menu tab
Use this tab to Add, Edit, or Remove groups, menus, forms, or actions.
Option
Description
Add
Click this button to create groups, menus, forms, or

actions.
Group
Menu
Form
Action
Edit
Click this button to edit options for the selected group,

menu, form or action.
Remove
Click this button to delete the selected group, menu,

form or action.
Group
Select this option if you want to add a user group. Each group entry requires the following entries:
Field Name
Name
Description
does not appear on the SendMe application and it is used
strictly as a logical group name.
This component is equipped with a default group called
Common Group. You may add a menu, form, or action
to the Common Group. Every user will receive the menu
options under the common group. After you configure
this component, the user can scan the files into the
workflow and select a configured menu, form or action.
Root Menu Title
Enter a menu title. This menu title appears on the

SendMe application. Choose a title that the user can
relate to a work task.
Member Name
Click the Add button to enter either a valid domain

groups or users that you want to have access to this menu
entry. Click the Remove button to delete an NT user or
group.
Menu
Use menu to create a menu hierarchy. The menu entry guides the SendMe user to select the workflow that is required
to complete a particular task.
Field Name
Name
Description
Form
Create a form when your workflow requires capture of index data. To add a form, fill out the following two tabs:
General tab
355
Components tab
General tab
Field Name
Description
Form Name
The name of the form to be displayed on the SendMe

application hierarchy.
Form Fields
Add fields by clicking on the new field button, labeled

by N on the first column header. After you add a field,
you can press the Tab key to navigate between field
attributes and to add additional fields.
For each field you can configure the following attributes:
Field NameField name is a string type and

can be any alphanumeric characters. Use of
special characters (~, &, <, >,%,", etc.) are not
recommended.
TypeClick to select one of the supported string
types:
Boolean
Date/Time (see Date and time formats)
String
String list
Click the Properties button to enter values for the

list. Optionally, you can click Import or Export
to import or export a string list in CSV
(comma separated value) format.
RequiredSelect the check box in the column
labeled by R to require the user to enter data in a
field.
Help MessageProvides space to type a help
message that is displayed in the client as a tool tip
when the mouse cursor is moved over a field on
the form. This can be used to guide a user who is
entering data in a form.
Properties Click the browse button (...) in the
column labeled by P to set the field attributes.
Components Tab
The Components tab lists processing and routing components in a workflow, their description, type, and the
configuration button to set component options. The configuration button is labeled by the browse button () in the
last column of each row.
Select a component by clicking the configuration button and configuring options in its properties dialog box. For
some components, you have to explicitly activate the component by selecting the Activate button in its properties
dialog box. Others are activated after you configure options that allow them to function, such as the destination folder
for the Send To Folder component.
Action
You can directly assign an action to a menu entry item, if there is no need to assign index fields by the SendMe
application user. This applies to a workflow scenario where the user selects a file that does not require any indexing
356
field information to be captured and applies the file directly in to the workflow process. Depending on the process
components and the route component selected, the files is processed and stored in the designated route component.
For every action you create, you are configuring a distinct workflow treatment based on the process components and
route component that you select.
Preferences tab
On this tab set the location of where the server stores the program files for the job that is processing.
Option
Description
Home directory
The root directory where the server creates all temporary

directories and files necessary for controlling device
related traffic. The server must have proper permission
to write to this directory.
Port number
Enter the port number used by the EFI SendMe Client to

communicate with the EFI SendMe Server (for example,
8086).
This port number must match the port number that is
used in configuring the EFI SendMe Client computer.
Note: f the client is having problems
communicating with the server, check the
port setting on the server to make sure that it
matches the port setting on the client. Also
make sure there that there is no firewall
blocking the specified port.
Keep
These options allow the workflow to retain processed or

rejected files. The service must have sufficient rights to
access this directory.
Processed filesThe directory where the captured

files (send to folder/application files) are stored upon
completion of successful routing. If you turn this
attribute on, all files are stored into the Processed
Files directory when the service successfully
completes writing them into the destination location.
Keep in mind that if this is option is enabled, a copy
of every file that has been routed successfully is
saved on this directory. Make sure that proper disk
storage is allocated for this directory.
Rejected filesThis folder is used for storing any
files that failed to store into the final destination
location.
There are many reasons for these failures. You can
research them by examining the server application
log file entries. It is recommended to have a
secondary process take this folder as an input and
notify a system administrator of a failure.
357
Runtime Replacement Tags (RRT)

EFI SendMe component RRTs
Component RRT ID
The RRT ID for this component is ESM.
Name
Description
UserName

documents.
AuthUseName
The authenticated user name of the client that is

submitting documents.
Domain

documents.
ComputerName
The NetBIOS name of the clients local computer that is

PageCount
Return the number of pages that are scanned and sent

through.
PageHeight
Returns the page Height of the image in inches as a float.
PageWidth
Returns the page Width of the image in inches as a float.
Resolution
Returns the resolution of the image in DPI (pixels per

inch). Possible return values are:
72
144
200
300
400
600

~ESM::%Client ID%~ is replaced by Company if the user types in Company for the field name called Client
ID.
358
Date and time formats

Date and time format strings define text representation of a date/time value for a Date/Time form field.
Table 15: Date/Time format specifiers
Format specifier
Description
Examples
%a

the week.
%A
The full name of the day of the week. 6/15/2009 1:45:30 PM -> Monday
(en-US)
6/15/2009 1:45:30 PM ->
(ru-RU)
6/15/2009 1:45:30 PM -> lundi (frFR)
%b
The abbreviated name of the month.
6/15/2009 1:45:30 PM -> Jun (enUS)

6/15/2009 1:45:30 PM -> juin (frFR)
6/15/2009 1:45:30 PM -> Jun (zuZA)
%B
The full name of the month.
6/15/2009 1:45:30 PM -> June (enUS)

6/15/2009 1:45:30 PM -> juni (daDK)
6/15/2009 1:45:30 PM -> uJuni (zuZA)
%C
The number of the century.
6/1/2009 1:45:30 PM -> 20

6/1/1992 1:45:30 PM -> 19
%d

through 31.
6/1/2009 1:45:30 PM -> 01

6/15/2009 1:45:30 PM -> 15
%e

through 31.
6/1/2009 1:45:30 PM -> 1

6/15/2009 1:45:30 PM -> 15
%H

00 to 23.
6/15/2009 1:45:30 PM -> 13
%I

01 to 12.
6/15/2009 1:45:30 PM -> 01
%j
The day of the year from 000 to 366.
6/15/2009 1:45:30 PM -> Mon (enUS)

6/15/2009 1:45:30 PM -> (ruRU)
6/15/2009 1:45:30 PM -> lun. (frFR)
1/5/2009 1:45:30 AM -> 015

6/15/2009 1:45:30 PM -> 166
359
Format specifier
Description
Examples
%k

0 to 23.
6/15/2009 1:45:30 PM -> 13
%l

1 to 12.
6/15/2009 1:45:30 PM -> 1
%m
The month, from 01 through 12.
6/15/2009 1:45:30 PM -> 06
%M
The minute, from 00 through 59.
6/15/2009 1:09:30 AM -> 09

6/15/2009 1:09:30 PM -> 09
%n
The newline character.
%p
The AM/PM designator.
6/15/2009 1:45:30 PM -> PM (enUS)

6/15/2009 1:45:30 PM -> (ja-JP)
6/15/2009 1:45:30 PM -> PM (esES)
%P
The am/pm designator.
6/15/2009 1:45:30 PM -> pm (enUS)
%S
The second, from 00 through 59.
6/15/2009 1:45:09 PM -> 09
%s
The number of seconds since Epoch

(since Jan 01 1970 00:00:00 UTC).
6/15/2009 1:45:09 PM ->

1245073509
%t
The tab character.
%U
The week of the year, with Sunday as 2/15/2001 -> 49

first day of week, from 00 to 53.
%u
The day of the week from 1 to 7 (1 =

Sunday)
6/15/2009 1:45:09 PM -> 2
%W
The week of the year, with Monday

as first day of week, from 00 to 53.
12/15/2001 -> 50
%y
The year, from 00 to 99.
1/1/0001 12:00:00 AM -> 01

1/1/0900 12:00:00 AM -> 00
6/5/1975 1:45:09 PM -> 75
6/5/2009 1:45:09 PM -> 09
%Y
The year as a four-digit number.
1/1/0001 12:00:00 AM -> 0001

1/1/0900 12:00:00 AM -> 0900
1/1/1900 12:00:00 AM -> 1900
6/15/2009 1:45:30 PM -> 2009
%%
The literal % character.
%%Y -> %Y
360
The EFI SendMe Port (for example, 8086) cannot be locked by another process. If EFI SendMe fails to start,
check for another process that could be listening on this port.
The characters &, <, and > are not permitted within menu, form or action button names.
Encryption/Decryption
Welcome to the Encryption/Decryption component
Using this component, all files handled through a process can be encrypted. The encryption component provides
secure data-routing to the final destination. All encrypted files are appended with the cryptology file extension .cry.
Depending on whether you are working on the server or on a workstation, you can use one of the following two
procedures to open the .cry file:
How to open an encrypted file on the server on page 361

How to open an encrypted file on a workstation on page 361
Important: Preserve and secure the encryption key. The data cannot be opened without the correct key or if
the key is lost.
How to open an encrypted file on the server

You do not need to install AutoSafe if this component is used to decrypt/encrypt the files on the server.
Perform one of these actions to decrypt the files:
Activate the digital sender decryption tab to decrypt the file.

Use a poll directory component followed immediately by an encryption/decryption component. Activate
decryption and set the proper decryption algorithm and key.
After the files are decrypted, the remaining components can operate as usual and no special configuration is
necessary.
How to open an encrypted file on a workstation
Use AutoSafe to decrypt/encrypt the files on a workstation.
1. Install AutoSafe on your desktop.
2. Double-click the .cry file and select the matching encryption algorithm and the matching key.
Note: Preserve and secure the key. The data cannot be opened if you lose or do not have the key.
3. Decrypt the file into a destination directory and open the file.
Getting started
Feature highlights
Decrypt secured files immediately after the source component. After files are decrypted and are again in their
normal format, other components can recognize them.
Encrypt files immediately before the destination component and after all other components have processed the
files. When files are encrypted, no other component can recognize the file format.
Using the Encryption/Decryption component

You can use encryption component either to encrypt outgoing files or decrypt incoming files. For files to be correctly
decrypted, the files received must be encrypted using one of the supported encryption algorithms, with a static
encryption key.
361
Decryption technology is also integrated with the digital sender component so .hps files and image files received from
a remote server can be decrypted.
Note that a process that has an active decryption component expects the file input stream to be encrypted (all files
must end with .cry extension and be encrypted). Server currently does not support a mix of secured and unsecured
files in a single process.
The following are common uses of the Encryption component:
Secured transmission between two servers can be achieved by setting up servers at remote sites, where encryption
is applied to the files. The encrypted files are then routed to the central location for processing (by using FTP, for
example). At the central location, decryption is used to open the files and process them.
Secured archival of data files can be accomplished by designing an application that stores your documents
encrypted mode. Use this component to encrypt your images and store them in this application.
Secured transfer of files using email can be accomplished using the Send to Email Recipient component combined
with Encryption component.
Note that all encrypted files carry no embedded keys. If encryption keys are lost, then the data cannot be opened by
any means. It is critical to maintain a thorough and secure track of encryption keys.
The decryption algorithm must match the encryption algorithm.
Configuring the Decryption/Encryption component
Encryption/Decryption filter options
The encryption/decryption filter options specify settings for either encrypting or decrypting files in a process.
Item
Description
None
Encryption/decryption is not activated.
Decrypt
Activates decryption algorithms for incoming files.
Encrypt
Activates encryption algorithms for outgoing files.
Algorithm
Choose the encryption algorithm. AutoStore currently

supports the following symmetric encryption algorithms:
ECB
RC2
RC4
Note: All files must have the same encryption
key and encryption algorithm. Support for
variable encryption methods, or variable
encryption keys is not currently available.
Key
An ASCII character string that is used to encrypt or

decrypt the files. Note that the decryption key must
match the encryption key.
Encrypt
Select this check box to encrypt the Key string.
Reenter Key
Reenter the encryption key string.
Key file
The full file pathname for a key file. You can use any file
or file type for encryption and decryption as key. The file
content of the file used for decryption must match the
file content of the file used for encryption.
Note: The server must be able to access and
open the specified file.
362
Encryption/Decryption component RRTs

This component does not generate Runtime Replacement Tags.
Problem Description
Solution
Native image files (TIFF or PDF files) are corrupted by

the encryption module.
When using the encryption component, the only

supported file format is the .cry file format. The native
image files are subject to corruption when used as input
to the encryption or decryption component.
The .cry files are not properly decrypted.
Check the method of encryption.

Check the key/key file.
Make sure the key file is useable.

Only the supported encryption algorithms (ECB, RC2, and RC4) are certified for use in the server process. If you
require other applications that use the same encryption algorithms to be certified, contact your reseller for information
about certification.
FileNet
Welcome to FileNet
FileNet component is used to provide full integration with FileNet Image Services and FileNet Content Services.
This component provides the full capability for routing documents and index data into FileNet libraries, classes, and
folders. Dynamic mapping using RRT values provides ability to map all available index data extracted from document
content or captured from users to be stored into FileNet depository.
Integration with FileNet document security is also provided by the component. The security integration allows
assigning users and groups that will have permissions for accessing documents routed to FileNet, and setting access
levels for these users and groups.
The component can be used both as a process component or route component.
Note: FileNet client software must be installed on the same machine as Workflow Service and it must be
fully configured prior to setting up the FileNet component.
For this component to work with FileNet Image Services the following software should be installed:
On the FileNet machine: Image Services, release 4.0.0.

On the Server machine: IDM Desktop 3.3, build erk400.155.
For work with FileNet Content Services the following software should be installed:
On the FileNet machine: Content Services 5.4, 5.3, or 5.2.

On the Server machine:
IDM Desktop 3.3, build erk400.155;

FileNet Client Library: Integration Build Release "yu400.030" (includes FileNet CS 54x Client
Libraries "yu400.030" and FileNet CS 43x Client Libraries "yu300.109").
Getting started
Feature highlights
Route documents into specified library and folder in FileNet Image Services or FileNet Content Services.
363
Specify fields of routed documents.

Allow access to specific FileNet users and groups, which is provided through integration with FileNet document
security settings.
Using FileNet
This component is intended to be used with FileNet Image Services and FileNet Content Services.
You can use this component to route the scanned documents directly into FileNet system from the MFD or to capture
documents on the local machine and then route them into FileNet.
How to Route Scanned Documents into FileNet
Follow steps in this procedure to scan documents from a variety of MFP devices directly into FileNet.
2. From the component tray, select the desired process components and select the FileNet route component for
storing the scanned document into FileNet.
3. You can configure the FileNet component to assign any document attributes acceptable by the FileNet library.
4. Configure other components in the workflow.
5. Run the process.
on the control panel of the MFP device, the document with the set attributes is routed directly into FileNet.
How to Route Documents into FileNet from Desktop
Follow steps in this procedure to allow users to send documents from desktop directly into FileNet
Note: You also might want to add an OCR process component to the workflow in order to recognize image
documents and index them on the FileNet server making it possible to search through routed documents. If so,
perform the additional steps.
1. Use the AutoCapture component as a capture source and FileNet as a route component in your workflow process.
2. In AutoCapture configuration create a form that allows users to enter necessary document attributes.
3. Set up the FileNet route component to use corresponding RRTs for filling document properties.
You can require users to select document class before submitting documents to AutoCapture server, so that a file
deposited to the FileNet library will have correspondent document class.
4. Run the process.
Configuring FileNet
General tab
Use this tab to set connection parameters and define document options such as the document class and destination
folder.
Option
Description
Activate
This check box is present only in process component

configuration window. Select this check box to activate
the component. If this box is not checked, the component
won't perform any actions during files processing.
Pass-through
This check box is present only in process component

configuration window. Select this check box if you want
documents to be available to the rest of the components
in your process.
Connection parameters
Use network name
Select this check box if you want to use the network

name to connect to FileNet server instead of the defined
user name.
364
Option
Description
User name
Enter a user name for accessing FileNet. The user name

can also be assigned to external values using RRTs.
Password
Enter the password for the specified user name.
Document library
Select FileNet document library.

Document options
Document class
Select document class. Stored files will receive

properties of the class (for example, its fields).
Index
Select this check box to index routed files.
Destination folder
Select a destination folder in which the files will be

stored. You can use RRTs within the folder name. If
the folder does not exist, it will be created during file
processing.
Field Values tab

Use this tab to modify the list of fields that will be assigned to routed documents.
Option
Description
Add
To add a field, click this button or double click on the

empty space in the list. This opens the Add Field Value
dialog box.
Edit
To edit a field, select the field in the list and click this
button or double click the chosen field. This opens the
Edit Field Value dialog box.
Delete
To delete a field, select the field in the list and click this
button or use the Delete key on your keyboard.
Note: If during processing of a document, the component cannot set a certain field value (if its name or value
is not correct for the specified document class), the field will be ignored. If a value of a required field is not
provided, the FileNet library will not accept such document for storage, and an error will be reported by the
component in the Status Monitor window.
Add/Edit Field Value dialog box

Option
Field name
Description
Enter a name for the field or select one from the list of
fields on the FileNet server.
Note: You cannot use a field which does not
belong to the class in the library or does not
exist. If you try to use a non-existent field, an
error message will appear.
Field value
Specify the value of the field.
Note: You can use RRTs in both Field name and Field value fields, but the values of the RRTs must be
correct:
Field names must correspond to the class.

Fields values must be appropriate to the fields' types.
365
The own RRTs of the component can be only used in Field value field. Use ~FNR::Counter~ to generate
unique field value.
Select Class Field dialog box
This dialog box displays the list of fields that belong to the selected Document class.
Select a field that you want to assign to routed files.
Option
Description
Name
The name of a field.
Label
The label of a field.
Required
This property shows if the field is required.
Current value
The current value of the field.
Field Value dialog box

Use this dialog box to set a value for the field.
Option
Description
Field name
The name of the field entered in the Add/Edit Field

Value dialog box.
Field label
The label of the field entered in the Add/Edit Field

Value dialog box.
Field value
Enter the desired field value.
Document Security tab

Use this tab to assign access rights for files being placed to the FileNet system.
You can specify proper access levels for users and groups.
Note: The behavior of this tab depends on the Services type (Image Services or Content Services), so that
only permissions allowed by a certain FileNet server can be entered. If the component cannot connect to the
FileNet server, no such checks will be performed.
Option
Description
Users and Groups
To add a user or a group select the corresponding radio

button.
Name
Select from the drop-down list the name of a user/group

which you are going to add to access list.
Access Level
Set the access level to be assigned to the selected user/

group.
Members
If a group is selected in the access list, the Members

button opens a list of the group's members. The members
list is not editable.
Add/Modify
Click Add to add a user or a group to the access list.

Click Modify to change attributes of an existing item.
To add a user or a group to the access list, select the
user or the group from the Name drop-down list, set the
Access level and click Add. The user or the group will
be added to the list.
366
Option
Description
Remove
To deny a user/group access to files, select a user/group

in the access list and click Remove.
Note:
1. Image Services allows exactly 3 access levels:
read
write
append/execute.
2. The FileNet component allows entering RRTs in the Access level and in the user/group Name
fields. However, if security settings contain RRTs, they cannot be validated by the component at the
configuration time.
3. In some cases Services type (Image/Content) is unknown at the configuration time. For example, when the
library is specified via RRT. In such cases no input validation is performed, and the user should specify
permissions manually. Valid access types are:
For Content Services:
Owner
None
Viewer
Author
Admin
For Image Services:
Read
Write
Append (for "Append/Execute" access)
When this component processes a document, all invalid entries are ignored. If some of Image Services "read",
"write" or "append/execute" access rights does not have a valid user/group name specified, the component
grants such access type to default user "(ANYONE)".
When there are no valid permissions provided for the Content Services library then the document's
permissions default to the current user (that is, user specified on the General tab) as Owner.
Component RRTs
Component RRT ID
The RRT ID for this component is FNR
Name
Description
FileName
FileExt
Counter
Automatically selected number to form unique value
Example usage of the above RRTN includes:

~FNR::FileName~~FNR::Counter~ is replaced with "MyDocument2" for the value of Field1 field assigned to
routed MyDocument.doc file if the file with Field1=MyDocument1 already exists in the destination folder.
367

This component does not have any FRTNs.
Name
Description
%d
%j
%I
%H
%P
Current locales AM/PM indicator for 12-hour clock
%M
%m
%b
%B
%S
%U

day of week (0053)
%W

day of week (0053)
%w
Weekday as decimal number (0-6; Sunday is 0)
%a
%A
%y
Year without century as decimal number (0099)
%Y
Year with century as decimal number
Examples usage of the above SSRTN include:

~FNR::%Y~-~FNR::%m~ will be replaced by 2011-02.
Note: All the component's RRTs may be used only in Field value field in Add/Edit Field Value dialog box
of the component configuration.
Use ~FNR::Counter~ to generate unique field value.
The component is intended for work with FileNet Image Services and FileNet Content Services.
For this component to work with FileNet Image Services the following software should be installed:
On the FileNet machine: Image Services, release 4.0.0.

On the Server machine: IDM Desktop 3.3, build erk400.155.
For work with FileNet Content Services the following software should be installed:
On the FileNet machine: Content Services 5.4, 5.3, or 5.2.

On the Server machine:
368
1. IDM Desktop 3.3, build erk400.155;

2. FileNet Client Library: Integration Build Release "yu400.030" (includes FileNet CS 54x Client Libraries
"yu400.030" and FileNet CS 43x Client Libraries "yu300.109").
Problem description
Solution
Library is not found in FileNet Neighborhood
This message appears when FileNet document library

is not or incorrectly selected in General tab of the
component's configuration. To verify that the library
exists, click the browse button (...).
The following error occurs at run time:
Possible reason is that the Server does not have

permissions for accessing the library. At configuration
time, FileNet is accessed with currently logged user
credentials, whereas at run time, the Server typically uses
Local System account. In order to allow this account
accessing FileNet libraries, you should make them
accessible for all local users.
Failed to create library object for

'DefaultIMS:Imaging:FileNet'. Error
Number: 80040207. Error Description:
Item is not in collection.
Run the configuration utility (click Start > All

Programs > IBM FileNet IDM > Configure). At the
bottom of the IDM Configure window, there are two
radio buttons: Set preferences for currently logged
on user (user name) and "Set default preferences
for new users". Depending on the selection, you will
be able to view and edit the list of libraries accessible
for current user only or for every user of this machine,
correspondingly. In order for a library to be accessible by
Local System account, you should create it with the Set
default preferences for new users option switched on.
Note: The radio buttons are only visible
if the current user is a Power User or an
Administrator. In other cases it will not be
possible to create libraries available for all
users.
Cannot retrieve fields list for the document class.
This message appears when FileNet document class is

specified incorrectly in General tab of the component
configuration. To verify that the class is input correctly,
use the browse button (...) next to the Document class
string.
The documents are not stored in the FileNet destination

folders.
Verify that Document folder is set correctly. The User

that you define to connect to FileNet must have write
permissions to the folder.
Also check the document security options and verify that
you have rights to view files in the folder.
While configuring the component or at run time, one

of the following errors occurs although the correct user
credentials have been entered:
If the error message

appears during work
with Image Services
Cannot log on to FileNet library.

Please check the connection
parameters.
Check capitalization of the

entered user name. The
name is case-sensitive. If
the option Use network
name is checked on, make
sure that the name of the
369
Problem description
Solution
FileNet Image Services
user coincides with your
Windows user name (casesensitive and without
domain name). Also, make
sure that the password of
the FileNet user coincides
with the password of the
Windows user. In order
to check whether the
component can connect
to FileNet using your
network name, temporary
switch off this option and
enter your Windows user
name and password.
Invalid user name or bad password.
If Use network name is

The error message
appears during work selected, make sure that
with Content Services the correct value is entered
for the Network Logon
Name user property on the
Content Services server:
Domainname;Username
if the component
connects to the server
using credentials of a
domain user.
Computername;Username
if the component
connects to the server
using credentials of a
local user.
The password of the

Content Services user
should coincide with the
password of the specified
user name.
Note: In order for the option Use network
name to work at run time, it is necessary to
specify user credentials to be used by Workflow
Service. This can be done in Service Manager.
When the process is launched in service mode, the
1. Open Control Panel > Administrative Tools >
component does not route the documents and the Service
Component Services.
Monitor shows the following error: The server
2. In the Component Services console, expand
process could not be started because
Component Services > Computers > Computers >
the configured identity is incorrect.
My Computer > DCOM Config.
Check the user name and password.
3. Right-click the FnLocDb service and click
Properties. On the Identity tab, switch from The
interactive user to The launching user.
370
FileNet P8
Welcome to FileNet P8
Use the FileNet P8 route/eConnector component to process and store documents into the FileNet P8 Content Engine
object store. The stored content becomes available for retrieval and collaboration across the network within the
organization.
The component communicates with the installed and configured FileNet P8 Content Engine 4.0.x ,4.5.x or 5.1.x via
its Web Service interface.
The work with the component requires knowledge of the special terminology related to the FileNet P8 Content
Engine. For definitions of unfamiliar terms used in this documentation, see the Glossary.
Getting started
Feature highlights
Integration with FileNet P8 Content Engine object store.

Specify the destination for routed documents: Object store and Target Folder.
Specify the document class and set the values of the class' fields.
Use check in capability.
Manage Permissions for users or groups to work with the document.
Add subscriptions, annotation and content elements to the routed documents.
Specify child-parent relationship for the routed documents.
How to use FileNet P8

This topic steps through an example of sending PDF documents to the FileNet P8 Content Engine object store.
1. Create a workflow with the FTP Poll capture component, the Barcode component, the OCR component, and
the FileNet P8 route component.
2. Specify connection parameters, Object store and Target folder on the General tab of the FileNet P8 component.
3. Specify document name and content type on the Document tab.
4. Set the document class and properties of the routed documents in the Document Class tab and configure the
permissions on the Security tab of the FileNet P8 component.
6. Run the process.
User scans a batch of documents with barcode cover page that describes the field attribute for each document. The
documents are then placed in the folder that is accessed through FTP. Now, when you start a process:
FTP Capture component polls the scanned document with a predefined schedule.
Barcode component reads the barcode value out of the cover page while splitting the scanned batch
into separate documents.
OCR converts the scanned documents into searchable PDF.
FileNet P8 route component delivers the searchable PDF documents to FileNet P8 Content Engine object store
along with the corresponding metadata.
Configuring FileNet P8
The component configuration window consists of five tabs:
371
Tab
Description
General tab
Use this tab to enter the connection settings for logging

in to the FileNet P8 Content Engine object store.
Document tab
Use this tab to specify settings for the document to be

stored in the FileNet P8 Content Engine object store.
Document Class tab
Use this tab to configure document class property.
Security tab
Use this tab to specify permissions of routed documents.
Advanced tab
Use this tab to set additional options for control of the

routing process.
Note: The
buttons used in the configuration tabs and dialog boxes are disabled when Content Engine
web service URL, User name or Object store text box is empty.
General tab
Use this tab to enter the connection settings for logging in to the FileNet P8 Content Engine object store.
Option
Description
Activate
This combo box allows you to activate the component

according to a condition. This combo box is enabled only
in the eConnector configuration dialog box.
Pass through
Select this check box to make the component pass

documents to the next component in the process.
This check box is enabled only in the eConnector
configuration dialog box.
Content Engine web service URL
Enter the URL of the Content Engine web service. This

URL should be in the following format:
protocol://host name or ipaddress:port
With the following parameters:
protocolThis is HTTP by default.

host name or ip-addressThis specifies the
application server where the Content Engine
application is hosted.
portThis is the number of the port that the
application server uses to communicate with clients
(7001 by default).
The following example URL uses an IP address:

http://192.178.223.10:7001. The Web service path, such
as "/wsi/FNCEWS40MTOM/", will be automatically
appended to this URL.
User name
Specify this value to connect to the object store in the

format that is required by the FileNet P8 Content Engine.
For the Directory Service or Active Directory security
provider it is usually the short name (login name) of the
Directory Server user. For example, FnAdmin. You can
click the
button to open the Select User dialog box
which allows searching for the user on the FileNet P8
372
Option
Description
server. Search request will use the currently entered user
name and password to connect to the server.
Note: The
button is enabled only if you
have already connected to the FileNet P8
Content Engine. The first time that you connect
you have to manually enter the Content Engine
web service URL, User name and Password.
Password
Specifies the user password to connect to the object

store. You cannot use RRTs in this text box.
Select this check box is you want to obtain the password

from an RRT from previous components. When this
check box is selected, the Password text box is disabled.
The component then obtains the password from the RRT
at run time to connect to the FileNet P8 Content Engine.
Password RRT
Enter an RRT of another component which will be used

for connection to the FileNet P8 Content Engine.
Note: You should never explicitly specify a
password in the Password RRT text box, since
the value of this field is not encrypted.
At configuration time the component always
uses the value of the Password text box as the
user password for connection to the FileNet P8
Content Engine even if the Obtain password
via RRT is selected.
Object store
Enter the name or identifier of the FileNet P8 Content

Engine object store to route documents into. You can
enter the name of the object store manually or click the
button to open the Select Object Store dialog box,
which allows selection of an object store.
Target folder
Enter the path to the target folder to route documents

into. You manually enter the path preceded by the slash
mark (/) character (for example, /Folder1/SubFolder2).
Note: When the Select Target Folder dialog
box opens, it expands to display the currently
selected folder. However, if the currently
selected folder is invalid for the actual folders
tree, it expands as many folders in the path that
it finds in the tree.
Create folders if not exists
If this check box is selected, the component will create

the specified folder if it does not exist. If this check
box is not selected and the specified path to the target
folder does not exist, the component will display an
error message at run time. By default, this check box
is selected. Click the
button next to this check
box to open New Folder Options dialog box, which
allows you to set up parameters for creating the folder.
373
Option
Description
If several folders are created, all of them will share the
same parameters.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
374

math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
375

Constants
Examples:

Boolean).
376
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
Select Object Store dialog box

This dialog box allows selection of one of the available object stores on the FileNet P8 Content Engine server.
Option
Description
Please select the object store
This list displays names and identifiers of the available

object stores.
Identifier
This read only text box displays the ID of the selected

object store. This can be used, for example, if you want
to copy the identifier to the clipboard.
377
New Folder Options dialog box

This dialog box allows configuration of parameters of newly created folders specified in the Target folder text box.
Note: If several folders are created, all of them will have the same parameters.
Option
Folder class
Description
Enter the name of the class for the folder object. This
should be a class inherited from the "Folder" class. By
default, the "Folder" class is used. You can click the
button to open the Select Folder Class dialog box that
allows you to select a folder class.
Class fields
This table lists names, values and types of the class fields
configured for the created folder.
Note: The Title field should not be specified in
this table as its value is taken from the Target
folder text box on the General tab.
Add
Click this button to add a new class field to the list. This
button opens the Add Property dialog box.
Edit
Select a class field and click this button to edit the

selected item. This button opens the Edit Property
dialog box.
Remove
Select a class field and click this button to remove the

selected item from the list.
Inline all fields into one string
Select this check box to set values of all class fields as

one string.
The text box below this check box allows entering the
values of class fields in the in-line form, for example:
{"DocumentTitle" = String:"MyTitle",
"FormPolicy" = Object
"DocumentLifecycleAction":
{"LastModifier" = String:"Me"}}
If you select this check box when the text box is empty
(for example, for the first time), the fields specified
in the list are converted into the inline representation
of fields, which is displayed in the text box. For more
information, see Inline Representation.
Verify field values
Select this check box to have the component check

names and values of the fields before submitting them.
This option is applicable only to the fields whose
Verification option is set to Default. For other fields,
the component uses the individual verification settings
specified in the Add/Edit Property dialog box.
When the component verifies a field value and finds that
it is not valid, it uses the default value for this field. If
the field name is invalid (the document class does not
contain such field) then the component will skip this
field.
378
Option
Description
If this check box is not selected and some field name
is incorrect (no field with such name exists), or a field
has incorrect value or type, or some required field is not
specified, then the document will be rejected. However,
if some name will be empty at run time (for example,
as a result of an RRT replacement), it will be silently
ignored.
Leave default permissions for folder
Select this check box to create folder with default

permissions set. If this check box is not selected, then the
Folder permissions list and its controls are enabled and
you can configure custom permissions for the created
folder.
Folder permissions
This access control list specifies users, groups and their

permissions for the folder. You can configure custom
permissions for the created folder here.
Add
Click this button to add a new permission to the list. This

button opens the Add Access Permissions dialog box.
Edit

button opens the Edit Access Permissions dialog box.
Remove
Select permission and click this button to remove the

Select User dialog box

This dialog box enables you to search for a user or group in the FileNet P8 server.
Option
Description
Realm
Specify the security realm from the drop-down list.

By default, the selected realm corresponds to the user
specified on the General tab.
Name starts with
Enter the substring to filter search results. Only users and

groups whose names start with this text will be displayed
in the list. To display all users leave this text box blank.
Search
Click this button to start the search.
Search for usersIf this option is selected, the

component searches for the users. If this dialog box
was opened from the General tab, only this option is
enabled and selected by default.
Search for groupsIf this option is selected, the
component searches for the groups. This option is
enabled only if this dialog was opened from the Edit
Access Permissions dialog box.
Note: If this dialog is opened from the Edit
Access Permissions dialog box, the search
results will contain two additional predefined
items:
CREATOR-OWNERThe special
account granted to the user who creates an
object.
379
Option
Description
Please select
AUTHENTICATED-USERSA group
whose members are all authenticated users.
This table displays the list the found users or groups.

Select a user or a group from this table and click OK.
Document tab
Use this tab to specify settings for the document to be stored in the FileNet P8 Content Engine object store.
Option
Target
Description
Specify the way the component will store the destination
document. You can select one of the following
alternatives:
Create new document if not exists
Note: In this case the search for existing

documents will be performed by comparing
document containment names.
Update document with the following name
Update document with the following IDThe
GUID property will be used to find the document.
The component saves the value of this property in

the configuration in the form of an internal identifier.
Therefore, if you use an RRT in this field, it should be
replaced with one of the valid identifiers, which are
presented in the following table:
Table 16: Identifiers
Display name
(English)
Create new document if
not exists
Internal name
NEW DOCUMENT
Update document with the DOCUMENT NAME

following name
Update document with the DOCUMENT ID
following ID
Title (Name/ID)
This text box is labeled as:
TitleIf the Target value is Create new document

if not exists. Enter the title of the new document. This
value will be assigned to the 'Title' property of the
new document as well as to its containment name if
no name conflicts take place. If this text box is left
empty, then the original file name is taken.
NameIf the Target value is Update document
with the following name. Enter the containment name
of the existing document to be updated.
380
Option
Description
Resolve conflict
IDIf the Target value is Update document

with the following ID. Enter the ID of the existing
document to be updated.
Name or ID - if the Target text box contains any
other value; for example, RRT.
Specify the component behavior in the case when a

document with the specified containment name or ID
already exists in the target folder. The following conflict
resolving policies are possible:
Reject double - if a document with the specified

containment name already exists in the target folder,
the component will reject the routed document.
Auto unique containment name - if a document with
the specified containment name already exists in
the target folder, a unique name will be given to
the routed document. For example, if the specified
document containment name is "New Document",
specified target folder is "/Folder1", and Folder1
already contains document named "New Document",
then the routed document will be renamed to "New
Document(1)"(however its title remains "New
Document").
Overwrite - if a document with the specified
containment name already exists in the target folder,
it will be overwritten by the routed document. If the
Target is Update document with the following name,
and the component does not find a document with
the specified containment name, the routed document
will be rejected.
Create new version - if a document with the specified
containment name or ID already exists in the target
folder, the routed document will be saved as a new
version. In this case, the document will be checked
out and its content elements will be replaced. If
the document is already checked out then it will
be checked in first to store the old version. If the
Check in check box is selected, then the new version
of the document will be checked in. If the Target
is Update document with the following name, and
the component does not find a document with the
specified containment name, the routed document
will be rejected. If the Target is Update document
with the following ID, and the component does not
find a document with the specified ID, the routed
document will be rejected as well.
Add content element - if a document with the
specified containment name or ID already exists in
the target folder, then the component will add a new
content element to the existing content elements. In
this case, the document will be checked out and its
content elements will be replaced. If the document is
already checked out then the component will add a
381
Option
Description
new content element to the existing content elements.
If the Check in check box is selected, then the new
version of the document will be checked in. If the
Target is Update document with the following name,
and the component does not find a document with
the specified containment name, the routed document
will be rejected. If the Target is Update document
with the following ID, and the component does not
find a document with the specified ID, the routed
document will be rejected as well.
The list of available conflict resolving policies depends
on the Target value. The below table specifies which
conflicts resolving policies are applicable to each kind of
target.
Table 17: Conflict resolving
Target Reject Auto OverwriteCreate Add
double unique
new content
containment
version element
name
Create
new
document
if not
exists
Update
document
with
the
following
name
Update
document
with
the
following
ID
The component saves the selected value of this option

in the configuration as an internal identifier. If you are
going to use RRTs in this field, they must be replaced
with one of the following internal names:
Table 18: Internal names
Display name
(English)
Internal name
Reject double
REJECT
Auto unique containment

name
AUTO NAME
382
Option
Description
Display name
(English)
Internal name
Overwrite
OVERWRITE
Create new version
NEW VERSION
Add content element
NEW CONTENT
Check in
If this check box is selected, then the component will

check the document in and its version status will be
determined by the Check in minor version option.
If the Check in check box is not selected, then the
newly created document will have version status "3
(Reservation)" and version 0.1.
Check in minor version
This check box is enabled only when the Check in check

box is selected, otherwise its state is ignored. If this
check box is selected, then the component will check
in the minor version of the document. The document
version status will be set to "2 (In progress)" and
version to 0.1. If this check box is not selected, then
the component will set the document version status
to "1 (Released)" and version to 1.0. In both cases the
document will be checked in.
Automatically classify document
This check box is enabled only when the Check in check

box is selected; otherwise, its state is ignored. Select
this check box to automatically assign properties of the
document based on the document's content type.
MIME type
Enter the MIME type corresponding to data format of the

routed document. For example, application/msword. You
can click the
button to open the Setup MIME Type
dialog box that allows you to select a MIME type or to
specify how the MIME type should be detected at run
time.
Application Engine URL
This value is used only to replace the ~FCE::AE_URL~

internal RRT. Enter the URL of a custom application
engine service application or select one of the two
predefined values:
~FCE::CE_URL~/WorkplaceXT
~FCE::CE_URL~/ECMF
Note: It is recommended to use
~FCE::CE_URL~ RRT in this text box if
application engine uses the same application
server as FileNet P8 Content Engine does.
Document URL pattern
Specify the FileNet P8 Content Engines URL of the

target document. This value is used to replace the
~FCE::DocumentURL~ internal RRT.
FileNet P8 supports the following two forms of the
documents URL that are supported by standard web
applications:
383
Option
Description
ID-based URL:
http://AE-server-name/ECMF/
getContent?objectStoreName=OSname&vsId={object-version-seriesid}&objectType=document
Path-based URL:
http://AE-server-name/ECMF/
getContent/OS-name/folder/subfolder/doc-containment-name
Select one of two predefined values that correspond to

these forms:
More options
~FCE::AE_URL~/getContent?
objectStoreName=~FCE::ObjectStore~&vsId=~FCE::
~FCE::AE_URL~/getContent/
~FCE::ObjectStore~~FCE::FolderPath~/
~FCE::DocumentName~
Click this button to configure the additional settings

for routed documents (like subscriptions, annotations,
relationships) in the More Options dialog box.
More options
This dialog box allows configuring of the additional settings for routed documents, like annotations, relationships, and
subscriptions.
This dialog consists of four tabs:
Option
Description
Content Elements tab
This tab allows configuring document content elements.
Annotation tab
This tab allows creation of the document annotation.
Relationship tab
Use this tab to specify the relationships which routed

documents will have with other documents.
Subscriptions tab
Use this tab to specify a list of subscriptions for routed

documents.
Content Elements tab

This tab allows configuring document content elements.
The main content element of the target document is the file being routed by the component. It is appended as the only
content element by default. Using the controls on this tab, you can change this behavior.
Option
Description
Do not add routed document as content element
Select this check box if you do not want to add the

routed document as the content element of the created
(or existing) object in the FileNet P8 Content Engine
object store. This may be used, for example, if you
include the documents body into annotation instead of
content.
Additional content elements
This list contains content elements that will be added to

the target document in addition to the routed document.
384
Option
Description
Add
Click this button to add a new content element. This

button opens the Add Content Element dialog box.
Edit
Select a content element and click this button to edit the

selected item in the Edit Content Element dialog box.
Remove
Select a content element and click this button to remove

the selected item from the list.
Storage policy
Specify the storage policy of the content element. By

default, this field is empty and the default storage policy
is used.
Add/Edit Content Element dialog box

This dialog box allows you to specify settings of the content element of a document or an annotation.
Option
Description
Store reference
Select this check box to store URI or path to the file in

the content element instead of the file body itself. By
default, this check box is not selected and the file content
is stored.
File path (Target)
If Store reference is OFF, then this text box is labeled as

File path and contains local system file path to the new
content element. If Store reference is ON, then this text
box is labeled as Target and contains local system file
path or external URI for the new content element.
MIME type
Specify MIME type for the content element. The

button opens the Setup MIME Type dialog box which
allows configuration of MIME type for the content
element.
Annotation tab
This tab allows creation of the document annotation.
Option
Description
Add annotation
Select this check box to add an annotation to the

document. If this check box is not selected, no
annotation will be created for the document.
Annotation class
Specify the name of the annotation class.
Description
Enter the description to annotate the document.
Enquoted multiline
This check box instructs the component how to store the

description in the configuration in case of multiline text.
The description is stored in one line in the component's
configuration. Three variants are possible:
1. If this option is ON, the component stores all lines
in one line with using a special format. The text is
placed in quotes, the \ and " symbols are transformed
to \\ and \" and the line breaks are marked as \r\n. The
value is stored with the string: prefix. For example:
DESCRIPTION = string:"First line\r\nSecond line".
385
Option
Description
Use this value if you want to use a multiline text as a
description.
2. If this option is OFF, all symbols are interpreted as
is and only the first line is stored. The value is stored
with the raw: prefix. For example: DESCRIPTION =
raw: First line. This may be useful if you use RRT for
the description; for example, raw:~RRT::rrt~.
3. If this option has an intermediate value, all symbols
are interpreted as is, only the first line is stored, and
no prefix is used. For example: DESCRIPTION =
First line. This may be useful if you are using RRT
for the description and not sure how this RRT will
be replaced. You may add necessary prefix in the
configuration.
Content elements
Add content elements to the annotation. Leave this list

empty to create a description-only annotation.
Add
Click this button to add an annotation content element

to the list. This button opens the Add Content Element
dialog box.
Edit
Select an annotation content element and click this

button to edit the selected item in the opened Edit
Content Element dialog box.
Remove
Select an annotation content element and click this

button to remove the selected item from the list.
Storage policy
Specify the storage policy of the annotation object.
Relationship tab
Use this tab to specify the relationships which routed documents will have with other documents.
Add child documents to the list of children and parent documents to the list of parents.
Option
Description
Children
This list contains list of children of the routed document.
Add
Click this button to add a document child to the list. This

button opens the Add Child Relationship dialog box.
Edit
Select a document child and click this button to edit the

selected item in the opened Edit Child Relationship
dialog box.
Remove
Select a document child and click this button to remove

Parents
This list contains list of parents of routed documents.
Add
Click this button to add a document's parent to the list.

This button opens the Add Parent Relationship dialog
box.
Edit
Select a document parent and click this button to edit the

selected item in the Edit Parent Relationship dialog
box.
386
Option
Description
Remove
Select a document parent and click this button to remove

Note: To have children, a document should be a compound document. The component automatically sets
"CompoundDocumentState=1" to a routed document if another value is not assigned to this property in the
Class fields list.
Add/Edit Relationship dialog box
Use this dialog box to add or to edit relationship between documents.
This dialog appears in the following forms:
Add/Edit Child Relationshipsetup child relationship.
Add/Edit Parent Relationshipsetup parent relationship.
Option
Description
Link name
Enter the name of the relation.
Child/Parent target type
Select how the child or parent will be identified to

establish relationships. Relationship will be established
between a routed document and:
Existing document by nameAn existing document

identified by name.
Existing document by IDAn existing document
identified by ID.
External referenceAn external document.
Note: External reference can be used to

specify only child relationships. Because a
document cannot be a child of an external
object.
The component saves the value of this option in the
configuration in the form of an internal identifier. If you
use an RRT in this field, the RRT must be replaced with
one of these identifiers:
Target path (Target type/ Target reference)
Display name
(English)
Internal name
Existing document by
name
DOCUMENT NAME
Existing document by ID
DOCUMENT ID
External reference
REFERENCE
This text box is labeled as:
Target pathIf the Child/Parent target type

value is Existing document by name. Enter the path
to an existing document.
387
Option
Description
Target typeIf the Child/Parent target type
value is Existing document by ID. Enter the ID of an
existing document.
Target referenceIf the Child/Parent target type
is External reference. Enter external URI (URL).
You can click the

button to open the Select Target
Document dialog box that allows selection of an existing
document in the object store. This button is disabled if
the Child/Parent target type is External reference.
Link type
If the target is Existing document by name or Existing

document by ID, this combo box is used to specify the
link type:
StaticThis link binds a specific parent document

to a specific child document.
DynamicThis link binds a specific parent
document to a child document based on whether the
component relationship object is defined to point to
the "current" version (latest version in the version
series) or the "released" version (latest major version
) of the child document.
Dynamic LabelThis link binds a specific parent
document to a child document based on whether the
component relationship object is defined to point the
"current" version (latest version in the version series)
or the "released" version (latest major version) of the
child document. Additionally, its value must match
the value of the label property of the child document.
This combo box is disabled if the Child/Parent target

type is External reference.
The component saves the value of this option in the
use an RRT in this field, the RRT must be replaced with
one of these identifiers:
Display name
(English)
Internal name
Static
STATIC
Dynamic
DYNAMIC
Dynamic Label
DYNAMIC LABEL
Label
Enter label value for the Dynamic Label link type. This
text box is enabled only if the Dynamic Label link type
is selected. This text box is disabled if the Child/Parent
target type is External reference.
Binding version
Specify if "current" or "released" version should be

linked for the Dynamic or Dynamic Label link type. This
388
Option
Description
combo box is disabled if the Child/Parent target type
is External reference. The component saves the value of
Binding version option in the configuration in the form
of an internal identifier. If you use RRTs in this field, the
replaced value must be one of the following:
Display name
(English)
Internal name
Current
CURRENT
Released
RELEASED
Delete child document if parent document is deleted
If the target type is Existing document by name or

Existing document by ID, and this check box is selected,
then the child document will be deleted together with the
parent document.
Prevent delete
Specify the documents whose deletion should be

prevented. You can select one of the following
predefined values:
Child and parent documentsPrevent both child

and parent document from being deleted.
Child documentPrevent child only.
Neither child nor parent documentsDo not prevent
(default).
Parent documentPrevent parent only.
This combo box is disabled if the Child/Parent target

type value is External reference.
The component saves the value of the Prevent delete
option in the configuration file in the form of an internal
identifier. If you use an RRT in this field, it must be
replaced with one of the following values:
Display name
(English)
Link position
Internal name
Child and parent

documents
BOTH
Child document
CHILD
Neither child nor parent

documents
NONE
Parent document
PARENT
Enter the index number of the link in the sequence of all

links related to the document. You can specify a decimal
number or select one of the predefined values:
389
Option
Description
Beginning of listMinimum position value is 1

End of listMaximum position value + 1
The values of these options are determined at run time

based on the current list of references (the index numbers
are taken to calculate the maximum and minimum
values).
The component saves the value of Link position in the
use an RRTs in this field, it must be replaced with one of
the following values:
Display name
(English)
Copy link to reservation if parent document is

checked out
Internal name
End of list
END OF LIST
Beginning of list
BEGIN OF LIST
If this check box is selected and the parent document is

checked out, then the same relationship is set between
the reservation of the parent document and the child
document. When the parent document is checked in, the
child document will remain a child of the new parent's
version.
Subscriptions tab
Use this tab to specify a list of subscriptions for routed documents.
Option
Description
Create following subscriptions for the document
This list contains names and descriptions of the

subscriptions.
Add
Click this button to add a subscription to the list. This

button opens the Add Subscription dialog box.
Edit
Select a subscription and click this button to edit the

selected item in the Edit Subscription dialog box.
Remove
Select a subscription and click this button to remove the

Add/Edit Subscription dialog box

This dialog box allows you to specify and edit settings for a subscription created for the routed document.
Option
Description
Name
Enter the name of the subscription object. This name

should be unique for the FileNet P8 Content Engine
object store and less than 64 characters in length.
Description
Enter the description of the subscription. The description

can be empty.
390
Option
Acts on
Description
Specify subscription action target, that is, type of object
this subscription acts on:
Applies to the single instance of the document

Applies to all versions of the document
Note: The component saves the value of this
option in the configuration in the form of an
internal identifier. If you use an RRT in this
field, the RRT must be replaced with one of the
following values:
Display name
(English)
Applies to the single
instance of the
document
Internal name
SINGLE INSTANCE
Applies to all versions ALL VERSIONS

of the document
Subscription events
Add events which will trigger event actions of the

subscription.
Add
Click this button to add an event to the list. This button

opens the Add Event dialog box.
Edit
Select an event in the list and click this button to edit the
selected item in the opened Edit Event dialog.
Remove
Select an event in the list and click this button to remove

Event action
Specify an identifier of the event action or click the

button to open the Select Event Action dialog box that
allows selection of an available event action.
Enable subscription
If this check box is selected, the subscription is enabled.

Clear this check box to disable the subscription.
Synchronize event action
Select this check box for the event action to run in

synchronous mode. When using synchronous event
actions, the subscription processor blocks further
processing until the action completes and returns. The
action runs in the same transaction as the originating
activity on the target object. If the action fails, the
transaction rolls back. In asynchronous execution, the
action occurs on a separate execution thread, allowing
the subscription processor to continue without waiting
for the action results. The action cannot be in the same
transaction as the originating activity.
Filter expression
Enter (optionally) filter expression evaluated against

the source object or an object referenced by an event
source object, to determine whether the subscription
should "fire". The expression uses the same format as the
WHERE clause of a query; however, only a subset of the
operators are supported. For example:
391
Option
Description
Type_CVLStr='Confidential'
where Type_CVLStr is the symbolic name of the

DocumentSensitivity document class property, which
expects a value of the String data type, in this case
"Confidential".
SVCPDateTime=20040611T000000Z
where SVCPDateTime is a property of the
TimeFormat document class, which expects a
value in the DateTime data type, in this case
"20040611T000000Z".
Filter property
Enter (optionally) the symbolic property name, which

must be a singleton object-valued property of the source
object. If set, the filter expression applies to the object
that property references, rather than the source itself.
Add/Edit Event dialog box

This dialog box allows adding/editing events.
Option
Description
Event name
Enter the event name or click the

button to open the
Select Event dialog box to select an event from the list
of events specified on the FileNet P8 Content Engine
server.
Setup MIME Type dialog box

This dialog box allows you to select a MIME type or to specify how the MIME type should be detected at run time.
Option
Description
Lookup MIME type for the file extension
This list allows setup of the custom lookup table for

MIME types. Each list item associates two fields:
extension and MIME type. When the component routes
the document it uses this table to detect what MIME type
it should use for the document.
Browse
Click this button to open the Select MIME Type dialog

box that allows you to choose an existing association
from the Windows extensions table.
Add

button opens the Add Extension to MIME Association
dialog box that allows you to associate an extension with
a MIME type.
Edit
Select an item in the list and click this button to edit the
selected item. This button opens the Edit Extension to
MIME Association dialog box.
Remove
Select an item in the list and click this button to remove

the selected item.
Lookup registered MIME types
When this check box is selected, the component will use

the table of MIME types registered in Windows if the
documents extension is not in the custom table.
392
Option
Description
Default MIME
Enter the MIME type that will be used by default if the

Lookup MIME type for the file extension check box is
not selected or the component cannot detect the MIME
type. You can click the
button to open the Select
MIME Type dialog box that allows you to choose an
existing association from the Windows extensions table.
Add/Edit Extension to MIME Association dialog box

This dialog box allows you to associate an extension with a MIME type.
Option
Description
File extension
Enter the file extension; for example, .doc. You can click
the
button to select the extension in the opened
Select MIME Type dialog box that displays existing
associations from the Windows extensions table.
MIME type
Enter the MIME type to be associated with the extension;

for example, application/msword. You can click the
button to select the MIME type in the opened
Select MIME Type dialog box that displays existing
associations from the Windows extensions table.
Document Class tab

Use this tab to configure document class property.
Option
Document class
Description
Enter document class name or ID. Routed documents
will have default settings (such as access permissions)
configured for this class by the FileNet P8 Content
Engine Administrator. You can click the
button
to open the Select Document Class dialog box, which
allows selection of a document class. The displayed
classes include "Document" class and its subclasses.
Note: A document class has two names: a
symbolic name and a display name. This field
should contain a symbolic name.
Class fields
This box displays the list of fields of the current

document class. The list displays name, value and type
of each field.
Note: The Title and Permissions system fields
should be specified on the Document tab and
Security tab respectively.
Add
Click this button to add a new field to the list. This

button opens the Add Property dialog box.
Edit
Select a field and click this button to edit a selected field.

This button opens the Edit Property dialog box.
Remove
Select a field and click this button to remove the selected

field from the list.
393
Option
Description
Inline all fields into one string
Select this check box to set values of all class fields as

one string. This allows you to set all field values at once,
for example, by using RRT. In particular, this may be
useful if the number of fields is unknown in advance.
The text box below this check box allows entering a
value for the string in the in-line form, for example:
{"DocumentTitle" = String:"MyTitle", "FormPolicy" =
Object "DocumentLifecycleAction":{"LastModifier" =
String:"Me"}}
If you select this check box when the text box is empty
(for example, for the first time), the fields specified in
the list are converted into the Inline representation and
the in-line value is displayed in the text box.
Verify field values
If this check box is selected, the component will check

names and values of the fields before submitting them.
This option is applicable only to the fields whose
Verification option is set to "Default". For other fields,
the component uses the individual verification settings
specified in the Add/Edit Property dialog box.
When the component verifies a fields value and
considers that it is not valid, it uses the default value for
this field. If the field name is invalid (the document class
does not contain such field) then the component will skip
this field.
If this check box is not selected and some field name is
incorrect (no field with such name exists), or a field has
an incorrect value or type, or some required field is not
specified, then the document will be rejected. However,
if some name is empty at run time (for example, as a
result of an RRT replacement), it will be silently ignored.
Add/Edit Property dialog box

Use this dialog box to add or edit a document property
Option
Property name
Inline type information
Description
Enter the name of the property or click the
button
to open the Select Field of Class dialog box that
displays list of fields of the currently selected document
class. When you specify a new property, its type and
cardinality are automatically selected in the Property
type and Cardinality lists correspondingly.
This check box controls how the information about the
property is stored in the component's configuration. If
this check box is not selected, then type, cardinality,
representation and value will be stored in separate
entries. If this check box is selected, then type,
cardinality and representation will be stored directly in
the single VALUE entry. For the formal definition of an
inline representation, see Inline Representation.
394
Option
Description
For example, for Integer type the default representation
of value "111" is: VALUE = 111. Inline representation is:
VALUE = Integer32:111.
Property type
Enter the type of the property. The following property

types are supported:
Binary
Boolean
Date/Time
Floating point
Identifier
Integer
Object
String
A property type has two names: an internal name (nonlocalized human-readable name) and a display name
(localizable human-readable name). This drop-down list
shows the display names of the types. If you use RRT in
this combo box, this RRT should be replaced with one of
the internal names listed in this table:
Display name
(English)
Internal name
FileNet P8 CE
type name
Binary
Binary
Binary
Boolean
Boolean
Boolean
Date/Time
DateTime
Date/Time
Floating point
Float64
Float
Identifier
GUID
GUID
Integer
Integer32
Integer
Object
Object
Object
String
String
String
The component stores Internal name in the

configuration, since display name can be translated
to another language in a localized version of the
component.
Cardinality
Specify cardinality of the property type. You can select

one of the following values:
Single - represents one value of the type.

List - represents ordered list of values.
Enumeration - represents unordered list of unique
values.
This drop-down list shows the display names of the

cardinalities. If you use RRT in this combo box, this
395
Option
Description
RRT should be replaced with one of the internal names
listed in this table:
Representation
Display name
(English)
Internal name
FileNet P8 CE
cardinality
Single
Single
Single (0).
Represents one
value of the type
List
List
List (1).
Represents
ordered list of
values
Enumeration
Enum
Enumeration
(2). Represents
unordered list of
unique values
Select a representation in which the property value

will be saved in the configuration. Each type has its
own specific set of representations. Select the type
of representation which is appropriate for you. Only
a limited set of types has specific representations.
The following table describes the list of additional
representations with the corresponding types:
Table 26: Representation display names
Type
Date/Time
Binary
Object
Representation Internal name

display name
Default
Default
Local date/time
Local
Binary from file
Fileref
Binary from
UNICODE
string
Unicode
Binary from
ANSI string
String
Object reference
Objectref
Other types have no specific representations. Lists and

Enumerations do not have them as well.
The drop-down list shows the display names of the
representations. If you use RRT in this combo box, this
RRT should be replaced with one of the internal names.
396
Option
Property value
Description
This text box cannot be empty for any type except for
the String type. Enter the value of the property or click
the
button to open a dialog box which helps to
enter the value for the field. Actual dialog box depends
on the fields Cardinality, specified Property type
and Representation. If the cardinality is Single and
the type is not specified (or contains an RRT) then this
button is disabled. If the cardinality is Single and the
type is specified, then one of the following dialogs are
displayed:
Edit Binary Data

Edit Boolean
Edit Date/Time
Edit Float Point
Edit Identifier
Edit Integer
Edit Multiline String
Edit Object Reference
If the cardinality is Enumeration or List then the

button opens Edit List / Edit Enumeration dialog box.
The format of the value definition depends on the value
of Representation and Inline type information options.
When specifying a property value the following format
should be used:
For Boolean type, strings "true", "yes", "on" and "1"

represent a values of true, and strings "false", "no",
"off" and "0" represent a value of false.
For Date/Time type, there are two representations:
Default and Local date/time.
For the Default representation, the following

format should be used: yyyy-MM-dd
HH:mm:ss.fff Z[+/-]HH:mm (4 digit year and 24
hour time are required, fff - milliseconds, hours
and minutes after Z mean time zone difference
with GMT (Greenwich Mean Time), if DST
(Daylight Saving Time) is in use in the specified
moment of time then 1 hour should be added to
this difference by the user). If some symbols are
omitted in the tail of this notation, then zeroes
are assumed in the omitted fields: 2021-01-02
14:05 means 2021-01-02 14:05:00.000 Z+00:00,
2021-01-02 means 2021-01-02 00:00:00.000
Z+00:00. Day, month an year should never
be omitted. You can use RRT in the property
value; for example, ~XED::%EXPDATE
%~00:00:00.0 Z-4:00, however, this RRT
should be replaced with date in yyyy-mm-dd
format only.
397
Option
Description
For the Local date/time representation, the time

should be represented in the user locale settings;
for example: MM/dd/yyyy hh:mm [am/pm]. This
format never contains a time zone, and always
means UCT (Universal Coordinated Time: GMT
+0).
Inline representation requires inclusion of the value in

quotation marks.
For Floating point type, a number can be represented

with simple or exponential record using '.' (point)
character as decimal point symbol. Special values are
represented with strings: "+INF", "-INF" and "NAN".
64 bit float point range is supported.
For Identifier type, a value should be
represented as "{8-4-4-4-12}", like {1A589494AC8A-4FF7-814D-7EEFE306A033}. Inline
representation requires inclusion of the value in
quotation marks.
For Integer type, a value should be represented in
decimal form in 32 bit signed range.
For String type, a value should be represented as is.
Since string is not encoded, the special characters
(like line separation or Unicode characters which
do not belong to the current user language) cannot
be stored in the configuration file. However, if an
RRT of another component is used as the string
value, then that component can pass an arbitrary
string as an RRT. Empty strings are also supported.
Inline representation requires inclusion of the value
in quotation marks and encoding content like the C
strings do (using backslashes '\').
For Binary, type the default representation is the
sequence of hexadecimal digits and blank separators.
All separators are ignored. If required, the value is
post-padded with "0" digit to fit into 8-bit bound. For
example, the following strings represent the same
value: "0d0a5570" , "0d0a 5570", "0 d0a 557".
Binary from file. Instead of hexadecimal value

specify the file path here in the same form as for
string value. When the component stores this field
it reads the file and place its content into the field
value.
Binary from UNICODE string. Instead of
hexadecimal value specify the string here in
the same form as for string value. The string
content will be passed into the binary value.
Each character will be represented with 16 bits
of UTF16 encoding. No null-terminator will be
appended.
Binary from ANSI string. Instead of hexadecimal
value specify the string here in the same form
as for string value. The string content will be
398
Option
Description
passed into the binary value. Each character will
be represented with 8 bits of ANSI encoding
using the Windows users code page. No nullterminator will be appended.
The above rules describe the format of the simple type
in single cardinality. To store values of such fields the
component creates VALUE entry which contains the
above format.
For Object type, when Inline type information is

OFF, the value contains additional "CLASS" entry,
which contains string value of the objects class
name. When the object's representation is Object
reference, the "VALUE" entry contains GUID of the
referenced object. When the object's representation
is Default, the value does not have "VALUE" entry.
Instead, it has set of subtopics each named "FIELD".
Each subtopic contains information about one field
of the object. Therefore, its impossible to replace
value of the Object type using RRT in default
representation. To do this, use inline representation.
Any type in enumeration and list cardinality in default

representation (when inline is OFF) does not have
VALUE entry. Instead it has set of subtopics each named
ITEM. Each subtopic contains information about one
item of the list (its representation and value). Therefore,
its impossible to replace value of the enumeration or list
using RRT in default representation. To do that use inline
representation.
Example:
This example demonstrates representation of list of
objects. The list contains one item. The item is object
with two fields: "f1" and "f2". Other information is
omitted for simplicity.
TYPE = Object
CLASS = MyClass
CARDINALITY = LIST
INLINE = NO
ITEM {
INLINE = NO
FIELD {
NAME = f1
VALUE = abcd
}
FIELD {
NAME = f2
VALUE = 123
}
}
Inline representation of the same example is:
399
Option
Description
INLINE = YES
VALUE = List Object "MyClass":
{{"f1"="abcd", "f2"= 123}}
Verification
Specify if the component should verify value of this

property when submitting the document into the FileNet
P8 Content Engine object store. The following settings
are possible:
Check - always check value of this field.

Do not check - never check value of this field.
Default - use parent settings: if this field is a subfield
of an object, use settings for the object; if this field is
a top-level field, use value of the Verify field values
check box.
Note: When parent value of a complex type
(Object, List or Enumeration) is in-line, then
all its children values (fields or items) will
be verified or not verified accordingly to the
parents settings. This is similar to the Default
value of Verification.
When the component verifies a fields value and
considers that its not valid it uses the default
value for this field. If the fields name is invalid
the document class does not contain such field)
then component will skip this field.
Edit Binary Data dialog box

Use this dialog box to edit binary data.
Note: This dialog is used when binary value representation is Default. For a binary value represented as
Unicode or ANSI string the Edit Multiline String dialog box is displayed; for a binary value represented as
file reference the standard Open File dialog box is displayed.
This dialog box does not support entering of RRTs.
When this dialog box opens, the value is converted from its string representation. If the string is ill-formed (or
contains RRTs) all non-hexadecimal characters are removed. Then the following grouping settings are applied to the
value:
Option
Description
Group by
Specify group size (in bytes). This number is the same

for all binary values.
Break lines
Specify row length (in groups). This number is the same

for all binary values.
Format now
This button performs re-grouping of the text according to

the currently specified grouping settings (Group by and
Break lines).
Load
This button allows loading of the binary value from a

file.
Save
This button allows saving of the binary value to a file.
400
Option
Description
Default value
This text box displays the default value for the field (if
it is configured in the FileNet P8 Content Engine Object
Store). Click the Set button to copy this value into the
value edit box.
Maximum length
This text box displays the maximum length for the field
(if it is configured in the FileNet P8 Content Engine
Object Store).
Current length
This text box displays the current length of the field.

This value is calculated for the valid hexadecimal
characters only.
When you click OK, the value is converted to its string representation (non-hexadecimal characters are removed and
the value is padded with 0 character to the byte bound if necessary).
Edit Boolean dialog box
Use this dialog box to edit the value of the Boolean type.
When this dialog box opens the value is converted from its string representation. If the string is ill-formed (or contains
RRTs), False is selected.
Option
Description
Value
Select True and False.
Default value
value edit box.
Edit Date/Time dialog box

Use this dialog box to edit the value of the Date/Time type.
When the dialog box opens the value is converted from its string representation.
Option
Description
Date/Time
Enter or select date and time in these two boxes.
Milliseconds
Enter milliseconds value.
Zone
Enter zone, for example, +06:00.

Note:
When you use Local date/time representation,
the zero values of milliseconds and zone are
always used. If you set some other values for
such property, save and reopen this dialog box.
The zero values will then be set automatically in
Millisecond and Zone text boxes.
FileNet P8 Content Engine server always
stores date/time values as UCT (Universal
Coordinated Time: GMT+0). When the
component stores value of the date/time field in
401
Option
Description
Default representation on the server, it subtracts
the specified time zone difference from the time
stamp.
When you look into the properties of a
sent document using FileNet P8 Enterprise
Manager, you see date/time value converted
into the time zone of the machine where the
Enterprise Manager runs. When you look
into the properties of a document using a web
browser, you see date/time value converted to
the time zone of the web server machine. When
the above conversion occurs, the web server/
enterprise manager applies system time settings
to the converted date. It assumes that the time
zone and clock skew rules in the moment of
time described by the date field will be (or was)
the same as currently configured in the OS.
Therefore if you want to see a particular
property value via web-browser, you should
precisely configure time zone taking this into
account.
For example, if you want to see "2011-06-10
00:00" and the web server time zone is EST
(Eastern Standard Time) with DST (Daylight
Saving Time), the following should be
specified: 2011-06-10 00:00:00.0 Z-4:00.
However, for winter months you should not add
DST to the time zone: 2011-01-10 00:00:00.0
Z-5:00.
Default value
it is configured in the FileNetP8 Content Engine Object
Date/Time, Milliseconds, and Zone text boxes.
Minimal value
This text box displays the minimal value for the field (if
Maximal value
This text box displays the maximal value for the field (if
Set current
Click this button to set current date and time.
When you click OK, the value is converted to its string representation accordingly to the Representation setting of
the field, which can be configured in the Add/Edit Property dialog box.
Edit Float Point dialog box
Use this dialog box to edit the value of the Floating point type.
402
Option
Description
Value
Enter decimal or exponent representation of the floating

point number.
Default value
value edit box.
Minimal value
value edit box.
Maximal value
value edit box.
When you click OK, the value is converted to its string representation.
Edit Identifier dialog box
Use this dialog box to edit the value of the Identifier type.
This dialog box does not support entering of the RRTs.
When the dialog box opens the value is converted from its string representation into the GUID in 8-4-4-4-12 format.
Option
Description
Value
Enter the split representation of the GUID, that is,

separate parts of 8-4-4-4-12 format.
Default value
value edit box.
Generate
Click this button to generate a new GUID. The generated

GUID is placed into the Value text boxes.
When you click OK, the value of the GUID is converted to its string representation.
Edit Integer dialog box
Use this dialog box to edit the value of the Integer type.
Option
Description
Value
Enter decimal representation of the integer number.
Default value
value edit box.
Minimal value
403
Option
Description
value edit box.
Maximal value
value edit box.
When you click OK, the value is converted to its string representation.
Edit Multiline String dialog box
This dialog box allows you to edit value of String type or of Binary type.
Note: This dialog box allows editing values of Binary type when representation Binary from UNICODE
string or Binary from ANSI string is used.
When the dialog opens, the value is converted from its string representation.
Option
Description
Value
Enter the value that consists of several strings.
Default value
value edit box.
Maximum length
This text box displays the maximum length for the string
(if it is configured in the FileNet P8 Object Store).
Current length
This text box displays the current length of the string.
When you click OK, the value is converted to its string representation and the inline string value is enquoted. The LF/
CR and Unicode characters are escaped with backslash (\) character.
Note: If the entered value contains line feeds, the Inline type information check box on the Add/Edit
Property dialog box becomes automatically selected when you save this dialog box.
Edit List / Edit Enumeration dialog box
This dialog box allows you to edit value of any type if the cardinality of the property is List or Enumeration.
When the dialog box opens the value is converted from its string representation if the value of the List or Enumeration
type is in the inline form.
Option
Description
Item type
This text box displays the type of selected item in the

list.
Items
This list contains values of the items of the list or the

enumeration.
Add

button opens the Add Item dialog box.
Edit
Select an item and click this button to edit the selected

item in the opened Edit Item dialog box.
Remove
Select an item and click this button to remove the

404
The Edit List dialog box also contains
and
buttons that allow moving list item up and down correspondingly.
Edit Object Reference dialog box

Use this dialog box to edit the value of the object type.
The value should be a reference to an object.
When the dialog box opens the value is converted from its string representation if the Inline type information check
box on the Add/Edit Property dialog box is selected for this value.
Option
Object class
Description
Enter the object class name or click the
open the Select Object Class dialog box.
Object id
button to
Enter object ID manually or click the

button to open
the Select Target Document dialog box to select the
document that the property will reference to.
Note: To be selected, an object has to be placed into a folder.

Select Target Document dialog box
This dialog box allows browsing for the documents in the FileNet P8 Content Engine object store and adding
reference to the existing document.
Option
Description
Folders
This box displays the folder tree and allows selection of

a folder.
Documents
This box displays names of the documents in the selected

folder and allows selection of a document.
Document path
Enter the path to the document. The path is displayed

automatically when you select a document.
Document ID
This text box displays the ID of the selected document.
Add/Edit Item dialog box

This dialog box allows you to add/edit item of the list or the enumeration.
Option
Description
Item type
This text box displays the type of the item.
Inline type information
This check box controls how the information about the

property is stored in the component configuration. If
this check box is not selected, then type, cardinality,
representation and value will be stored in separate
entries. If this check box is selected, then type,
cardinality and representation will be stored directly
in the single VALUE entry. This can be useful when
the values of the complex objects are replaced. For a
formal definition of an inline representation, see Inline
Representation.
In particular, this check box is taken into consideration
for representation of property value.
405
Option
Description
For example, for Integer type the default representation
of value 111 is: VALUE = 111. Inline representation is:
VALUE = Integer32:111.
Representation
Select a representation in which the property value

will be saved in the configuration. Each type has its
own specific set of representations. Select the type
of representation which is appropriate for you. Only
a limited set of types has specific representations.
The following table describes the list of additional
representations with the corresponding types:
Table 27: Additional representations
Type
Date/Time
Local date/time
local
Binary
Binary from file
fileref
Binary from
UNICODE
string
unicode
Binary from
ANSI string
string
Object reference
objectref
Object
Item value
Representation Internal name

display name
This text box cannot be empty for any type except for
String type. Enter the value of the property manually or
click the
button to open a dialog box which helps
to enter value for the item. Actual dialog box depends of
the specified Item type and Representation. One of the
following dialog boxes are displayed:
Edit Binary Data

Edit Boolean
Edit Date/Time
Edit Float Point
Edit Identifier
Edit Integer
Edit Multiline String
Edit Object
The format of the value definition depends on the value

of Representation and Inline type information options.
When specifying an item value the following format
should be used:
For Boolean type strings "true", "yes", "on" and "1"

represent a values of true, and strings "false", "no",
"off" and "0" represent a value of false.
For Date/Time type there are two representations:
default and Local date/time. For the default
406
Option
Description
representation the following format should be used:

yyyy-MM-dd HH:mm:ss (4 digit year and 24 hour
time are required). For the local representation,
the time should be represented in the users locale
settings. Inline representation requires inclusion of
the value in quotation marks.
For Floating point type a number can be represented
with simple or exponential record using '.' (point)
character as decimal point symbol. Special values are
represented with strings: "+INF", "-INF" and "NAN".
64 bit float point range is supported.
For Identifier type a value should be
represented as "{8-4-4-4-12}", like {1A589494AC8A-4FF7-814D-7EEFE306A033}.
For Integer type a value should be represented in
decimal form in 32 bit signed range.
For String type a value should be represented as is.
Since string is not encoded, the special characters
(like line separation or Unicode characters which do
not belong to the current user language) cannot be
stored in the configuration file. However if an RRT
of another component is used as the string value,
then that component can pass an arbitrary string as
an RRT. Empty strings are also supported. Inline
representation requires inclusion of the value in
quotation marks and encoding content like the C
strings do (using backslashes '\).
For Binary type the default representation is the
sequence of hexadecimal digits and blank separators.
All separators are ignored. If required, the value is
post-padded with "0" digit to fit into 8-bit bound. For
example, the following strings represent the same
value: "0d0a5570" , "0d0a 5570", "0 d0a 557".
Binary from file. Instead of hexadecimal value

specify the file path here in same form as for
string value. When the component stores this field
it reads the file and place its content into the field
value.
Binary from UNICODE string. Instead of
hexadecimal value specify the string here in same
form as for string value. The string content will be
passed into the binary value. Each character will
be represented with 16 bits of UTF16 encoding.
No null-terminator will be appended.
Binary from ANSI string. Instead of hexadecimal
value specify the string here in same form as for
string value. The string content will be passed
into the binary value. Each character will be
represented with 8 bits of ANSI encoding using
the Windows user code page. No null-terminator
will be appended.
407
Option
Description
The above rules describe the format of the simple type.
To store values of such fields the component creates
VALUE entry which contains the above format.
Object type in default representation (when Inline

type information is OFF) contains additional entry
CLASS which contains string value of the objects
class name. It does not have VALUE entry. Instead
it has set of subtopics each named FIELD. Each
subtopic contains information about one field of the
object. Therefore, its impossible to replace value of
the Object using RRT in default representation. To
do that use inline representation (when Inline type
information is OFF).
Any type in enumeration and list cardinality in default

representation (when inline is OFF) does not have
VALUE entry. Instead it has a set of subtopics each
named ITEM. Each subtopic contains information
about one item of the list (its representation and value).
Therefore its impossible to replace value of the
enumeration or list using RRT in default representation.
To do that use inline representation.
Example:
This example demonstrates representation of list of
objects. The list contains one item. The item is object
with two fields: "f1" and "f2". Other information is
omitted for simplicity.
TYPE = Object
CLASS = MyClass
CARDINALITY = LIST
INLINE = NO
ITEM {
INLINE = NO
FIELD {
NAME = f1
VALUE = abcd
}
FIELD {
NAME = f2
VALUE = 123
}
}
Inline representation of the same example is:
INLINE = YES
VALUE = List Object "MyClass":
{{"f1"="abcd", "f2"= 123}}
Verification
specify if the component should verify value of this item

when submitting documents into the FileNet P8 Content
Engine object store. Following settings are possible:
408
Option
Description
CheckAlways check value of this item.

Do not checkNever check value of this item.
DefaultUse parent (list or enumeration) settings.
Note: When parent value of a complex type
( List or Enumeration) is inline, then all its
items will be verified or not verified accordingly
to the parents settings. This is similar to the
Default value of Verification.
Select Class dialog box

This dialog box is titled as Select Document Class, Select Object Class, or Select Folder Class and displays lists of
document classes, object classes, or folder classes of the object store correspondingly.
Option
Description
Show system classes
If this check box is not selected, the system classes are

not displayed in the list. The classes marked as system
are predefined classes as opposed to the custom usercreated classes. The system classes are critical for the
Content Engine functionality. Some predefined classes
may not be marked as system.
Show hidden classes
If this check box is not selected, the hidden classes are

not displayed in the list. The classes marked as hidden
are usually designated to create some service objects.
Allow creation of objects
If this check box is not selected, then the classes that

do not allow instances are not displayed in the list. It is
possible to create objects of a class only if it has "Allow
instances" property, that is, it allows creation instances of
itself.
Note: Custom classes are always displayed in
the list. Only custom and system classes are
displayed by default.
Please select class
This table displays the list of classes. The display name

and the symbolic name of each class are displayed.
Description
This read-only text box shows the description of the

selected class.
Hidden
This check box is selected if the selected class is hidden.
System
This check box is selected if the selected class is system.
Allows instances
This check box is selected if the selected class allows

instances of itself to be created.
Select Field of Class dialog box

This dialog box allows you to select field of the document class, of the folder class or of the object class.
The title of this dialog box is Select Field of Class [ClassName], where [ClassName] is the name of the selected
Document class, Folder class, or Object class correspondingly.
This dialog box displays list of fields in the class with names, types and additional information.
409
Option
Description
Show system fields
If this check box is not selected, the system fields are not
Show hidden fields
If this check box is not selected, the hidden fields are not
Note: Custom classes are always displayed in
the list. Only custom and system classes are
displayed by default.
Hide configured fields
This check box is selected by default. Clear this check

box to show those fields whose values were already
configured.
Description
This read-only text box displays description of the

selected field provided by the FileNet P8 Content Engine
administrator.
Hidden
This box is checked if the selected field is a hidden one.
System
This box is checked if the selected field is a system one.
Inline representation
Value of any type can have in-line representation and be saved in the configuration in one line(since multiline values
cannot be stored). The component uses VALUE entry to store full information about the property. The value is
prefixed with type information.
VALUE = inline_value
The inline_value is formally defined as:
inline_value ::-- type_prefix: represented_value | represented_value
type_prefix ::-- enum single_type_name | list single_type_name | single_type_name
single_type_name ::-- basic_type_name | Object "class_name
represented_value ::-- representation_name : inline_value_body | inline_value_body
inline_value_body ::-- value_body | { object_fields_list } | { enum_items_list }
object_fields_list ::-- object_field_value, object_fields_list | object_field_value
object_field_value ::-- "field_name" = inline_value | = inline_value
enum_fields_list ::-- inline_value , enum_fields_list | inline_value
Where:
basic_type_name - the internal name of the simple (not Object) type.
representation_name - the internal name of the Representation value.
value_body - the value of a basic type.
class_name - name of the object class.
field_name - name of the object field.
410
Security tab
Use this tab to specify permissions of routed documents.
Option
Security policy
Description
Specify a security policy that will be applied to routed
documents. By default, this text box is blank, that is, no
security policy is used. You can click the
button
to open the Select Security Policy dialog box, which
displays a list of existing policies.
Document permissions
This box displays the list of users/groups and their rights

for the routed document.
Leave default permissions
If this check box is selected, the component does not

change documents permissions and the document
gets default permissions configured by the FileNet P8
Content Engine Administrator for the current Document
class. This check box is selected by default.
Add

button opens the Add Access Permissions dialog box.
Edit
Select permission and click this button to edit a

selected permission. This button opens the Edit Access
Remove
Select permission and click this button to remove the

selected permission from the list.
Change owner to
Enter a user name that will become the owner of routed

documents. You can click the
button to open the
Select User dialog box, which displays a list of existing
users.
Selection dialog box

This dialog box allows selection of some existing object from the FileNet P8 CE object store.
This dialog box can be titled as:
Select Security Policy
Select Storage Policy
Select Event
Select Event Action
Option
Description
Please select...
This box displays a list of security policies, storage

policies, events, or event actions. Select an object.
Identifier
This text box contains an ID of the selected object.
Add/Edit Access Permissions dialog box

This dialog box allows you to enter user (or group) name and to grant access permissions to this user (or group).
Option
Grantee name
Description
Enter the name of the permission grantee, that is, user
or group in the form suitable for the Authentication
Provider configured for the FileNet P8 Content Engine
411
Option
Description
domain. For example, when a directory service - based
provider (like Active Directory) is in use, then user or
group should be specified by its short (login) name (for
example: fnuser) or by its principal (qualified) name (for
example: FileNetUser@myDomain.com).
Additionally, two predefined grantees can be used:
CREATOR-OWNER user and AUTHENTICATEDUSERS group.
You can enter the name of a permission grantee manually
or click the
button to open the Select User dialog
box that allows selection of a user or group.
Access type
Select one of two access types: Allow or Deny. The

access types may be selected from the drop down list or
entered manually. If an RRT is used in this text box, this
RRT should be replaced with one of the internal names:
"ALLOW" or "DENY". The Deny type takes precedence
over the Allow type.
Access level
Enter the bitmask value of access rights granted (or

denied, if access type is Deny) to the grantee. Bitmask
value is an integer number, which can be entered in
decimal or hexadecimal form; for example, 0xf0081.
Alternatively, you can select from the list of predefined
access levels suitable for the Document class:
Full control
Minor versioning
Major versioning
Modify properties
View properties
Publish
View
You can also click the

button to open the Access
Flags dialog box which allows selection of the custom
bitmask.
The following table lists these levels and respective
bitmask values:
Table 28: Bitmask values
Display name
Internal name
Bitmask value
Full control
FULL
CONTROL
DOCUMENT
0xf3dd7
Minor
versioning
MINOR
VERSION
DOCUMENT
0x205f3
412
Option
Description
Display name
Internal name
Bitmask value
Major versioning MAJOR

VERSION
DOCUMENT
0x205f7
Modify
properties
WRITE
DOCUMENT
0x205b3
View properties
READ
0x20001
Publish
PUBLISH
0x208b1
View
VIEW
0x20081
Internal names are given based on the FileNet P8 API

names.
When you enter an external name, the component stores
the internal name in the configuration. Therefore, if an
RRT of another component is used in this combo box,
this RRT should be replaced with the internal name of
desired access level. Alternatively it can be replaced
with an integer (decimal or hexadecimal) representing
the desired bitmask.
A bitmask is composed from the individual access rights.
Access Flags dialog box
This dialog box displays the list of predefined access levels and set of individual access rights.
You can select a predefined access level or the desired set of the access rights.
Option
Description
Access rights flags
This list contains set of access rights flags and check

boxes corresponding to them. You can select or clear the
check boxes in order to configure a custom set of the
access rights.
Access level
Enter name of the access level or select a predefined

access level from the drop down list. Each level
determines a set of actual access rights. The level
becomes selected if you specify individual flags set
which matches to one of the predefined levels. When you
select an access level in this combo box, the respective
access rights become selected in the Access rights flags
list and its hexadecimal representation appears in the
Bitmask value text box.
Bitmask value
Enter decimal or hexadecimal (prefixed with 0x)

representation of the access rights flags. The changes
will be immediately reflected in the Access rights flags
list and Access level combo box. And when you select a
custom set of assess rights or a predefined access level,
the bitmask value is automatically displayed in this text
box.
413
Option
Description
Choose level
Click this button to select a symbolic name of the

predefined access level currently selected in the Access
level combo box. In this case the symbolic name will
appear in the Access level combo box of the Add/Edit
Access Permissions dialog box. This button is enabled
only if a predefined access level is selected.
Choose bitmask
Click this button to select an integer bitmask value

currently specified in the Bitmask value text box. In
this case the integer value will appear in the Access level
combo box of the Add/Edit Access Permissions dialog
box. This button is enabled only if a valid (decimal or
hexadecimal) integer is specified.
Note: This dialog box does not contain OK button. Choose level and Choose bitmask buttons are used to
confirm the selection and to close the dialog.
Access Rights
The following table lists the available access rights with the bitmask values for the Document class:
Access
Bitmask value
View all properties
0x00001
Modify all properties
0x00002
Major versioning
0x00004
Link a document / Annotate
0x00010
Unlink document
0x00020
Minor versioning
0x00040
View content
0x00080
Create instance
0x00100
Change state
0x00400
Publish
0x00800
Reserved 12 (Deploy is deprecated)
0x01000
Reserved 13 (Archive is deprecated)
0x02000
Delete
0x10000
Read permissions
0x20000
Modify permissions
0x40000
Modify owner
0x80000
Following table displays individual rights for all access levels:

Access
View all
properties
Full
control
Minor
Major
Modify
versioning versioning properties
View
properties
Publish
View
414
Access
Full
control
Modify all
properties
Major
versioning
Link a
document /
Annotate
Unlink
document
Minor
Major
Modify
versioning versioning properties
Publish
View
Minor
versioning
View
content
Create
instance
Change state
Publish
View
properties
Reserved 12
Reserved 13
Delete
Read
permissions
Modify
permissions
Modify
owner
Advanced tab
Use this tab to set additional options for control of the routing process.
The options are related to the peculiarities of the MTOM API and may improve the compatibility between Workflow
Server and FileNet P8 Content Engine in some specific environment.
Option
Upload timeout
Description
Specify upload timeout in seconds. If, during upload,
a problem occurs or upload takes too much time, the
component waits for this time and then aborts upload
and rejects the document. It is recommended to increase
timeout value when sending big documents. The default
timeout is 120 seconds. The maximum timeout is 3600
seconds (1 hour). -1 means infinite timeout.
Note: FileNet P8 server can have its own
timeout settings.
415
Option
Description
Use Content Engine 4.0 compatibility mode
Select this option to use DIME extension via WSE 2.0

to connect to FileNet P8. In this case the component
connects to the endpoint "http://host:port/wse/
FNCEWS40DIME" of the FileNet P8 CE web service.
Note: In order to use this mode, you have to
install Web Services Enhancements (WSE) 2.0
SP3 for Microsoft .NET, which you can
download from the Microsoft Download Center
(http://www.microsoft.com/download/en/
details.aspx?displaylang=en&id=23689)
Upload stream buffer
Specify buffer size in kilobytes. By default this value is

10240 (10MB).
Note: This option is related only to uploading
of documents. Other parts of the network
message such as fields, will be loaded into
memory before the component sends this
messages to the object store. That is, large
Binary fields will consume as much memory as
the size of the fields, while large documents will
consume only a specified in this option amount.
However, if the Send chunk without buffering
option is turned OFF, then the component will
consume as much memory as it is required to
load routed files.
Send chunk without buffering
This check box is selected by default. In this case, the

component starts streaming of the MTOM attachments
before it buffers entire message. This significantly
reduces memory usage when the component routes big
files. When this option is turned OFF the component
loads the entire file into memory before sending it.
It is highly recommended to keep this option turned
ON unless the specific compatibility and performance
reasons require buffering of the entire message before
sending it to the server.
POST data chunk size
Specify the size of chunks that WSE 2.0 uses to stream

the uploaded document as a DIME attachment.
Component RRTs
Component RRT ID
Component RRT ID is FCE.
The following table describes the reserved RTNs for this component:
Note: When the component processes a batch of documents, the RRT's replacements depend on internal (in
the component's configuration) or external (in the subsequent components' after the eConnector component)
usage.
416
RRTN
FileName
Description
When used internally, the component replaces it with the
name of the currently routed document.
When used externally, the component replaces it with the
name of the first routed document.
FileExt

When this RRT is used internally, the component
replaces it with the file extension (including the point
character .) of the currently routed document.
file extension of the first routed document.
FileFolder
The original file path without file name.

replaces it with the path of the currently routed
document.
path of the first routed document.
DocumentId
The unique identifier of the routed document (updated or

created).
replaces it with the ID of the target document specified
in the Document tab. It can be either ID of the newly
created document or of an existing document. The
component does not replace this RRT in the settings
required to create a new document or to find an existing
document because the document ID is unknown at run
time in these cases. If the Target is Update document
with the following ID, then the value of this RRT is
first taken from the ID text box and than is updated after
updating the document.
When used externally, it is the identifier of the first
routed document.
DocumentTitle
The title of the routed document.

replaces it with the title (name) of the target document
specified in the Document tab. It can be either title of
the newly created document or of an existing document.
The component does not replace this RRT in the settings
document because the document title is unknown at run
time in these cases.
When used externally, it is the title of the first routed
document.
DocumentVsId
A unique identifier of the routed document's version

series object.
417
RRTN
Description
replaces it with the ID of the version series object of
the document specified in the Document tab. The
component does not replace this RRT in the settings
document because the document version series is
unknown at run time in these cases.
When used externally, it is the identifier of the version
series of the first routed document.
DocumentURL
The URL of the routed document on the Application

Engine.
When used internally, the component uses the value of
Document URL pattern specified in the Document tab
for its replacement.
When used externally, it is the URL of the first routed
document.
CE_URL
This is an internal RRT. Its value is taken from the

Content Engine web service URL text box on the
General tab.
This RRT is designated to be used within Application
Engine URL pattern when the Application Engine is
hosted on the same server where the Content Engine is.
AE_URL
This is an internal RRT. Its value is taken from the

Application Engine URL text box on the Document
tab. This value should be specified in the form like:
http://FileNetAEserver.doman:80/ECMF.
This RRT is designated to be used in the Document
URL pattern text box on the Document tab and
should keep URL of the web application hosted on the
Application Engine server. The default web application
is Workplace; therefore, the default value of this field
is: ~FCE::CE_URL~/WorkplaceXT
ObjectStore
The name of the FileNet P8 Content Engine object store.

Its value is taken from the Object store text box on the
General tab. This is an internal RRT.
FolderPath
Path of the FileNet P8 Content Engine folder containing

the routed document. Its value is taken either from the
Target folder text box on the General tab or determined
at run time if the document is specified by its ID. When
the component replaces the path, it prefixes it with a
slash and removes slash from the end (root folder will be
an empty string). This is an internal RRT.
DocumentName
Containment name of the document in the FileNet P8

folder. Its value is either taken from the Name text box
on the Document tab or determined at run time if the
document is specified by its ID or a new document
418
RRTN
Description
is created (with Auto Name for example). This is an
internal RRT.
The example of the RRTNs usage: if the component rejects first document in the batch, ~FCE::FileName~ will be
replaced by the name of the currently processed document when used inside the component, and will be replaced by
the name of the second input document when used outside the component.
This component does not generate FRTNs.
SSRTN
Description
%a
Abbreviated weekday name
%A
Full weekday name
%b
Abbreviated month name
%B
Full month name
%d
Day of month as decimal number (01 - 31)
%H
Hour in 24-hour format (00 - 23)
%I
%j
Day of year as decimal number (001 - 366)
%m
Month as decimal number (01 - 12)
%M
Minute as decimal number (00 - 59)
%p
Current locale's A.M./P.M. indicator for 12- hour clock
%S
Second as decimal number (00 - 59)
%U

day of week (00 - 53)
%w
Weekday as decimal number (0 - 6; Sunday is 0)
%W

%y
Year without century, as decimal number (00 - 99)
%Y
If the component receives a batch of several documents on input, the Date/Time RRTs are replaced once and have the
similar values for all documents from the batch.
The examples of the component SSRTN usage:
~FCE::Year~-~FCE::Month~ will be replaced by 2010-03.
This component was certified as working with the FileNet P8 Content Engine versions 4.0.0, 4.5.0 and 5.1.0.
419
The component communicates with the installed and configured FileNet P8 Content Engine 4.0.x ,4.5.x, 5.1.x via
its Web Service interface. The communication is based on WSE 2.0 using DIME or on WSE 3.0 using MTOM
extension.
If you use Content Engine 4.0 compatibility mode, you have to install Web Services Enhancements(WSE) 2.0
SP3 for Microsoft .NET, which can be found at the Microsoft Download Center.
The .NET Framework 2.0 and WSE 3.0 should be installed on the machine with the Workflow Server.
The maximum limit for the size of the routed documents is approximately 120Mb.
Problem
Description
The document storing fails and the Status Monitor shows This problem can occur for the document class properties
the following error message:
which have a choice list, that is, a specific list of correct
values defined on the FileNet P8 server. Probably the
The value PropertyValue specified for
specified value is absent in the choice list. Define a
property PropertyName is not in the
correct value for the property.
CVL
where the PropertyValue is the specified value of a
property, PropertyName is the name of a property.
Glossary
A
annotation
Unstructured information (such as notes, comments, or messages) about a folder or document.
application engine
This web server hosts different web applications that can access the Content Engine. For example, Workplace (the
default front end for web-access to Content Engine) is hosted on the Application Engine. Application Engine can use
the same Application Server as Content Engine does.
application server
The web server which runs the Java machine and hosts Java-based P8 services (such as the Content Engine and
Application Engine).
C
compound document
A collection of files that are used together to form a single complete document. A compound document has a property
setting of CompoundDocumentState=1 and consists of the following:
A parent document component. This parent document is not required to contain content.
A child document component linked to a parent document component by a component relationship object. Any
child document component can be the parent document component of another compound document structure.
A component relationship object that links together a parent document component with its child document
components.
containment name
The string property that identifies an item of a folder. A document in the Object Store can be stored into several
folders. Each item of the folder should have unique containment name. Usually, the containment name of a document
is the same as its title, but its possible that a document has different containment names in each folder where it is
stored.
content element
File or reference to external content contained in a document object or annotation object. Each document object or
annotation object of the FileNet P8 Content Engine object store may contain one or several content elements.
D
display name
A human-readable name of a class depending on the current client locale settings.
420
E
event action
A script, object, or workflow that Content Engine runs, as defined in a subscription or event subscription. Event
actions can be used to launch workflows and to declare records.
I
ID
Unique identifier of an object (string in the form of GUID). Each object in the FileNet P8 Content Engine has its
unique ID: a document, a folder, a custom object and even an object store.
M
major version
A document version that has been released. Typically, the security of a major version makes the document available
to a wide range of users. A major version always has an integer other than zero as its major number, and always has a
minor number equal to zero; for example, 5.0.
Microsoft Web Services Enhancements 3.0
The library to build Web-services and Web service clients. This library utilizes MTOM extension to pass binary data.
WSE 3.0
minor version
A document version that has not been released. Typically, the security of a minor version makes the document
available only to the authors and reviewers. h 0.1 and 4.32 are examples of a Minor version. Reservation versions
are always assigned a Minor number. If a new document is first checked in as a minor version, its version number
becomes 0.1. The next version in this series would be 0.2 if a minor, and would be 1.0 if it is checked in as a Major.
Message Transmission Optimization Mechanism
The SOAP protocol extension that is used to communicate with FileNet P8 Content Engine 4.0 and 4.5 web service to
send documents.
MTOM
Multipurpose Internet Mail Extension
A specification for formatting non-ASCII messages so that they can be sent over the Internet. FileNet P8 Content
Engine provides a document property called MIME type. The value for MIME type identifies a type of data in the
document (such as text, XML, or application).
MIME
O
object store
A set of services provided by Content Engine to access and manage documents and their objects.
S
security realm
The collection of all user accounts and group memberships available to the FileNet P8 domain. Realms are created,
maintained, and authenticated by the authentication provider and are thereafter read and utilized by a FileNet P8
domain.
storage policy
subscription
A method that sets up the conditions required for an event action to take place and the class, object, instance or
workflow the event acts upon.
symbolic name
The non-localized human-readable name of a document class that can be used as a programmatic identifier.
V
version series
All versions of a document. A version series from which one or more versions have been deleted is said to be a
sparse version series. The version number is unique in the document's version series and is actually comprised of two
properties: the Major version number and the Minor version number. For example, in version number 5.2 the Major
number is 5 and the Minor number is 2.
421
version status
The state of a version. Minor versions have the status In Process, Reservation, or Superseded. Major versions have
the status Released, Reservation, or Superseded. These four version states are actually stored as integers and are
sometimes displayed as integers by Enterprise Manager and applications such as Workplace:
Released = 1 (a Major version which is generally made available to all users).

In Process = 2 (a checked in Minor version, which is generally made available to a restricted set of authors and
reviewers).
Reservation = 3 (a document whose content is currently being edited).
Superseded = 4 (a Major or Minor version that is no longer the most recent version).
File Options
Welcome to the File Options component
Reduce computing requirements by capturing the processed files into a directory and rerouting them into multiple
destinations. This component is a must-have when expensive and repetitive CPU-intensive tasks should be eliminated.
The purpose of this component is to determine treatment of various types of files, depending on whether they were
processed successfully or unsuccessfully.
"Process once and Store many times" is the best description of File Options process (filter) component.
Getting started
Feature highlights
With this component:
Depending on the file extension, you can either remove the files or place them into particular folders.
Depending on whether the process was a success or a failure, define output file option based on success and
failure.
Using the File Options component

With this component, you can:
Customize this component so that depending on the file extension, you can either remove the files or place them
into particular folders. This also depends on whether the process was a success or a failure.
Save and reuse the files that are created within a process to conserve time and resources required to distribute the
same file out to other destinations.
File Options increases accuracy through reuse of output files.
Example 1: Use the File Options component with the TRIM Context process component. Use Poll Directory
to capture various file types (such as .doc and .xls) in a specified directory. Use the TRIM Context process
component to store the files into TRIM and to pass them onto a route component. Place a File Options component
before the TRIM Context process component to specify a folder to place files according to the file extension. If
the Poll Directory consists of Word and Excel files, you can create two new tabs by using the Add button on the
component. The extensions you specify should be doc and xls for the new tabs. Then you can specify what to do
with Word or Excel files placed into the Poll Directory based on the file type (remove them or add them to a directory
for successes and failures).
Example 2: Place all files that were failures into a particular directory when using Poll Directory. In the File Options
component options, choose the Move files option, and specify where you want to place failures. For example, specify
the folder C:\failure. If you do not already have the folder failure in that location, you are prompted to create
the directory. Click Yes, and the component will proceed to create the folder failure in the specified location. For a
route component, select and configure the Send to Database component, then run the process. If the process is unable
to store files with the Send to Database component, then the files will be sent to the C:\failure folder. Then, even
if you there are lots of in the Poll Directory location, you can quickly check in the C:\folders for any failures.
422
Configuring the File Options component

File Options tabs
The On Success and On Failure options in the File Options dialog box specify how to handle files when a process
succeeds or fails.
The General tab allows you to configure default settings for any unspecified file type. You can add tabs to the File
Options dialog box to configure On Success and On Failure options for specified file types.
Option
Description
On Success
Choose what happens if a process is successful:
Remove filesDeletes the files.

Move filesCopies files to a specified location.
Click the browse button (...) to specify a folder.
The Move files option does not remove files from the
source directory.
On Failure
Choose what happens if a process fails.
Remove filesDeletes the files when the process

was a failure.
Move filesCopies files to a specified location.
Click the browse button (...) to specify a folder.
The Move files option does not remove files from the
source directory.
Add
Click this button to add a new tab to the configuration. A

new tab is for a particular file extension, such as .pdf
or .docx. When you add a tab for a file extension, files
with the file extension will be processed according to
settings on the tab.
Clicking the Add button opens the File Extension
dialog box. In the File type extension box, specify
the file extension, such as "pdf" or "docx" for PDF or
Word files. Do not include the leading dot on the file
extensions.
Any file with an unspecified extension is processed
according to settings on the General tab.
For example, you can move files with extension txt to
the folder c:\TextSuccess on success and to the folder
c:\TextFailure on failure while moving files with the
extension docx to the folder c:\WordSuccess on
success and to the folder c:\WordFailure on failure.
Remove
Click this button to remove the currently selected tab.

The General tab cannot be removed.
File Options component RRTs

This component does not generate Runtime Replacement Tags.
You must specify a folder when you choose on the Move files option on any tab.
423
Problem Description
Solution
Using Digital Sender with File Options component.
If you place the File Options process component

directly after the Digital Sender, then it overrides the
Digital Sender options. If you have multiple process
components, and you decide to place a File Option
after your first process component, that first process
components success and failures will not be affected
by the File Options. If the File Option is in between two
different process components, then, the second process
component will be affected by the changes.
The service does not start.
When adding a new tab name, make sure the "File

Type Extension" entry does not include a leading dot.
For example, if the file extension is .tif, enter "tif",
without the leading dot.
Error message pops up when I decide to select the Move

files radio button, and create a new folder entering the
value Successfolder.
You must specify the complete path for any folder.

You have to specify a valid path, such as C:
\Successfolder. The full path is entered
automatically if you click the browse button (...) to
specify the path.
Fortis
Welcome to the Fortis component
Use the Fortis eConnector and Fortis Route components to process and store documents into the Westbrook Fortis
document management system. Fortis users can efficiently store content from a variety of sources into a database.
Once the content is captured, it becomes available for retrieval and collaboration across the network within the
organization.
Now you can design and implement workflow that capture electronic documents from a variety of sources such as
MFP devices, network/local folders, PC desktop, POP3email servers to manage and store your documents into Fortis.
The only difference between Fortis eConnector and Fortis route component is that the eConnector component
provides a document Pass-through option. This option, when selected, passes the document to the next component in
the process.
This component supports Fortis Version 2.5.
Getting started
Feature highlights
The Fortis eConnector and route components provide the following Fortis features:
Automate document routing into Fortis document management system.

Add metadata to documents for indexing.
Using this component

Using Fortis component:
Scan documents from a FTP site directly into Fortis: Design a workflow process by selecting FTP site that has a
series of files to be processed. You can configure the Fortis component to assign document fields, depending on
the Document Type that was selected. The document with the set attributes is routed directly into Fortis.
Capture electronic documents from a local/network folder directly into Fortis: Design a workflow process by
selecting Poll Directory capture component. From the component tray, select the desired process components
424
and select the Fortis route component for storing the scanned document into Fortis. You can configure the Fortis
component to assign document fields, depending on which Document Type was selected. With the Server running,
the walk-up MFP user (with or without authentication) enters a preconfigured function key on the control panel of
the MFP device, and the document along with the set attributes is routed directly into Fortis.
Configuring the Fortis component
General tab
Configure Fortis authentication and storage options on this tab.
Option
Description
Activate
Select this check box to activate the component in the

process. Other options on this tab are only available
while this option is selected.
User Name
Specifies the user name used to access the Fortis

document management system.
The user name is provided by the Fortis administrator.
Password
Specifies the password that is associated with the user

name.
Database
Click this option to use a database as the repository for

document metadata, such as information required to
locate a document. Click the browse button (...) to select
a Fortis database to which the user has been granted
access.
InBasket
Click this option to store documents in an In Basket.

Click the browse button (...) to select a Fortis In Basket
to which the user has been granted access.
Pass-through
Select this check box to pass documents to the next

component in the workflow process.
Document tab
Configure document options on this tab.
Option
Document Type
Description
Associates a document type with the captured document.
Click the browse button (...) to select from available
document types. This option is only available if the
user specified on the General tab has been successfully
authenticated by the Fortis system.
This option defines the nature of the contents of
a document, including all the fields used to index
documents of this type. Fields associated with a
document depend on the document type specified here.
For example a Medical Form has the name of the patient
and the doctor. The patient name and the doctor name
fields would be associated with that document type. The
fields are used for indexing the documents.
Folder
Select the folder that you would like to store the

document into. Click the browse button (...) to select
from available folders. This option is only available
425
Option
Description
if the user specified on the General tab has been
successfully authenticated by the Fortis system.
If the folder does not exist, the files are stored in the root
of the database. This component support creation of new
folders.
Description
Provides space to briefly describe the original document.
Fields tab
Fields defined on this tab allow users to provide information to the process at run time.
Option
Description
Add
You can create field values that get stored with the
document in Fortis. Click this button to open the Add a
property dialog box.
In the Add a property dialog box, select the properties
that you want to add to the file. The properties that are
available here depend on the document type selected on
the Document tab. you choose. Each document type has
a specific set of fields.
Modify
Click this button to modify the field value attributes for

the currently selected field.
Remove
Click this button to remove the currently selected field.
Fortis component RRTs

Component RRT ID
The RRT ID for this component is FTS.
Name
Description
ID
The unique identifier for the stored document, which can

be used by the eConnector in proceeding components.
Example: Configure a process with the Fortis eConnector and Send to Database Route component. When Send to
Database component is configured with the appropriate table, specify a field with the value of ~FTS::ID~. Once
the documents are successfully stored into Fortis and sent to the Send To Database component, the database will now
have an entry for the ID of the document saved.
There are no FRTNs for this component.
426

FortisBlue
Welcome to the FortisBlue component
FortisBlue component provides integration into FortisBlue, a browser-based content and document management
system. The documents as well as index data are stored into FortisBlue.
The component can be used both as a route or eConnector component.
Getting started
Feature highlights
The component routes files into the FortisBlue document management system.
The key features are:
Integration with FortisBlue allows loading data from the server (list of databases, folders, document types,
templates) and presenting it to the user in a friendly way to facilitate configuring of the component.
Renaming the documents according to a scheme specified by the user.
Support for index fields.
Using FortisBlue
Main examples of using FortisBlue.
The component is used to route documents to FortisBlue Content Management System from a variety of sources such
as MFP, network/local folders, PC desktop, POP3/IMAP email servers.
There are two main examples of using FortisBlue component:
An example of using the component to send documents from an MFP device

An example of using the component to send documents with bar code separation
How to route documents into FortisBlue

This is a simple example of using the FortisBlue component to route documents that are captured from an MFP
device.
1. Create and configure a workflow.
a) Select the type of MFP used for scanning.
b) Select the FortisBlue component as the route component.
2. Configure the connection parameters.
Select the document type and other properties of the documents on the Document types tab.
After a document is scanned and captured by the process, it is routed to a space on the FortisBlue server.
How to separate documents by barcode
This is an example of using the FortisBlue component to route documents with barcode separation.
1. Create a workflow with AutoCapture as a capture component and FortisBlue the route component.
2. In the AutoCapture component settings, create a form to capture documents.
3. Add a field to the form with the name BarcodeType, set it as a string field.
This field will be used for entering the barcode types.
4. Configure the connection parameters on the General tab of FortisBlue.
427
Select the document type and other properties of the document on the Document types tab.
Select Multiply document per file option on the Advanced tab.
Select barcode separation as a separation method.
Drag and drop the RRT, generated by the BarcodeType field of the AutoCapture component (~ACC::
%BarcodeType%~) into the barcode type field.
6. Capture the document with AutoCapture client, and in the BarcodeType field specify the type of the barcode for
separation.
a)
b)
c)
d)
The document will be routed to the FortisBlue system as multiple documents, separated by the specified barcode.
Note: Remember that you may enter only those types of barcodes that are supported by the server (see
Advanced Tab).
Configuring the FortisBlue component
General tab
This tab is used to set connection parameters to the FortisBlue Content Management System.
Option
Description
Activate
Activate the component according to a condition (see

Conditional Activation). This option is only present in
the eConnector.
Pass through

This option is only present in the eConnector.
Connection group
Server URL
Enter the address of the server. If the protocol is not

specified, http is used by default.
Select this check box to ignore errors when you connect

to the server using an invalid SSL server certificate. This
check box is only available when you enter an HTTPS
prefix.
Login
Enter the login that you use to enter the system.
Check this box if you want to obtain the password via

RRT at run time.
Password
The password to log in the system.
Password RRT

replaced by the actual password at run time.
Timeout
Specify the connection timeout in seconds. The default

value for timeout is 100 seconds.
Test connection
Click this button to test the connection to the server.

Note: The FortisBlue system retains user
credentials in the cache. If the configuration was
saved with valid parameters, the test will still be
successful if you reenter the configuration with
an invalid password.
Destination group
428
Option
Description
Database
Enter the target database name or click the browse

button (...) to select the database from the list of existing
databases.
Folder
Specify the folder, including the path to it, where the

documents will be stored. The folders can be separated
by a back or forward slash (\ or /). If the field is left
empty, the document will be uploaded to the root folder
of the database. If the folders specified in the path do not
exist, they will be created.
Rename file
Check this box to rename the uploaded file. Enter the

rename scheme into the text field. The default scheme is
~FTB::FileName~_~FTB::Counter,3~~FTB::FileExt~,
which renames documents by adding the count number.
For example, the file named Document.doc will be
renamed Document_001.doc if there are no documents
with the same name in the destination folder.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



429
Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
430

Constants
431
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
1Boolean
2, 3Any
432
Symbol
Description
Parentheses
(expression)
Result type
Operands type
Same as operand
Any
Document Types tab

Option
Description
Document type
Select the document type. This field is required.
Template
Enter the name of the OCR template. An OCR template

is a template for zonal OCR according to which the
document will be processed after being uploaded in the
system.
Index fields
This table contains index fields for the documents that

are routed to the FortisBlue system. Index fields contain
metadata about the document and facilitate searching the
documents in the system. Click Add to add a new field
(see Add/Edit Index Field).
When several values are specified for one index field, the
component will randomly choose one.
Ignore redundant fields
Select this check box to make the component ignore the

fields specified in the table but absent in the FortisBlue
server.
Add/Edit Index Field dialog box

Use this dialog box to specify an index field that will be added to the document.
Option
Description
Document type
Select the document type. Each document type has its

own set of fields.
Index field
Select the field that will be added to the list of index

fields. Each field can be added only once.
Type
This field displays the type of the field so that you know
in what format the value is expected.
Value
Enter the value of the field.
Advanced tab
Option
Description
Single document per file
Select this option if you want to upload a file as a single

document.
Multiply document per file
Select this option if you want to upload a file as

a multiply document. If this option is selected the
separation group settings are enabled.
Separation group
Convert files to JPG
Select this check box to convert an uploaded file into the

JPG image format.
433
Option
Description
By page
Select this option to separate the document by a specified

page count. The document will be separated into
documents that contain the specified number of pages.
Page count
Specify the page count in this field. You may specify

the page count manually or via RRTs of the previous
components.
Blank page separation
Select this option to separate an document by blank

pages.
Barcode separation
Select this option to separate a document by the specified

barcode.
Delete barcode page
Select this check box if you want to delete the barcode

page after separation.
Barcode type
Select a barcode type that will be used for barcode

detection. You may drag and drop the RRTs of the
previous components in this field. The RRTs must take
BT_AutodetectThe type of barcode will be

detected automatically. Use this option if you are not
aware of the barcodetype.
BT_AztecMatrix symbology that does not require
a surrounding blank "quiet zone".
BT_CodabarDiscrete and self-checking
symbology. Also known as NW-7, USD-4 or 2 of 7
code. It can contain numerical characters: 0..9 and
characters $ : / . + -.
BT_Code128Very high density alphanumeric
barcode symbology of variable length with 106
different printed barcode patterns.
BT_Code39Discrete, self-checking symbology. It
can have a variable length and encodes 26 upper case
letters A..Z, 10 digits 0..9 and 7 special characters
-, ., *, $, /, +, %, SPACE.
BT_Code93Alphanumeric, variable length
symbology. It can encode 26 upper case letters A..Z,
10 digits 0..9 and 7 special characters -, ., *, $, /, +,
%, SPACE.
BT_EAN13European Article Numbering consists
of 13 digits(12 data and 1 check).
BT_EAN8European Article Numbering
consisting of 7 digits of data plus 1 check digit.
BT_IATA25Variation of the Standard 2 of 5
scheme commonly used in the airline industry.
BT_Industrial25Symbology representing the
numbers 0..9, the start character and the stop
character.
BT_Interleaved25Numeric only barcode used
for interleaving pairs of numbers in a high density
barcode format.
434
Option
Description
BT_Matrix25Discrete, non-self-checking
numeric-only code, with an optional modulo 10
check digit.
BT_PatchSet of 6 distinct barcode patterns (1,
2, 3, 4, 6 and T) that are typically used as document
separators when scanning.
BT_PDF417Stacked barcode symbology. PDF
stands for Portable Data File. The 417 signifies that
each pattern in the code consists of 4 bars and spaces,
and that each pattern is 17 units long.
BT_PostNetPostal Numeric Encoding Technique
barcode which encodes a US zip code which may
contain 5, 9 or 11 digits (often called Zip, Zip+4 and
Zip+6).
BT_UCC128Structured data defined by UCC/
EAN organization.
BT_unknownAn unknown type of barcodes.
BT_UPCEA short form representation of a
Universal Product Code number. It has 6 digits with
an implied number system 0.
Note: The FortisBlue server recognizes only
barcodes of the types that are listed above; all
other types of barcodes will not be recognized
and the component will skip the documents at
run time.
Note: You may select only one separation
option.
Image Enhancement group

Deskew
Select this check box to correct misalignments on a skew

of the image.
Despeckle
Select this check box to remove noise from the image.
Delete blank pages
Select this check box to delete blank pages from the

document after uploading.
FortisBlue component RRTs

Component RRT ID
The RRT ID for this component is FTB.
The following tables describe internal and external reserved RTN values for this component.
Table 29: Internal RRTs
RRT Name
Description
~FTB::FileName~
~FTB::FileExt~
435
RRT Name
Description
~FTB::Counter,3~
An incremental counter of the files with duplicate

names within the destination directory, where 3 is a
number of digits used for the counter; for example,
~FTB::Counter,3~ will be replaced with 001. You
can change the number "3" to any other number from
range of 1 to 99 that will be used for the counter.
~FTB::GUID~
A global unique identifier generated at run time.
Table 30: External RRTs

RRT Name
Description
~FTB::DocName~
The resulting names of all routed documents separated

by semicolon.
~FTB::DocName,*~
The resulting name of an uploaded document, by

number.
~FTB::URL~
The URLs of all routed documents concatenated into one

string, separated by semicolons.
~FTB::URL,*~
The URL of a document defined by number.
~FTB::DatabaseGUID~
The GUID of the FortisBlue database into which the file

was routed.
~FTB::TypeGUID~
The GUID of the document type of the routed document.
~FTB::FolderGUID~
The GUID of the destination folder for the routed

document.
~FTB::DocGUID~
The GUIDs of all routed documents concatenated into

one string, separated by semicolon.
~FTB::DocGUID,*~
The GUID of an uploaded document defined by number.
~FTB::FileCount~
The count of processed files.
Example usage of an RRTN:

The RRT string ~FTB::FileName~_~FTB::Counter,3~~FTB::FileExt~ will be replaced with the value
Admiration_001.doc if the original file name is Admiration, its extension is .doc and it is the first file with
the name in the destination path.
SSRRT Name
Description
%a
%A
%b
%B
%d
%H
436
SSRRT Name
Description
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Example usage of an SSRTN:

The RRT string ~FTB::%Y~-~FTB::%m~ will be replaced by 2012-04.
The component cannot work with databases, that contain folder trees larger than 1800 folders. If database
contains 1800 or more folders, the component cannot display its folder tree during configuring and fails to upload
documents.
When the timeout is too small and the component receives timeout exception, the whole imported document will
be uploaded with GUID as a file name.
The component is certified to work with the FortisBlue server version 1.4.
Problem
The component fails to upload documents of 100 MB
and larger.
Solution
To make component correctly upload large
files to FortisBlue server you have to increase
FortisBlue service buffers and enable streaming
upload on the server. Open file C:\Program
Files\Westbrook Technologies Inc
\WTI.FortisBlue.Services\Web.config
(the path may differ depending on where the FortisBlue
server was installed) and complete the following steps:
1. Within XML path configuration/
system.serviceModel/bindings/
basicHttpBinding find the
node binding with the attribute
name="BasicHttpEndpointBindingCustom".
2. Set values of the node attributes maxBufferSize,
maxReceivedMessageSize, and
maxArrayLength to 1073741824. This
increases buffers to 1 GB.
437
Problem
Solution
3. On the same node, add the attribute
transferMode="Streamed". This enables
streaming upload support.
FTP Poll
Welcome to the FTP Poll component
FTP Poll is a Capture (source) component used to download files from FTP sites. This component scans FTP sites
listed in its configuration, looks for new files that match particular filter configurations, polls the files, and puts them
into knowledge objects. It also provides a scheduled activity for each site, which allows the FTP traffic to be targeted
during designated hours.
Getting started
Feature highlights
Major features of this component are:
Multiple FTP sites.

File name filter.
Scheduled download.
Transfer rate.
Using the FTP Poll component

Set up FTP Poll attributes as required by your business process and add Process and Route components to your
process. The files are automatically passed to the following component and, at the end of the process, they are kept
either in special "Processed" or in "Rejected" folders defined in FTP Poll configuration.
Configuring the FTP Poll component
Main component window
In the main component window you can create new sites, edit or remove the existing ones.
The component will scan the listed URLs and poll new files from them according to the settings of every site.
Option
Description
Add
Click this button to add a new site into the list. Add FTP
Site dialog box will open.
Edit
Select a site from the list and click this button to change
its settings. Edit FTP Site Properties dialog box will
open.
Remove
Select a site or several sites in the list and click this

button to remove the selected sites.
Add/Edit FTP Site dialog box

Use this dialog box to configure settings of a particular FTP site.
This dialog box consists of the following tabs:
Tab
Description
General
Use this tab to set the Site name and Description of the
FTP site
FTP
In this tab you can set FTP properties.
438
Tab
Description
Files
Use this tab to set files options.
Schedule
Use this tab to set periods of time during which the

component will check the FTP site at a given interval.
Components
Use this tab to configure other components in the

workflow.
Advanced
Use this tab to enable data flow control and set

maximum transfer rate.
General tab
Use this tab to set the Site name and Description of the FTP site
Option
Description
Site name
Enter the name of the FTP site, that will be used in the
workflow.
Description
Enter the description for the selected FTP site.
.
FTP tab
In this tab you can set FTP properties.
Connection group:
Site URL
Enter the URL of the FTP site in the following form:

[ftp ://]host[/ path]
Alternatively, you can enter the IP address or NetBIOS
name of the required machine.
Examples:
URLftp://mycompany.com
IP address197.168.0.163
NetBIOS nameMainFTPserver
Path
Specify the folder, from which the documents will be

captured on the FTP server. Click
to browse the
directories on the server through the Folder Path dialog
box.
Encryption
Select the security method to be used to establish the

connection with the server.
Use plain FTPNo security mechanism will be

used
Implicit FTP over SSLThe connection will be
established using implicit mode of invoking security.
Explicit FTP over SSLThe connection will be
established using explicit mode of invoking security.
Trust any certificate
Select this option to disable server certificate validation.
Passive mode
Check this option on if you want to use FTP that works

in passive mode.
439
Connection group:
Authentication group:
Authentication required
Check this option on if the FTP site requires login and

password.
Login
Enter the account user name that will be used to connect

to the FTP server.
Password
Enter the password for the user name that will be used to
connect to the FTP server.
Test connection
Click this button to check connection with the defined

FTP.
Folder Path dialog box

Use this dialog box to select folders from the folder tree on the FTP site.
This dialog box contains the directories of the server. Select the folder in the folder tree, where you want to capture
the documents.
Files tab
Use this tab to set files options.
Option
Description
File filter
Input filter for files. Only files matching the filter will be
downloaded by FTP Poll. By default, the filter is set to
*.* (this means that any files will be downloaded). "*" is
a wildcard meaning that any possible characters will be
accepted. You can enter several file filters, separated by
the ; (semicolon) without any intervening spaces.
Working directory
Files will be downloaded to the defined folder. If the

folder does not exist, it will be created by the component.
Note: If the process contains two site
configurations that are configured to download
files from the same FTP site, use different
working directories for these configurations to
avoid conflicts during downloading.
Keep processed files
If a file is successfully processed through the workflow,

that is, if it reaches the destination, it will be placed into
this directory.
Keep rejected files
If this check box is selected, files that failed to process

through the entire workflow will be copied to the folder
defined here.
Schedule tab
Use this tab to set periods of time during which the component will check the FTP site at a given interval.
Option
Description
Start
Define time at which download should start.
Finish
Define time at which download should stop. If the finish

time is earlier than the start time, the component will
start at the start time and continue checking files until the
finish time next day.
440
Option
Description
Interval
Set time interval at which the component will check the

FTP site for new files to be downloaded.
Start days
Select days of week for which these schedule settings

will apply.
Note: If the schedule is disabled, then all files
found in particular FTP sites will be polled by
the component. They will not be passed to the
next component in the process until they all are
polled.
Components tab
Use this tab to configure other components in the workflow.
To configure settings of a component, select a component in the list of components and press the browse button.
Note: FTP Poll is a blocking component, which means that it requires configuring of other components that
follow FTP Poll in the processing chain.
Advanced tab
Use this tab to enable data flow control and set maximum transfer rate.
Maximum transfer rateSet the maximum transfer rate. This is a limitation on the data flow.
Note: The value should be between 1 and 100000 kbps.
FTP Poll component RRTs
Component RRT ID
The RRT ID for this component is FTP.
The following table describes the reserved RTN values for Schema field of this component.
Note: The RRTs are generated for each file separately.
Name
Description
SiteName
The original FTP site name, which is set in the sites

configuration on the General tab.
SiteDescription
The FTP site description, which is set in the sites

configuration on the General tab.
SiteIP
The site URL, which is defined in the sites configuration

on the FTP tab.
Path
Path to the folder where the file is placed.
FileName
Name of the file (without file path and extension, for

example, File1 - NOT File1.txt or C:\Temp\File1.txt).
FileExt
The file extension(with dot, for example, .txt).
DatePolled
Date of download.
441
Name
TimePolled
Description
Time of download.
The RRT replacement string ~FTP::SiteName~~FTP::SiteIP~is replaced with the value Music192.168.0.115
if the defined site name was Music and the selected IP was 192.168.0.115.
FTP service uses the default port (21) for non-secure connection and explicit mode, and 990 port for implicit
mode. Non-standard settings of FTP service are not supported.
The number of downloads that can be created depends on many factors, such as the number of running system
processes or services. (On the average, the maximum number of downloads is about 40.) In order to be able to run
more downloads it's necessary to apply additional settings.
Note:
The recommended way is to allow the Capture Server's Windows service to interact with desktop. To do
this, go to Administrative Tools, click Services, point to the Server's service, select Properties from the
context menu. In the Properties dialog box navigate to the "Log On" tab. In the "Log on as" group, select
the "Local System account" radio button, check the "Allow service to interact with desktop" check box,
and press OK. If the service is running you will need to restart it.
The other way to allow more downloads requires editing the registry using the Registry Editor.
WARNING: Using Registry Editor incorrectly can cause serious, system-wide problems that may require
you to reinstall the system to correct them. When the "Allow service to interact with desktop" option is
checked for the Server's service, it runs in the interactive window station. If this option is off, the service
runs in the non-interactive window station. By default, the non-interactive window station has a desktop
with 512 kilobytes heap, whereas the desktop of the interactive window station has 3 megabytes heap.
The number of downloads is limited by the heap size. If you wish to run the service in the non-interactive
window station (with "Allow service to interact with desktop" option switched off), you may increase the
heap size of the non-interactive window station's desktop. Please read the Microsoft Knowledge Base for
details, which you can find in the article INFO: COM Servers Activation and NT Windows Stations in the
"Window Stations and Windows NT Resources" section.
The number of scheduled downloads that can run simultaneously depends on many factors, such as available
physical memory, processor performance, the average time required for processing of one polled file, and the
number of files coming from FTP sites. (Please note that this section is applicable to the scheduled downloads
only.) For each download working in scheduled mode, the component collects messages that will be output to
Status Monitor and to log files. These messages are output and deleted from the memory each time the server
process runs (the frequency of running is set up in server process information dialog). The number of messages
stored in memory can grow if there are too many files to download, and the server does not have enough time
to process them. If this occurs, you need to adjust scheduling settings, and possibly the frequency of FTP Poll
process as well. If you set up the server to make a smaller pause between runnings of the process, it will flush the
status messages more often, and FTP Poll will consume less memory space. If you schedule FTP polling with a
longer interval, or within a shorter period of time, the number of messages will decrease, which results in smaller
memory space used as well. In order to determine, whether it is necessary to adjust your polling process, you can
look at the log files created in the debug mode. There are a number of messages containing 'message generation'
and 'message output to the server' times. If after a period of work, there are messages in the log file which were
output long after their generation (the time difference is significantly more than the process frequency), this means
that the process needs to be adjusted.
If the process contains two site configurations that are configured to download files from the same FTP site, use
different Working directories for these configurations to avoid conflicts during downloading.
There is no information available.
442
Fujitsu Network Scanner

Welcome to the Fujitsu component
Fujitsu component allows direct integration of Fujitsu fi-6010N and fi-6000NS network scanners with the workflow
server. This component provides key functionality such as:
Multi-Layer menu definition for ease of use and quick indexing.

Centralized meta-data form definition providing full centralized control over the indexing forms.
Support for various meta-data field types such as Text, Numeric, Checkbox, Date/Time, AddressBook, List,
Button, and Tree.
Support for Single Touch Scan when there is no need to enter document meta-data at the scanner panel.
Support for various Scan Setting parameters; option to allow the user change the scan setting at the scanner panel.
Device groupings allow devices to be grouped into functional or organizational groups.
Dynamic forms with scripting lets users browse to desired Document Management Systems to display document
profiling information.
Windows and Novell authentication at the network scanner panel.
In addition to Windows and Novell authentication, custom authentication allows you to configure specialized
authentication methods (for fi-6010N scanner only).
Getting started
Device setup
How to upload the client add-in to a device
After you install the Fujitsu component, the client add-in can be installed from the Fujitsu Network Scanner
folder.
There are two types of add-ins for the fi-6010NS US\European and SnapScanN1800 devices:
AddinModule05.00.03.xxxxx_auth.cab supports AutoStore authentication.

AddinModule05.00.03.xxxxx.cab does not support AutoStore authentication.
The difference between the two is that the AddinModule05.00.03.xxxxx_auth.cab blocks other Fujitsu
applications. In both cases, the string xxxxx refers to the highest number.
Note: See How to Use the Fujitsu Component when there is no support for AutoStore authentication.
1. Open the device web page by entering the device IP address (http://ip_address) in a web browser.
2. Log on with administrator credentials and download the fi Network Scanner Admin Tool.
3. Install the fi Network Scanner Admin Tool.
4. On the Windows Start menu, click All Programs > fi-Scanner > fi Network Scanner Admin Tool to start the
tool
5. Connect to the device IP address.
6. Log on with fi-maintenance/fi-scanner6-maintenance credentials.
7. Go to the Maintenance/Add-in install page.
8. Browse to the plug-in for the model, then click the Install button:
For device model
Browse to
fi-6000NS US
install_directory\Distributables
\Fujitsu Network Scanner\EN
fi-6000NS European
\Fujitsu Network Scanner\IN
fi-6010NS US\European
\Fujitsu Network Scanner\IS
443
For device model

SnapScan N1800
Browse to
\Fujitsu Network Scanner\IS
9. Wait for the scanner to reboot itself.

Supported devices
This component supports:
fi-6000NSUS device (.Net Framework 1.1 on the device)

fi-6000NSEuropean device (.Net Framework 2.0 on the device)
fi-6010NSUS device (.Net Framework 2.0)
fi-6010NSEuropean device (.Net Framework 2.0)
SnapScan N1800
How to modify panel display label

This procedure describes how to modify the AutoStore name and the button's image on the device - US Device or
European Device.
The procedure outlined below describes how you can modify the "workflow" button label and image that is displayed
on the panel of the network scanner upon logging into the scanner. By default the "workflow" label and image is set to
"AutoStore" and its logo.
This procedure is applicable to both the fi-6000NS and fi-6010NS devices.
1. Select the AddinModule*.cab file from the following location
Device
Location
US device
Install Directory>\Distributables
\Fujitsu Network Scanner\en
Europe device
Install Directory>\Distributables
\Fujitsu Network Scanner\in
2. In order to extract and rebuild AddinModule* .cab file you can go to http://www.powerarchiver.com/download/
and download the PowerArchiver software.
3. Extract AddinModule*.cab file using the PowerArchiver software.
4. Go to this path \AddinModule*\C\Aries\Exporter\AutoStoreClient\
5. Select the file Exporter.dll.config.
6. Open this file in a notepad.
7. Modify the value at this location from AutoStore <add key="AppName" value=" Autostore "/> to any desired
value.
8. Save and close this file.
9. Go to this path \AddinModule*\C\Aries\Images and you will notice that there is one folder in US device and
several folders in Europe device.
10. The following list of numbers stands for the corresponding language (Codepage):
1031 Deutsche
1033 US
1036 French
1040 Italian
1041 Japanese (not supported by this version)
2057 UK
3082 Espaol
11. To change the buttons image on the device, these are the stages they stand for.
PBMainMenuButtonD.bmp - Disabled state
444
PBMainMenuButtonN.bmp - Normal state

PBMainMenuButtonNF.bmp - Normal Focused state
PBMainMenuButtonS.bmp - Selected state
PBMainMenuButtonSF.bmp - Selected Focused state
Image Properties of the button:
Width : 374 Pixels

Height: 104 Pixels
Horizontal Resolution: 149 dpi
Vertical Resolution: 149dpi
Bit depth: 24
Frame Count: 1
12. Change the images for the language which you are going to use.
13. After the images and text are modified you have to rebuild the AddinModule*.cab file with all the files included.
14. Select the folder \AddinModule* from \AddinModule*\C\Aries\ location:
a) Right click and click compress with options.
b) Modify the output file name. Choose the CAB option.
c) From Compression type field select MsZIP type.
d) Click on Add to rebuild the .CAB file.
15. Upload the plugin (.CAB file) to the appropriate device and the text and the buttons will be modified.
Using the Fujitsu component
In this example we will create a workflow to capture documents from Fujitsu Network Scanner. The user, at the
scanner panel, will be able to enter a string value or select a string value from a preconfigured list. This string value
will be used to create a folder name dynamically, where the captured file will be stored.
Configuring the Workflow

Using the Fujitsu 6001ns Device
While Using the Addin Module 05.00.03.xxxxx.cab Client
Using Email Option on the 6010 Device
Using the Fujitsu 6000ns
How to configure the workflow

1. Drag and Drop Fujitsu Network Scanner and Folder Store components in the Process Designer.
2. Open the properties of Fujitsu Network Scanner component.
3. On the Preference tab, leave the port number is set to the default, 3255, and select the Encrypt all connections
check box.
4. Click the General tab, select Default Form and click the Edit button.
5. Clear the Single Touch Box check box and select all Allow Changes check boxes.
This allows users to change scan options at the device panel.
6. Click the Fields tab and create a new field.
a) Select List from drop-down list of available types.
b) Change Name to Folder.
c) Change Display Name to Folder Where to Save.
d) Mark the field as Required.
7. Click the properties button (...) of the field.
a) Enter several values and labels.
b) Select one of them, so that it appears selected by default on the device side.
c) Select the Allow to edit value on device side check box.
d) Click the OK button.
445
8. In the Form Setting dialog box, click the Components tab.

9. Click the properties button (...) for the Folder Store component.
10. In the Folder Store properties, configure the following parameters:
Option
Folder Path
Setting
C:\dest\~FUJ::%Folder%~
Drag the RRT from the Fujitsu Network Scanner RRTs

in the Available RRTs window.
Rename file
No
File names are already unique so we do not need to

make them unique here.
11. Click the OK button in Folder Store component properties.
Do not create folders now.
12. Click the OK button in Form Settings dialog, and then click OK in Fujitsu Network Scanner configuration
dialog.
13. In , click File > Save, and save the workflow as FujitsuDemo.cfg, then close the Process Designer.
14. Start the process from Service Manager.
How to use the Fujitsu 6010ns device
1. Upload and install the client add-on.
See How to Upload the Client Add-in to a Device.
2. Login to Fujitsu Network Scanner (user id/password):
as-maintenance/as-scanner6-maintenance credentials
3. Click the Workflow button.
If you do this for the first time, the error dialog will pop up.
4. Click OK and then click the Maintenance button
5. In the Connection Properties window, enter the IP address or DNS name of the workflow server, click the
Encrypt Connection button and then click OK.
6. In the main screen of workflow server client, go to the Default Menu and then Default Form.
7. Enter a folder in the Folder Where To Save box (such as Folder3).
8. You can change Scan Settings or turn on/off Scan viewer.
9. Click the Scan button.
10. Preview scanned images and then press Send.
How to use the AddinModule05.00.03.xxxxx.cab client
1.
2.
3.
4.
5.
6.
Connect to the fi-6010N device.

Login on to the device using fi Network Scanner Admin Tool (admin/password)
Select Network Settings from the tool bar
Select Login LDAP server from the list on the left hand side
Select method LDAP option
For Address, specify the LDAP server (ip address/name).

7. Enter Search Base (DN) enter the distinguished name for the search base.
For example, CN=users,DC=nsilab,DC=local.
8. Save the settings and exit out of the fi Network Scanner Admin Tool.
9. Create a logon name called as-maintenance on the LDAP server and assign a password to it.
10. Start the AutoStore server.
446
11. On the device, log on using as-maintenance and the assigned password.
How to use the email option on the 6010 device
1.
2.
3.
4.
5.
6.
Log on to the device using fi Network Scanner Admin Tool (admin/password).

Select Network Settings from the tool bar.
Select SMTP Server option from the list on the left hand side.
Enter the SMTP Server address.
Save the settings and exit out of the fi Network Scanner Admin Tool .
Log on to the device as guest or as-maintenance.
You will see the enabled email button.

How to use the Fujitsu 6000ns
1. Log on to Fujitsu Network Scanner.
You can use guest/guest credentials.
2. Press the Workflow button.
When you do this for the first time, the error dialog will pop up.
3. Click OK and then click the Maintenance button.
4. In the Connection Properties window, enter the IP address or DNS name of the workflow server, click the
Encrypt Connection button, and click OK.
5. In the main screen of the workflow server client, go to Default Menu, then Default Form.
6. Enter text in the Folder Where To Save field or select filed value from the list (for example Folder3).
You can change Scan Settings or turn on/off Scan viewer.
7. Press Scan button.
8. Preview scanned images and then press Send.
Configuring the Fujitsu component
General tab
This tab defines menu structure that will be shown on the Fujitsu Network Scanners. The devices can be grouped
based on their IP address. Each group of devices can have its own menu structure. By default there is a single group
called Default Device Group. If you do not configure additional groups, all devices pointed to the workflow server
will display the menu structure under Default Device Group.
Use this tab to add, edit, or remove the following interface elements for the component.
Interface Element
Description
Group
Groups provide a container for exposing menus and

forms to users.
Menu
Menus present a hierarchical list of options for capturing,

processing, and routing documents.
Form
Forms allow users to enter data that is sent to

components in a process.
You can create additional groups and assign devices to the newly created groups. This way even though all devices
are connecting to the same workflow server, they can be used for different functions. Drag and Drop to change the
order of menus and forms that appear on the scanner control panel.
Option
Add
Description
Click this button to create an interface element:
Group
Menu
447
Option
Description
Form
Edit
Click this button to edit the currently selected group,

menu, or form.
Remove
Click this button to remove the currently selected group,

menu, or form.
Group
Groups provide a container for exposing menus and forms to users.
Click Add > Group on the General tab to add a group. Configure the following options for a group.
Option
Description
Name

string value describing the name of the group. This
name does not appear on the panel and it is used strictly
as logical group name. This component is equipped with
a default group called "Default Device Group". You may
add menus and forms to this group.
Associated MFPs
Enter the IP address or the host name of the devices that

belong to this group. Click Ping to validate the host
name or IP address of the scanner.
Global Authentication
Specify whether to use component or group level

authentication.
Select this check box to use component level

authentication.
Clear this check box to use group level
authentication.
Menu
Menus present a hierarchical list of options for capturing, processing, and routing documents.
Click Add > Menu to add a menu to a selected group. Add a menu to create a hierarchy. Menu entries guide scanner
users to select the workflow that will accomplish a task.
Field Name
Description
Name
Enter the name of the menu entry. This name must be

unique among the menus of the current level.
Display Text
Enter the name that as you want it to display on the

scanner panel.
Button Images
Text Position
NormalBrowse to the image that is displayed for

this menu option.
FocusedBrowse to the image that is displayed
when focused on this menu option.
PressedBrowse to the image that is displayed
after the menu option is selected.
Position of the text on the button can be moved from 0 to

100 pixels
448
Form
Forms allow users to enter data that is sent to components in a process.
When setting up a form, configure options on the following three tabs:
General Tab
Fields Tab
Components Tab
Appearance Tab
General Tab
Option
Description
Name
The name of the form to be displayed on the Fujitsu

scanner. For example, if this form is used to send the
scanned documents to the users home directory, then
you can name the form Scan to Users Home Directory.
This name must be unique among the forms of the
current level.
Single Touch Scan
Select this check box if you do not want the user to enter
any indexing data about the document. By selecting this
option, the scan will start immediately after the user
presses the "form" button on the device.
Scan Settings
This table lists all the available Fujitsu Network Scanner

scan settings. In the Value column you can set default
scan settings, which will be used if the user does not
change the setting at the device panel.
Select the Allow changes check box on each setting to
provide the user the ability to change setting from the
device panel. See Fujitsu Operators guide for detailed
description of each scan parameter.
Max Page Count per BatchA batch can be

from 1 to 999. The default is 0, which is the same as
specifying 999. If this is set to 2, the user can scan
2 pages at a time. The user then has to click Scan
More to continue scanning to add to the existing
batch.
Color ModeSelect from Auto, Color, Gray Scale
(6010) or Black & White (6000), Black & White
(6010).
Paper Size (mm)Select from the drop-down list.
By selecting the custom option, you can enter paper
height and width.
Regular paper sizeWidth ranges from 1.0mm
to 215.9mm (8.50 inch), Height ranges from
1.0mm to 355.6mm (14.00 inch).
Long pagesWidth ranges from 1.0mm to
215.9mm (8.50 inch), Height ranges from 1.0mm
to 863.6mm (34.00 inch).
ResolutionEnter the resolution level that is
desired.
449
Option
Description
Dynamic Form
Scan ModeSelect Simplex to scan the front side

or Duplex to scan front and reverse sides.
File FormatSelect from TIFF, MTIFF, JPEG
(JPEG format is not compatible with Black & White),
and PDF
PDF PasswordIf PDF is selected for File
Format, you can select this check box and provide a
password for opening the PDF file.
Searchable PDFWhen the file format is PDF,
the scanned data can be converted to a searchable
PDF. You can select which pages are to be made text
searchable. This functionality works with US and
European devices.
BrightnessSelect a brightness level by moving
the bar.
ContrastSelect a contrast level by moving the
bar.
Auto Page OrientationAutomatically rotates
each scanned page that contains text through 0, 90,
180, or 270, so the text is upright.
Blank Page SkipThis feature removes blank
pages from the scan job. This feature is useful when
scanning both one-sided and two-sided documents
in Duplex mode. When this option is checked, the
reverse sides (blank pages) are removed.
Multi-feed DetectionWhen two or more sheets
are fed simultaneously into the scanner by and
automatic document feeder (ADF), this setting
detects multi-feeds.
Enable Dynamic FormStandard behavior of a
form can be modified by responding to events. This
check box allows the workflow server to load form
snap-ins. Here are some examples of what enabling
dynamic forms can do:
Add and remove fields.

Change field contents (Example: load the contents
of a list field from a database).
Validate field contents before the document is
scanned into the server.
Snap-in pathPath to the compiled snap-in (.net
assembly) that contains the code to respond to form
and field events. If you have an existing snap-in you
want to use, click the browse button (...) next to the
Snap-in path box. Create/Edit Snap-in:You can also
click the Create/Edit Snap-in button to open a code
editor window with basic snap-in code.
For details of the code editor window and the object
model used to respond to form and field events,
please refer to the Fujitsu Capture Component Snapin documentation by clicking Help in the code editor
window.
450
Option
Description
Source PathThe path to the source code of the

snap-in. This path is used by code editor to compile
the snap-in only during design time.
Form is LoadedSelect this check box to cause
the form to initiate an event every time the user
enters the form.
Form is SubmittedSelect this check box to make
presses Scan button in this form.
Fields Tab
Configure the indexing fields that will be presented to user. Add fields by clicking on the New field button appearing
as the first column header and labeled with N. Once you have added the first row, you can tab through to get
additional fields added.
Option
Description
Name
The field name should be unique among the other fields

within this form.
Display
The text which is displayed above the field at the device

panel.
Size Type
A field can be full sized or half sized. A full sized field

takes the entire space form the left margin to the right
margin on the scanner panel, a half sized field takes only
half the space between the margins.
Type
A field type represents the format by which data is

collected at the device panel. Regardless of field type,
the result will be in text format. The following field
Required Field
Text - Allows a user to enter unformatted text.

Numeric - Allows a user to enter numbers (with or
without decimal point).
CheckboxAllows a user to set yes/no or true/false
values by pressing a button.
DateTimeAllows a user to enter date and time
information in different formats
ListAllows to present users with a list of choices
from which users select the desired item. Use this
field type if you want a text field with auto complete
capabilities. If a list of choices is too long, the list can
be made searchable.
AddressBookAllows a user to perform a search in
LDAP directory.
ButtonAllows a user to raise an event on server
side.
TreeAllows to present users with a list of choices
in a tree from which users select the desired item.
Select this check box to require the user to enter a field

value at the scanner panel.
451
Option
Description
Notify Server
If checked, this field triggers an event when the value

of the field changes. You can respond to this event in
the snap-in that was configured for the dynamic form
section in the General tab. For details on how to respond
to form and field events, refer to the Fujitsu Capture
Component Snap-in documentation.
Properties
Allows editing additional properties of the field type.
Components Tab
Configure the component for this form by clicking the Properties button (rightmost column on each row). The
configuration window for the component will be displayed. Refer to the help for the component for instructions to
configure.
Appearance Tab
Option
Description
Display Text
Enter the form name as you want it to display on the

scanner panel.
Button Images
Text Position
NormalBrowse to the image that you want to be

displayed for this form.
FocusedBrowse to the image that you want to be
displayed upon pressing this form.
PressedBrowse to the image that you want to be
displayed after the form is selected.
The position of the text on the button can be moved from

0-100 pixels.
Preferences tab
In this tab, you can specify the location where the server will store the program files for the job that is being
processed.
Option
Description
Port Number
Enter the port number used by the scanner to

communicate with the Server. The device must be
configured to use the same port number to communicate
with the server. If the device is having problems
communicating with the server check the port settings
on the server to make sure they match the device port
number. Also make sure there are no firewall equipment
blocking the specified port.
Home Folder

Encrypt all connections
Check this option to encrypt all communication between

the device and workflow server.
452
Option
Keep
Description
Processed FilesSelect Processed files to keep a copy
of all files that are processed without errors. Enter the
directory where these files will be kept.
WarningIf this option is enabled, a copy of every
file that has been routed successfully is saved in the
Processed Files directory. Make sure that proper disk
storage is allocated when using this option
Rejected FilesSelect Rejected Files to keep a copy
of all files that failed to be process entirely. Enter the
Important: The service account for the service
must have write permissions on the Processed
Files and Rejected Files directories.
Server Timeouts
Form Inactivity TimerThe amount of time

in minutes that a form can be inactive before the
corresponding server object is deleted.
For example if the user enters a form and does not press
any other button within 30 minutes (default interval),
the form on the server side becomes unavailable and as
a result the following message is displayed to the user:
Server object does not exist.
When a user makes additional calls to the form on the
server side (by manipulating the fields that have server
side events or by pressing Scan setting button), the Form
Inactivity Timer is reset to 30 minutes again from the
moment the call takes place.
Note: If you expect high volumes of scanning
to occur in one scan job, it is recommended to
adjust this parameter to be set to a value larger
than maximum scan time.
Authentication tab
Set up the authentication attributes for fi-6010 NS devices in this tab. Contents of this tab do not apply to fi-6000 NS
devices, as authentication is not supported by this model.
Option
Authentication Type
Description
Choose the authentication method to be used.
NoneNo authentication method will be used.

StandardUses Active Directory or an LDAP
server to authenticate users. After you select this
option, configure the Standard Authentication and
User Info Lookup settings.
NetWareUses NetWare authentication. After
you select this option, configure the Netware
Authentication settings.
CustomAdministrator defines prompts for
authentication for a custom application. After
453
Option
Description
you select this option, configure the Custom
Standard Authentication
Standard authentication is used to authenticate a user in

the following cases:
Against the Active Directory domain which the

AutoStore server is a member
Against the local user database of a standalone
AutoStore server (workgroup environment)
Against another LDAP server
Choose the correct option for your authentication

environment:
Windows BindThis option is selected by default.

If authentication occurs within the same Active
Directory domain, the entry for Server or LDAP
Path can be omitted. If authenticated against the
local user database, the LDAP path should contain
WinNT://autostore_server_NetBIOS_name
.
Simple BindThis option is used for third party
LDAP servers. The full LDAP path is required in the
format LDAP://ldap_server,port . Check
with your system administrator if you are uncertain
about what path to use. These are the default LDAP
ports:
Standard LDAP: 389

Active Directory Global Catalog: 3268
LDAP over SSL: 636
Active Directory Global Catalog over SSL:
3269
For either Simple Bind or Windows Bind, you can

select the following options:
Fast BindSelect this check box to have the Active

Directory or LDAP server return a limited set of
user attributes to the workflow. If you do not select
this check box, all user attributes are returned to the
workflow server.
Use SSLSelect this check box to encrypt
communications between the workflow server and
the Active Directory or LDAP server. If you do
not select this check box, the connection will not
be encrypted. To use this option, you must have a
server certificate for the ADAM service. If the LDAP
server is in a different domain from the workflow
server, enter the server name and port number (that
is, LDAP://server_name,port ). Click Test
to verify that the user name created on the server
authenticates successfully.
Server BindIf this option is disabled, the Active
Directory or LDAP server will attempt to connect to
454
Option
Description
the DNS server in order to resolve the IP address of
the Workflow server.
Refer to the Microsoft web site for more information
about setting the LDAP bind options.
NetWare Authentication
This authentication method prompts the user for a

NetWare user name, password, context and tree.
NDS TreeEnter the default NDS tree.

NDS ContextEnter the default NDS context.
If the device is configured to use an authentication

server with the authentication type being NDS, then the
provided credentials will be used by workflow server. If
the authentication type of the device is other than NDS,
then in addition to the workflow server logon screen, the
device authentication screen is displayed to the user.
Custom Authentication
When Custom is selected for Authentication Type, the

administrator defines prompts that are displayed to the
user. An event is sent to the server when a user logs in.
The administrator must provide the .NET plug-in DLL
that responds to the event.
Use LDAP search to retrieve email
Snap-in pathThis is the path to the compiled

Snap-In (.NET assembly) that contains the code to
respond to form and field events. You can click the
browse button (...) to locate a .NET assembly file
containing an existing Snap-In.
Source pathThis is the path to the source code
of the Snap-In created by the built-in Snap-In editor.
You can use this option to compile a source file
at startup instead of using the Snap-In path for a
compiled assembly.
Create/Edit Snap-inClick this button to create
or edit a Snap-in DLL. A sample custom script is
available with this component. For details about the
code editor window and the object model, click the
Help button in the code editor to refer to the Fujitsu
Capture Component Snap-in Documentation.
Select this check box to have the server look up the

email address and other attributes of the authenticated
user on a designated LDAP server. Click the Configure
button to configure the LDAP settings in the LDAP
Lookup Settings dialog box.
Note: When Windows authentication is used,
the email address is retrieved automatically
as part of the authentication and as a result an
LDAP search is not required if only the email
address is needed.
For information about specifying the LDAP server
settings, see LDAP Lookup Settings Dialog Box.
455
LDAP Lookup Settings dialog box

This dialog box specifies settings to look up the email address and other attributes for an authenticated user on an
LDAP server.
Option
Description
Search Root
Enter the distinguished name for the node where the

search should start. No value is required if Windows
authentication is used. Any value entered must begin
with LDAP://.
The following format must be used:
LDAP://ldapserver.domain.com:port/
OU=Users,DC=domain,DC=com
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636
Active Directory Global Catalog over SSL: 3269
If the field is left blank, then by default the starting point

of the search will be the root node of the directory tree.
Search root patterns for different cases are shown below.
Authentication
Specifies the authentication type.
TypeAnonymous, SSL, Windows or Simple

Username//PasswordIf SSL or Simple is
selected, specify the username and password that will
be used for authentication.
Directory Search
Two LDAP attributes are searched. The default attributes

for Active Directory Server are "samAccountName" for
Match Username Against and "mail" for Get E-mail
Address From.
Test Lookup
To test the search settings, enter a sample user name in

the Username and click the Test button.
Search Root Patterns for Authentication

Authentication/Use Case
Case 1: Windows/Used when
AutoStore server belongs to the
Active Directory domain. Username
and password should be left empty.
Case 2:Windows/Used when

Search Root Patterns

Empty
Result
Credentials of the user under which
Autostore server is running will be
used.
Searches through all containers in
Active Directory to which AutoStore
Server belongs.

LDAP://distinguished_name_of_container
used.
Searches within a specified container

and its child container.
456
Result
Example: LDAP://
OU=Dept,DC=md,DC=nsi,DC=com
Case 1: Simple,SSL or Anonymous/
Used when either AutoStore server
is not a part of the domain or it is
necessary to conduct search on nonactive directory server.

LDAP://server_name:port
Example: LDAP://
abcweb.md.nsius.com:389
User name and password are

necessary when Simple/SSL type is
used.
Searches through the entire LDAP
tree on the specified server.

LDAP://server_name:port/distinguished_name_of_container
and its child container on the
specified server.
Example: LDAP://
abcweb.md.nsius.com:389/
OU=Dept,DC=md,DC=nsius,DC=com
How to obtain an SSL certificate

Refer to Microsoft's web site for the latest updates to this procedure.
[.NET] Using SSL with ADAM
How to obtain a server certificate on a Windows 2003 Server. If you already have a certificate, import it into your
"Personal store" and skip to the second section on Using the certificate with the ADAM service.
To create a certificate you need to install IIS and Certificate Authority. For information on how to install IIS refer to
the Microsoft website. To install a Certificate authority select the Certificate services checkbox.
Note: IIS should be installed before or at the same time as you install the certificate services.
Once the installation is complete, request a certificate using your browser (address: http://localhost/certsrv):
1.
2.
3.
4.
5.
6.
7.
8.
9.
Click Request a certificate.

Click Advanced certificate request.
Click Create and submit a request to this CA.
In the Name box, type the full DNS name of the server.
Make sure Type of certificate is "Server authentication certificate".
Select PCKS10 as the format.
Optional: Optionally, fill in the other information.
In the Friendly name textbox, write the full DNS name of the server.
Click the Submit button.
You have now created a certificate request. To create a certificate we need to process the request:
10. Open Control Panel > Administrative Tool > Certification Authority.
11. Browse to the "Pending requests" folder.
12. Locate the certificate request, right-click it, and click All tasks\issue.
The certificate has now been created and resides in the "Issued certificates"-folder.
Next we need to download and install the certificate:
13. Open http://localhost/certsrv.
14. Click View the status of a pending certificate request.
15. Click the certificate request.
457
16. Click the certificate to install it.

Using the certificate with the ADAM service
To let our ADAM service use the certificate we need to

put the certificate in the personal store for the ADAM
service.
17. On the Start menu, in Run, type mmc.

This open the Microsoft Management Console.
18. Click File > Add/Remove snap-in.
19. Click Add and select Certificates.
20. Select Service account.
21. Select Local computer.
22. Select your ADAM instance service.
23. Add a new "Certificate" snap-in, but this time select "My user account" instead of "Service account".
24. Click Close and OK.
25. Open the "Personal"-folder under the "Certificates - Current user"-tree.
26. Select the certificate and copy it into the same location under "Certificates - adam instance name".
27. Give the ADAM service account read permissions to the key using winhttpcertcfg (best practice) or by browsing
to C:\Documents and Settings\All Users\Application Data\Microsoft\Crypto\RSA
\MachineKeys.
If these permissions are not set correctly you will get an error in the event log: Schannel ID: 36870 "A fatal error occurred when attempting to access the SSL server credential
private key. The error code returned from the cryptographic module is 0x6.
28. Restart your ADAM instance.
Verifying that SSL is working
The remaining steps verify that SSL is working with

ADAM.
29. Run the ADAM Tools Command Prompt from your ADAM program group.
30. Type "ldp" and press Enter.
31. Click Connection > Connect.
32. Type the DNS name of your server in the server textbox.
localhost will not work as the DNS name is checked against the certificate
33. Enter the SSL port of your ADAM installation (636 or 50001 or whatever you chose during the installation of
ADAM).
34. Select the SSL checkbox and click OK.
If the installation was successful, you should get a lot of text in the right window and be able to bind using the
"Connection \ bind..."-functionality.
If you still get the 8009030e No credentials are available in the security package after
the import, or you get an error when importing the keys into the LOCAL_MACHINE\Personal store, check that you/
administrators have full access to C:\Documents and Settings\All Users\Application Data
\Microsoft\Crypto\RSA\MachineKeys. Try importing the certificates directly into both LOCAL_MACHINE
\Personal and ADAM\Personal instead of copying them for the Current_user store.
RRT Format tab
This tab allows you to configure the format of RRTs that represent date and time.
# of Received Time RRTsUse this field to specify the number of RRTs that represent Received Time. For
example if you set this value to 2, then 2 sets of RRTs (representing the Scan Time Stamp) will be available for use.
The grid allows you to specify which time format a particular date-time RRT will have.
The Time Stamp list shows some examples of date time formats. You can drag & drop to fill out format strings or
press the < button.
458
Full description of format strings can be found in Custom DateTime format strings and Standard DateTime format
Strings.
File Size FormatSpecify the unit in which File Size RRT will be represented.
Obtain Device Host NameCheck this box to enable the DeviceHostName RRT to return the host name of the
device. This option comes handy in environments where Host Name resolution is slow. In such environments, you
may want to leave this check box unchecked.
Fujitsu component RRTs
Component RRT ID
The RRT ID for this component is FUJ.
Name
Description
FileFormat
Format of the files in a batch (TIFF, MTIFF, JPEG

(JPEG format is not compatible with Black & White),
PDF). A batch cannot contain files of different format.
PageCount
Number of Pages received in a batch. A batch can

contain either several single page files or one multi-page
file. In both cases Page count returns a number of pages
in a batch. Therefore if Number of files is greater that 1,
then PageCount = Number of files.
NumberofFiles
Number of Files received in a batch. If Number of Files

> 1 then Page count = Number of files
FileSize
File size in bytes, kilobytes, megabytes, or gigabytes.

The unit depends on the File Size Format field.
FormName
The name of the form selected at network scanner
FormID
The guid of the form selected at network scanner
BatchID
The guid of the received batch
SenderUsername
The authenticated users domain name if Authentication

has been turned on for the device.
SenderEmail
The authenticated users display name if Authentication

has been turned on for the MFP device.
DeviceIP
IP Address of the device from which a batch has been

received.
DeviceHostName
The domain name of the device from which a batch has

been received. If the Obtain Device Host Name check
box is unchecked, this RRT returns an empty string.
ColorMode
Color or Black and White document (Auto, Color, Gray

Scale (6010) or Black & White (6000), Black & White
(6010)).
ResolutionType
Type of resolution (150dpi, 200dpi, 300dpi, 600dpi)
PaperSize
Paper size of the scanned document
459
Name
Description
ReceivedTimeX
The time stamp at which the batch was received by the

workflow server. Please refer to RRT Format tab for
details.

This component does not support FRTNs.
This component does not support SSTNs.
Fujitsu field types
The Fujitsu component supports eight field types.
Field Type
Description
Text
A Text field allows a user to enter unformatted text.
Numeric
A Numeric field allows a user to enter numbers (with or

Checkbox
A Checkbox field allows a user to set yes/no or true/false

values by pressing a button.
DateTime
A DateTime field allows a user to enter date and time

information in different formats.
List
A List field allows to present users with a list of choices

capabilities. If a list of choices is too long, the list can be
made searchable.
AddressBook
An AddressBook field allows a user to perform a search

in LDAP directory.
Button
A Button field allows a user to raise an event on server

side.
Tree
A Tree allows to present users with a list of choices in a

tree from which users select the desired item.
Text field
A Text field allows a user to enter unformatted text.
Option
Description
Default
The default field value which appears on the device

panel
Mode
The text field can be any of the following modes:
Max Length
SimpleSimple text-box.
Read onlyField value cannot be changed on the
device panel.
MaskedThe text in the field will be masked.
Maximum length of the value entered in this field.
460
Numeric field
A Numeric field allows a user to enter numbers (with or without decimal point).
Option
Description
Default Value
The default value for the field which appears on the

device panel.
Decimal Places
The number of digits after decimal point.
Interval
The interval by which the value will be increased or

decreased on the device panel by pressing forward or
backward button.
Maximum Value
The maximum value a user is allowed to enter.
Minimum Value
The minimum value a user is allowed to enter.
Thousand Separator
Check this box to show a thousand separator on the

device panel.
Checkbox field
A Checkbox field allows a user to set yes/no or true/false values by pressing a button.
Option
Description
True Value
The value that will be sent to the server if the field is

selected.
False Value
The value that will be sent to the server if the field is not
selected.
Default Value
Check this box if you want the field to be initially

selected when the user opens the form.
DateTime field
A DateTime field allows a user to enter date and time information in different formats.
Default value can be represented in two different ways:
Absolute (fixed time)When set to fixed time, a user opens up a form which contains this field and its value will
be exactly as specified in Fixed Time text-box.
relative (interval from now)When set Time Interval from Now, the default value of the field will be the time a
user opens a form plus the interval. For example if you want the default time to be yesterday, enter "-1" into the
time interval check box.
Format on the device sideThis field defines the format of the date or time, in which the date/time value will
appear on the device panel. Drop-down list contains some predefined useful templates.
Table 31: Custom Date and Time Format Strings
Format specifier
Description
Represents the day of the month as a number from 1

through 31. A single-digit day is formatted without a
leading zero.
dd
Represents the day of the month as a number from

01 through 31. A single-digit day is formatted with a
leading zero.
ddd
Represents the abbreviated name of the day of the week
461
Format specifier
Description
dddd (plus any number of additional d specifiers)
Represents the full name of the day of the week
Represents the most significant digit of the seconds

fraction; that is, it represents the tenths of a second in
a date and time value. If the f format specifier is used
without other format specifiers, it is interpreted as the f
standard date and time format specifier.
ff
Represents the two most significant digits of the seconds

fraction; that is, it represents the hundredths of a second
in a date and time value.
fff
Represents the three most significant digits of the

seconds fraction; that is, it represents the milliseconds in
a date and time value.

a date and time value. Nothing is displayed if the digit
is zero. If the F format specifier is used without other
format specifiers, it is interpreted as the F standard date
and time format specifier.
FF

in a date and time value. However, trailing zeros or two
zero digits are not displayed.
FFF

a date and time value. However, trailing zeros or three
g, gg (plus any number of additional g specifiers)
Represents the period or era, for example, A.D.

Formatting ignores this specifier if the date to be
formatted does not have an associated period or era
string.
Represents the hour as a number from 1 through 12,

that is, the hour as represented by a 12-hour clock that
counts the whole hours since midnight or noon. A
particular hour after midnight is indistinguishable from
the same hour after noon. The hour is not rounded, and
a single-digit hour is formatted without a leading zero.
For example, given a time of 5:43, this custom format
specifier displays "5".
hh, hh (plus any number of additional h specifiers)

a single-digit hour is formatted with a leading zero.
For example, given a time of 5:43, this format specifier
displays "05".
Represents the hour as a number from 0 through 23, that

is, the hour as represented by a zero-based 24-hour clock
462
Format specifier
Description
that counts the hours since midnight. A single-digit hour
is formatted without a leading zero.
HH, HH (plus any number of additional H specifiers)

that is, the hour as represented by a zero-based 24-hour
clock that counts the hours since midnight. A single-digit
hour is formatted with a leading zero.
Represents the minute as a number from 0 through 59.

The minute represents whole minutes that have passed
since the last hour. A single-digit minute is formatted
without a leading zero.
mm, mm (plus any number of additional m specifiers)

with a leading zero.
Represents the month as a number from 1 through 12. A

single-digit month is formatted without a leading zero.
MM
Represents the month as a number from 01 through 12.

A single-digit month is formatted with a leading zero.
MMM
Represents the abbreviated name of the month
MMMM
Represents the full name of the month
Represents the seconds as a number from 0 through 59.

The result represents whole seconds that have passed
since the last minute. A single-digit second is formatted
ss, ss (plus any number of additional s specifiers)

Represents the first character of the AM/PM designator.

The AM designator is used if the hour in the time being
formatted is less than 12. Otherwise, the PM designator
is used.
tt, tt (plus any number of additional t specifiers)
Represents the AM/PM designator. The AM designator

is used if the hour in the time being formatted is less than
12. Otherwise, the PM designator is used.
Represents the year as a one or two-digit number. If the

year has more than two digits, only the two low-order
digits appear in the result. If the first digit of a two-digit
year begins with a zero (for example, 2008), the number
yy
Represents the year as a two-digit number. If the year

has more than two digits, only the two low-order digits
appear in the result. If the two-digit year has fewer than
two significant digits, the number is padded with leading
zeros to achieve two digits.
463
Format specifier
Description
yyy
Represents the year with a minimum of three digits. If

the year has more than three significant digits, they are
included in the result string. If the year has fewer than
three digits, the number is padded with leading zeros to
achieve three digits.
yyyy
Represents the year as a four-digit number. If the year

has more than four digits, only the four low-order digits
appear in the result. If the year has fewer than four digits,
the number is padded with leading zeros to achieve four
digits.
yyyyy (plus any number of additional y specifiers)
Represents the year as a five-digit number. If the year

has more than five digits, only the five low-order digits
appear in the result. If the year has fewer than five digits,
the number is padded with leading zeros to achieve five
digits. If there are additional y specifiers, the number
is padded with as many leading zeros as necessary to
achieve the number of y specifiers.
Represents the time separator. This separator is used to

differentiate hours, minutes, and seconds.
Represents the date separator. This separator is used to

differentiate years, months, and days.
"
Represents a quoted string (quotation mark). Displays

the literal value of any string between two quotation
marks (").
'
Represents a quoted string (apostrophe). Displays the

literal value of any string between two apostrophe (')
characters.
%c
Represents the result associated with a c custom format

specifier, when the custom date and time format string
consists solely of that custom format specifier. That is,
to use the d, f, F, h, m, s, t, y, z, H, or M custom format
specifier by itself, the application should specify %d, %f,
%F, %h, %m, %s, %t, %y, %z, %H, or %M.
\c
Represents the escape character, and displays the

character "c" as a literal when that character is preceded
by the escape character (\).
Table 32: Standard Date and Time Format Strings

Format specifier
Name
Description
Short date pattern
Represents a custom date and time

format string "MM/dd/yyyy".
Long date pattern

format string "dddd, dd MMMM
yyyy".
464
Format specifier
Name
Description
Full date/time pattern (short time)
Represents a combination of the long

date (D) and short time (t) patterns,
separated by a space.
Full date/time pattern (long time)

format string "dddd, dd MMMM
yyyy HH:mm:ss".
General date/time pattern (short time) Represents a combination of the

short date (d) and short time (t)
patterns, separated by a space.
General date/time pattern (long time) Represents a combination of the

short date (d) and long time (T)
patterns, separated by a space.
M, m
Month day pattern

format string "MMMM dd"
O, o
Round-trip date/time pattern

format string using a pattern that
preserves time zone information.
The custom format string is
"yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK".
In this string, the pairs of apostrophes
that delimit individual characters,
such as the hyphens, the colons,
and the letter "T", indicate that the
individual character is a literal that
cannot be changed. The apostrophes
themselves do not appear in the
output string. The pattern for this
specifier reflects a defined standard
(ISO 8601).
R, r
RFC1123 pattern
The custom format string is "ddd, dd

MMM yyyy HH':'mm':'ss 'GMT'".
Sortable date/time pattern; conforms

to ISO 8601
The custom format string is

"yyyy'-'MM'-'dd'T'HH':'mm':'ss"
Short time pattern

format string "HH:mm"
Long time pattern

format string "HH:mm:ss"
Universal sortable date/time pattern

format string "yyyy'-'MM'-'dd
HH':'mm':'ss'Z'".
Universal full date/time pattern
The pattern is the same as the

F pattern. However, formatting
operates on the UTC
Y, y
Year month pattern

format string "yyyy MMMM".
465
List field
A List field allows to present users with a list of choices from which users select the desired item. Use this field type
if you want a text field with auto complete capabilities. If a list of choices is too long, the list can be made searchable.
The table in the upper part of the window lists the options (list items) which will be available for the user to select
from.
Value ColumnThe value associated with the list item. This is the value that will be sent to the Server (and
used for the field RRT)
Label ColumnThe text associated with the list item which will be displayed to a user.
Selected Column Specifies which list items will be preselected when a user activates the form. If Allow
Multiple Select is checked, you can preselect multiple list items, otherwise, only one.
Allow to edit value on device side If this check box is selected, a user can enter his/her own value into the text
box, otherwise, only listed options are available for the selection.
Item SeparatorIf Allow Multiple Select is checked, Item Separator is used between the selected values to
form the value of the field.
Allow Multiple SelectIf checked a user will be able to select multiple options simultaneously. The value of the
field will form from the values of the selected options separated by Item Separator.
Display Search OptionsIf checked, a user will be able to search through available options.
The search dialog on the device panel looks like this:
Two type of search can be implemented:
Simple Simple search is performed through items listed in List Field Properties dialog. Apply search target to
current list should be checked.
Dynamic - Dynamic search can be implemented through snap-in.
Raise event after pressing Find buttonIf checked, the search event is triggered when a user presses the "Find"
button on the device panel. You can respond to this event in the snap-in that was configured for the dynamic form
section in the General tab. For details on how to respond to search events refer to the Fujitsu Capture Component
Snap-in documentation.
Show Subject ButtonWhen you implement dynamic search, you may not need "Subject" button (it has Search
label on it and defines where to look for the search target during simple search. It could be Display Text or Value).
This option allows to hide it from the user.
Show Position ButtonWhen you implement dynamic search, you may not need "Position" button (Anywhere,
Head, Tail). This option allows to hide it from a user.
466
AddressBook field
An AddressBook field allows a user to perform a search in LDAP directory.
Address Book field is designed especially for making queries to LDAP Server from the device.
Search root - Specify the directory node in the LDAP hierarchy where the search starts.
Available syntaxes:
LDAP://<server>:<port>/<Hierarchy Path>
LDAP://<server>/<Hierarchy Path>
LDAP://<Hierarchy Path>
Here are some examples:
LDAP://mydc.mydomain.com/DC=mydc,DC=mydomain,DC=com
LDAP://RootDSE
LDAP://10.10.11.100:50000/OU=somecontainer,O=mydirectory
LDAP://CN=Users,DC=mydc,DC=mydomain,DC=com
Default port is 389 (636 when using SSL).

Authentication (Type)
Windows - This option indicates to use the Windows Security Support Provider Interface (SSPI) authentication
system when binding to the directory. This binding uses the current Windows security context for authentication.
Simple - Used when an LDAP simple bind is desired. An LDAP simple bind is the only binding mechanism
defined in the actual LDAP version 3 specification, so it has excellent compatibility across LDAP server vendors.
Unfortunately, it relies on a plain text exchange of credentials, as a result it is completely insecure by itself.
Anonymous - This option tells the server not to perform authentication before attempting searches. As such, the
state of the LDAP connection will not be authenticated. This flag is not typically used with Active Directory, as
unauthenticated users can do very little in the directory. In fact, Windows Server 2003 Active Directory does not
allow anonymous operations by default. This flag is generally used with non-Microsoft directories that allow
completely anonymous access.
SSL - Specifies that the SSL/ TLS protocol will be used to encrypt the network traffic with the directory server,
including the Bind request. When specifying this option, an SSL certificate must be installed and available
in Active Directory or LDAP server. Under the covers, server will change the TCP port (if it is not already
specified) from the default port 389 to port 636, and SSL will be used to secure the communication. SSL is often
supported by third-party LDAP directories and should be the preferred method of protecting credentials when
communicating with directories other than Active Directory.
Scope
OneLevel - Searches the immediate child objects of the base object, excluding the base object.
Subtree -Searches the entire subtree, including the base object and all its child objects.
Last Name Attribute - First Name Attribute, Email Attribute. LDAP Attributes which contain last name, first name
and e-mail respectively.
Test lookup - Allows to check authentication options interactively
Allow to edit value on device side - If this check box is selected, a user can enter a value into the text-box, otherwise,
only listed options are available for the user to select from.
Item Separator - If Allow Multiple Select is checked, Item Separator is used between the selected values to form the
value of the field.
Allow Multiple Select - If checked, a user will be able to select multiple options simultaneously. The value will form
from the values of the selected options separated by Item Separator.
467
Button field
A Button field allows a user to raise an event on server side.
Option
Description
Normal
Browse to the image that you want to be displayed for

this button.
Focused
Browse to the image that you want to be displayed upon

pressing this button.
Pressed
Browse to the image that you want to be displayed after

the button is selected.
Text Position
The position of the text on the button can be moved,

from 0 to 100 pixels.
Tree field
A Tree allows to present users with a list of choices in a tree from which users select the desired item.
This dialog allows creating a tree which will be displayed on the device panel. Right click on the tree to add, edit and
remove nodes. Each tree node has a label and a value.
Value
The value associated with the tree node. This is the value
that will be sent to the Server (and used for the field
RRT).
Label
The text associated with the tree node which will be

displayed to a user
Table 33: Options in the Tree Field Properties dialog box

Option
Description
Value of the Node
This text box allows you to edit the node value without
leaving Tree Field Properties dialog.
Default Selected Node
Select the node which will be selected by default on the

device side when user activates a form.
Allow to edit value on device side.
If this check box is selected, a user can enter his/her own

value into the text box, otherwise, only tree nodes are
available for the selection.
Path Separator
Specifies the separator between the node labels to form

full node path.
Problem
Possible Cause
Solution
Error Message: This key was not

present in the directory
European Mode : The Administrator

modified the configuration and the
user is at the Form level
Cancel out of the Default form and

go up two levels and try to access the
Default Form again. The error will
not be listed anymore.
Searchable PDF functionality does

not work
Searchable PDF functionality works

only with the US device and Europe
device.
US Device and Europe device. This

option is not available with non-OCR
scanners.
468
Problem
Possible Cause
Solution
List Values are getting appended and

repeat itself
Allow to edit value on the device

side is checked
If Allow to edit value on the device

side is unchecked, the values if
selected once will be unique.
Error Message: Expected shared key

from server
Encrypt connection unchecked

on device but checked on the
component.
If Encrypt connection is checked

on device then turn the Encrypt
connection on device to YES.
"Workflow" button is not displayed

on the device even when the
"Workflow" Service is running.
The plug-in AddinModule*is not

uploaded to the device.
Upload the plugin AddinModule* to

the device from <Install Directory>
\Distributables\Fujitsu Network
Scanner. Select en for US or in for
European device.
Tree View can go to only 14 levels
Tree View cannot select more than

14 levels
As designed.
Regular paper size - Width ranges
from 1.0mm to 215.9mm (8.50
inch), Height ranges from 1.0mm
to 355.6mm (14.00 inch).Long
pages - Width ranges from 1.0mm to
215.9mm (8.50 inch), Height ranges
from 1.0mm to 863.6mm (34.00
inch).
Page Size: Long Pages
Error Message: Parameter is not

valid
If the button images are not pointing

to the valid location.
Select the appropriate paths for

Normal - browse to the image that
is displayed for this menu option
Focused - browse to the image that
is displayed upon pressing this menu
option.Pressed - browse to the image
that is displayed after the menu
option is selected.
Find IP Address of the device
Login under admin credentials.

Under Network Settings tab select
Network Status.
Find Client Version
Login under admin credentials.

Under Device Status tab select Addin Status
Change Languages on European

device :"Workflow" button
disappears
Changing languages clears the

uploaded plug-in for any language.
Groups cannot be added to groups

Error Message: Fujitsu Network
Scanner: Exiting Component (Could
not find a part of the path 'Z:\...'.)
Upload the plugin AddinModule* to

the device from <Install Directory>
\Distributables\Fujitsu Network
Scanner. Select en for US or in for
European devices.
As designed
You must have mapped to a network

drive for any of the home, processed
or rejected folders
LDAP Server location
Run the "Workflow" service as the

user who can create folder at that
location.
Network Settings LDAP Server
Turn it ON.
Enter Server Name
469
Problem
Possible Cause
Solution
Enter Search Base
SMTP Server Location
Network Settings SMTP Server:

Enter Server Name
Plug-in add-in location for US and

European Devices
European version - Maintenance

Add-in Manager US version Maintenance - Add-in Install
Image Properties of the button
Error: Value cannot be Null.

Parameter name: format
List property is modified on the

"workflow" server and the device is
at Default Form level.
Address book search: Lists the

Global Address book if no value is
entered in the Search Target
Width : 374 Pixels

Height: 104 Pixels
Horizontal Resolution: 149 dpi
Vertical Resolution: 149dpi
Bit depth: 24
Frame Count: 1
Click OK to close the error

message.Cancel out of the Default
form and go up two levels and try to
access the Default Form again the
error will not be listed anymore
Enter value to search to avoid
populating the entire address book.
Address Book Search displays error

when clicked on the First name, Last
name, Email address or Find button
European version: An Operations
error occurred. US version: Value
cannot be Null. Parameter name:
format
The user does not have access to the

Address book.
Run the service as the user who can

access the Exchange server.
Address book field Properties: Test

will list only addresses with First
Name, Lastname and email address
The address book is missing either

the first name or Last name or the
email address
The address book needs to update all

the 3 values for any user such that
it will be listed in the Address book
search.
Fields tab cannot be accessed
The Single Scan Touch option is

enabled on the General tab
Disable the Single Scan Touch

option and you can access the Fields
tab.
Running two processes, connecting

to two different Fujitsu devices. The
configuration is not displayed on
the second device but only on one
device.
Certain parameters need to be

different while configuring two
workflow processes.
Both processes should have:
Selecting Color Mode as Black

& White (6010) will display as
label1 on Fujitsu 6000NS devices.
Same Encryption (Preferences

tab)
Same Form Inactivity Timer
time
Different home folder location
Different Port numbers.
It will scan as Black and White on

Fujitsu 6000NS.
470
Problem
Possible Cause
Solution
Selecting Color mode as Gray Scale

(6010) or Black & White (6000).
It will select Gray Scale on Fujitsu

6010N devices and Black & White
on Fujitsu 6000NS devices
Selecting Color mode as Gray Scale

(6010) or Black & White (6000)
and file Format as JPEG does not
scan a document in Fujitsu 6000NS
devices
You clicked No when a warning

message was displayed
A warning message is displayed if

you select Color Mode: Gray Scale
(6010) or Black & White (6000)File
Format: JPEGA warning message is
displayedIf this value is used with
6000 devices, Black and White color
mode is not compatible with JPEG
file format. Do you want to change
File format to TIFF?
Select Yes if you are using Fujitsu

6000NS devices or else you will
not be able to scan. You can ignore
this warning if you are using Fujitsu
6010N devices
Fuji Xerox AIP

Welcome to the Fuji Xerox AIP component
The Fuji Xerox AIP component allows you to capture documents from a Fuji Xerox device that is enabled for
custom services (AIP) and send the documents to route destinations that are supported by the Workflow server.
When scanning documents at the MFP device, users can provide information about the documents that can be used to
identify and route the documents.
The Fuji Xerox AIP component provides the following features:
Allow different set of forms to be used with groups of devices.

Support for Tree, List, Text, Checkbox, Numeric, Date and Lookup List field types to provide document indexing
flexibility.
Simplified creation of forms for sending scanned documents to an email address destination or to a folder
destination.
Easy sharing of forms with the use of the save/load form from template functions.
Forms are extensible through VB.NET. You can create more interactive forms and validate before a document is
scanned. Integrated editor with IntelliSense makes the creation of scripts easier.
Windows authentication at the MFP panel.
In addition to Windows authentication, custom authentication allows you to configure additional authentication
methods.
Allow only certain users to have access to a form.
Prerequisites: Device setup and configuration

These instructions apply for Vista Enterprise Edition.
1. Install ASP.NET
471
2.
3.
4.
5.
6.
In Windows Control Panel, open Programs and Features.

Click Turn Windows features on or off.
In the Windows Features dialog box, select the check box next to ASP.NET.
Click OK.
Complete the installation.
Supported devices
For a current list of supported devices visit the Fuji Xerox MFDs page on the Notable Solutions website.
Using the Fuji Xerox AIP component
You can design custom scanning processes for Fuji Xerox devices to capture, process, and route documents. These
processes include the Fuji Xerox AIP capture component. To add the Fuji Xerox AIP component to a workflow,
expand the Capture section of the Toolbox, and drag the Fuji Xerox AIP component to a task in the AutoStore
Workflow Process Designer window.
For additional information about how to create a process, refer to the Process Designer section of the AutoStore
Process Designer help.
Configuring the Fuji Xerox AIP capture component
The procedures in this section describe how to configure component level settings and authentication.
The Fuji Xerox AIP capture component settings determine the behavior of the component of a workflow as well as
default settings for the component groups, menus, and forms.
How to configure Preferences settings
1. If necessary, double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP settings
dialog box.
2. Click the Preferences tab.
3. In the Home Directory box, enter the path to the root directory where the server will create all temporary
directories and files necessary for running the application.
The service account for the service must have full control permission in this directory.
472
4. In the Web Server Port box, enter the port on which the web application will be running.
5. Optional: To use a secure connection between devices and the AutoStore server, select the Use SSL check box.
a) In the Choose Certificate box, click to browse for an existing certificate or to create a new self-signed
certificate.
b) In the Certificate Password box, type the password for the certificate.
If you created a self-signed certificate, the password you provided when creating the certificate is entered
automatically.
6. In the FTP Port box, enter the port on which the internal FTP service will use to communicate with the device.
Note: When Use SSL is selected, the icon that appears on the device panel will be the default Fuji Xerox
icon and not the AutoStore icon. To display the AutoStore icon in the device panel, you should change the
SSL port number to 443.
7. To configure logging and passive FTP options for the FTP server, click the Advanced button.
a) To enable logging for the embedded ftp server, select the Enable Log check box, then in the Directory box
enter the path to the directory where the logs should be created.
b) In the Data Port Range box, enter the port range that will be used when receiving passive FTP connections
from a device. The default is ports 35000 through 49000.
This must be configured on any device that you want to connect using passive FTP mode. By default devices
are configured to use active FTP.
c) Click OK to save changes to settings in the Advanced Server Settings dialog box.
8. In the Keep settings, configure whether to retain processed and rejected files.
Select this check box
Processed Files
To to this
Retain copies of all files that are processed without
errors. Enter the path to the folder where you want to
keep these files.
Warning: If you enable this option, a copy of
every file that has been routed successfully is
saved in the Processed Files directory. Make
sure that sufficient disk space is allocated
when using this option.
Rejected Files
Retain copies of all files that are not successfully

captured. Enter the path to the folder where you want to
keep these files.
Important: The service account for the service must have write permissions on the Processed Files and
Rejected Files directories.
9. Optional: If necessary, configure an FTP server as a temporary repository for storing images scanned at the device
under Additional Temporary Repositories:
a) Select the Local FTP check box to use a local ftp server as the temporary repository for storing images
scanned at the device.
b) In the FTP Port box, enter FTP port number.
The default port number is 21.
c) In the FTP Folder box, enter the name of the subfolder where the scanned documents will be temporarily
stored.
d) For Path to FTP Folder, enter the local path to the FTP Folder entered in the previous step.
Important: The Workflow server account must have permission to delete files from this folder.
e) For FTP Login, type the user name required to access the FTP folder.
f) For FTP Password, type the password for the user name.
473
Note: To specify this FTP folder when enabling authentication at the group level, select External FTP
for Temporary Repository in the Group Settings dialog box. For more information, see How to Enable
Group Level Authentication.
How to register devices
Device registration options allow you to register AutoStore on devices. Device registration groups allow you to
specify default administrator credentials for a group of devices so that you can quickly register multiple devices
without logon errors.
Through the device registration component, you can:
Define custom registration groups

Add different devices to different registration groups
Register all devices within a single registration group at one time
Adding multiple devices
dialog box.
2. Click the Device Registration tab.
3. Click the Start Registration Manager button.
Define custom registration groups:
4. Click Add Registration Group on the menu bar to open the Edit Device Group dialog box.
Note: This dialog box opens initially when there are no device groups.
5. For Device Group Name, enter the name for the registration group.
6. For Connect to Server using Address, enter either the name or IP address of the machine where the workflow
server is installed.
7. For General Device Access Settings, enter the Admin User name and Password.
8. Click OK to save your changes in the Edit Device Group settings dialog box.
Add device to registration group:
9. Click Add Device to open the Add Device dialog box.
10. For Device Address, enter either the name or IP address of the device.
11. To use access settings configured the group, select the Use Group Access Settings check box and skip to step 13
on page 474.
12. Enter Admin User name, Password, and AutoStore menu position for the device.
Note: The AutoStore menu position determines where the AutoStore icon will appear in the list of
external applications by the MFP.
13. Click OK to save changes to settings in the Add Device dialog box.
Register devices
14. In the Device Registration dialog box, select the registration group to be registered.
15. Click Register on the menu bar.
You must ensure that the AutoStore icon is placed in the correct menu position on each MFP. This action will
effectively overwrite previous values.
You will see a status bar at the bottom of the window, which will display the number of devices that were
successfully registered.
Adding multiple devices:
You can open a comma separated list of device addresses parameters into the Registration Manager. For details about
the device list format, see Import Device List.
16. In the Device Registration dialog box, click the device group to which you want to import devices
17. click the Import Device List hyperlink.
474
18. In the Open dialog box, specify the CSV file that contains the list
19. Click Open.
How to enable authentication for the component
Enable authentication for the Fuji Xerox AIP component in a workflow to allow authentication for all groups, forms,
and menus that are defined on the component. When authentication is enabled for the component, you can still enable
or disable authentication at the group, menu, or form level.
1. If the Fuji Xerox AIP settings dialog box is not open already, double-click the Fuji Xerox AIP component in the
workflow.
2. Click the Authentication tab.
3. In Authentication Type box, select the authentication method you want to use:
Authentication Type
None
Windows
Description
Authentication is disabled.
This prompts the user for a Windows user name,
domain and password.
Under Windows, enter the default domain in the
Domain box. Do not use the fully qualified Domain
Name Server (DNS) domain name. Do not use top
level domain qualifiers such as .com, .net or .org.
For example, if the user is listed as mydomain/user1
or user1@mydomain.domain.com, then in a User
Principal Name (UPN) format, the domain should be
mydomain and NOT mydomain.domain.com.
Note: If the device is configured to use an
Authentication Server with authentication type
SMB, then the credentials provided will be
used by Workflow server. If the authentication
type of the device is something other than
SMB, then in addition to Workflow server
login screen, the devices authentication screen
is also displayed.
Custom Script
The administrator has full control over the prompts that

will be presented to the user as well as how the prompts
are validated. LDAP may be used for authentication of
lookup data.
Under Custom Script, in the Script File Path box,
enter the full path to the script file.
To specify an existing script, click the browse

button (...).
To create a script, click the Edit Script Code
button to open a script editor window with basic
script code.
For details on the script editor window and the
object model used to authenticate users, click Help
in the script editor to refer to the Fuji Xerox AIP
Script documentation.
Click the Prompts button to configure the prompts

that will be used to collect user information. For
more information about the Authentication Prompts
settings, see Authentication Prompts Dialog Box.
475
4. To look up the email address and other attributes about the authenticated user, select the Use an LDAP Search to
retrieve additional user information check box and click Configure to specify the LDAP Lookup Settings.
For information about the LDAP Lookup Settings options, see LDAP Lookup Settings Dialog Box.
Note: When Windows authentication is selected as the Authentication Type, the email address is
retrieved automatically as part of the authentication, so an LDAP search is not required if only the email
address is needed.
5. When you finish editing the Fuji Xerox AIP component settings, click the OK button to save your changes.
How to restrict access to menus and forms using the Fuji Xerox Authentication Agent
To restrict access to groups and menus using Xerox Secure Access, use the following steps:
Enable Authentication for AIP Component:
1. If the Fuji Xerox AIP configuration dialog is not open already, double-click the Fuji Xerox AIP component in the
workflow.
3. In the Authentication Type box, select Windows.
4. Type the default domain in the Domain box.
The domain must be the same domain as used by the external authentication agent. Do not use the fully qualified
Domain Name Server (DNS) domain name or top level domain qualifiers such as .com, .net or .org.
For example, if the user is listed as mydomain/user1 or user1@mydomain.domain.com, then type mydomain, not
mydomain.domain.com.
5. Click the Groups tab.
6. Click the group where the authentication settings will be configured, and click Edit on the menu bar to open the
Group Settings dialog box .
8. Select the Requires Authentication and Use Global Authentication Settings check boxes.
Restrict access to menus or forms:
10. In the Fuji Xerox AIP configuration dialog box, click the Groups tab.
11. Click the menu or form that you want to edit and click Edit on the menu bar.
12. Click Restricted Access.
13. In the Allowed Users/Groups box, enter the groups that will have access to the menu.
Use device authenticated credentials:
15. In the Fuji Xerox AIP configuration dialog box, click the Groups tab.
16. Click the group that you want to configure, and click Edit on the menu bar.
18. Select the Query device Authentication session for credentials check box.
19. Click OK to save changes to the Group Settings, then click OK to save changes to the Fuji Xerox AIP settings.
Configure the agent:
20. On the Home tab of the AutoStore Workflow Process Designer ribbon, click Save to save changes to the
configuration.
21. Click Restart to restart the service.
The SMARTdocument Travel logon screen will not be displayed if Xerox Secure Access and the MFP are properly
configured.
476
Managing groups
Device groups allow you to apply different settings to different groups of devices.
A group applies menus and forms that will be displayed on the device panel. Authentication settings may also be
defined for a group. By default there is a single group called the Common Group. This group cannot be deleted. If you
do not configure additional groups, all devices will display the forms and menus that are configured for the Common
Group. The Common Group will always use the default authentication settings that you configure for the Fuji Xerox
AIP component. These options appear on the Authentication tab of the Fuji Xerox AIP configuration dialog box.
If you need to use separate sets of forms and menus on different devices, then you will need to create additional
groups and assign devices to them. This allows devices to be used for different functions. You can configure separate
authentication settings for a group or choose to use the default settings that you configure for the device. Even when
you create your own groups, my may still want to define menus and forms for the Common Group, as any device that
is not explicitly assigned to a group will belong to the Common Group.
How to add a group
Create a device group to configure forms, menus, and authentication settings for a particular group of MFP devices.
1. Double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP dialog box.
2. On the Groups tab, click Add Group on the menu bar.
This opens the Group Settings dialog box in which you can configure General and Authentication settings..
3. On the General tab, type a name for the group in the Name box.
This name does not appear on the MFP display and it is used strictly for identification purposes.
4. In the Associated MFP Addresses box, add the MFP devices that will be associated to this group:
For each device, type its IP address or host name in the blank row marked by the *.
The network name is preferable, because the IP address can change if you are using DHCP.
The MFP address list must contain at least one MFP.

5. If the MFP devices in this group should authenticate the user, click the Authentication tab, and select the
Requires Authentication check box.
To configure authentication settings that only apply to the devices in this group, select an Authentication
Type and configure the options that are available for that type.
You can click the Help button for information about all of the options on the Authentication tab.
To use the default authentication settings that have been configured for the Fuji Xerox AIP component, select
the Use Global Authentication Settings check box.
All Authentication settings are then unavailable except for the Query device authentication session for
credentials check box.
6. If workflow server should query the credentials of the user logged onto the device, then select the Query device
authentication session for credentials check box.
Tip: Click the Help button for more information about this option and how it behaves for the different
authentication types.
7. When you finish configuring settings for the group, click OK.
How to edit a group
You can edit properties for any existing group other than the Common Group.
1. If necessary, double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP dialog box.
2. On the Groups tab, click the Group that you want to edit.
3. Click the Edit button on the menu bar.
This opens the Group Settings dialog box.
4. You can change the setting for any General or Authentication option.
For additional information about options on either tab, click the Help button.
5. When you finish making changes, click the OK button.
477
How to remove a group

Removing a group deletes the group and its device definitions and all menus and forms in the group.
You can remove any group except for the Common Group.
1.
2.
3.
4.
If necessary, double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP dialog box.
On the Groups tab, click the Group that you want to remove.
Click the Remove button on the menu bar.
When prompted whether to remove the group, click Yes.
How to enable group-level authentication

You can enable and configure authentication for devices in a group.
A group uses the authentication settings if you do not enable authentication for the group.
1.
2.
3.
4.
If necessary, double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP dialog box.
On the Groups tab, click on the group and then click Edit on the menu bar.
Click the Authentication tab and select the Requires Authentication check box.
If you want to use the same authentication settings that were configured for the component, select the Use Global
Authentication Settings box, and then skip to step 7 on page 479.
Authentication Type
None
Windows
Description
is also displayed.
Custom Script

lookup data.
Under Custom Script, in the Script File Path box,
enter the full path to the script file.

button (...).
script code.
478
Authentication Type
Description
in the script editor to refer to the Fuji Xerox AIP
address is needed.
7. Optional: To query the device for credentials, select the Query device authentication session for credentials
check box.
8. Click the General tab.
9. For Temporary Repository, select one of the following:
Internal FTPThis option will use internal FTP settings.

External FTPThis option will use external FTP settings that were configured for creating optional
temporary repositories by the Local FTP settings on the Preferences tab of the Fuji Xerox AIP configuration
dialog box.
Internal HTTP(S)The internal web server will be used to receive scanned documents. Select the SSL option
to use the SSL protocol when transmitting scanned documents to the AutoStore server.
Use one of the FTP options if you anticipate scanning documents with more than 200 pages. The maximum
number of pages that can be scanned with HTTP or HTTPS is 200.
10. In the Associated MFP Addresses list, add or remove devices to which you want to apply the new settings.
11. When you are finished editing the group, click the OK button.
How to add a menu
Menus allow users to access different forms for a workflow. A menu can be added to a group or menu.
1. If necessary, double-click the Fuji Xerox AIP component in a workflow to open the Fuji Xerox AIP dialog box.
2. On the Groups tab, click a group or menu item, and click Add Menu on the menu bar.
3. In the Menu Name box, type a name for the menu.
The name must cannot match the name of another menu or form at the same level in the menu hierarchy.
4. Optional: To display an icon for the menu on the device console, enter the full path to an image file in the Icon
box.
An icon image must have the following characteristics:
PNG or GIF with transparent background
Dimensions: 44x44 pixels
Maximum size: 24 KB
5. If authentication is enabled for the group that contains the menu, then you can configure the Access Control
options to specify users who can use the menu:
Click this
To
Public Access
Allow all users who can access the group or any parent
menu to use the menu.
479
Click this
Restricted Access
To
Limit access to specific groups or users.
Enter groups or users who can see the form in
the Allowed Users/Groups box. For Windows
authentication, you can click the browse button (...) to
select groups or users. Use the semicolon (;) to separate
multiple entries in this list.
Group membership is determined by the authentication type for the group that contains the form:
NoneThe Access Control options are unavailable.

WindowsGroup membership determined by the Windows Groups that the user belongs.
Custom ScriptGroup membership determined by the Groups collection of the UserInfo object that
represents the authenticated user.
For details on the object model used in authentication scripts see the Fuji Xerox AIP Scripting documentation.
To restrict access to groups and menus using the Fuji Xerox AIP Authentication Agent and smart card
authentication, see Restricting Access to Menus/Forms using Fuji Xerox AIP Authentication Agent.
How to restrict access to a menu

If authentication is enabled for a group, you can configure authentication for menus in the group to restrict or change
access to the menus.
1. If the Fuji Xerox AIP settings dialog box is not open already, double-click the Fuji Xerox AIP component in the
workflow.
2. On the Groups tab, click the menu you want to edit, and click Edit to open the Menu Properties dialog box.
3. In the Access Control settings choose the access you want to apply to the menu:
Access
Description
Public Access
Choose this option to allow all users with access to the

group to use the menu.
Restricted Access
Choose this option to only allow groups or users

listed in the Allowed Users/Groups box to use the
menu. Separate users or groups in this list with the
semicolon (;). When the authentication type for a group
is Windows, you can click the browse button (...) to
select Windows groups or users.
Group membership is determined by the authentication
type that has been specified for a device group:
NoneAuthentication not used for the menu.

WindowsDetermined by the Windows groups to
which a user belongs.
Custom ScriptDetermined by the Groups
collection of the UserInfo object that represents
the authenticated user.
For details on the object model used in
authentication scripts, see the Fuji Xerox AIP
Scripting documentation.
To restrict access to groups and menus using Fuji Xerox AIP Authentication Agent and smart card authentication,
see Restricting Access to Menus/Forms using Fuji Xerox AIP Authentication Agent.
4. When you finish configuring settings for the menu, click the OK button.
480
Adding and Editing Forms

Add a form when your workflow process requires capturing data prior to scanning. A form can be added at the group
or menu level.
The procedures in this section step you through managing forms for the Fuji Xerox AIP component.
How to add a form
Add a form to collect information and pass it to a workflow.
dialog box.
2. Click the group or menu where you want to add the form. Then, on the menu bar, first click Add Form and then
click type of form that you want to create.
Form Type
Use to
Basic Form
Collect general information for a workflow.
Send to DocuShare Form
Send documents to a DocuShare repository
Send to Email Form
Send documents to an email destination.
Send to Folder Form
Send documents to a folder.
Send to SharePoint Form
Send documents to a SharePoint 2007 or SharePoint

2010 server.
Send to Smarticket Form
Send documents to a Smarticket repository.
This displays the Form Settings dialog box with three basic tabs (General, Fields, and Components) plus the
form type tab for any type except the basic form.
3. In the Name box, type a name for the form in the Name.
The name of the form will be displayed in the forms screen of the application, so use a text that describes the
function of the form.
For example, if a form is to send to the home directory for a user, then you can name it "Scan to Users Home
Directory".
4. Optional: To display an icon for the form on the device console, enter the full path to an image file in the Icon
box.
Maximum size: 24 KB
5. Optional: If you do not want the user to enter information about the document, select the Single Touch mode
check box.
Selecting this option starts the scan immediately after the user presses the form button on the device without
prompting for further information.
6. If authentication is required for the group that contains the form, then you can configure the Access Control
options to specify users who can use the form:
Choose
To
Public Access
menu to use the form.
Restricted Access
Limit access to specific users or groups.

Enter groups or users who can see the menu in
481
Choose
To

For details on the object model used in authentication scripts see the Fuji Xerox AIP Scripting documentation.
7. In the Scanning Settings box, configure default settings for scanning documents.
For additional information about each of the settings, see Basic Form.
8. To modify the standard behavior of a form by responding to events, select the Enable Dynamic Form check box,
and configure options for Dynamic Form.
For more information, see Enabling a Dynamic Form
9. Click the Fields tab, and add fields to the form.
For more information, see How to Add Fields to a Form.
10. Click the Components tab to activate and configure subsequent components in a workflow.
To activate or configure a component, click the browse button (...) in the

Components list.
(properties) column of the
For information about how to configure a component, click the Help button in a component properties window.
11. For any form type except the basic form, click the form-specific tab and configure type-specific properties for the
form.
For more information about properties on this tab, click the Help button.
12. Click OK when you finish configuring the form.
How to edit a form
This topic describes how to edit form settings, cut, copy, paste, delete, and reorder forms.
dialog box.
2. You can do any of the following:
To
Do this
Open the Form Settings

dialog box to edit a form.
Click the form to select it, then click the Edit on the
menu bar. You can also double-click a form.
Cut or copy a form
Right-click the form and click Cut or Copy on the

shortcut menu.
Paste a cut or copied form
Right-click a group or menu, and click Paste on the

shortcut menu.
Tip: To quickly copy a form to another group
or menu, click and drag the form to the desired
location. This will not remove the form from
its original location.
Delete a form
Click the form to select it, and then click the Remove
button.
482
To
Do this
Reorder forms on menus
To change the order that forms are displayed on the

device panel, right-click the form, and click Move Up
or Move Down on the shortcut menu.
Save the form as a template
To save the form as a template for reuse in other menus

or groups, right-click the form and click Save As
Template on the shortcut menu.
For more information, see Saving a Form as a
Template.
How to restrict access to a form

If authentication is enabled for a group, you can configure authentication for forms in the group to restrict or change
access to the forms.
The form you want to edit must be open in the AutoStore Workflow Process Designer. See How to Edit a Form.
1. In the Form Settings dialog box, click the General tab.
2. In the Access Control settings choose the access you want to apply to the form:
Access
Description
Public Access

group or menu that contains the form to use the form.
Restricted Access

form. Separate users or groups in this list with the
NoneAuthentication not used for the form.

authentication scripts, see the Fuji Xerox AIP
To restrict access to groups and menus using Fuji Xerox AIP Authentication Agent and SmartCard authentication,
see Restricting Access to Menus/Forms using Fuji Xerox AIP Authentication Agent.
3. When you finish configuring settings for the form, click the OK button.
How to enable a dynamic form
You can modify the standard behavior of a form by responding to events.
Before you can perform this procedure, the Form Settings dialog must be open for the form that you want to edit. See
Editing a Form.
Some of the things you can do by enabling dynamic form are:

Change field contents, such as loading the contents of a list field from a database.
483
Change form scan settings.

Validate field contents before the document is scanned into the server.
1. On the General tab of the Form Settings dialog box, select the Enable Dynamic Form check box.
2. In the Script Path box, enter the path to the VB.NET script that contains the code to respond to form and field
events.
To use an existing script, click the browse button (...) to locate the script file. To edit the script, click the Edit
Script Code button.
To create a new script, click the Edit Script Code to open a Visual Basic Script template with empty
subroutines to respond to Form_OnLoad and Form_OnSubmit events.
For details about the script editor and the object model used to respond to create and handle events, click the
button button in the Edit Script Contents window to view the Fuji Xerox AIP Scripting documentation.
3. For Raise an event when, select form events that must be responded to by the script:
Option
Description
Form is loaded
Select this check box to raise an event every time the

user enters the form.
Form is submitted

user presses Scan in the form.
4. To run under the authentication context of the logged on user, select the Run as device logged in user.
This option should be used carefully and only in cases where you need to access a system that requires
explicit identification. Whenever possible specify user names and passwords in your script. You can use .NET
technologies, such as encryption, to hide the passwords from view when editing the script.
Note: The Run as device logged in user option is only available if the when authentication is enabled for
the group that contains the form and the authentication mode is Windows.
How to Add fields to a form
Add fields to a form to gather information from users and pass values from the form to subsequent components in a
workflow.
Editing a Form.
1. In the Form Settings dialog box, click the Fields tab.
2. In the Name column of the last row of the table, type the name of the field.
The name can be any combination of alphanumeric characters. Special characters (for example, ~, !, @, , $, %)
are not allowed. The maximum number of characters for this field is 64.
3. In the Display column, type an alternative text to represent the field on the MFP console.
If this column is left empty, then the field name will be displayed on the MFP console.
4. In the Type column, choose how the data for the field will be collected by selecting an option:
Field Type
Allows users to
Checkbox
Set yes/no or true/false values by selecting or clearing a

check box.
Date
Enter date values based on selected date formats.
List
Present users with a list of choices from which users

select the desired item.
Lookup List
Numeric
Dynamically retrieve values from an OBDC data

source.
Enter numeric values.
484
Field Type
5.
6.
Allows users to
Text
Enter unformatted text into a text box such as

sentences, names, numbers, date, and time.
Tree
Select an item from a tree list.
Optional: To require users to enter a value for a field, select the check box in the
column.
To trigger an event when the value of the field changes, select the
check box.
The event can be responded to in the script specified in the Dynamic Form section on the General tab.
7.
To configure properties for the field, click the browse button (...) in the
column.
This opens a window that allows you to configure properties for the specified the field type. For information about
options for a field, click the Help button
8. Repeat this procedure for each field that you want to add to the form.
How to save a form as a template
You can save a form to a template file to reuse the form in another group.
You must create and configure a form before you can perform this procedures. See Adding a Form.
A form template is an XML formatted file that saves the all of the settings that are required to copy a form to a
different Fuji Xerox AIP group or menu.
dialog box.
2. On the Groups tab, right-click the form you want to save and click Save as Template on the shortcut menu.
This opens the Save Form as Template dialog box.
3. In the Location box, enter the full path to the folder where you want to save the template.
You can click the browse button (...) to locate a folder.
4. In the Template Name box, type a name for the template.
5. Optional: If Enable Dynamic Form is selected in the form settings, then you can select Save copy of dynamic
script in the same location to copy the associated .Net script to the same location.
6. Click the Save button to save the template.
The template file is saved to a file with the name specified by Template Name, with the .xml extension is
appended to the file name.
How to create a form from a template
You can use a form template to add a form to a group.
A form must be saved for the component to a template file before you can perform this procedure. See Saving a Form
as a Template.
A form template is an XML formatted file that saves the all of the settings that are required to reproduce a form in a
different Fuji Xerox AIP group or menu.
dialog box.
2. On the Groups tab, click the group or menu where you want to add a form from a template.
3. Click Add Form > From Template on the menu bar.
4. In the Template file box, enter the full path to the form template file.
5. Optional: If the template is for a dynamic template, enter the full path to the template script file in the Dynamic
Form script file box.
You can click the browse button (...) to locate the script file.
6. Click the Create button.
This opens the Form Settings dialog box.
7. Enter a new name for the form and make any other necessary changes to the form settings.
485
8. Click the OK button when you are finished editing the form.
Completing this procedure adds a new form based on the template to the selected menu or group.
Configuration reference
Groups tab
This tab is used to add and configure groups, menus, and forms for the Fuji Xerox AIP component.
Devices can be grouped based on their IP address or host name. Each group of devices can have its own menu
structure. By default there is a single group called the Common Group. If no additional groups are configured, all
devices pointed to in the workflow server will display the menu structure under the Common Group.
Additional device groups can be created and devices assigned to them. Using this framework you can use devices
connected to the same workflow server for different functions. You can use shortcut menu commands to cut, copy,
paste, and reorder menu items and forms to build the menu hierarchies that appear on the MFP control panel.
Table 34: Menu bar commands on the groups tab
Option
Description
Add Group
Click this button to add a group.
Add Menu
Select a group or menu and click this button to add a

menu item.
Add Form
Select a group or menu, and click this menu and select a

form type to add a form.
Basic Form
Send to Email Form
Send to Folder Form
Edit

menu, or form.
Remove
Click this button to delete the currently selected group,

menu, or form.
Group Settings dialog box

Options in the Group Settings dialog box to configure settings for device groups.
Add a group on the Groups tab of the Fuji Xerox AIP configuration dialog box.
To add a group, click Add Group on the menu bar. Then, in the Group Settings dialog box, configure options on
the General and Authentication tabs.
General Tab
Option
Description
Name
Type a name for the group. This name does not

appear on the MFP display and it is used strictly for
identification purposes.
Temporary Repository
Specify the protocol that will be used to connect to

temporary repositories:
486
Option
Description
Internal FTPThis option uses internal FTP

settings.
External FTPThis option uses the external
FTP folder that is configured for creating optional
temporary repositories in the Local FTP settings
on the Preferences tab of the Fuji Xerox AIP
configuration dialog box (see Preferences Tab).
Internal HTTP(S)The internal web server will be
used to receive scanned documents. To use the SSL
protocol when transmitting scanned documents to the
AutoStore server, select the Use SSL option on the
Preferences tab of the Fuji Xerox AIP configuration
dialog box (see Preferences Tab).
Use one of the FTP options if you anticipate scanning

documents with more than 200 pages. With HTTP or
HTTPS, the maximum number of pages that can be
scanned is 200.
Associated MFP Addresses
Enter the IP address or host name for each device that

you want to add to the group. This list must contain at
least one MFP device.
Tip: A network name is usually preferable,
because an IP address can change if you are
using Dynamic Host Configuration Protocol
(DHCP).
Authentication Tab
Options on this tab configure authentication settings for devices in a group.
Option
Description
Requires Authentication
Select this check box to require that MFP devices in this

group authenticate users.
Use Global Authentication Settings
If authentication has been configure on the

Authentication tab of the Fuji Xerox AIP component
settings, then you can select this check box to apply the
component authentication settings for the group. When
this check box is selected, the Authentication Settings
options are unavailable.
Authentication Settings
Choose the Authentication Type to be used:
NoneNo authentication method specified.

WindowsSelect this option to prompt the user for
their Windows user name, domain, and password.
After you select this option, configure the Windows
and User Info Lookup options.
Custom ScriptAdministrator defines prompts for
authentication for a custom application. After you
select this option, configure the Custom Script and
options.
487
Option
Windows
Description
Windows authentication authenticates users using their
Windows domain user name. In the Domain box, specify
the default domain for authenticating users.
Do not use the fully qualified Domain Name
Server (DNS) domain name. Do not use top level
domain qualifiers such as .com, .net or .org. For
example, if the user is listed as mydomain/user1 or
user1@mydomain.domain.com, then in a User Principal
Name (UPN) format, the domain should be mydomain
and NOT mydomain.domain.com.
SMB, then the credentials provided will be used
by workflow server. If the authentication type
of the device is something other than SMB, then
in addition to workflow server login screen, the
device authentication screen is also displayed.
Custom Script

User Info Lookup
Script File PathThis is the path to script that

contains the code to respond to form and field
events. You can click the browse button (...) to locate
a Visual Basic Script (.vbs) file containing an
existing script.
Edit Script CodeClick this button to create or
edit a script. A sample custom script is available with
this component. For details about the code editor
window and the object model, click the
button
in the code editor to refer to the Fuji Xerox AIP
Configure PromptsClick this button to configure
prompts that collect authentication information for
users.
Select the Use LDAP search to retrieve email check

box to have the server look up the email address and
other attributes of the authenticated user on a designated
LDAP server. Click the Configure button to configure
the LDAP settings in the LDAP Lookup Settings dialog
box.
address is needed.
488
Option
Description
Query device authentication session for credentials
The behavior determined by this check box depends on

the Authentication Type setting:
NoneThe user is not prompted for credentials.
If this check box is selected, the sender RRTs will

use the logon credentials for the device.
If this check box is cleared, the sender RRTs will
be empty.
WindowsThe user is prompted for credentials
except for the following cases:
This check box is selected and the device has

been configured to use Windows authentication.
been configured to use third-party authentication
that passes valid Windows credentials (name
and domain). If the domain is not passed, then a
user must be in the default domain that has been
configured for Windows authentication.
In these two cases, the sender RRTs will use the

logon credentials for the device. Otherwise, the
sender RRTs will use the credentials that the user
entered on the logon screen.
Custom ScriptThe user will always be prompted
for user credentials even when this check box is
selected. The sender RRTs will use credentials
Menu Properties dialog box

Options in this dialog box configure settings for a menu.
Add a menu on the Groups tab of the Fuji Xerox AIP configuration dialog box.
To add a menu, click a group or menu, then click Add Menu on the menu bar. Then, in the Menu Properties
dialog box, configure options for the menu.
Option
Description
Menu Name
Specifies a unique name for a menu.
Icon
Specifies an icon image that will be displayed on the

device for the menu. This entry is optional. You can click
the browse button (...) to locate an image.
Access Control
FormatPNG or GIF with transparent background

DimensionsMust be 44x44 pixels
Maximum size24 KB
Choose whether to restrict access to a menu:
Public AccessChoose this option to allow all

users to access the menu.
Restricted AccessChoose this option to only
allow users listed in Allowed Users/Groups. Click
489
Option
Description
the browse button (...) to select Windows groups or
users.
Note: This option is only available when
the authentication type is Windows.
Group membership depends on the authentication type:
WindowsDetermined by the Windows Groups to

which a user belongs
the authenticated user. For details on the object model
used in authentication scripts see the Fuji Xerox AIP
Forms
Add a form to workflow when the process needs to capture data prior to a scanning process. There are several types of
forms that you can use to capture information for different processing and routing options.
Add a form on the Groups tab of the Fuji Xerox AIP configuration dialog box.
To add a form, first, click a group or menu node, then click Add Form on the menu bar, and then click one of the
form types.
Basic form
Use a basic form to collect general information for a workflow.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a basic form to a process, first
click any group or menu node and then click Add Form > Basic Form on the menu bar.
Configure options for a basic form on the General, Fields, and Components tabs in the Form Settings dialog box.
These tabs provide options that may be configured for every type of form.
When setting up any type of form, the following three tabs must be configured:
General Tab
Fields Tab
Components Tab
General Tab
Option
Description
Name
The name of the form to be displayed on the MFP panel.

For example, if this form is used to send the scanned
documents to the users home directory, then name the
form "Scan to Users Home Directory". This name must
be unique among the forms at the current nesting level.
Icon
Specifies an icon to be associated with this form. Enter

the path where the image is stored. The image must have
the following characteristics.
PNG or GIF with a transparent background

Maximum size: 24 KB
490
Option
Description
Single Touch Mode
Select this check box to begin the scanning process upon

selection of the form. The user will not be prompted for
any selections on the device panel.
Access Control
Specifies who can use a form.
Scanning Settings
Public AccessAllow any user to access the form.

Restricted AccessAllow specified users to access
the form.
Allowed Users/GroupsSpecifies users who can
access the form for Restricted Access. Click the
browse button (...) to select users or groups.
This table lists all the available scan settings for the
device. Default scan settings can be configured in the
Options column. A default scan setting is used when a
user does not change the setting at the device panel.
2 Sided ScanningSpecifies single side or two

side scanning. Choose 1 Sided, 2 Sided, or 2 Sided
Rotate Side 2. The rotate side 2 option rotates side 2
of the pages for top-binding pages of a document.
Build Job ModeSpecify On or Off to combine
multiple scans into a single, compiled output. Set this
to On to allow users to feed multiple documents into
the MFP scanner.
Color Document QualitySpecify High, Medium,
or Low for scanning quality of color documents.
Higher quality takes longer to scan and creates larger
files.
Color ModeProvides the color mode. The target
document will be rendered in Full Color, Grayscale,
or Black & White. Choose the Auto option to scan
documents containing color pages using the Full
Color option and documents without color pages
using the Black and White option.
Note: This setting is ignored and all scans
will be monochrome for a device that can
only scan in monochrome.
File FormatSpecifies the file format in which to
save scanned documents:
PDFSaves scanned pages in PDF format.

MTIFFMultipage TIFF format saves multiple
pages into a single file in TIFF format.
TIFFSaves each page into a different file in
TIFF format.
JPEGSaves scanned pages in JPEG format.
Note: JPEG file format and Black and
White Color Mode cannot be selected at
the same time. The Black and White Color
Mode is disabled when JPEG is selected.
491
Option
Description
Image EnhancementClick the browse button (...)

for this setting to configure the following settings in
the Image Enhancement dialog box:
Auto Background SuppressionSelect this
check box to automatically reduce or eliminate
the dark background resulting from colored paper
or newspaper originals.
ContrastClick or drag the slider to one of
the five tick marks between Low, Normal, and
High to control the difference between image
densities within scanned images. Select a lower
setting to improve the copy quality of pictures.
Select a higher setting to produce more vivid
blacks and whites for sharper text and lines. This
option applies only when Color Mode is set to
Grayscale or Full Color.
Image MagnificationResizes scanned images as
a percentage of the original size.
Image OptionsClick the browse button (...) for
this setting to configure the following settings in the
Image Options dialog box:
Lighten/DarkenThis option controls how the

scan service processes the images of the scanned
input document so the output document appears
either lighter, darker, or the same as the original
input document.
SharpnessThis option controls the balance
between sharp text and moir (patterns within
the image). This feature allows you to increase
or decrease the sharpness level of fine lines and
edges. Adjust the sharpness values from sharper
to softer, based on the quality of the input images.
Original OrientationSpecifies whether
originals are scanned in Portrait or Sideways Images
(landscape) orientation.
Original SizeSpecifies the size of the original
documents: Auto, Mixed, 8.5 x 11 LEF, 8.5 x 11
SEF, 8.5 x 14 SEF, 11 x 17 SEF, 5.5 x 8.5 LEF,
5.5 x 8.5 SEF, 8.5 x 13 SEF, A4 LEF, A4 SEF,
A3 SEF, A5 LEF, A5 SEF, B5 LEF or B5 SEF.
Note: LEF (Long Edge Feed) and SEF

(Short Edge Feed) describe the manner in
which the documents are feed into the MFP.
Original TypeSpecifies text and photos in the
original documents:
TextUse this option to copy documents that

contain text only. Select this option when text
must be clearly copied.
PhotoUse this option to copy documents that
contain photographs only.
492
Option
Description
Dynamic Form
Photo and TextUse this option to copy

documents that contain both text and
photographs. Text and photographs are
automatically identified and an appropriate
quality mode is selected for individual areas.
ResolutionResolution (dots per inch) of the scan.
Settings are 200 dpi, 300 dpi, 400 dpi, or 600 dpi.
Enable Dynamic FormStandard behavior of
a form can be modified by responding to events.
Select this check box to allow the workflow sever to
load form snap-ins. Here are some examples of what
enabling dynamic forms can do:

Script pathEnter the path to the VB.NET script
that contains the code to respond to form and field
a script file.
Edit Script CodeYou can click this button
to open a code editor window and edit the script
code. If you do not specify an existing script in the
Script path box, this button opens a new script
with stub routines for the Form_OnLoad and
Form_OnSubmit events. For details about the code
editor window and the object model used to respond
to form and field events, refer to the Fuji Xerox AIP
Scripting documentation by clicking Help in the code
editor window.
Raise event when:The following options specify
when the form raises events:
Form is loadedSelect this check box to cause
enters the form.
Form is submitted:Select this check box to
cause the form to initiate an event every time the
user presses Scan button in this form.
Run as device logged in userSelect this
check box if you need the script to run under the
authentication context of the logged on user. This
option should be used carefully and only in cases
where you need to access system resources that
require explicit authentication. Whenever possible
specify user names and passwords in the script.
You can use .NET Framework features, such as
encryption, to hide passwords from view when
editing the script. Keep in mind that the Run as
device logged in user option is only available if the
group requires authentication and the Authentication
493
Option
Description
Type specified on the Authentication tab is
Windows (see Authentication Tab).
Fields Tab
Configure the fields that will be presented to the user. Add a field by entering data on the last line, which is marked in
the first column by the asterisk (*).
Column
Description
Name
The field name should be unique among the other

fields within this form. The field name labels the RRT
that returns the field value at run time. For example,
if the field name is "Field1", the RRT is ~AIP::
%Field1%~.
Display

panel.
Type
Enter the field type. A field type represents the format by

which data is collected at the device panel. Regardless
of field type, the result will be in text format. Click
the browse button (...) in the properties column
configure settings for a field type.
to
The following field types are supported:
(Required)
(Notify server)
(Properties)
CheckboxAllow users to set true/false values by

selecting or clearing a check box in a form.
DateAllow users to enter date values based on
selected date formats.
ListAllow users to select an item from a list of
choices.
Lookup ListAllows users to dynamically retrieve
values from an ODBC data source.
NumericAllows users to enter numeric values.
TextAllows users to enter plain text, such as
sentences, names, numbers, dates, and times.
TreeAllows users to select an item in from a list of
choices in a tree.
Select this check box to require a user to enter a value in

a field.
Selecting this check box triggers an event when the value
of the field changes. The event can be responded to in
the script specified in the Dynamic Form section on the
General tab.
Click the browse button (...) to edit additional properties
for a particular field type.
494
Components Tab
This tab lists process and route components in the workflow. Configure a component for this form by clicking the
browse button (...) in the configure column
for a row. This opens the configuration dialog box for the component.
You can click the Help button in the configuration dialog box for component instructions.
Checkbox field options
A Checkbox field allows users to select or clear a check box to specify a Boolean Yes/No or True/False state.
Option
Description
True Value
Enter the value that will be sent to the AutoStore server

if the check box field is selected. "1" is the default value.
False Value

if the check box field is cleared. "0" is the default value.
Checked by default
Select this check box if you want the check box to be

initially selected when the user opens the form.
Date field options

A Date field allows users to enter dates.
Option
Description
Date Format
Click a format for dates in this field. For information

about date formats, see Date Formats.
Restrict to date range
Select this check box to restrict entries in this box to a

range of dates. Enter the beginning and end dates for the
range in the From and To boxes.
Date formats
Use date formats to specify how date values are formatted in a Date field RRT.
Date type
Device Short Date
Description
Short date pattern using the device
language setting.
Examples
12/31/2012 (en-US)
31/12/2012 (fr-FR)
31/12/2012 (es-ES)
Device Long Date
Long date pattern using the device

language setting.
Monday, December 31, 2012 (enUS)

lunes, 31 de diciembre 2012 (es-ES)
Montag, 31. Dezember 2012 (de-DE)
MM/DD/YYYY
Short date pattern, month first, slash

delimited
12/31/2012
MM-DD-YYYY
Short date pattern, month first, dash

delimited
12-31-2012
DD/MM/YYYY
Short date pattern, day first, slash

delimited
31/12/2012
DD-MM-YYYY
Short date pattern, day first, dash

delimited
31-12-2012
495
Date type
Description
Examples
YYYY/MM/DD
Short date pattern, year first, slash

delimited
2012/12/31
YYYY-MM-DD
Short date pattern, year first, dash

delimited
2012-12-31
MM.DD.YYYY
Short date pattern, month first, dot

delimited
12.31.2012
DD.MM.YYYY
Short date pattern, day first, dot

delimited
31.12.2012
YYYY.MM.DD
Short date pattern, year first, dot

delimited
2012.12.31
Note: There may be more or fewer patterns than those shown in this table.
Important: When you refer to a Date field in a script, the day (DD) and year (YYYY) designations must be
in lower case. In other words, DD must be dd and YYYY must be yyyy. For example, when the format MM/
DD/YYYY is required in scripting, the format should be specified by MM/dd/yyyy in the script. This
applies to all of the date formats that use day (DD) or year (YYYY) designations.
List field options
A List field allows users to select from items in a list.
Option
Description
Value
The value associated with the list item. This is the value
that will be sent to the server. It is also used for the field
RRT. Entries can be sorted by the Value column.
Label
The text associated with the list item that will be

displayed to the user. Entries can be sorted by the Label
column. If this field is empty, the Value text is used as
the label that is displayed on the MFP console.
Description
Provides space for you to briefly describe a value in a

list. This field is displayed in the details section of the
user interface. This option is only available with device
panels that display in color.
Default
Select this check box for a list item to make the value in
the Value column be the default value for the field.
Allow Multiple Selection
Select this check box to allow users to select multiple

list items in the list. When this option is selected, the
value of the RRT will be the selected values separated by
semicolons (;).
Allow user to add items
Select this check box to allow users to enter new values

at the device console.
Raise event after pressing the search button
Select this check box to raise an event when a user

performs a search on this field. On device panels that
display in black and white, the button is labeled Search.
On device panels that display in color, the search button
is displayed as a search icon.
You can respond to this event in the script that was
configured for the Dynamic Form section in the
496
Option
Description
General tab. For details on how to respond to form
and field events refer to the Fuji Xerox AIP Scripting
documentation.
Maximum number of search results to display
Specifies the maximum number of list items displayed

that satisfy search criteria entered by a user.
Import Items
Click this button to import list items from an ASCII

comma separated value (CSV) file. This allows you to
reuse a list.
Export Items
Click this button to export list items to an ASCII comma

separated value (CSV) file.
Lookup List field options

A Lookup List field allows users to specify items from a field a database table.
Option
Description
ODBC Data Source
Select an ODBC data source to connect with a data

provider. You can click "<New...>" to configure a new
ODBC data source item. Only system data sources can
be selected as a data source.
ODBC Data Sources Administrator
Click this button to open the Windows ODBC Data

Source Administrator application to add, delete, or
configure data sources with user data source names
(DSNs).
User ID
Enter a user ID that has permissions to the database.

This field is optional. If it is left empty the user account
running the AutoStore service will be used.
Password
Enter the password that corresponds to the User ID.
Connect
Click this button to connect to the ODBC Data Source.
Table View
Choose this option to select the table or view. Then

specify the following:
Query
Value ColumnSelect the name of the column

from which values will be loaded into the lookup list.
This value is required.
Display ColumnSelect the name of the column
which will provide the names which will be
displayed in the lookup list. This value is optional.
If this value is left blank, values listed in the Value
Column will be displayed in the device console.
Description ColumnSelect the name of the
column which will provide the description for the
names displayed in the lookup list. This value is
optional. Values from this column will be displayed
in the details section of the user interface. This option
is only available for device panels that display in
color.
Choose this option to enter a SQL query to

produce results that populate the list. Entries for
497
Option
Description
<ValueField> and <DisplayField> are required
in the SQL query.
For information about SQL scripting syntax see General
SQL Syntax.
Maximum number of rows to be preloaded
The user can select the maximum number of rows to

preload into the display when the lookup list is first
displayed. The default value is 50, and the greatest
number of rows that can be specified for this option is
100. If more than 100 rows must be searched, the user
can use the search option located on the device panel.
Note that when Query is chosen, then only preloaded
rows will be searched.
Select this check box to allow users to make multiple

selections based on the results populated within the
lookup list.
Select this check box to allow users to insert their own

values into the lookup list.
Specify the number of results returned when a search

is executed. The default value is 25 and the maximum
value is 200.
General SQL syntax

A simple SQL query
select <ValueField>, <DisplayField>
from <Table>
where <Some Condition>
The first column must be the value for the list item and the second column the display for the list item.
A select statement can also return a single column
select <ValueField>
from <Table>
In this example, the column will be used for both the value and display for the list item.
A conditional select statement
select Customer Id, Customer Name
from Customers
where Customer Name = Fred
In this example, all customers where Customer Name is Fred will be returned.
A conditional select statement using wildcard characters
from Customers
498
where Customer Name like %Johnson

In this example, all customers where Customer Name ends with the text Johnson will be returned. For example,
customers where Customer Name is FJohnson, FredJohnson, Johnson or 3Johnson will be returned.
SQL wildcard syntax is used with the like operator. The % wildcard character is used to specify one or more
characters.
Using a RRT pattern in a conditional select statement:
It is possible to use a RRT pattern in a conditional select statement if field values are entered by the user from the
Workflow form.
RRT pattern takes the following format: ~AIP::%FieldName%~.
It is important to note that the % wildcard character used with RRT patterns does not function like the % delimiter
character used for field searches. With RRT patterns, the entire pattern between the two % delimiter characters will
be replaced with the field value that was entered by the user from the workflow form.
Example
from Customers
where Customer Name like ~AIP::%Customer%~
In this example, the workflow form has the RRT pattern Customer. Once a user enters a value for Customer,
~AIP::%Customer%~ will get replaced with the value entered in the Customer field.
If the user entered Johnson at the MFP for Customer, the resulting query would be:
from Customers
where Customer Name like Johnson
Note that RRT patterns within SQL select statements can be used with other SQL syntax, including wildcard
characters. The following would be a valid SQL statement:
from Customers
where Customer Name like %~AIP::%Customer%~%
Numeric field options
An Numeric field allows users to enter numbers.
Option
Description
Default Value

device panel.
Minimum Value
Specifies the minimum value (inclusive) permitted in the

field. For example, a value of 10 for this option would
allow all values greater than or equal to ten.
Maximum Value
Specifies the maximum value (inclusive) permitted in the

permit any value less than or equal to fifty.
Precision
Specifies the number of positions required after the

decimal point. If the precision is set to zero, then the
device will only accept whole number values. If the
precision is set to a value greater than zero, then the user
499
Option
Description
may press the * button on the device to input a value that
requires a decimal point. The default is 0. The maximum
is 5.
Text field options

A Text field allows users to enter unformatted text, such as sentences, names, numbers, date and time.
Option
Description
Default
The default alphanumeric data that initially appears on

the device panel.
Mode
For this option, select the list type:
Single LineThe field will be displayed as a simple

text box.
Read OnlyThe user cannot edit the field.
PasswordThe text in the field will be masked.
HiddenThe field will not be visible on the device
panel.
Tree field options

A Tree field allows users to select an item from a tree.
Option
Description
Tree Items
This box displays items in a tree field.
Add
Click this button to add a the first (root) node to the tree.
To add a node under an existing node, click a node in the
tree and then click this button. Clicking the Add button
opens the Add/Edit Tree Item dialog box in which you
specify the Display Text and Value.
Edit
To edit the display text or value for an existing node,

click the node and then click this button.
Remove
To remove a node, click the node in the Tree Items

box, and then click the Remove button. This deletes the
selected node and any nodes under the selected node.
Add/Edit Tree Item dialog box

This dialog box specifies the display text and value for an item in a tree field.
Option
Description
Display Text
Enter the text that users will view for a tree item when
navigating the tree
Value
Enter the value that will be sent to the server when a user
selects the tree item.
Send to DocuShare form options

Use a Send to DocuShare form when you need to send the document to a DocuShare repository.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a Send to DocuShare form,
click any group or menu, then click Add Form > Send to DocuShare Form on the menu bar to open the Send to
DocuShare Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components,
and DocuShare Settings tabs.
500
Note: This form type requires that the DocuShare component is installed on the AutoStore server.
DocuShare Settings Tab
This topic describes options on the DocuShare Settings tab. Refer to the Basic Form Options to configure settings on
the General, Fields, and Components tabs.
Option
Description
Server Address
Enter the URL of the SharePoint Server that will

store the documents. The URL can contain "http://" or
"https://" followed by the server name or IP address. For
example, "http://dsserver" or "https://192.199.292.255".
If you enter only the server address, for example,
dsserver, the component will insert "http://" before the
server address.
User Name
Enter the domain and user name that will be used to log
on to the DocuShare server in the format domain \
username . You only need to enter the user name if
you are using a local user account.
User Password
Domain
Enter the domain for the user address.
Use Authenticated User Credentials
Select this check box to use user logon credentials

from the device to log on to the SharePoint server if
authentication has been enabled.
Prompt for document title
Select this check box to allow the user at the device

console to provide the title for the document that will be
displayed by DocuShare.
Default Collection
Click the browse button (...) and in the Select Collection

dialog box, either expand the Collections tree and select
the DocuShare collection to which to deliver documents,
or type a DocuShare collection ID in the Collection ID
box, and click OK.
To allow the user to change the collection at run time,
select the Allow user to change collection check box.
This check box is disabled if you manually type a
collection ID rather than selecting a collection in the
Collections tree.
Default Document Type
Enter the default document type.

To allow the user to specify a different document type
at run time, select the Allow user to change Document
Type check box.
Send to Email form

Use an Email form when you need to send the document to an email destination.
An Email form is commonly used in conjunction with the Send to SMTP and Send to Exchange Route components.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a Send to Email form, click
any group or menu, then click Add Form > Send to Email Form on the menu bar to open the Send to Email Form
501
Settings dialog box. In this dialog box, configure settings on the General, Fields, Components, and Send to Email
Fields tabs.
Send to Email Fields Tab
This topic describes options on the Send to Email Fields tab. Refer to the Basic Form Options to configure settings
on the General, Fields, and Components tabs.
Option
Description
Do not show a From field. Use the device logged in

user's email address
Select this check box to use the email address for the
user that is logged into the device as the value for the
"From" field.
Show a CC Field
Select this check box to show the "CC" field in which

the user can specify a secondary list of people that will
receive the message.
Show a BCC Field
Select this check box to show the "BCC" field in which

the user can specify people that will receive the message
secretly.
Global Address List
Select this check box to allow the user to search the

Global Address List for addresses that can be added to
the To, CC and BCC fields. In the Display as box, type
the display value for this search option. Note that the
Global Address List that will be searched will be decided
based on following criteria:
If Windows Authentication is used, then the search

will be performed on the Global Address List
associated to the device logged on user.
If Custom Authentication is used and the
authentication code populates the Username and
Domain fields, then the search will be performed
on the Global Address List associated to the device
logged on user.
If there is no logged on user then the search will be
performed on the Global Address List associated to
the service account for the service.
Regardless of which Global Address List is used, the

service account for the AutoStore service must have
enough permissions to perform this search.
Exchange Contacts
Select this check box check box to allow users to search

their Microsoft Exchange contacts folder for addresses
that can be added to the To, CC and BCC fields. In the
Display as box, type the display value for this search
option.
Enter the full address of the Exchange Server (IP

address or host name). If the address is unknown,
contact your system administrator.
If a secure socket layer (SSL) connection should
be used to connect to the Exchange Server, select
the Use SSL check box. Note that when Use SSL is
checked, if an icon appears on the device panel it will
be the default Fuji Xerox icon and not the AutoStore
icon. To have the selected AutoStore icon displayed
502
Option
Description
on the device panel, the default SSL port number
should be changed to 443.
LDAP Server
Select this check box to allow the users to search an

LDAP Server for addresses that can be added to the To,
CC and BCC fields.
Display asType the display value for this search

option.
LDAP ServerType the address or host name of
the LDAP server.
Search Root DNType the distinguished name for
the node where the search should start. For example:
DC=Sales, DC=MyCompany, DC=com. If this
field is left empty then the starting point of the search
will be the root of the directory tree.
Email Address fieldType the name of the LDAP
attribute that represents the email address.
Name FieldType the name of the LDAP attribute
that represents the name of the user.
Login as AnonymousSelect this check box to
establish an anonymous connection to the LDAP
server.
Login with following credentialsSelect this
check box to log on to the LDAP server with the
specified User name and Password. Note that if
the LDAP server is an Active Directory server, then
NTLM authentication will be used.
To test the LDAP search settings, click the Test LDAP

button. In the LDAP Search Test window enter a search
term in the Search Criteria box, click Find Contacts. If
the settings are correct and there are users that match the
search criteria, you should see the appropriate results (a
maximum of 25), otherwise an error will be returned
Maximum number of contacts to return
Specify the maximum number of contacts that the search

will return.
Search root patterns

Windows/Used when AutoStore
server belongs to the Active
Directory domain.

Directory domain.

Empty
Username and Password are left
empty.
Result
AutoStore server is running are used.
Search through all containers in
Server belongs.

Search within a specified container
and its child container
Example: LDAP://
503
Result

empty.
Simple,SSL or Anonymous/Used
when either AutoStore server is not a
part of the domain or it is necessary
to conduct search on non-active
directory server.
Example: LDAP://
Search through the entire LDAP tree

on the specified server.
Username and Password are

required when Simple/SSL type is
used
and child container on the specified
server.
directory server.
Example: LDAP://
Possible LDAP Ports:
Standard LDAP: 389
LDAP over SSL: 636
Send to Folder form options

Use a Send to Folder form to send captured documents to a folder destination.
A Send to Folder form is commonly used in conjunction with the Send to Folder and Send to Folder eConnector
components.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a Send to Folder form, click
any group or menu, then click Add Form > Send to Folder Form on the menu bar to open the Send to Folder Form
Settings dialog box. In this dialog box, configure settings on the General, Fields, Components, and Send to Folder
Fields tabs.
Send to Folder Fields Tab
This topic describes options on the Send to Folder Fields tab. Refer to the Basic Form Options to configure settings
Option
Description
Base Directory
Enter the location of the directory that the user can

browse to select the destination of the document. You
can click the browse button (...) to locate a folder.
Default Document Name
Type the default name that will be used for the document
name field.
Send to SharePoint form options
504
Use a Send to SharePoint form when you need to send documents to a SharePoint 2007 or SharePoint 2010 server.
This type of form to allows users to browse document libraries, folders and list values at the device. A Send to
SharePoint form is commonly used in conjunction with the Send to SharePoint 2007/2010 eConnector and route
components.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a Send to SharePoint form,
click any group or menu, then click Add Form > Send to SharePoint Form on the menu bar to open the Send to
SharePoint Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components,
and SharePoint Document Library Settings tabs.
Note: This form type requires that SharePoint 2007 or SharePoint 2010 be installed on the AutoStore server.
SharePoint Document Library Settings Tab
This topic describes options on the SharePoint Document Library Settings tab. Refer to the Basic Form Options to
configure settings on the General, Fields, and Components tabs.
Option
Description
Server Version
Refers to the SharePoint version. Options are:
Server Address
SharePoint 2007
SharePoint 2010 - AutoStore Add-on Services
SharePoint 2010 - Native Services
SharePoint Office 365 Services

example, "http://sp2007" or "https://127.0.0.1".
sp2007, the component will insert "http://" before the
server address.
User Name
Enter the domain and user name that will be used

to log on to the SharePoint Server in the format
domain\username. You only need to enter the user
name if you are using a local user account.
User Password

Prompt for document name

console to provide a document name that can be used
in the file renaming schema of the SharePoint 2007 or
SharePoint 2010 component.
Site
Enter the name of the SharePoint site where the

documents will be stored. You can type the name of the
SharePoint site or select a site from the drop-down box.
You can specify a sub-site using the following format:
parent-site/sub-site.
To allow the user to change the SharePoint site at run
time, select the Allow user to change Site check box.
505
Option
Document Library
Description
Enter the name of the document library where the
documents will be sent. You can type the document
library or select a library from the drop-down list.
To allow the user to change the document library at
run time, select the Allow user to change Document
Library check box.
Default Folder
Enter the name of the default folder where the routed

files will be stored. You can type the location of the
default folder or click the browse button (...) to locate a
folder.
To allow the user to change the folder at run time, select
the Allow user to change Folder check box.
Content Type
Enter the name of the default content type to associate

to the document. Either type a content type or select a
content type from the drop-down list.
To allow the user to change the content type at the device
panel, select the Allow user to change Content Type
check box. This check box is always selected when
Allow user to change Document Library is selected.
The user will only be able to select a Content Type at
the device panel if there is more than one content type
assigned to the selected document library, otherwise the
content type is assigned automatically.
Send to Smarticket form options

Use a Send to Smarticket form when you need to send documents to a Smarticket repository.
Add forms on the Groups tab of the Fuji Xerox AIP configuration dialog box. To add a Send to Smarticket form,
click any group or menu, then click Add Form > Send to Smarticket Form on the menu bar to open the Send to
Smarticket Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components,
and Smarticket Settings tabs.
Note: This form type requires that the Smarticket component is installed on the AutoStore server.
Smarticket Settings Tab
This topic describes options on the Smarticket Settings tab. Refer to the Basic Form Options to configure settings on
Option
Authentication
Description
Web Service
Use authenticated user credentials for browsing

Select this check box to use user credentials entered
at the MFP panel when authentication is enabled to
log on to the Smarticket web service.
UsernameSpecifies a user name to be used for
accessing the web service.
AddressSpecifies the name or IP address for the
Smarticket web service.
506
Option
Description
Enter the machine name or IP address where the
Smarticket web service is located, then click the Test
button to test the address setting.
The web service address format depends on whether SSL
is enabled:
SSL enabled
https://server
name:port
-orhttps://ip
address:port
SSL not enabled
http://server
name:port
-orhttp://ip
address:port
Note: The port number is required.

General
Display ticket ID with ticket nameSelect this

check box to display the ticket ID as well as the ticket
name in the list of Smartickets. Clear this check
box to display only the ticket name in the list of
Smartickets.
Save Form as Template dialog box

You can save a form to a template to reuse it in a different group or menu. A form template is an XML formatted file
that saves the all of the settings that are required to copy a form to a different Xerox EIP Connect group or menu.
Option
Location
Description
Enter the full path to the folder where you want to save
the template. You can click the browse button (...) to
locate a folder.
507
Option
Description
Template Name
Type a name for the template file. Do not include an

extension, as the .xml extension will be automatically
appended to the name that you enter here.
Save a copy of dynamic script in the same location
Select this check box to copy an associated .NET script

to the same location. A script is specified with the
Enable Dynamic Form option in the form settings
Preferences tab
Options on this tab configure settings for the component web server, retaining processed and reject files, and
additional temporary directories.
Server settings
Keep settings
Additional Temporary Repositories settings
Server
Specify the web server that captures scanned document images and associated metadata using HTTP or HTTPS.
This allows a web application or service to directly receive the data rather than monitoring for a file to appear at a
predetermined location.
Option
Description
Home Directory
Enter the root directory where the server creates all

temporary directories and files necessary for running the
application and controlling device related traffic. The
service account must have full permission to write to this
directory. You can click the browse button (...) to locate a
folder on the host machine.
Web Server Port
Enter the port number that the web server uses to

Use SSL
Select this check box to use secure connections between

the web server and clients.
Choose CertificateSelect the certificate by which

data can be retrieved by the workflow server when
using HTTPS (SSL). To create a new certificate,
select "<New self signed...>". To locate an existing
certificate, click "<Browse...>".
Certificate PasswordType the password for the
certificate. If you created a self-signed certificate,
this value will be automatically entered into the field
based on the information you provided when creating
the certificate.
Note: When Use SSL is checked, if an
icon appears on the device panel it will
be the default Fuji Xerox icon and not
the AutoStore icon. To have the selected
AutoStore icon displayed on the device
panel the default SSL port number should be
changed to 443.
508
Option
Description
FTP Port
Enter the port on which the FTP service will be running.

To enable FTP logging or to specify the data port range
for passive FTP, click the Advanced button to open the
Advanced Server Settings dialog box.
Keep
These options allow you to keep processed and rejected files.
Option
Description
Processed Files
Select this check box to keep a copy of all files that are
processed without errors. Enter the path to the folder
where these files will be kept. You can click the browse
button (...) to locate a folder.
Caution: If this option is enabled, a copy of
every file that is routed successfully is saved in
the Processed Files directory. Make sure that
proper disk storage is allocated when using this
option.
Rejected Files
Selected this check box to keep a copy of all files that

failed to be processed. Enter the path to the folder where
these files will be kept. You can click the browse button
(...) to locate a folder.
Additional Temporary Repositories
You can set up additional temporary FTP repositories, although these selections are optional. These FTP settings can
be accessed when enabling authentication at the group level. In the Group Settings dialog box, you should select
External FTP for the Temporary Repository setting. See Group Settings.
Option
Description
Local FTP
Select this check box to use a local FTP server as the

temporary repository for storing images that have been
captured from a device.
FTP Port
Enter the FTP port number for the FTP server. The
default port number is 21.
FTP Folder
Enter the name of the subfolder where the scanned

documents will be temporarily stored.
Path to FTP Folder
Enter the local path to the FTP Folder on the host

machine.
Note: The workflow server account must have
permission to delete files from this folder.
FTP Login
Type a user name that has permission to log onto the

FTP server.
FTP Password
Type the password associated with the user name.
509
Advanced Server Settings dialog box

Options in this dialog box configure settings for logging connections with devices and the port range for passive FTP
connections.
Option
FTP Logging
Description
Use these options to configure logging communicating
with MFP devices.
Passive FTP
Enable LogSelect this check box to enable

logging for the embedded FTP server.
DirectoryEnter the full path to the directory
where logs should be created. You can click the
browse button (...) to locate a folder.
Configure the data port range that will be used when

receiving passive FTP connections from MFP devices.
In the Data Port Range box, enter the range of ports,
for example 6000-6500. The default range is ports
35000-49000.
Note: If you want a device to connect using
passive FTP mode it must be configured on the
device. Devices are configured by default to use
active FTP.
New Self Signed Certificate dialog box

Options in this dialog box specify settings for a new self signed certificate.
Option
Description
Company
Type the name of the company for the certificate.
Expiration Date
Enter the expiration date for the certificate in the format

m/d/yyyy. The default setting is 10 years from the
current date.
Password
Enter the password for the certificate.
Authentication tab
Settings on this tab allow you to enable and configure authentication settings for the component.
Option
Authentication Type
Description
Choose the authentication method to be used:
Windows

options.

510
Option
Description
Custom Script

User Info Lookup

existing script.
button
in the code editor to refer to the Fuji Xerox AIP
users.

box.
Note: When Windows authentication is
selected as the Authentication Type, the email
address is retrieved automatically as part of the
authentication and as a result an LDAP search is
not required if only the email address is needed.
511
Authentication Prompts dialog box

Options in this dialog box configure prompts that collect authentication information for users.
This dialog box is opened by clicking the Prompts button on the Authentication tab of the Fuji Xerox AIP dialog
box.
Option
Description
Name
To add a prompt, enter a name in the last row

of the table. The GetData method on the
MetadataCollection class uses this name to get
the value that was entered for a prompt by the user at the
MFP console.
Display
Enter the label for the prompt that is displayed on the

MFP console. If this value is left empty, the prompt
name will be used for the label.
Default
Type a default value for the prompt in this column. This

entry is optional.
(Required field)
Select the check box in this column to require the user to

enter a value in this field.
(Masked)
Select the check box in this column to mask the prompt

value that is displayed on the MFP console for security.

LDAP server.
Option
Description
LDAP Server
Type the address or host name of the LDAP server.
Root DN

with LDAP://.
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636

Login as anonymous
Choose this option to establish an anonymous connection

with the LDAP server.
Login with the following credentials
Choose this option to log on to the LDAP server using

the specified User name and Password.
512
Option
Description
Directory Type
Select the type of directory that will be searched. If an

option other than Custom is selected then predefined
attributes will be used to match the authenticated
username and retrieving the email address.
Match User name against
This is a variable set by the system administrator. Check

with your system administrator to adjust this settings.
Get email address from

Additional Attributes
Type the name of the user attributes separated by a

semicolon. If no attributes are specified in this box, then
only the email address will be retrieved. These attributes
will be available as User Attributes Replacement Tag
Names (URTN). For details on the format of these
URTNs, refer to Fuji Xerox AIP Component RRTs .
Test Lookup






Empty
Result
used.
Server belongs.

used.
Example: LDAP://
Example: LDAP://

used.

specified server.
Example: LDAP://
513
Device Registration tab

Use this tab to register the AutoStore server on devices. Device registration groups allow you to specify default
administrator credentials for a group of devices so that you can register multiple devices without logon errors.
To open the Device Registration dialog box, click the Start Registration Manager button on the Device Registration
tab of the Fuji Xerox AIP configuration dialog box. Use this dialog box to do the following:

Add multiple devices
Device Registration Dialog Box Options

Option
Register
Description
To register all devices within a registration group, select
the registration group that will be registered and click
Register. You will see a status bar at the bottom of the
window. Once the registration process is complete, the
number of devices which were successfully registered
will be displayed.
Note: You must ensure that the AutoStore icon
is placed in the correct menu position on each
MFP. This action will effectively overwrite
previous values.
Add Registration Group
Click this button to create a new registration group. This

opens the Add Device Group dialog box. See Add/Edit
Device Group Dialog Box.
Add Device
Select a registration group and click this button to add a

device to the group. This opens the Add Device dialog
box. See Add/Edit Device Dialog Box.
Remove
Click a registration group or device and click this button

to delete it. Removing a group deletes all of the devices
in it.
Edit
Select a registration group or device and click this button

to edit the settings.
Import Device List
Click this link to add multiple devices simultaneously.

This option reads in device names and parameters from a
comma delimited list. Each device entry must appear on
a single line formatted as follows:
device_IP,device_admin_user,device_admin_passw
Make sure that there are no spaces between values or
commas. The device IP address is required, so any
line missing an IP address will be ignored. All other
values are optional If a value is empty, then the value
specified for the group will be used. The group value for
the device administrator password is always used if the
device administrator user name is omitted.
514
Option
Description
When you omit values, retain the commas without
any spaces. For example, the following line omits the
device administrator user name (the device administrator
password is then ignored):
device_IP,,device_admin_password,AutoStore_men
The following line omits all values except for the device
IP address:
device_IP,,,
If the device IP address is entered by itself, then all
values except the IP address are copied from the group
settings and the Use Group Access Setting option is
enabled for the device. If at least one value (other than
the administrator password) is entered with the device
IP address, then missing values are copied but the Use
Group Access Setting option is disabled for the device.
That means that any subsequent changes to the group
settings will not change the device settings.
Add/Edit Device Group dialog box
Configure options in this dialog box to create or edit a device registration group.
Option
Description
Device Group Name
Type the name for the registration group.
Connect to Server using Address
Enter either the name or IP address of the machine where

the workflow server is installed.
Admin User Name
Enter the administration user name for the device.
Password
Enter the password for the administration user name.
AutoStore Menu Position
The AutoStore menu position determines where the

AutoStore icon appears in the list of external applications
by the MFP.
Add/Edit Device dialog box

Use this dialog box to add or edit a device in a device registration group.
Option
Description
Device Address
Enter either the name or the IP address for a device.
Use Group Access Settings
Select this check box if the settings configured for group

access on the Groups tab are to be used. Clear this check
box to configure access settings for the device.
Admin User name
Enter the administrator user name for the device.
Password
515
Option
Description
AutoStore Menu Position
The AutoStore menu position determines where the

AutoStore icon appears in the list of external applications
by the MFP.
Fuji Xerox AIP component RRTs

Component RRT ID
The RRT ID for this component is AIP.
Name
Description
FormName
Name of the form.
Sender
The user name of the authenticated user that is

submitting documents. This RRT is populated in any of
The component has been configured to use an

authentication method other than None.
The device authentication is turned on for Extensible
Services (Custom Services).
SenderEmail
The email address of the authenticated user.
SenderDomain
The authenticated users domain name. This RRT is

populated in any of the following cases:
The component has been configured to use Windows

authentication.
The component has been configured to use Custom
authentication and the associated .Net script
populates the Domain property of the UserInfo
object.
IP
The IP address of the MFP device.
HostName
The resolved host name of the MFP device.
ServerIP
The IP address of the AIP application server associated

with the device (IIS server IP address).
ServerHostName
Host name of the AIP application server associated with

the device (IIS server host name).
PageCount
Number of pages of the scanned file.
Format
Format of the scanned file. Possible values are:
FileSize
MTiff (Multi-page TIFF file)

Tiff (Single page TIFF file)
PDF
JPEG
Size in bytes of the scanned file.
516

This component supports FRTNs and replacement of field names generated from the MFP devices. For example, the
RRT ~AIP::%ClientID%~ is replaced by "Company" if the user types in "Company" for the field name called
"Client ID"
User attributes Replacement Tag Names (URTN)
This component supports URTNs and replacement of user attributes specific to the authentication method used.
For example, if custom authentication is used and there is a user attribute named "Full Name" with the value" John
Doe" then the RRT ~AIP::User,%FullName%~ is replaced by "John Doe"
If an LDAP Search is used to retrieve additional attributes and a user enters "displayName" on the Additional
Attributes box, then for an authenticated user which displayName is "Jane Doe" then the RRT ~AIP::User,
%displayName%~ - is replaced by "Jane Doe".
This component supports all the Date/Time tag names listed below:
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
OCR component cannot OCR documents produced by a WorkCentre 7655/7665 when the following settings
are used: Color Multi-page tif with a 300dpi resolution.
517
There are currently no troubleshooting tips for the Fuji Xerox AIP component.
Problem Description
Scans take 15 seconds or more to start.
The problem is evident after the service has been
restarted or the device has been idle for a few minutes.
The user will observe logged events with ID number
8 logged by the Windows application log. This
occurs when running the component on Windows
2003/Windows XP with the option for Update Root
Certificates selected when the server is not connected
to the Internet or does not have access to the Microsoft
Windows Updates.
Solution
Either connect the server to the Internet or turn off the
Update Root Certificates component.
To turn off the Update Root Certificates component,
follow these steps:
1. In Windows Control Panel, double-click Add/
Remove Programs.
2. Click Add/Remove Windows Components.
3. Clear the Update Root Certificates check box,
and then continue with the Windows Components
Wizard.
For more information about this problem, see the
Microsoft KB article ID 317541: Event ID 8 is logged in
the Application log, at the Microsoft web site.
Google Docs
Welcome to Google Docs
The Google Docs route/eConnector component provides the full capability for routing documents to the Google Docs
and Google Drive services. The documents of any format can be stored into the service; however, only the documents
of the following types can be converted into the Google Docs format:
XLS, XLSX, ODS, CSV, TAB, TSV, TXT, TSB, DOC, DOCX, HTM, HTML, PPT, PPS, PPTX, JPG, GIF, PNG,
ODT, SXW
Getting started
Feature highlights
Sending documents into the Google Docs/Google Drive services using the existing user account.
Support for proxy.
Convert into Google Docs format capability.
How to use the Google Docs component

An example of the component usage:
Scan documents from a variety of MFP devices, recognize text from the images and send the searchable PDF files
into a specified Google Docs directory.
1. Design a workflow process by selecting the type of MFP used in scanning of the documents. Use the OCR as
a process component and the Google Docs as a route component.
2. Activate and configure the OCR component.
3. In the Google Docs component configuration, specify the account to connect to the Google Docs service, specify
the folder path and the rename schema for the documents.
4. Run the process.
518
When the walk-up MFP user enters a pre-configured function key on the control panel of the MFP device, the
scanned images are recognized and the corresponding PDF documents are routed directly into the specified Google
Docs directory.
Configuring Google Docs
Use the Google Docs dialog box to configure connection settings and documents destination parameters.
Option
Description
Activate

to a condition. This combo box is enabled only in the
eConnector configuration dialog. If the activation is OFF,
the component won't perform any actions during files
processing.
Pass through

components. This check box is enabled only in the
eConnector component.
Account
This group contains connection parameters.
GoogleDocs ID
Enter Google Docs user ID. This ID is actually the user's

e-mail used in the Google Docs user account.
Password
Enter the password for the Google Docs user account.
Select this check box if you want to obtain the password

via RRT. When this check box is selected, the Password
text box becomes disabled. In this case the component
will use the password obtained via RRT at run time to
connect to the Google Docs service.
Password RRT
Enter an RRT or a combination of RRTs that will be

replaced with the actual password at run time.
Test
Click this button to test the connection. This button is

enabled only if the Obtain password via RRT is not
selected and the Password text box is used for entering
the password.
Timeout (sec.)
Specify the timeout in seconds for connection to Google

server. When the timeout expires, the component aborts
connection and rejects the document.
Use default timeout (100 sec.)
Select this check box to use the default timeout. The

default timeout is 100 seconds.
Proxy settings
This group of options defines proxy settings. Test

connection through proxy by clicking the Test button in
the Account group.
Use proxy
Select this check box if you use proxy to connect to

Google Docs.
Proxy address
Enter the address of the proxy server.
Port
Enter the port number of the proxy server.
Select this check box if the proxy server requires

authentication. If proxy server uses the NTLM
authentication scheme, skip this check box.
519
Option
Description
Login
Enter proxy user name. If proxy server uses

NTLM authentication scheme, you must specify
the user name and domain name in the form
"MYCOMPANYCOM\Username"
Password
Enter proxy password.
Destination
This group specifies destination parameters.
Convert to GoogleDoc format
Select this check box if you want to convert uploaded

documents into Google Docs format.
Note: Only the documents of the following
formats can be converted: XLS, XLSX, ODS,
CSV, TAB, TSV, TXT, TSB, DOC, DOCX,
HTM, HTML, PPT, PPS, PPTX, JPG, GIF,
PNG, ODT, SXW
Retry upload as file if conversion failed
If this option is selected and the document fails to be

converted(due to an error or because the format is not
supported), the component will try to upload it without
conversion.
Google directory
Enter the path to the directory within the Google Docs

account into which the documents will be routed. For
example, MyFolder1/SubFolder1. If this text box
is empty, then the root directory of the Google Docs
account will be used. You can enter the path manually or
click the button
to open the Select Directory dialog
box. This dialog box allows selection of the directory
in the displayed tree. If the specified directory does not
exist within the Google Docs account, it will be created
at run time.
Note: The "/" symbol cannot be used as folder
name in this text box as it is reserved as a
delimiter in the folder path. Also this symbol
should not be used at the beginning or at the end
of the Google directory value.
Rename file
Select this check box if you want to change the name

of the routed document. In this case, enter a rename
schema into the text box. The default rename schema is
~GDR::FileName~_~GDR::Counter~.

520
Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
521
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
522

Constants
Examples:

Boolean).
value False.
Identifiers
Operators
523
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
Component RRTs
Component RRT ID
The RRT ID for this component is GDR.
RRTN
Description
FileName
Original file name value.
FileExt
Original file extension value.
Counter

GUID
Globally unique identifier of the document generated at

run time, contains only upper-case hexadecimal letters
and digits.
URL
The URL of the routed document in Google Docs. If

the component processes a batch of several documents,
524
RRTN
Description
this RRT is replaced by their URLs separated by
semicolon. This RRT is applicable only for the Google
Docs eConnector component and can be used in the
URL.*
The URL of a routed document from the processed

batch. The * should be replaced by a corresponding
number. For example, ~GDR::URL.1~ for the first
document in the batch, ~GDR::URL.2~ for the second
document. This RRT is applicable only for the Google
Docs eConnector component and can be used in the
Note:
The component replaces ~GDR::FileName~, ~GDR::Counter~, ~GDR::FileExt~ only in the
Rename schema text box in the Google Docs configuration dialog box.
If the ~GDR::Counter~ and ~GDR::Guid~ are used in one rename schema, then the
~GDR::Counter~ is replaced by 0 as the ~GDR::Guid~ guarantees the unique name. Therefore, there is
no sense in using these two RRTs in one rename schema.
~GDR::FileName~_~GDR::Guid~ will be replaced by "MyDocument_b14fd21a-8a35-4074ae32-92e54a38a6b8"

~GDR::URL~ is replaced by "http://spreadsheets.google.com/ccc?
key=0AosfBrMfMJRldHNDV29tZzNkU1dHT2dfQzZRM1RreXc&hl=e"

SSRTN
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
525
SSRTN
Description
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

~GDR::%Y~-~GDR::%m~ will be replaced by "2011-02".
Only the documents of the following formats can be converted into Google Docs format:
XLS, XLSX, ODS, CSV, TAB, TSV, TXT, TSB, DOC, DOCX, HTM, HTML, PPT, PPS, PPTX, JPG, GIF, PNG,
ODT, SXW
The "/" symbol cannot be used as a folder name for the Google directory setting in the Google Docs
configuration dialog box, as it is reserved as a delimiter in the folder path. This symbol should also not be used at
the beginning or at the end of the Google directory value.
The Google Docs service imposes limitation on the size of the uploaded documents. If the limit is exceeded, an
error will be returned. Please, refer to the Google Docs documentation to find out the information about size
limits.
The component is certified and provides users with the complete compatibility with Google Drive service.
Problem
The following error message appears when you click the
Test button or at run time:
Solution
Probably your GoogleDocs ID or password is incorrect.
Check the connection parameters.
"Unable to update Authentication Token (Invalid

credentials)".
The following error message appears when you click the
Test button or at run time:
"Captcha required".
This error message may appear if there is a problem in

logging in to Google Docs; for example, if incorrect
password was entered for several times. In this case,
enter the Google Docs via web interface and fill in the
required CAPTCHA field.
HP MFP/Digital Sender OXPd

Welcome to the HP MFP/Digital Sender (OXPd) component
HP MFP/Digital Sender (OXPd) component allows direct integration of HP OXPd MFPs with the workflow server.
This component provides key functionality such as:
Support for multi-layered menu configurations

Support for various meta-data field types such as Text, Numeric, Date/Time, List, and Label field types.
Support for Single Touch Scan when there is no need to enter document meta-data at the MFP panel.
Support for various Scan Setting parameters; option to allow the user change the scan setting at the MFP panel.
526
Device groupings allows devices to be grouped into functional or organizational groups.

Windows and Novell authentication at the MFP pane. In addition to Windows and Novell authentication, custom
authentication allows you to configure specialized authentication methods.
Getting started
Device setup
Prerequisites for installation
There are minimum firmware requirements for HP devices.
Visit the HP website for more information and for firmware downloads.
Group 10
CLJ 9500mfp 08.170.9

CLJ 4730mfp 46.260.9
LJ 9040mfp 08.170.9
LJ 9050mfp 08.170.9
LJ 4345mfp 09.180.9
DS 9200C 09.180.8
Group 20
LJ M3035 MFP 48.131.3

LJ M4345 MFP 48.131.3
LJ M4349 MFP 48.131.3
LJ M5035 MFP 48.131.3
LJ M5039 MFP 48.131.3
LJ M9040 MFP 51.081.2
LJ M9050 MFP 51.081.2
LJ M9059 MFP 51.081.2
CLJ CM4730 MFP 50.111.3
DS 9250C 48.121.0
Group 40
CLJ CM6030mfp series

52.081.2
52.081.2
52.081.2
Group 50
CLJ CM3530 MFP 53.061.3

Jedi
Note: OXPd 1.4 is pre-installed for Jedi devices with firmware 11.1.
CLJCM4540MFP 2110179_149073
SJ7000n 2110180_149077
To install firmware for the Jedi group, follow directions that provided with your firmware download from the HP
website.
HP OXPd can be installed using the HP Web Jetadmin or Solution Installer. HP Web Jetadmin is recommended
when upgrading a large number of devices. Several devices can be added to a specific group which can be created
with HP Web Jetadmin. Solution Installer is recommended for simple configurations such as the upgrading of one
527
device at a time. The solution management capabilities of HP Web Jetadmin 10.2.X support integration with OXPds
Solution Installer. HP Web Jetadmin can be downloaded from HPs website. Prior to installing OXPd jar files, prior
installations of other jar files should be removed to ensure there are no conflicts.
Important: During the Chai DSE and OXPd jar file installation process (using either Solution Installer or
HP Web Jetadmin), AutoStore server must be running with a configuration that uses the HP OXPd Capture
component along with any Route component. The HP OXPd Capture component publishes the Chai DSE
and OXPd jar file through the HTTP protocol, which is only possible while running a valid AutoStore
configuration.
Using HP Web Jetadmin to install the component
HP OXPd can be installed using HP Web Jetadmin or Solution Installer.
The HP Web Jetadmin is recommended for installing HP OXPd if you are upgrading a large number of devices.
Several devices can be added to a specific group which can be created with HP Web Jetadmin. Solution Installer is
recommended for simple configurations such as the upgrading of one device at a time. The solution management
capabilities of HP Web Jetadmin 10.2.X support integration with OXPds Solution Installer. HP Web Jetadmin can be
downloaded from HPs website.
Note: OXPd 1.4 is preinstalled for Jedi devices with firmware 11.1.
Important: During the Chai DSE and OXPd jar file installation process (using either Solution Installer
or HP Web Jetadmin), AutoStore server must be running with a configuration that uses the HP OXPd
Capture component along with any Route component. The HP OXPd Capture component publishes the Chai
DSE and OXPd jar file through the HTTP protocol, which is only possible with a running valid AutoStore
configuration.
Follow these steps to install Chai DSE, OXPd:Workflow and Authentication Agent components with HP Web
Jetadmin using Groups and Templates:
Step 1 Check firmware

Step 2 Remove all prior jar file installations
Step 3 Create Groups
Step 4 Import Solution Installer, Chai DSE & OXPd:Workflow components
Step 5 Import Authentication Agent components
Step 6 Create templates for installation
Step 7 Apply templates
Templates can be used for uninstalling Chai DSE, OXPd:Workflow and Authentication Agent as well.
How to uninstall using HP Web Jetadmin
You can use HP Web Jetadmin to uninstall prior jar file installations.
Check for and remove any prior jar file installations.
1.
2.
3.
4.
Click View and Task Modules.

Then click Task Module Docking Area.
In the right pane of the HP Web Jetadmin window the Task Module Docking Area will be displayed.
In the Task Module Docking Area, click Uninstall Solution.
The Uninstall Solution window will be displayed.
5. Select all of the solutions, and click Next.
The confirmation prompt will be displayed.
6. Click Uinstall.
If this procedure is successful, a Success message is displayed.
How to create groups
Using groups to organize devices is a fast and convenient method of updating several devices or groups of devices at
one time.
Several devices can be added to a specific group which can be easily created with HP Web Jetadmin.
528
1. In the left panel, click Groups.

This opens Groups on the right, in which you can create new groups, edit, delete and view groups, and add
devices to existing groups.
2. Click New Group.
This opens the New Group dialog box.
3. Enter the Group name, and click Next.
4. Click Create Group on the next window.
5. Click Done.
How to add a device to a group
You can add a devices to an existing group.
1. Click the Add Devices button.
This opens the Add Devices dialog box.
2. Use Source to select a specific group of devices.
3. After selecting the devices, click the >> button to add devices to the Devices to add panel.
4. Click Next.
5. Click Add Devices.
This displays a Success message if the device was added successfully.
How to import Solution Installer and Chai DSE & OXPd:Workflow components
The Solution Installer, Chai DSE and OXPd:Workflow components must be imported into the Repository.
Import Solution Installer on page 529

Import Chai DSE on page 529
Import OXPD:Workflow on page 530
Import Solution Installer

1. In the left panel, under Solutions, click Repository.
This opens the Repository on the right where Solution Installer, Chai DSE and OXPd:Workflow components
can be imported, edited, deleted and installed.
2. Click Import.
This opens the Import Solutions window.
3. Click Browse and select hp_oxpdsolutioninstaller-ex-1.0.1.0.jar located inside ..\Distributables\HP MFP-Digital
Sender (OXPd)\jars\.
4. Click Open and then click Import on the Import Solutions window.
This configures the pointer to point to the solutions repository.
Solution Installer will be displayed as ILCStealthUpdater within the repository.
Import Chai DSE
1. In the left panel, under Solutions, click Repository.
This opens the Repository on the right where Solution Installer, Chai DSE and OXPd:Workflow components can
be imported, edited, deleted and installed.
2. Click Import.
3. Click Browse and select the chai.xml file for the Chai DSE jar solution to be installed.
The Chai DSE file for OXPd:SolutionInstaller is located within ..\Distributables\HP MFP-Digital
4. Click Import.
This configures the pointer to point to the solutions repository. Chai DSE will be displayed as Chai Digital Send
Enablers-V.4.3.0 within the repository.
5. Select Chai Digital Send Enablers-V.4.3.0, and click Edit.
6. Enter the web address of the JAR file (solution) to install. This tells the pointer where to get the solution when it is
installed from the repository.
529
Use the following http://host_name:3233/HPDS2/GetFile/chai. where host_name is the IP address or DNS name
of the AutoStore Server running a configuration that uses the HP OXPd component.
If the actual machine name is used, note that the machine name or complete DNS path name will need to be used
depending on the network configuration. Check with the system administrator.
7. Leave the username and password blank, and click OK.
Chai Digital Send Enablers V.4.3.0 should be displayed in the Repository.
Import OXPD:Workflow
1. In the left panel, under Solution, click Repository.
This opens the Repository on the right where Solution Installer, Chai DSE and OXPd:Workflow components can
be imported, edited, deleted and installed.
2. Click Import.
3. Click Browse and locate the oxpd.xml file for the OXPd:Workflow jar solution to be installed.
The OXPd:Workflow jar files are located inside ..\Distributables\HP MFP-Digital Sender
(OXPd)\jars\.
4. Click Import.
This imports the pointer into the Solutions Repository, where it will be displayed as OXPd: Workflow 1.4.9.0 in
the repository.
Note: If this is not displayed then delete Chai Digital Send Enablers-V.4.3.0 from the Repository and start
over.
5. Select OXPd:Workflow 1.4.9.0, and click Edit.
6. Enter the web address of the OXPd:Workflow jar file solution to install. This tells the pointer where to get the
solution when it is installed from the repository.
Use the URL http://host_name:3233/HPDS2/GetFile/oxpd, where host_name is the IP address or DNS name of
the AutoStore Server running a configuration that uses the HP OXPd component.. If the actual machine name
is used, note that the machine name or complete DNS path name will need to be used depending on the network
configuration. Check with the system administrator.
7. If credentials are necessary to reach the server, enter the user name and password.
8. Click OK.
OXPd: Workflow 1.4.9.0 should be displayed in the Repository.
How to import Authentication Agent components
The Authentication Agent component must be imported into the Repository.
1. In the left panel, under Solutions, select Repository.
This opens the Repository on the right, where Authentication Agent components can be imported, edited, deleted
and installed.
2. Click Import.
3. Click Browse.
4. Select the AutoStoreAuthxx_xxx.jar file for the Authentication Agent to be installed.
The Authentication Agent file for OXPd:SolutionInstaller is located within ..\Distributables\HP MFP-Digital
5. On the Import Solutions windows, click Import.
This configures the pointer to point to the solutions repository. The Authentication Agent will be displayed as
Autostore Auth Agent within the Repository.
Once the Authentication Agent is imported, a Success dialog box is displayed.
6. All versions of the Authentication Agent that have been imported will be displayed in the Repository. Repeat for
other Authentication Agent component versions, if needed.
7. Ensure the Show versions (Advanced) check box is selected.
530
How to create and use templates for installation
Create Template for Chai DSE on page 531

How to create a template for OXPd:Workflow on page 532
Create Template for Authentication Agent on page 532
Create Template for Chai DSE

1. In the left panel, under Solutions, click Templates.
This opens Solution Templates in the right panel where templates can be created, applied, edited, deleted or
copied.
2. Click Create.
This will open the Create Solution Template window.
Tip: Installation against a large number of devices can take several hours. In order to minimize downtime,
installation can be scheduled to occur during non-peak periods by selecting the Schedule option.
3. Select Install and click Next.
4. Select Chai Digital Send Enablers-V.4.3.0.

This file will be installed when using the template.
5. Click Next.
6. Select the settings for the solutions to be installed. Enter the proper Application URL.
531
This will be in the form of http://host name:3233/HPDS2/GetFile/chaixx, where host name is the IP address or
DNS name of the AutoStore Server running a configuration that uses the HP OXPd component. If the actual
machine name is used, note that the machine name or complete DNS path name will need to be used depending
on the network configuration. Check with the system administrator. With chaixx, the xx refers to the Group
xx where xx = 10, 20, 30, 40 or 50.
7. Make sure that Activate Choice for Solution is pushed.
9. Specify template name, and click Next.
10. Confirm and create template.
If this procedure is completed successfully, the message Template was saved successfully will be
displayed.
How to create a template for OXPd:Workflow
copied.
2. Select Create.
3. Choose Install, and click Next.
4. Select OXPd: Workflow 1.4.9.0.
This file will be installed when using the template.
5. Click Next.
6. Select the settings for the solutions to be installed. Enter the proper Application URL.
This will be in the form of http://<HOST NAME>:3233/HPDS2/GetFile/oxpdxx where HOST NAME is the
IP address or DNS name of the AutoStore Server running a configuration that uses the HP OXPd component. If
the actual machine name is used, note that the machine name or complete DNS path name will need to be used
depending on the network configuration. Check with the system administrator. With oxpdxx, the xx refers to
the Group xx where xx = 10, 20, 30, 40 or 50.
7. Make sure that Activate Choice for Solution is pushed.
10. Confirm and create template.
If this procedure is successful, the message Template was saved successfully will be displayed.
Create Template for Authentication Agent
This opens Solution Templates in the right panel, where templates can be created, applied, edited, deleted or
copied.
2. Click Create.
3. Click Install, and click Next.
4. Select the AutoStore Auth Agent corresponding to the group for which the template has been created.
Ensure that Show versions (Advanced) is selected. These files will be installed when using the template.
5. Click Next.
7. Confirm and create the template.
532
How to apply installation templates
Once Templates have been created they can be applied. By applying previously created Templates, Chai DSE
and OXPd:Workflow components will be applied to the selected devices or groups. It is important to note, when
applying Templates, Templates must be applied in the following order: 1) Chai DSE, 2) OXPd:Workflow and finally
3) Authentication Agent (if authentication is used on the device). It is important to note that each component must
be successfully installed prior to installing the next component. Also note, that uninstallation must occur in reverse
starting with 1) Authentication Agent (if authentication is used on the device), 2) OXPd:Workflow and finally 3) Chai
DSE.
How to apply the Chai DSE template on page 533

Applying the OXPd:Workflow Template on page 533
Applying the Authentication Agent Template on page 534
How to apply the Chai DSE template

1. To apply template solutions, click Apply.
This opens the Apply Solution Template.
2. Select the template to be used.
3. Under Selection method, click Devices or Groups. If you select Devices, all available devices will be returned,
and you should complete the following steps:
a) Use Source to select a specific group of devices.
b) After you select the devices, click the >> button to add devices to the Selected devices panel.
Groups which consist of more than one device can be selected as well. Instructions for creating Groups can be
found at the beginning of this document.
c) Click Next.
4. Click Apply Template to install the solution.
Important: When the template is applied, the device will automatically reboot.
A status screen will be displayed which shows whether the installation was successful.
5. To verify that the Chai DSE files are installed, use the following link:
http://{Device_IP_Address}/hp/device/hp.OXPdSolutionInstaller
The following message should be displayed:

Chai Digital Send Enablers - V 4.3.0 Load Status: Loaded Applying the OXPd:Workflow Template
Applying the OXPd:Workflow Template
The Apply Solution Template will be displayed.
b) After you select the devices, click the >> button to add devices to the Selected devices panel.
Groups which consist of more than one device can be selected as well. Instructions for creating Groups can be
found at the beginning of this document.
c) Click Next.
4. Click Apply Template to install the solution.
Important: It is important to note when the template is applied, the device will automatically reboot.
5. To verify that the OXPD:Workflow jar files are installed, use the following link:
533
http://{Device_IP_Address}/hp/device/hp.OXPdSolutionInstaller
The following message should be displayed:

OXPd:Workflow 1.4.9.0 Load Status: Loaded Applying the Authentication Agent Template
Applying the Authentication Agent Template
This displays the Apply Solution Template.
b) After selecting the devices, click the >> button to add devices to the Selected devices panel.
Note: Groups which consist of more than one device can be selected as well. Instructions for creating
Groups can be found at the beginning of this document.
c) Click Next.
4. Click Apply Template to install the Authentication Agent.
5. To verify, enter the URL, http://device_ip/hp/device/this.loader where device_ip is the IP address for the device
into a web browser.
6. In the Reloadable Packages section, see if AutoStore Auth Agent is listed.
Using templates for uninstallation
In the same manner that Templates were created and applied to facilitate installation of Chai DSE, OXPd:Workflow
and Authentication Agent components, Templates can be used to uninstall Chai DSE, OXPd:Workflow and
Authentication Agent components. It is important to note, when applying uninstallation Templates, uninstallation
must occur in the following order 1) Authentication Agent (if authentication is used on the device), 2)
OXPd:Workflow, and finally 3) Chai DSE. Ensure that each component has been successfully uninstalled before
moving on to the next component.
Uninstall Authentication Agent on page 534

Uninstall OXPd:Workflow on page 535
Uninstall Chai DSE on page 535
Once the templates have been created for Chai DSE, OXPd:Workflow, and Authentication Agent, they can be applied
in a similar manner as Installation Templates are applied. Again, it is important to note, when applying uninstallation
Templates, uninstallation must be completed in the following order: 1) Authentication Agent (if authentication is
used on the device), 2) OXPd:Workflow and finally 3) Chai DSE. Ensure that each component has been successfully
uninstalled before moving on to the next component.
Uninstall Authentication Agent
1. In the left panel, under Solutions, select Templates.
copied.
2. Click Create.
Tip: Removing an installation against a large number of devices can take several hours. In order to minimize
downtime, removal can be scheduled to occur during non-peak periods by selecting the Schedule option.
3. Select Remove, and then click Next.
4. Select Authentication Agent files to be removed when using the template.
Templates have the capability of removing several Authentication Agent files at one time, so if all Authentication
Agent files must be removed, select all versions of AutoStore Auth Agent.
5. Ensure Show versions (Advanced) is selected.
534
6. Click Next.
7. In the Create Solution Template window, specify a name for the template and Click Next.
8. Click Create Template.
If the prorcedure is successful, the message Template was saved successfully will be displayed.
Uninstall OXPd:Workflow
copied.
2. Click Create.
3.
4.
downtime, removal can be scheduled to occur to occur during non-peak periods by selecting the Schedule
option.
Select Remove, and click Next.
Select OXPd: Workflow 1.4.9.0.
The file will be removed when using the template.
Click Next.
In the Create Solution Template window, specify a name for the template and Click Next.
5.
6.
7. In the next window click Create Template.
Uninstall Chai DSE
copied.
2. Select Create.
downtime, removal can be scheduled to occur during non-peak periods by selecting the Schedule option.
3. Click Remove, and then click Next.
4. Select Chai Digital Send Enablers-V.4.3.0, and click Next.
The file will be removed when using the template.
5. In the next window click Create Template.
If the procedure is successful, the message Template was saved successfully will be displayed.
Solution Installer
Installation using Solution Installer
HP OXPd can be installed using HP Web Jetadmin or Solution Installer.
Before yo ustart this procedure, ensure that Solution Installer is installed.
The HP Web Jetadmin is recommended for installing HP OXPd if you are upgrading a large number of devices.
Several devices can be added to a specific group which can be created with HP Web Jetadmin. Solution Installer is
recommended for simple configurations such as the upgrading of one device at a time. The solution management
capabilities of HP Web Jetadmin 10.2.X support integration with OXPds Solution Installer. Solution Installer is
installed when the HP OXPd component is installed.
It is very important to note that during the Chai DSE and OXPd jar file installation process (using either Solution
Installer or HP Web Jetadmin), AutoStore server must be running with a configuration that uses the HP OXPd
Capture component along with any Route component. The reason is that the HP OXPd Capture component publishes
the Chai DSE and OXPd jar file through the HTTP protocol which is only possible with a running valid AutoStore
configuration.
535
1. Enter the URL, http://device_ip/hp/device/this.loader, where device_ip is the IP address for the device into a web
browser.
2. Click Browse and select hp_oxpdsolutioninstaller-ex-1.0.1.0.jar located inside ..\Distributables\HP
MFP-Digital Sender (OXPd)\jars\.
3. Click Open.
4. To access the OXPd:SolutionInstaller User Interface webpage, enter the following web address into the browser:
http://Autostore Server IP:3233/HPDS2/Install, where Autostore Server IP is the IP address of the machine
where the Autostore server is installed.
5. Ensure the proper firmware has been installed on the device, then enter the IP address of the device into the field
labeled Device IP.
6. Enter the user name and password to access the device.
7. Click GetVersionInfo to get version information for the device.
8. Click ListApps to get information on which applications and components have been installed.
If this is a new install of Chai Digital Send Enablers-V.4.3.0 and OXPd:Workflow 1.4.9.0, there will be no
references to either of these components.
9. To install Chai DSE, browse and locate the directory ..\Distributables\HP MFP-Digital Sender
(OXPd)\jars\.
10. For Chai DSE, select the file chai.xml.
11. Enter the App URL.
The App URL will be in the form of http://host_name:3233/HPDS2/GetFile/chaixx where host_name is the IP
address or DNS name of the AutoStore Server running a configuration that uses the HP OXPd component. If
the actual machine name is used, note that the machine name or complete DNS path name will need to be used
depending on the network configuration. Check with the system administrator. With chaixx, the xx refers to
Group 10, 20, 30, 40 or 50.
12. Click InstallApp.
In the right pane of the window, the message 202 Accepted will appear.
13. Click ListApps to get the status of the installation.
While installation is continuing, the message Loading will be displayed.
14. Select ListApps several times until the message Loaded is displayed.
15. Select ListApps to display the application id.
There may be several applications installed onto the device. The application id is displayed immediately before the
application name.
16. Check to make sure the right application id is being selected.
17. Copy and paste the application ID into the AppID field. Click GetAppStatus to retrieve status information for
the application.
18. Repeat step 6 on page 536 through step 15 on page 536 for OXPd: Workflow.
In step 8 on page 536, select the file oxpd.xml.

In step 11 on page 536, the App URL will be in the form of http://host_name:3233/HPDS2/GetFile/oxpdxx,
where host_name is the IP address or DNS name of the AutoStore Server running a configuration that uses the
HP OXPd component.
If the actual machine name is used, note that the machine name or complete DNS path name will need to be
used depending on the network configuration. Check with the system administrator. With oxpdxx, the xx
refers to Group 10, 20, 30, 40 or 50.
browser.
20. In the Enter Package File section, click Browse.
21. Select the AutoStoreAuthxx_xxx.jar file for the Authentication Agent to be installed, and click Open
536
The Authentication Agent file is located within ..\Distributables\HP MFP-Digital Sender

(OXPd)\jars\.
22. Once the Authentication Agent file has been selected, click Load Package Now.
Once the Authentication Agent file has been loaded, a Success message will be displayed.
23. Click Loader Home.
Verify that Authentication Agent is installed.
Uninstallation using Solution Installer
This procedure steps through using Solution Installer to uninstall Chai DSE.
Keep in mind that uninstallation must take place in the following order:
1.
2.
3.
4.
5.
Using Package Loader, remove Authentication Agent

Using Solution Installer, remove OXPd:Workflow components
Using Solution Installer, remove Chai DSE components
Using Package Loader, remove Solution Installer
Using Package Loader, remove Chai SSL Service
1. For Enter Package URL, enter http://device/hp/device/this.loader, where device is the IP address for the device
into a web browser.
2. In the Reloadable Packages section, select AutoStore Auth Agent.
3. Click Remove Selected Packages.
The message that the Authentication Agent has been unloaded will be displayed.
4. Click ListApps to display the application ID.
There may be several applications installed onto the device. The application ID is displayed immediately
before the application name. Check to make sure the right application ID is being selected. Keep in mind that
OXPd:Workflow components must be uninstalled first. Once OXPd:Workflow components are uninstalled, then
Chai DSE components can be uninstalled.
5. Copy and paste the application ID into the AppID field.
6. Click UninstallApp to uninstall the application.
Once the application has been uninstalled, the message 202 Accepted will be displayed.
7. After steps 4 on page 537 through 6 on page 537 are completed for uninstalling OXPd:Workflow
components, then complete the same steps for uninstalling Chai DSE components.
browser.
9. In the Reloadable Packages section, select OXPd:SolutionInstaller.
This displays the message OXPd:SolutionInstaller unloaded.
browser.
12. In the Reloadable Packages section, select Chai SSL Service.
This displays the message ChaiSSLConfig unloaded.
14. Enter the URL, http://device_ip/hp/device/this.loader. where device_ip is the IP address for the device into a web
browser.
15. In the Reloadable Packages section, select Chai SSL Service.
After you complete this procedure, no packages should be displayed in the Reloadable Package section.
How to configure OXPd to work with an AutoStore server
1. Access the devices setup web page by typing the following URL in your browser: http://Device_IP_Address,
where Device_IP_Address is the IP address of the device.
2. Click the Digital Sending tab.
537
3. Click the OXPd:Workflow button on the left side of the page to display the OXPd:Workflow configuration
page.
4. Take Server URL or Server SSL URL from Preferences Tab of HP MFP/Digital Sender (OXPd) component,
replace localhost with real AutoStore server name and add GetXml at the end of URL.
For example, if Server URL is http://localhost:3233/HPDS2/ and address of AutoStore server is
autostore.mycompany.com, then the resulting URL will be http:// autostore.mycompany.com:3233/HPDS2/
GetXml. The IP address of the machine where the AutoStore server is installed can also be used. In this instance,
the resulting URL will be http://10.16.16.142:3233/HPDS2/GetXml. Put the resulting URL l in the URL#1 field.
5. Select Apply URL Polling Service Settings and then Force Update Now.
Make sure that the URL and the name of the Autostore group appears below the Apply URL Polling Service
Settings button.
How to configure the authentication agent
1. Enter the URL, http://device_ip>/hp/device/this.loader where device_ip is the IP address for the device into a web
browser.
2. In the Reloadable Packages section, click the link AutoStore Auth Agent.
3. Click Configure AutoStore Authentication Agent.
4. Click the Settings tab.
5. Click AutoStore Authentication on the left side of the page to display the AutoStore Authentication
configuration page.
6. For Server Authentication URL enter https://host_ip_address:3234/HPDS2/Auth where host_ip_address is the
address of the AutoStore server.
7. When using SSL (https) communication protocol, provide a certification authority (CA) certificate.
A CA certificate is used to sign a certificate configured in HP MFP/Digital Sender (OXPd) Capture component in
base-64 encoded X.509 format.
8. Click Apply to save the settings.
9. Click Test to verify the certificate is valid.
Using the OXPd component: Configuring the workflow
In this example, a workflow will be created which captures documents from Digital Sender 9250C.
On the device, during a scanning process, the user will be able to enter a string value or select it from the preconfigured list. This string value will be used as a folder under the pre-configured folder, which will be created. This
is where the captured file will be stored.
1. Drop HP MFP/Digital Sender (OXPd) and Folder Store components into the Process Designer.
2. Open the properties section of HP MFP/Digital Sender (OXPd) component and click the Preferences tab.
The URL can be based on either HTTP or HTTPS (SSL).
3. On the General tab, select Default form, and click the Edit Button.
4. Clear the Default checkboxes check box, and select the Allow Changes checkbox Paper Size, Page
Orientation, Color Mode and Resolution.
These selections will allow the user to change these scan settings directly on the device.
5. On the Fields Tab, select List from the drop-down list of available types.
6. Enter Folder for Name and Folder Where to Save for Display.
7. Click the properties button (...) of the field being configured.
8. Enter random values and labels and check whether they appear by default on the device display. If they do, select
OK.
9. In the Form Settings dialog box, click the Components tab.
10. Click on the properties button ... of Folder Store component.
The properties for the Folder Store component will be displayed along with Available RRTs.
11. Configure the folder store component with the following options:
538
Option
Configuration
Folder Path
C:\dest\~DS2::%Folder%~ (use HP MFP/

Digital Sender (OXPd) RRTs)
Rename file
No (file names are already unique so there is no make

them unique)
12. Click the OK button in Folder Store component. Choose not to create folders now.
13. Press OK button in Form Settings dialog, and then click OK in the HP MFP/Digital Sender (OXPd)
14. Save the workflow in Process Designer (click File > Save and specify the file name Hp2Demo.cfg), and then
close the Process Designer.
15. Start the process from the Service Manager interface.
Using the HP OXPd Capture component
General tab
This tab defines menu structure that will be shown on the HP OXPd MFP. The devices can be grouped based on their
IP address. Each group of devices can have its own menu structure. By default there is a single group called Default
Device Group. If no additional groups are configured, all devices pointed to the workflow server will display the
menu structure under Default Device Group.
Use this tab to Add, Edit, or Remove the following:
Group
Menu
Application
Form
Additional groups can be created and devices assigned to newly created groups. Through this process, all devices
connected to the same workflow server will still be capable of being used for different functions. Drag and drop
functionality is available to change the order of menus and forms that appear on the MFP control panel.
Option
Description
Add
Select this button to create create one of the following

elements:
Group
Menu
Application
Form
Edit
Click this button to edit the selected group, menu,

application or form.
Remove
Click this button to delete the selected group, menu,

application or form.
Group
Select this option to add a group.
Each group entry requires the following entries:
Field Name
Name
Description
Enter a name for the group to be created. This is a string
value describing the name of the group. This name does
539
Field Name
Description
not appear on the panel and it is used only as a logical
group name. This component is equipped with a default
group called "Default Device Group". A Menu and/or
Form can be added to this group.
Associated MFPs
Enter the IP address or the host name of the devices

that belong to this group. Select Ping to validate the
hostname/IP address of the MFP.
If unchecked, the authentication level of the group is

used. If checked, the authentication level of the
component is used.
Application
Workflow applications are represented by a top-level button on the MFP device.
Define the workflow application parameters. Pressing the application button may lead to one or more forms.
Field Name
Description
Display Name
Enter a name for the application being created. This will

be a string value describing the name of the application.
This name does not appear on the panel and it is used
only as a logical group name.
Display Description
Enter a description for the application.
Icon
Standard Icon - If this option is enabled, select one of the

available icons from the drop down list. Otherwise select
the customized icons:
"Up" iconSelect the icon for application button.

"Down" iconSelect the icon when the user
touches the application button.
"Disabled" iconSelect the icon when the
application button is disabled.
Note: There is no size restriction for the icon.
Icons are automatically resized to fit.
Action List
Check this box to enable single Touch Scan to

immediately initiate a scan operation.
Menu
Add a menu to create a hierarchy. The menu entry guide an MFP user to select the desired workflow.
Field Name
Description
Name

unique from other menu names at the current nesting
level.
Display Text
Enter the name that as it should be displayed on the MFP

panel.
Action List
Select this check box to enable single Touch Scan to

540
Form
When setting up a form, configure settings on the General, Fields, and Components tabs.
General Tab
Fields Tab
Components Tab
General Tab
Field Name
Description
Name

Display Name
The name that will be displayed on the MFP for this

form.
Description
Description of the form.
Single Touch Scan
Check this option if the user should be restricted from

entering any indexing data about the document. By
selecting this option, the scan operation will start
immediately after the user presses the "form" button on
the device.
Scan Button Label
Label to be displayed on the Scan button.
Scan Settings
This table lists all the available scan settings. In the

Value column default scan settings can be configured,
which will be used if the user does not change the setting
at the device panel. Check Changeable checkbox on
each setting to provide the user the ability to change
setting from the device panel. See HP OXPd User Guide
for detailed description of each scan parameter.
Job Assembly ModeSpecifies whether job

assembly mode should be used. The default is off.
Job assembly mode allows the user to assemble a
complete scan job, one set of pages at a time. This is
necessary when the ADF is not big enough to hold
the entire job, when the user has several documents
of different sizes that need to be scanned, or when
the flatbed scanner is being used to scan multiple
pages. Job assembly mode prompts the user to place
additional material either in the ADF or on the glass.
This prompt allows the user to indicate that there are
no more documents to scan. For some devices, it also
allows canceling the job.
Duplex ModeSpecifies whether duplex mode
should be used (whether both sides of a document
should be scanned). The default is simplex.
Page SizeProvides the list of available page size.
File TypeProvides the list of available file types.
The TIFF and JPEG file formats generate one file
per document page. The other formats include all
pages in the same file.
541
Field Name
Description
Page OrientationOrientation of the target

document, either portrait or landscape
Color ModeProvides the enumeration for an
available color mode. The target document will
be rendered in grayscale or color. If no value is
specified, color will be used. If the device can only
scan in monochrome then all scans, regardless of
specification, will be monochrome.
Output QualityDetermines the trade-off between
quality and file size.
Optimize Text PhotoProduces a target document
with the text or graphics optimizedthis determines
which content will look better in the output.
DarknessSets the lightness/darkness of the
image. It is a value between 0 8. The default is 4.
Background CleanupAllows removal of the
background. It is a value between 0 8. The default
is 2.
SharpnessAdjusts the smoothing/sharpness. It is
a value between 0 4. The default is 2.
The following scan setting options are available with

selected models:
Dynamic Form
ContrastAllows contrast to be increased or

decreased. It is a value between 0 8. The default is
5. This is available with Group 30 devices.
Heavy OriginalsSpecifies whether the original
has heavy paper. Available with Group 10 & 20
devices.
OCR LanguageDetermines the language or
character set used to optimize the Optical Character
Recognition (OCR) engine. Available with Group 30
devices.
Enable Dynamic FormStandard behavior of a form

can be modified by responding to events. This checkbox
allows the workflow sever to load form snap-ins. Here
are some examples of what enabling dynamic forms can
do:

Change field contents (Example: load the contents of
a list field from a database).
Snap-in pathPath to the compiled snap-in (.NET

Snap-in path box. Create/Edit Snap-inYou can
also click the Create/Edit Snap-in button to open a code
editor window with basic snap-in code. For details of
542
Field Name
Description
the code editor window and the object model used to
respond to form and field events, please refer to the HP
MFP/Digital Sender (OXPd) Capture Component Snapin documentation by clicking Help in the code editor
window. Source Path: Path to the source code of the
the snap-in only during design time. Raise event when
Form is LoadedCheck this checkbox to cause the
form to initiate an event every time the user enters the
form. Raise event when Form is Submitted: Select
this checkbox to make the form to initiate an event every
time the user presses Scan button in this form.
Fields Tab
Configure the indexing fields that will be presented to the user. Add fields by clicking on the New field button
appearing as the first column header and labeled with N. Once you have added the first row, you can tab through to
get additional fields added.
Option
Description
Name

within this form.
Display

panel.
Size Type
A field can be full-sized or half-sized. A full-sized field

takes the entire space form the left margin to the right
margin on the MFP panel, a half-sized field takes only
half the space between the margins.
Type

Notify Server
TextAllows a user to enter unformatted text.

NumericAllows a user to enter numbers (with or
be made searchable.
LabelAllows a user to enter text labels as index
value within a form. There can be none or several
free-form labels in a form.
If this check box is selected, this field triggers an event

when the value of the field changes. The event can be
responded to in the snap-in that was configured for the
dynamic form section in the General tab. For details on
543
Option
Description
how to respond to form and field events, refer to the HP
OXPd Capture Component Snap-in documentation.
Properties
Allows user to edit additional properties of the field type.
Components Tab
Configure the component for this form by clicking the Properties button (right-most column on each row). The
configure.
Text field
A text field allows users to enter unformatted text.
Option
Description
Default
The default text that appears on the device panel.
Max Length
Specifies the maximum number of characters that may

be entered.
Required
Select this check box to specify that a value must be

entered into this field before a scan can be initiated. The
default value, if specified, satisfies this requirement.
Password
Obscures data (so it cannot be read) whenever it is

displayed on the control panelincluding while the
data is being entered. This can be used for obscuring
passwords. This obscures the value displayed on the
control panel in the way that passwords are typically
hidden in a user interface. The default value is false.
Search Assist
Static List
Select this check box to enable search assist to provide

a list of item suggestions for a text field. This will speed
up indexing by narrowing down the selections.
Minimum Length
Indicates the minimum number of characters which the

user must enter before the application will search for an
auto-completion item from the list of suggestions.
Suggestion List
Provides the list of suggestions. The list must be sorted

in alphabetical order. The search is not case-sensitive.
List field
The list field type defines a list from which users can select values.
Option
Description
Value
Specifies the value associated with the list item. This

is the value that will be sent to the server and returned
by the field RRT. Entries can be sorted by the Value
column.
Label

column.
544
Option
Description
Selected
Specifies that a list item will be preselected when the

user activates the form. You can preselect multiple list
items ff the Allow Multiple Select check box is selected,
you can preselect multiple list items, otherwise, one list
item can be selected.
Allow Multiple Select
Select this check box to allow the user to select multiple

options. The value of the field will then contain the
selected options separated by Item Separator.
Import
Click this button to export list field value definitions to

a comma separated value (CSV) ASCII file. You can do
this to use a list field definition repeatedly in multiple
work flows.
Export
Click this button to import list field value definitions

from a previously exported CSV file.
Numeric field
An integer field allows the user to enter an integer number (whole numbers, positive or negative, with no fractional
component).
Option
Descritpion
Default Value

device panel.
Required
Select this check box to require that a value must be

entered into this field before a scan can be initiated. If a
default value is specified, it satisfies this requirement.
Maximum Value
Specifies the maximum value that may be entered into

the field. For example, a value of 50 in this element
would allow all values less than or equal to 50.
Minimum Value
Specifies the minimum value that may be entered into

the field. For example, a value of 10 in this element
would allow all values greater than or equal to 10.
Enable Grouping
Select this check box to group the the non-fractional

part of a number. For example, when this check
box is selected, the number one million is shown as
1,000,000. When this check box is cleared, it is shown
as 1000000.
Group Separator
Specifies the character to be used when grouping the

digits of a number. For example, the number one
million is displayed as 1.000.000 if the grouping
separator is set to a period (.). This setting is ignored if
the Enable Grouping check box is cleared.
Grouping Digits
Specifies the number of fractional digits that will be

displayed. For example, the number 10.25 has two
fractional digits. The default number of digits is 2.
Decimal Places
Specifies the number of digits after decimal point.
Decimal Separator
Specifies the character to be used when separating the

non-fractional part of a number from the fractional part.
545
Option
Descritpion
For example, 10,25 if the decimal separator is set to a
comma (,) or 10.25 if the decimal separator is set to a
period (.). This setting is ignored within the scope of an
integer field.
Format String
The format string allows numbers to be formatted in

custom ways.
Specifying Custom Format Strings

The following characters are used in the Format String box to format a numeric string.
String
Description
The zero placeholder indicates that if a value exists in

the digit of the number to be displayed it should be used;
otherwise, a zero will be displayed.
The digit placeholder indicates that if a value exists in

otherwise, no character will be displayed.
The decimal point indicates the position of the decimal

character. The actual character used, however, is
specified first by the number format parameters
described in section 5.7.3.1, Number Format and then
by the default parameters for the current locale.
The grouping separator indicates the number of digits

that should be grouped together in the whole part of the
number. For example, ,0.00 indicates that there
should be four grouping digits used. The actual character
used is specified first by the number format parameters
Used for separating the positive representation from the

negative representation. The positive number format
precedes the negative number format. In the absence of a
negative format, a negative sign - is addedpreceding
all characters.
All other characters are not parsed. A few examples:

The format $,0.00;$(,0.00) yields the following (note that the dollar sign $ is not a special character and is
interpreted literally):
1 -> $1.00
5654.35 -> $5,654.34
-6000.34 -> $(6,000.34)
The format 0.0% yields the following (the percentage sign % is not a special character):
6.5 -> 6.5%

-0.5 -> -0.5%
0 -> 0.0%
Additional characters may only be added to the beginning or end of the format string.
546
Label field
The label field type allows define labels for use in a form.
Option
Description
Font
Select the font appearance (type, size, and color) options

to use for the label. The elements that describe the
appearance of the font are not applied on all devices. A
particular font type, size and color may not be supported
on all devices.
Alignment
Horizontal alignment of the label text within the label

box. This predefined identifier may be Right, Center, or
Left. The default alignment is Left.
Line Wrap
Select this check box to wrap text to subsequent lines.

When this check box is cleared, the text will be truncated
if necessary to fit in one line.
Date Time field

A date time field allows a workflow to capture dates and times from the console.
Option
Description
Default Value
The default value can be represented in two ways:
Time interval from nowWhen selected, the

default value of the field will be the time when the
user opens a form plus the interval. For example, if
default time is to be set to yesterday, enter "-1" into
the Time interval from now checkbox.
Fixed timeWhen selected, a user opens up a form
which contains this field and its value will be exactly
as specified in the Fixed time text-box.
Displayed format on the device side
This field defines the format of the date or time, in which

the date/time value will appear on the device panel.
Enter a date/time format string in this box. For more
information, see Custom Date and Time Format Strings.
Select what to show on the device side
Choose an option to specify components of the date to

display on the device.
Year, Month, Day, Hour, Minute

Year, Month, Day
Year, Month
Month, Day
Hour, Minute
Custom Date/Time format strings

The date/time format string specifies how a date and/or time should be formatted when displayed. Some of these
formats are not available on all devices.
The following elements are supported in date/time format strings.
547
Format variable
Description
Displays the day of the month (131). If the day can

be expressed as a single digit number, then it will be
formatted with one digit.
dd
Displays the day of the month (0131) as a two-digit

number. Single digit days will have a leading zero added.
EEE
Displays the abbreviated name of the day of the week

(for example Sat, Mon). This is a calculated field
based upon the values entered by the user at the control
panel.
EEEE
Displays the full name of the day of the week (for

example Saturday, Monday). This is a calculated
field based upon the values entered by the user at the
control panel.
Displays the month (112). If the month can be

expressed as a single digit number, then it will be
MM
Displays the month (0112) as a two-digit number.

Single digit months will have a leading zero added.
MMM
Displays the abbreviated name of the month (for

example Jan, Feb).
MMMM
Displays the full name of the month (for example

January, February).
yy
Displays the last two digits of the year.
yyyy
Displays all four digits of the year.
Displays the hour of the time (112). If the hour can

formatted with one digit. This is for clocks based on
twelve-hour time.
hh
Displays the hour of the time (0112) as a two-digit

number. Single digit numbers will have a leading zero
added. This is for clocks based on twelve-hour time.
HH

added. This is for twenty-four hour time.
mm
Displays the minutes of the time (0059) as a two-digit

added
Displays the A.M/P.M. designator for the time.
All other alphabetic characters are invalid. Symbols and numeric characters, however, are untouched. Here are a few
examples:
EEEE, MMMM dd, yyyy is Monday, January 03, 2009

yyyy-MM-dd HH:mm is 2009-01-03 15:35
hh:mm a is 3:35 P.M.
548
Preferences tab
The location can be specified where the server will store the program files for the job that is being processed.
Option
Server
Description
Specify the web server information where the scanned
document images and associated metadata should
be transferred via HTTP or SSL. This allows a web
application/service to directly receive the data rather than
watching for a file to appear at a predetermined location.
Keep
Server URLThe workflow will retrieve data from

this http URL.
Server SSL URLThe workflow will retrieve data
from this https (SSL) URL.
SSL CertificateEnables secure data retrieval by
the workflow server when using https (SSL).
Home FolderThe folder where the server will
create all temporary directories and files necessary
for controlling device related traffic. The server must
have proper permission to write to this folder.
Processed FilesSelect to keep a copy of all
files that are processed without errors. Enter the
directory where these files will be kept. If this option
is enabled, a copy of every file that has been routed
successfully is saved in the Processed Files directory.
Make sure that proper disk storage is allocated when
using this option.
Rejected FilesSelect Rejected Files to keep
a copy of all files that were not processed. Enter
the directory where these files will be kept. The
service account for the service must have write
permissions on the Processed Files and Rejected
Files directories.
RRT Format tab

Option
# of Received Time RRTs
Description
Use this field to specify the number of RRTs that
represent Received Time. For example if you set this
value to 2, then 2 sets of RRTs (representing the Scan
Time Stamp) will be available for use.
The grid allows you to specify which time format a
particular date-time RRT will have.
Time Stamp
List shows some examples of date time formats. You can

drag & drop to fill out format strings or press < button.
For more information about date time formats, see
Custom Date/Time Format Strings.
File Size Format
Use this field to specify the unit in which File Size RRT
will be represented.
549
Authentication tab
The authentication type and parameters are specified on this tab.
Option
Authentication Type
Description

you select this option, configure the Netware
CustomPluginAdministrator defines prompts
for authentication for a custom application. After
you select this option, configure the Plug-in



environment:

WinNT://autostore_server_NetBIOS_name
.
format LDAP://ldap_server,port . Check
ports:
Standard LDAP: 389

LDAP over SSL: 636
3269


550
Option
Description

workflow server.
the Active Directory or LDAP server. If you do
not select this check box, the connection will not
be encrypted. To use this option, you must have a
server certificate for the ADAM service. If the LDAP
server is in a different domain from the workflow
server, enter the server name and port number (that
is, LDAP://server_name,port ). Click Test
to verify that the user name created on the server
Directory or LDAP server will attempt to connect to
the DNS server in order to resolve the IP address of
the Workflow server.
Refer to the Microsoft web site for more information
about setting the LDAP bind options.


If the device is configured to use an authentication

server with the authentication type being NDS, then the
provided credentials will be used by workflow server. If
the authentication type of the device is other than NDS,
then in addition to the workflow server logon screen, the
device authentication screen is displayed to the user.
Plug-in Authentication
When CustomPlugin is selected for Authentication

Type, the administrator defines prompts that are
displayed to the user. An event is sent to the server when
a user logs in. The administrator must provide the .NET
plug-in DLL that responds to the event.
Snap-In pathThis is the path to the compiled

compiled assembly.
Create/Edit Snap-InClick this button to create
available with this component. For details about
the code editor window and the object model, click
the Help button in the code editor to refer to the HP
OXPd Capture Component Snap-in Documentation.
551
Option
Description
Use LDAP Search to Retrieve Email

Lookup Settings dialog box.
address is needed.

LDAP server.
Option
Search Root
Description
with LDAP://.
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636

Authentication

Directory Search

Address From.
Test Lookup

552





Empty
Result
used.
Server belongs.

used.
Example: LDAP://
Example: LDAP://

used.

specified server.
Example: LDAP://

the Microsoft website. To install a Certificate authority select the Certificate services checkbox.
1.
2.
3.
4.
5.
6.
7.

553
8. In the Friendly name textbox, write the full DNS name of the server.
9. Click the Submit button.
To let our ADAM service use the certificate we need to put the certificate in the ADAM service's personal store:
\MachineKeys.
To verify that SSL is working with ADAM:
32. Type the DNS name of your server in the server textbox.
ADAM).
34. Select the SSL checkbox and click OK.
554

HP MFP/Digital Sender (OXP) component RRTs
Component RRT ID
The RRT ID for this component is DS2.
Name
Description
Date
Date of the scan job
FormatterSN
The serial number of the Formatter Board in the device.
FwVersion
Firmware version of the scanning device.
Hostname
Hostname of the MFP
IP
MFP device IP address
DeviceModel
Model number of the device
OxpdWfVer
OXPd workflow version
DeviceSN
Device Serial Number
Time
Tim of the scan job
UserAlias
Alias of the currently authenticated user
AuthType
Authentication agent used to authenticate current user.

The values can be: NT, Novell, Novell Bindery, LDAP.
Other values can also be returned.
BinderyServer
The Bindery server name.
Context
NDS Context Tree
Dep
Department of the currently authenticated user. This

value is not available on all devices
DepAccCode
Department access code of the currently authenticated

user. This value is not available on all devices
Domain
Domain in which the currently authenticated user

belongs to.
Email
Email address of the currently authenticated user
NdsServer
NDS Server Name
NdsTree
NDS Tree name
Username
Username of the currently authenticated user
Device Group Name
Group Name that the device belongs to.
SessionID
Value of the session id between the server and the MFP
SessionLanguage
Control Panel language in effect when meta-data was

entered.
555
Name
ColorMode
Description
Supported types are:
DuplexMode
FileType
Color
Mono
On
Off (Simplex, default)
The TIFF and JPEG file formats generate one file per
document page. The other formats include all pages in
the same file. The following file types (fileTypeType) are
supported:
PDF
MTIFF
TIFF
JPEG
OCR
OCR with text under image
OCR with comma-separated values (CSV) Rich Text
Format (RTF) OCR
XML OCR
HTML OCR
Note: When handling the results of a scan,
remember that TIFF and JPEG formats will
generate multiple files for multiple scanned
pages.
HeavyOriginals
This specifies whether the original is set to:
heavy paper or
normal paper
BkgCleanup
Background Image cleanup. A number from 0 through

8. The default is 2. 0 removes less background while 8
removesmore background.
Contrast
A number from 0 through 8. The default is 5. 0 results in

less contrast while 8 results in more contrast
Darkness
The lightness/darkness of the image. It is a number in

the range 0 8. The default is 4.0 results in the lightest
image while 8 results in the darkest image
Sharpness
The smoothing/sharpness. It is a number in the range 0

4. The default is 2.0 esults in the smoothest image while
8 results in the sharpest image
JobAssemblyMode
Job Assembly Mode is used or not. Supported types are:
OcrLang
On
Off (default)
Native OCR language. Not all options are available on

all devices.
556
Name
OptimizeTextPhoto
Description
Target document with the text or graphics optimized.
OutputQuality
Text
Mixed (5 varieties)
Graphics
Supported values are:
High
Medium
Low
These options are not available on all devices

PageOrientation
Supported values are:
PageSize
Portrait
Landscape
Letter
Legal
Executive
ISO A4
ISO A5
JIS B5
Mixed (default)
Ledger
ISO A3
JIS B4
Statement
Government-Legal
These options are not available on all devices.

Resolution
Type of resolution:
ScanResult
75
150
200
300 (default)
400
600
Indicates whether the scan was successfully completed.

Possible values are:
Success
Failed
Canceled
TotalImages
Total number of images scanned.
NumberofFiles
Number of Files received in a batch. If Number of Files

> 1 then Page count = Number of files.
557
Name
Description
FileSize
File Size in Byte, KByte, MByte, or GByte. The unit

depends on the File Size Format field.
FormName
The name of the form selected at network scanner
FormID
The guid of the form selected at the MFP
ReceivedTimeX

workflow server. For details, refer to RRT Format Tab.

This component does not support FRTNs
Problem
Possible Cause
Configuration cannot be uploaded to

the device
Solution
Verify that the right jar files are
uploaded.
Verify that the port which you are
using is available and open.
Verify that the firewall is

allowing the port to communicate
Check to see if your device falls

in a certain group and then upload
the correct jar files.
Check to see if the port is
not being used by any other
application or blocked by the
firewall.
Check to see if firmware on the
device is upgraded according to
match the OXPd requirement.
Authentication doesnt work for

Group 50 devices.
N/A
Authorization files are not available

for Group 50 devices.
Jar files for group devices not

available.
N/A
Jar files are not available for Group

30 devices.
A red exclamation mark is displayed

on the General tab when trying to
click OK.
Check for one of the following
Depending on the cause, do one of

the following:

on the Preferences tab when trying
to click OK.
The application does not have a

menu or a form.
The application has a menu but
no form.
There is a menu within a menu.
Some of the fields in the preferences

tab are empty.
Add a form to the application if

no menu exists.
Add a form to the menu if menu
exists within an application.
Delete a menu within a menu.
Fill the required fields in the

Preferences tab.
An error message is displayed

The Fields tab has no fields added to Add a field in the Fields tab.
There should be at least it.
one field on the form.
558
Problem
Possible Cause
Solution
Authentication selected during

configuration but no authentication
required at device.
Single Scan Touch option is grayed

out at the form level.
N/A
Single Scan Touch option is enabled

or disabled only at the application or
menu level.
Fields tab cannot be accessed.

enabled on the General tab.

option at the application or menu
level and you can access the Fields
tab.
Scan Settings options cannot be

edited.


option at the application or menu
level and you can access the Fields
tab.
Failed to start session

message is displayed on the device
when you select the config.
Scan button not displayed on the

device.
The device does not support it.
This option is not available on all

devices.
Certain scan settings are only for

Group 10, 20, 30, 40 or 50
Not all the devices support all the

scan settings.
Make sure you are selecting the

scan settings for the device which
supports it or a message is displayed
on the device warning about the
setting not being compatible.
Authentication jar files not

Authentication not selected
for that application on the
Authentication Manager for the
device.
The workflow server has stopped.

The connection to the workflow
server is disconnected.
Upload the right authentication

jar files.
Select the authentication for that
application in the Authentication
Manager.
Restart the workflow server.

Verify if the workflow server
connection is still active.
Error Message: Maximum

Lets say 5 devices are licensed and
Purchase additional device licenses.
Devices has been reached. 5 devices already working with the
server. Then the 6th device (new
one) is trying to connect to the same
server. In this case the device will get
this error message.
Error Message: Device
Excluded
The device is trying to connect to the The device is blocked from the
server but it has been excluded from device list by the administrator.
the license list by administrator.
Unblock the device from the license
manager, then the message wont be
displayed.
Error Message: License

Expired
This error occurs when the license

mode changes from "evaluation"
mode to "expired" or the license was
transferred to another device.
Licenses are expired and you need to

license your workflow server or your
HP OXPd component.
Checking the device log

If you have scanned large number of pages and want to monitor device activity and when the device sends the
scanned images to the workflow server, type the following link in the address box on your browser and press Enter.
559
https://<deviceIPAddress>/hp/device/sdc?GetLog
After you press Enter, the browser window will display the following:
To clear the log, you can type the following link in the browser address box and press Enter.
https://<deviceIPAddress>/hp/device/sdc?clearlog
After you press Enter, the browser will display the following information:
HP OXPd
Welcome to HP OXPd component
HP OXPd component allows direct integration of HP OXPd MFPs with the workflow server, with support for OXPd
version 1.6.
This release of the HP OXPd component provides key functionalities, including the following:
Allows direct integration of HP MFPs which supports HP OXPd 1.6 technology

Support for multi-layered menu configurations
Support for various meta-data field types, such as Text, Numeric, Date/Time, List, and Label.
Support for various Scan Setting parameters and provides an option that allows users to change the scan setting at
the MFP panel.
Dynamic forms with scripting lets users browse to a document management system to display document profiling
information.
Windows, Novell, and custom authentication types at the MFP panel. Custom authentication allows you to
configure specialized authentication methods.
How to use the HP OXPd component

This topic shows how to create a workflow that uses the HP OXPd capture component.
In this example, a workflow will be created which captures documents from HP Scanjet 7000n. During the scanning
process, a user working on the device will be able to copy a document to any local or network directory. This defines
where the captured file is stored.
1.
2.
3.
4.
5.
6.
7.
8.
Drag and drop the HP OXPd and the Send to Folder components into the Process Designer.
Double-click the HP OXPd component to open the configuration dialog box.
On the Preferences tab, enter the required information.
On to the General tab, right-click the Default Form and click the Edit button.
On the General tab of the Form Settings dialog box, select the Allow Changes check box for Media Size,
Orientation, Color and Resolution.
These selections allow the user to change these scan settings directly on the device.
On the Fields tab, configure a new field:
a) In the Type column, click the "List".
b) For Name, type "Folder".
c) For Display, type "Folder Where to Save".
d) In the properties column (labeled P), click the ... button .
e) Enter random values and labels and check whether they appear by default on the device display. If so, select
OK.
On the Form Settings dialog box, click the Components Tab.
Click on the browse button (...) for the Send to Folder component.
560
9. In the Available RRTs dialog box, expand the Send to Folder RRTs, and configure the component with the
following parameters:
Option
Folder Paths
Rename Schema
Value
C:\dest\~DS2::%Folder%~ (use HP OXPd
RRTs)
Leave blank. (File names are already unique so there is
no make them unique.)
10. Press OK button on the Send to Folder component.

11. Press OK button in Form Settings dialog, and then click OK in HP MFP/Digital Sender (OXPd) dialog box.
12. Save the workflow in Process Designer (File > Save) as Hp2Demo.cfg.
13. On the ribbon, click the Start button to start the process.
Supported devices
For a current list of supported devices, see the Notable Solutions website.
Firmware requirements
There are minimum firmware requirements for HP devices.
LaserJet M5035 MFP: 48.171.5

Color LaserJet CM4730 MFP: 50.151.0
LaserJet M5035 MFP
ScanJet 7000n Color: 113770_118969
CLJ CM4540 MFP: 113702_118761
Visit the HP website for more information and firmware downloads.

Hosting the component in IIS
You can host the HP OXPd component in Microsoft Internet Information Services (IIS) versions 7.0 and 7.5.
Configuring the component for IIS consists of the following tasks:
Configuring roles and features on page 562

Verifying the ASP.NET 4.0 configuration on page 562
Configuring access to the application pool identity on page 562
Creating the IIS web application on page 563
Enabling authentication on page 563
Validating the IIS web application on page 564
Disabling the component web server on page 564
Configuring the component for IIS on page 565
The instructions in these tasks serve as general guidelines for a typical IIS installation. Advanced settings such as the
web application name, application pool, and application pool identity may vary depending on your environment and
561
company policies. An IIS administrator who is familiar with your IIS environment should complete the instructions in
the tasks.
Configuring roles and features
Hosting the component in IIS requires you to configure the server for required roles and features. The following
procedure applies only to Microsoft Windows 2008 and Microsoft Windows 2008 R2.
1. Under Server Manager, use the Add Roles Manager to add the following roles to the server:
Application Server
Web Server IIS
2. When the wizard displays the subcomponents for the Application Server role, verify that the Web Server (IIS)
Support option is checked.
3. When the wizard displays the subcomponents for the Web Server role, verify that the following items are checked:
Common HTTP Features:
Static Content
Default Document
HTTP Errors
Application Development:
ASP.NET
.NET Extensibility
ISAPI Extensions
ISAPI Filters
Security:
Request Filtering
Performance:
Static Content Compression

Management Tools:
IIS Management Console
Verifying the ASP.NET 4.0 configuration

Verify that the IIS environment contains ASP.NET 4.0:
1. Open a command prompt as an administrator.
2. Type the following command and press Enter:
"%windir%\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe" -lv
If the IIS environment contains ASP.NET 4.0, the command returns the following entry:
4.0.30319.0 C:\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_isapi.dll
3. If you do not see the entry, type the following command and press Enter to install ASP.NET 4.0:
"%windir%\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe" -i
Configuring access to the application pool identity
Configure the OXPd directory for access to the application pool identity:
1. Open IIS Manager.
2. Expand the computer name node and then expand the Application pools node.
3. Right-click DefaultAppPool and select Advanced Settings.
The following figure shows sample settings:
562
4.
5.
6.
7.
8.
9.
Select the <AutoStore Install Directory>\OXPd16Site directory.

Right-click the directory and select Properties.
Select the Security tab.
Click Edit and then click Add.
Click Locations and select your machine.
Type IIS AppPool\DefaultAppPool in Enter the object names to select.
10. Click Check Names and click OK.

11. Click OK to close the Properties dialog box.
Creating the IIS web application
Create the IIS web application that hosts the component:

1.
2.
3.
4.
Right-click Default Web Site and then select Add Application to open the Add Application dialog box.
In the dialog box, type OXPd16Site as the alias for the virtual directory that you are creating.
Set the physical path to <AutoStore Install Directory>\OXPd16Site.
Click OK.
Enabling authentication
Enable the IIS web application for anonymous authentication:
563
1. Select the OXPd16Site application.

2. In Features View, double-click Authentication.
3. On the Authentication page, select Anonymous Authentication.
4. In the Actions pane, click Enable to use anonymous authentication with the default settings.
Validating the IIS web application
Validate that you successfully configured the IIS web application by opening a browser and browsing to:
http://localhost:<port number>/OXPd16Site/Menu.aspx
where <port number> is the port number for your IIS web application. The default port is 80 for HTTP connections
and 443 for HTTPS connections. If you successfully configured the IIS web application, the following page appears:
To configure the web application for SSL, refer to http://technet.microsoft.com/en-us/library/cc771438(WS.10).aspx

for more information.
Disabling the component web server
Because you are using the IIS web application to host the component, disable the component's built-in web server:
1. In Windows Explorer, browse to the AutoStore installation directory (for example, C:\Program Files (x86)\NSi
\AutoStore).
2. Open the batch.exe.config file in a text editor.
3. Find the <appSettings> section.
If there is not an <appSettings> section, add it to the file.
4. Add the following line:
<add key="SkipHpOxpd16WebInit" value="true"/>
564
The following code shows a sample configuration:

<configuration>
...
<appSettings>
<add key="SkipHpOxpd16WebInit" value="true"/>
</appSettings>
...
</configuration>
5. Save your changes.
Configuring the component for IIS
Configure the HP OXPd component to use IIS web application settings:
1.
2.
3.
4.
Open the AutoStore Process Designer.

Add the HP OXPd component to the configuration.
Double-click the component to open its configuration dialog box.
On the Preferences tab, specify the Web App Port setting for your IIS web application (typically, 80 for HTTP
connections or 443 for HTTPS connections).
The following figure shows sample settings:
5. If you want the MFP device to connect using SSL, select Use SSL.
Note: The system applies the certificate that you select from the SSL Certificate drop-down list box to
the File Transfer Port, not the Web App Port.
565
6. Save your changes and restart the AutoStore service.

The Status Monitor shows entries indicating that the component is using IIS and the MFP device has been
updated. The following figure shows an example:
Enabling HP OXPd 1.6 on Oz devices

Supported devices
Check to see if the device is supported:
LaserJet M3035MFP
LaserJet M4345MFP
LaserJet M4349MFP
LaserJet M5035MFP
LaserJet M9040MFP
LaserJet M9050MFP
LaserJet M9059MFP
Color LaserJet CM4730MFP
JetDirect support for OXPd 1.6 feature set

The OXPd 1.6 feature set includes new Secure Socket Layer (SSL) capabilities not previously available in Oz
devices:
OXPd web services calls into an OZ device over port 7627 use SSL.
The OXPd 1.6 certificate management service can be used to configure a store of certificates from a trusted
authority.
OXPd-based HTTP/S connections initiated from the device (for example, web browsing and scan image
transmission) are validated against certificates in the trusted authority store.
Changes were implemented in JetDirect Inside (JDI) firmware to support these new features. The OXPd 1.6 SSL
feature set has not been integrated to Enhanced Input/Output (EIO) JetDirect products. The OXPd 1.6 SSL feature set
is only supported on JDI-based network connections. To avoid issues using OXPd 1.6 functionality over SSL, remove
any EIO-based network interfaces from the device.
566
After performing an upgrade to a firmware version that supports OXPd 1.6 functionality, the JDI firmware version of
a device should be equal to the version listed in the device release notes.
The JetDirect firmware version can be verified from the embedded web server of the device:
1. Navigate to Networking > Configuration Page.
2. Observe the value listed next to Firmware Version on the JetDirect configuration page.
Enabling OXPd 1.6 on OZ devices

OZ devices ship with the embedded web browser and OXPd web services disabled by default. To enable OXPd 1.6,
the file labeled "OXPdEnable.pjl" should be uploaded to the MFP via ftp (ftp://device_ip/) and then the device must
be rebooted.
567
Configuring the HP OXPd component

General tab
This tab defines the menu structure that is displayed on the HP OXPd component.
Devices can be grouped based on their IP address or hostname. Each group of devices can have its own menu
structure. By default there is a single group called Default Device Group. If no additional groups are configured, all
devices pointed to the workflow server will display the menu structure under the Default Device Group.
connected to the same workflow server for different functions. Drag and drop functionality is available to change the
order of menus and forms that appear on the MFP control panel.
Option
Add
Description
Click Add and then click Group, Menu, Application or
Form to add one of the following:
Group
Menu
Application
Form
Shared Form
Note: Addition of elements is dependent on
whether you click Group, Menu, Application,
Form, or Shared Form on the Add menu.
Edit

menu, application, or form.
Remove

Group options
Click Add > Group to add a group of devices. When you add a new group, configure options on the following tabs:
General tab
Option
Description
Name
Enter a name for the group to be created. This is a string

value describing the name of the group. This name does
not appear on the panel and it is used only as a logical
group name. This component is preconfigured with a
default group called "Default Device Group". A menu or
form can be added to this group.
Associated MFPs

that belong to this group. Click Ping to validate the
Select this check box to use the authentication

component authentication for this group. Do not
select or clear this check box to configure group-level
authentication for this group. If this check box is not
selected, options on the Authentication tab can be
configured.
568
Authentication tab
See Authentication tab for information on configuring options on the Authentication tab.
Application options
Define the workflow application parameters. Workflow applications are represented by a top-level button on the MFP
device. Pressing the application button may lead to one or more forms.
Option
Description
Name
Enter a name for the application being created. This is a

string value that labels the application. This name is only
used as a logical group name and does not appear on the
MFP panel
Description
Enter a description for the application.
Icon
Select the Standard Icon check box to select one of the

available icons in the box.
Clear the Standard Icon to specify custom icons. Click
the browse button (...) next to each of the boxes to locate
an icon.
"Up" IconThe icon for the application button.

"Down" IconThe icon when a user touches the
application button.
"Disabled" IconThe icon when the application
button is disabled.
There is no size restriction for an icon. Icons are

automatically resized to fit.
Action List

Menu options
Add a menu to create a hierarchy. The menu entry will guide the MFP users to select the desired workflow.
Field Name
Description
Name

unique from other menu names at the current nesting
level.
Display Text
Enter the name as it should be displayed on the MFP

panel.
Action List

Form options
When setting up a form, the following three tabs must be configured:
General tab
Fields tab
Components tab
569
General tab
Option
Description
Name

documents to the user's home directory, then name the
form "Scan to User's Home Directory". This name must
Description
Description of the form.
Single Touch Mode
Select this check box if the user should be restricted

from entering any indexing data about the document.
By selecting this option, the scan operation will start
immediately after the user presses the "form" button on
the device.
Select MFP
Select the MFP to which scan settings will be applied.
Scan Options
Scan Settings
Get Default Values from MFPDefault values are

taken from the MFP.
Validate with MFPValues entered within
AutoStore are validated against the MFP.
Reset to AutoStore DefaultValues will be reset
to AutoStore default values.
This table lists all the available scan settings. In the

Options column, default scan settings can be configured
if the Customize check box is selected. A default setting
is used when a user does not change the setting at the
device panel. Select the Allow Changes check box on
a setting to allow users to change the setting from the
device panel.
Type of file(s)Provides the list of available file

types. The TIFF and JPEG file formats generate one
file per document page. The other formats include all
pages in the same file.
ColorProvides the color mode. The target
document will be rendered in grayscale or color.
If no value is specified, color will be used. If the
device can only scan in monochrome then all scans,
regardless of specification, will be monochrome.
File OptionsFile options can be selected
according to the type of file selected. Options include
compression level, selection of OCR language and
encryption. Note that with certain file types, all or
some of these options are not available.
OrientationOrientation of the target document,
either portrait or landscape.
Media sizeThe size of the target document.
Custom Length (inches)Length of custom media
size in inches.
Custom Width (inches)Width of customer media
size in inches.
570
Option
Description
Blank image removalOption to remove blank

images. Note that if all images in the job are
removed, the job will fail. Additionally, some older
devices will always include the first image in the job,
even it is blank.
Duplex ModeSpecifies whether duplex mode
should be used (whether both sides of a document
should be scanned). The default is simplex.
Duplex formatOption to select orientation of
the binding for a document. Select Book for binding
on the leftas with a book. Select Flip for binding
along the top.
Background CleanupAllows removal of the
background. It is a value between 08. The default
is 2.
Color dropoutOption to remove a given color
plane. For example, select RemoveRed to remove
the red color plane.
Output QualityAdjust to compromise between
quality and file size.
Text/photo optimizationProduces a target
document with the text or graphics optimized.
ContrastAllows contrast to be increased or
decreased. It is a value between 08. The default is
4.
DarknessSets the lightness/darkness of the
image. It is a value between 08. The default is 4.
SharpnessAdjusts the smoothing/sharpness. It is
a value between 04. The default is 2.
CropRemoves white space from the top, left,
right and bottom of scanned images. Blank images
will not be cropped.
Media sourceDirects the device to scan from
either the automatic document feeder (ADF), flatbed
scanner or the device will automatically select the
media source.
misfeed Misfeed detectionOption to detect
misfeeds.
Media weightAdjusts the scanner feed
mechanism for the weight of the media (the weight of
the paper).
Job assembly modeSpecifies whether job
assembly mode should be used. The default is off.
Job assembly mode allows the user to assemble a
complete scan job, one set of pages at a time. This is
necessary when the ADF is not big enough to hold
the entire job, when the user has several documents
of different sizes that need to be scanned, or when
the flatbed scanner is being used to scan multiple
pages. Job assembly mode prompts the user to place
additional material either in the ADF or on the glass.
This prompt allows the user to indicate that there are
571
Option
Description
no more documents to scan. For some devices, it also

allows canceling the job.
Scan PreviewOption to display thumbnail
preview images on the device.
Scan progress dialogOptions to display built-in
scan progress dialogs.
Refer to the HP OXPd User Guide for detailed

descriptions of the scan parameters.
Dynamic Form

check box allows the workflow sever to load form

Snap-in pathPath to the compiled snap-in (.NET
Snap-in path box.
Source PathPath to the source code of the snapin. This path is used by code editor to compile the
snap-in only during design time.
Create/Edit Snap-inYou can click this button to
open a code editor window with basic snap-in code.
For details of the code editor window and the object
model used to respond to form and field events,
please refer to the Snap-in documentation by clicking
Help in the code editor window.
Raise event when Form is Loaded:Select this
check box to cause the form to initiate an event every
time the user enters the form.
Raise event when Form is Submitted:Select this
check box to make the form to initiate an event every
time the user presses Scan button in this form.
Fields tab
Configure the indexing fields that will be presented to the user. Add fields by entering data on an existing line or by
selecting the notify server check box (N).
Column
Description
Name

within this form.
Display

panel.
572
Column
Type
Description
TextAllows a user to enter unformatted text.

be made searchable.
LabelAllows a user to enter text labels as index
value within a form. There can be none or several
free-form labels in a form.
R (Required)
A field is required when this check box is selected.
N (Notify Server)

section in the General tab. For details on how to respond
to form and field events, refer to the HP OXPd Capture
Component Snap-in documentation.
P (Properties)

Components tab
browse button (...) in the C (configure) column for a row. This opens the configuration dialog box for the component.
Date Time Field Options
A date time field allows a workflow to capture dates and times from the console.
Option
Time interval from Now
Description
Choose this option to specify that the default value of the
field will be the time when the user opens a form plus the
interval. In the box, specify the interval in the following
format:
[-]d[. hh[: mm[:[ss .[ff]]]]]
In this syntax, d is days, hh is hours, mm is minutes, ss
is seconds, and ff can be used to specify hundredths of
a second. To specify an interval in the past, precede the
interval with the minus symbol (-) .
Examples:
573
Option
Description
To specify one day earlier, type:
-1
To specify 30 minutes later, type:
0.00.30
Fixed Time
Choose this option to specify that the value of a field

when a user opens up a form will be exactly as specified
in the Fixed Time box. Click the
button to select a
date in the calendar control.
This option defines the format of the date or time as a

date/time value will appear on the device panel. Create
the format string using the date and time format variables
listed for Custom Date and Time Format Strings .
Custom Date and Time Format Strings

formats are not available on all devices.
Table 35: Date format variables
Format variable
Description

dd

Displays the day of the year (1365). If the day can

formatted with one digit. The same holds for two-digit
and three-digit numbers.
oo
Displays the day of the year (001365) as a threedigit number. Single-digit and two-digit days will have a
leading zeros added.
Displays the abbreviated name of the day. For example,

"Monday" is displayed as "Mon".
DD
Displays the full name of the day. For example,

"Monday" is displayed as "Monday".
Displays the month of the year (112). If the month

can be expressed as a single digit number, then it will be
mm
Displays the month of the year (0112). Single-digit

months will have a leading zero added.

example Jan, Feb).
574
Format variable
Description
MM

January, February).
yy
Displays the UNIX timestamp (the number of

milliseconds (ms) since 01/01/1970).
Displays the number of Windows ticks (the number of

100 nanoseconds (ns) since 01/01/0001).
'...'
Displays the text within the quotes. Note that if anything

other than a format variable is used, it will be displayed
as text as well.
"
Displays a single set of quotes.
Table 36: Time format variables

Format variable
Description
Displays the hour with no leading zero.
hh
Displays the hour with a leading zero.
Displays the minute with no leading zero.
mm
Displays the minute with a leading zero.
Displays the second with no leading zero.
ss
Displays the second with a leading zero.
Displays milliseconds. This is always displayed with

leading zeros.
Displays a for AM or p for PM.
Displays A for AM or P for PM.
tt
Displays am or pm.
TT
Displays AM or PM.
Examples:
DD, MM dd, yy is Monday, January 03, 2009

yy-mm-dd hh:mm is 2009-01-03 05:35
h:mm TT is 3:35 PM
Label Field Options

Label field options define the appearance of a label in a form.
Option
Font
Description
Select the font appearance (type, size, and color) options
to use for the label. The elements that describe the
appearance of the font are not applied on all devices. A
particular font type, size and color may not be supported
on all devices.
575
Option
Description
Alignment
Horizontal alignment of the label text within the label

box. This predefined identifier may be Right, Center, or
Left (the default is Left)
Line Wrap
Determines whether the label can wrap to the next line.

If set to False, then text will be shortened when it is too
long.
List Field Options

Option
Description
Value
Label

column.
Selected
Select the check box for a list item to preselect it when

the user activates the form. You can preselect no more
than one field except when Allow Multiple Select is
selected.
Select this check box to allow users to select multiple list

items. The value of the field will then contain selected
values separated by the Item Separator.
Import

separated value (CSV) file. This allows you to reuse a
list.
Export

comma separated value (CSV) file.
Numeric Field Options

An numeric field allows the user to enter numbers in a form.
Option
Description
Default Value

device panel.
Required
Select this check box to require that a user enter a value

into this field before a scan can be initiated. The default
value, if specified, satisfies this requirement.
Maximum Value

Minimum Value

Enable Grouping
Select this check box to specify that the non-fractional

part of a number should be grouped. For example, select
576
Option
Description
this check box to show one million as 1,000,000, or
clear this check box to shown one million as1000000.
Group Separator
Specifies the character used when grouping the digits.

For example, set this option to "." to display one million
as 1.000.000. This setting is ignored if grouping is
disabled.
Grouping Digits
Specifies the number of digits that are grouped between

group separators when the Enable Grouping check box
is selected. The default number of digits is 3.
Decimal Places
The number of digits after decimal point. The default

number of digits is 0.
Decimal Separator

For example, if the decimal separator is a comma, the
number ten and twenty-five hundredths is displayed as
10,25. This setting is ignored when Decimal Places is
set to 0.
Format String
The format string allows custom formatting of a field

using the Format String Entity Characters .
Format String Entity Characters

Use numeric string entity characters to in the Format String box to custom format content in a numeric field. These
character are parsed to format a number field. Other characters in the Format String box are interpreted literally and
may be added before or after the entity characters in a numeric string definition.
Characters
Description





577
Characters
Description
all characters.
Examples:
The format $,0.00;$(,0.00) yields the following numeric strings:
1 -> $1.00
5654.35 -> $5,654.34
-6000.34 -> $(6,000.34)
6.5 -> 6.5%

-0.5 -> -0.5%
0 -> 0.0%
Note: The dollar sign "$", the percent sign "%", and the parentheses "(" and ")" shown in the examples are
not entity characters, so they are interpreted literally.
Text Field Options

Option
Description
Default

the device panel.
Max Length

be entered in the field. The default maximum length is
32767.
Required
Specifies that a value must be entered into this field

before a scan can be initiated. The default value, if
specified, satisfies this requirement. This check box is
initially not selected.
Password
Select this option to obscure data so that it cannot be

read on the control panel, including while data is being
entered. This obscures the value displayed on the control
panel in the way that passwords are typically hidden in a
user interface. This setting can be used for passwords or
any field that is used for confidential information. This
check box is initially not selected.
Static List
Select this option to enable search assist to provide a list

of item suggestions for a text field. This will speed up
indexing by narrowing down the selections.
Minimum Length
Indicates the minimum number of characters which the

user must enter before the application will search for an
auto-completion item from the list of suggestions. The
default minimum length is 2.
Suggestion List
Provides space to enter suggested values. The list must

be sorted in alphabetical order. The search is not casesensitive. Type in the suggested list column to enter or
replace a value in the list.
578
Shared form options

A shared form is a form that can be used across several menus and groups. Manage shared forms in the Forms List
dialog box.
A shared form can be added by right-clicking any group or menu node and then clicking Add > Shared Forms on the
shortcut menu. A shared form can be also added by clicking Shared Forms on the Add menu. Either method opens
the Forms List dialog box.
Option
Description
Form List
Lists forms in the workflow. For each form in the list,

Display Name shows the name of the form and # of
Refs shows the number of menus and groups that contain
this shared form.
Add
Creates a new shared form. You can choose to add

a Basic Form, Sharepoint Form, Email Form, or
Smarticket Form.
Remove
Click this button to remove the currently selected form in

the list.
Edit
Click this button to edit the currently selected form in the

list.
Refs
Click this button to view the menus and groups that

contain the shared form in the References dialog box.
You can then click Remove to remove shared form
references from a selected menu or group.
A shared form can be configured the same way a regular form is configured.
Preferences tab
The location can be specified where the server will store the program files for the job that is being processed
Option
Server
Description
Specify the web server information where the scanned
document image(s) and associated metadata should
be transferred via HTTP or SSL. This allows a web
application/service to directly receive the data rather than
watching for a file to appear at a predetermined location.
Server AddressThe workflow will retrieve data

from this server. Enter the server IP Address or
hostname.
Use SSLIf enabled, the connection will be
encrypted.
Web App PortEnter the port number for the Web
App. Ensure that the port number is not being used
by another application.
File Transfer PortEnter the port number for
HTTP. Ensure the port number is not being used by
another application.
SSL CertificateEnables secure data retrieval by
the workflow server when using https (SSL).
Home FolderThe folder where the server will
create all temporary directories and files necessary
579
Option
Description
have proper permission to write to this folder.
Keep
Processed FilesSelect to keep a copy of all

files that are processed without errors. Enter the
Make sure that proper disk storage is allocated when
using this option
Rejected FilesSelect Rejected Files to keep
a copy of all files that were not processed. Enter
the directory where these files will be kept. The
service account for the service must have write
permissions on the Processed Files and Rejected
Files directories.
Device Manager options

Option
Description
Data File
Select the location of the data file for storing device

information. This file can be any CSV formatted file.
Do not update MFPs when server starts
Check the box to not update MFPs when the AutoStore

server is started or restarted. MFPs can be individually
updated by clicking the Device Manager button below
and selecting update for the corresponding MFP. For
more information, see Device Manager.
Retry
In this box, configure the number of attempts that will

be performed to update MFPs. The server will attempt
initially one time and then retry the update additional
times based on the number entered. Enter zero (0) for no
limit on the number of retries.
How to configure settings for an HP OXPd device

Complete this procedure to use Device Manager to configure device settings for an HP OXPd device.
1. Enter the location of the MFP device list to be used by the Device Manager.
2. Select Device Manager to start.
3. Configure the following settings.
Option
MFP Address
Do this
Enter the IP address of the MFP device.
Comment
Enter a comment/description for the MFP device.
Admin login name
Enter the admin login name for the MFP device.
Admin password
Unregister application
Enter the password for the admin login name.

Select to unregister an application from the MFP
device.
Update
Select button to update.
Status
Displays the status of the MFP device.
580
How to configure language settings for an HP OXPd device

You can localize an HP OXPd device on the web settings page for the device.
The following languages are supported for HP OXPd MFDs:
English
French
German
Spanish
Portuguese
Italian
Swedish
Danish
Norwegian
Finnish
Dutch
Czech
Polish
Greek
Perform the following steps to change the language for a device.

1.
2.
3.
4.
5.
In a web browser, open the device page.

Click the General tab.
Click Control Panel Customization.
Scroll down to Control Panel Language and Keyboard Layouts section.
Select a language.
The device language will change the next time that the device connects to AutoStore.
How to Manage certificates
1. Download and install OpenSSL.
2. Add the corresponding executable path for the environment variable.
3. Generate your Certificate Authority (CA):
a) Create the directory C:\HpOXPd16Capture\cert.
b) Create a 2048-bit key to be used when creating your CA.
Navigate to C:\HpOXPd16Capture\cert.
Enter the command:
openssl genrsa -des3 -out ca.key 2048
581
A pass phrase is required for ca.key. This pass phrase will be requested whenever you use the CA
certificate, so make sure that you remember it!
This will create a file called ca.key, which will contain the private key for the certificate authority.
c) Create the CA certificate request
1. Navigate to C:\HpOXPd16Capture\cert.
2. Enter the command:
openssl req -new -x509 -days 4000 -key ca.key -out ca.cer
Enter the pass phrase created in Step 3-ii.

The CA certificate will be generated as ca.cer.
4. Generate a server certificate.
582
a) Create a 2048-bit key that will be used when creating the server certificate. Navigate to C:
\HpOXPd16Capture\cert Enter the command: openssl genrsa -des3 -out server.key
2048.
A pass phrase is required for server.key. This pass phrase will be requested whenever you use this certificate so make sure you remember it!
This will create a file called server.key which will contain the private key for the server.
b) Create the server certificate request. Navigate to C:\HpOXPd16Capture\cert Enter the command:
openssl req -extensions ssl_server -new -key server.key -extensions
usr_cert -out server.csr
583
Enter the pass phrase created in Step 4-i.

Important: The Common Name has to match the FQDN (Fully Qualified Domain Name) of the Web server. In
this example, the FQDN of the Web server is "user.companyabc.com". A quick way to get this information is
by executing the following command:
nslookup webserver_ip_address
This OpenSSL command will create the server certificate request server.csr.
c) Create a new text file labeled "ca.srl". Enter any four characters in the file and save it as a file in the directory
C:\HpOXPd16Capture\cert.
d) Sign the certificate signing request (csr) with the self-created certificate authority (CA) that was created earlier.
584
Navigate to C:\HpOXPd16Capture\cert, and enter the command:

openssl x509 -req -startdate -days 365 -in server.csr -CA ca.cer -CAkey
ca.key -extensions usr_cert -out server.crt
Enter the pass phrase created in Step 3-ii to create the server certificate labeled server.crt.
Important: By using the -startdate parameter, you are signing the certificate against the current date/
time. Make sure that your environment has the correct date/time and timezone.
e) Generate a .PFX file / PKCS12 certificate.
Navigate to C:\HpOXPd16Capture\cert, and enter the command:
openssl pkcs12 -export -in server.crt -inkey server.key -certfile ca.cer
-name "user.companyabc.com" -out serverCert.pfx
f) You will be prompted enter a pass phrase for server.key and an export password. Make sure you enter the
pass phrase used for ca.cer.
This creats the serverCert.pfx file.
5. Install the Certificate on the MFP.
Upload the CA certificate labeled ca.cer to the MFP using the EWS. Navigate to the Certificate Management
page: On Jedi-based devices, it is under the Security tab. On OZ-based devices, it is on the Settings tab.
585
The certificate can also be installed programmatically using the OXPd 1.6 Certificate Management service or
through WJA.
Important: If the server certificate is signed by a chain of CA certificates, the root certificate is the one
that will have to be installed on the MFP.
6. Install the server certificate in Computer Account personal store, which is imported using Microsoft Management
Console.
a) From the Start menu, click Run, and mmc in the text box and click OK.
This opens the MMC Console window.
b) On the Console menu, click Add/Remove Snap-in.
c) Click Add to add a snap-in to the current console.
d) Select Certificates in the Snap-in list, click Add.
Note: If you select Certificates on a domain controller you are prompted whether you would like
to manage certificates for "My user account", "Service account", or "Computer account". For this
scenario, select the "Computer account", and click Finish.
e) Click Close.
f) Click OK to close the Add/Remove Snap-in dialog box.
The Certificates directory is now added to the MMC console.
586
g) Right-click on the subfolder Certificates (Local Computer)\Personal\Certificates, and

then click All Tasks > Import on the shortcut menu.
A wizard will show up to let you import the PFX file. Make sure that you enter the correct private key and select the
option Automatically select the certificate store based on the type of certificate.
RRT Format tab
Option
Description
represent Received Time.
For example if you set this value to 2, then 2 sets of
RRTs (representing the Scan Time Stamp) will be
available for use.
587
Option
Description
Time Stamp
This list shows some examples of date time formats. You

can drag & drop to fill out format strings or press "<"
button.
Full description of format strings can be found in Custom
Date and Time Format Strings.
File Size Format
Authentication tab
Specify authentication parameters on this tab.
Option
Authentication Type
Description
Select the authentication type you want to use and
configure options for the selection. Choose from the
following authentication types:
None
Do not use authentication

(anonymous).
Standard
Use Active Directory

Domain Services
authentication. Configure
settings in the Standard
NetWare
Use NetWare
authentication. Configure
settings in the NetWare
Custom Plugin
Use a custom plugin.

Configure settings and
edit the name space
script in the Plug-in
Uses Active Directory Domain Services authentication.

Choose either Simple bind or Server Bind and select
additional options as necessary.
Server or LDAP pathSpecifies the LDAP server

in the format LDAP://host-name:objectname , where host-name specifies the server to bind
to, and object-name represents a specific object. The
server can be in the same or a different domain. The
object name can be a distinguished name or a GUID
(that is, 5001).
Windows bind (selected by default)If
authentication is within the same domain, you can
leave Server or LDAP path blank. For a bind to an
588
Option
Description
object in a different domain, enter the DNS name of

the target domain for host-name.
Simple bindFor this setting, you must enter a
value for Server or LDAP path.
Fast BindSelect this check box to exchange full
object support for faster binding. If this option is
not selected, the Active Directory Service Interface
returns all the user attributes to the workflow server.
Server BindIf disabled, the Active Directory
Server tries to connect to DNS server to resolve the
IP address of the workflow server.
communications between the LDAP and Workflow
servers. To use the SSL encryption, you must have a
server certificate for the Active Directory Application
Mode (ADAM) service (for more information, see
Obtaining an SSL Certificate). If you are verifying
against another domain, enter the server name
and port number in the format LDAP://server
name:port .
Tip: Click the Test button to verify that the
user name created on the server authenticates
successfully. Please refer to Microsoft web site
to learn about setting the LDAP Bind options.
Uses NetWare Authentication. This option prompts the

user for the NDS tree and context.
NDS TreeSpecifies the default NDS tree.

NDS ContextSpecifies the default NDS context.
authentication server with the authentication
type being NDS, then the provided credentials
will be used by the workflow server. If the
authentication type of the device is other than
NDS, then the device authentication screen is
displayed in addition to workflow server logon
screen.

are validated.
Snap-in pathThe path to the compiled snapin (.net assembly) that contains the custom
authentication code. If you have an existing snap-in
you want to use, click the browse button (...) next to
the Snap-in path box.
the snap-in only during design time.
Create/Edit Snap-inClick this button to open the
Edit Script Contents code editor window with basic
snap-in code. For details about the object model,
589
Option
Description
open the HP OXPd Capture Component SnapIn
documentation by clicking the help button in the
code editor window.
Note: A sample custom script is available
with this component.
Select this check box to look up the email address

and other attributes for the authenticated user. Note
that when windows authentication is selected, the
email address is retrieved automatically as part of the
authentication and as a result an LDAP search is not
required if only the email address is needed.
To configure the LDAP server, click the Configure
button and in the LDAP Lookup Settings dialog box,
enter the following information:
Search RootEnter the search root folder you want

to begin searching against. If this field is left blank,
the search starts at the LDAP default directory.
AuthenticationSelect the required authentication
type and provide the user credentials.
Directory SearchSearch the entries in the address
book directory services database.
Test Look-upTo test the search settings, enter a
sample user name in the Username box and click
Test.
Using SSL with Active Directory Application Mode

To use SSL with Active Directory Application Mode (ADAM) you must obtain an SSL certificated, put the certificate
in the personal store of the ADAM service, and verify that SSL is working with ADAM.
Refer to Microsoft's web site for the latest updates to these procedures.
Active Directory Application Mode (ADAM) is an LDAP-compliant directory service. ADAM runs as a service on
the Windows operating system. It can be fully customized and distributed as an application component or used as
a stand-alone LDAP directory. ADAM uses the same technologies found on Active Directory Domain Controllers
(including replication and delegation features) and has it own administration and customization features.
How to Obtain a Certificate on a Windows 2003 Server
Before you configure ADAM, you must obtain a certificate. If you already have a certificate, import it into your
"Personal store" and skip this procedure.
Microsoft. To install a Certificate authority select the Certificate services check box. (IIS should be installed before
or at the same time as you install the certificate services).
1. In a web browser, open http://localhost/certsrv.
2. Click Request a certificate.
3. Click Advanced certificate request.
4. Click Create and submit a request to this CA.
5. In the Name box, write the full DNS name of the server.
6. Make sure Type of certificate is "Server authentication certificate".
7. Select PCKS10 as the format.
8. Optionally fill in the other information.
590
9. In the Friendly name box write the full DNS name of the server.
You have now created a certificate request. To create a certificate you need to process the request.
11. Open Control Panel > Administrative Tools > Certification Authority.
12. Browse to the Pending requests folder.
13. Locate the certificate request, right-click it, and click All tasks > Issue.
The certificate has now been created and resides in the Issued certificates folder. Next you need to
download and install the certificate.
How to Use the Certificate with the ADAM Service
To let the ADAM service use a certificate, you need to put the certificate into the personal store of the ADAM service.
1. On the Windows Start menu, click Run and type mmc.
This opens the Microsoft Management Console.
3. Click Add, and click Certificates.
4. Click Service account.
5. Click Local computer.
6. Select the ADAM instance service.
7. Add a new "Certificate" snap-in, but this time click My user account instead of Service account.
9. Expand the "Personal" folder under the Certificates - Current user tree.
11. Give the ADAM service account read permissions to the key by doing one of the following:
Using winhttpcertcfg (best practice).

Browsing to:
C:\Documents and Settings\All Users\Application Data\Microsoft\Crypto\RSA
\MachineKeys.
If these permissions are not set correctly you will get an error in the event log:
Schannel ID: 36870 - "A fatal error occurred when attempting to access the SSL server credential private key. The
error code returned from the cryptographic module is 0x6."
12. Restart the ADAM instance.
How to Verify that SSL is Working with ADAM
To verify that SSL is working with ADAM, run the ADAM Tools Command Prompt and use SSL to connect ADAM.
1.
2.
3.
4.
In the ADAM program group, run ADAM Tools Command Prompt.

Type ldp and press Enter.
Click Connection > Connect.
Type the DNS name of your server in the server box.
Localhost does not work here as the DNS name is checked against the certificate.
5. Enter the SSL port of your ADAM installation.
Either 636 or 50001, or whatever was configured during the installation of ADAM.
6. Select the SSL check box and hit OK.
591
Connection > Bind functionality.
If you still get a "8009030e No credentials are available in the security package"
error message after the import, or you get an error when importing the keys into the LOCAL_MACHINE\Personal
store, check that the logon account has full access to C:\Documents and Settings\All Users
\Application Data\Microsoft\Crypto\RSA\MachineKeys. Try importing the certificates directly into
both LOCAL_MACHINE\Personal and ADAM\Personal instead of copying them for the Current_user store.
HP OXPd component RRTs
Component RRT ID
The RRT ID for this component is DS2.
Name
Description
Job Id
The job ID of the current scan job.
Page Count
The page count for the current scan job.
Color Mode
Media Size
Color
Mono
Letter
Legal
Executive
ISO A4
ISO A5
JIS B5
Mixed (default)
Ledger
ISO A3
JIS B4
Statement
Government-Legal
These options are not available on all devices.

Scan Source
The source for the current scan job. Options include:
Adf
Flatbed
Auto
Username
Username of the currently authenticated user.
Password
Password of the currently authenticated user.
Domain
Domain of the currently authenticated user.
Email
Email address of the currently authenticated user.
Alias
Alias of the currently authenticated user.
592
Name
Description
Auth Type
Authentication agent used to authenticate current user.

The values can be: NT, Novell, Novell Bindery, LDAP.
Other values can also be returned.
NDS Server
The NDS Server.
NDS Tree
The NDS Tree.
NDS Context
The NDS Context.
Novell Bindery server
The Bindery server name.
Department
The department of the currently authenticated user. Note

that this value is not available on all devices.
Department Access Code
The department access code of the currently

authenticated user. Note that this value is not available
on all devices.
JobAcct13
An available RRT for 3rd party application or plug-in.
JobAcct14
JobAcct15
JobAcct16
Device IP v6
The device IP address.
Device Hostname
The hostname of the device.
Device Model
The model number of the device.
Scan Date
Date of the scan job.
Scan Time
Time of the scan job.
Formatter Board SN
The serial number of the Formatter Board in the device.
Firmware Version
Firmware version of the scanning device.
Device SN
The serial number of the device.
Number of Files
Number of files received in a batch. If Number of Files >

1 then Page count = Number of files.
File Size
File Size in Byte, KByte, MByte, or GByte. The unit

depends on the File Size Format field.
Form Name
The name of the form selected at the device.
Form ID
The GUID of the form selected at the device.
Received Time (x)

workflow server. RRTs can range from 1 through 10 (that
is, Received Time 1, Received Time 2, ...). Refer to
RRT Format Tab for details.

This component does not support FRTNs
593

Problem
Possible Cause
Solution
Enter Scan Options and select Get
default values from MFP.
Attempting to scan results in a

Media Weight Unsupported
message being displayed.
Media weight selected is not

supported by device.
Warning: HP OXPd: There

was no endpoint listening at
https://servername/ip;:7627/
hp/device/webservices/OXPd/
UIConfigurationService that could
accept the message. This is often
caused by an incorrect address or
SOAP action. See InnerException, if
present, for more details.
The message is received when

Verify the device is up and running
running HP-OXPd 1.6 service with
and restart the AutoStore service
SSL enabled, but the HP Device is in again.
the process of restarting.
Attempting to scan results in

a Invalid parameter:
ScanTicket message being
displayed.
This message is the result of one or

Enter Scan Options and choose the
more unsupported scan settings being Validate with MFP option. This
selected for scanner options.
will display any invalid settings
that may have been selected during
configuration.
Unable to see any of the scanner

configuration settings.
First time configuring the

component.
Go to Scan Options and select Get

default values from MFP.
User wants to revert back to original

AutoStore scan settings.
Configuration change.
Select Scan Options and choose to

Reset to AutoStore Default.
Having problems scanning and want

to validate scanner settings.
The AutoStore service is not running Go to Scan Options and select

or there is an invalid configuration of Validate with MFP. This will
scanner settings.
display any conflicts or will report
conflict.
Receive message Concurrency:

Scanner is busy when
attempting to scan.
The job is stuck in the scanner.
Need to cancel job from device

panel.
Error during serialization or

deserialization using the JSON
JavaScriptSerializer. The length of
the string exceeds the value set on
the maxJsonLength property.
Too large/many list field property

values.
Decrease the number of values in

your List field properties.
The maximum message size

quota for incoming messages
(65536) has been exceeded.
To increase the quota, use the
MaxReceivedMessageSize property
on the appropriate binding element.
Too large/many list field property

values.
Decrease the number of values in

your List field properties.
Minimum length for Text field

cannot be set.
Minimum length for Text field does

not apply for the text field.
Minimum length for Text field does

not apply for the text field.
594
Problem
Possible Cause
Solution
Through scripting you want to enable Password is named as Obscured in

the password check box in the text
scripting.
field.
You can use textInfo.Obscured

where textInfo is of type
AdditionalInfoText.
Unregistering from the device

manager will unregister all the
applications run by AutoStore.
Un-registration from one AutoStore

server unregisters every application
on the HP device run by AutoStore.
The unregistered application will

register itself again.
Attempting to scan results in Media

Weight Unsupported message.
Media Weight selected is not

supported by device.
Enter Scan Options and choose to

retrieve Get default values from
MFP.
Attempting to scan results in

Invalid parameter:
ScanTicket message.
This message is the result of one or

more unsupported scan settings in
scanner options.
Enter Scan Options and choose

the Validate with MFP options.
This will expose any invalid settings
you may have selected in device
configuration.
Configuration cannot be uploaded to

the device
Verify that the right jar files are
uploaded.
Verify that the port which you are
using is available and open.
Verify that the firewall is

allowing the port to communicate

on the General tab when trying to
click OK.
Either the Application does not

have a menu or a form OR
The application has a menu but
no form OR
There is a menu within a menu
Check to see if your device falls

in a certain group and then upload
the correct jar files.
Check to see if the port is
not being used by any other
application or blocked by the
firewall.
Check to see if firmware on the
device is upgraded according to
match the OXPd requirement.
Add a form to the application if
no menu exists OR
Add a form to the menu if menu
exists within an application OR
Delete a menu within a menu.

on the Preferences tab when trying
to click OK.
Some of the fields in the preferences

tab are empty.
Fill the required fields in the

preferences tab.
An error message is displayed

There should be at least
one field on the form.
The fields tab has no fields added to

it.
Add a field in the fields tab form
Authentication selected during

configuration but no authentication
required at device.
Single Scan Touch option is grayed

out at the form level.
N/A
Single Scan Touch option is

enabled or disabled only from the
Application or the Menu level.
Fields tab cannot be accessed.


option at the Application or the
Authentication jar files not

Authentication not selected
for that application on the
Authentication manager for the
device.
Upload the right authentication

jar files.
Select the authentication for that
application in the Authentication
manager.
595
Problem
Possible Cause
Solution
Menu level and you can access the
Fields tab.
Scan Settings options cannot be

edited.

Failed to start session

message is displayed on the device
when you select the configuration.
Scan button not displayed on the

device.
The device does not support it.

option at the Application or the
Menu level and you can access the
Fields tab.
The workflow server has stopped.

The connection to the workflow
server is disconnected.
All scan settings are not available for Not all the devices support all the
certain MFP devices
scan settings.
Restart the workflow server.

Verify if the workflow server
connection is still active.
This option is not available on all

devices.
Make sure you are selecting the
scan settings for the device which
supports it or a message is displayed
on the device warning about the
setting not being compatible.
Error Message: Maximum

Lets say 5 devices are licensed and
Need to purchase additional device
Devices has been reached. 5 devices already working with the
licenses.
server. Then the 6th device (new
one) is trying to connect to the same
server. In this case the device will get
this error message.
Error Message: Device
Excluded
The device is trying to connect to the The device is blocked from the
server but it has been excluded from device list by the administrator.
the license list by administrator.
Unblock the device from the license
manager, then the message will not
be displayed.
Error Message: License

Expired
This error occurs when the license

mode changes from "evaluation"
mode to "expired" or the license was
transferred to another device.
Licenses are expired and you need to

license your workflow server or your
HP OXPd component.
Error (Attempts 0): The

HTTP request was
forbidden with client
authentication scheme
'Basic'.
This error is either the result of an

incorrect password entry or that no
password is required.
Enter the correct password or clear

the existing password.
Icons not appearing on the device.
Icon size is not supported.
Black and white icon of size 48x44

and color icon of size 66x66 are
supported.
German, Swedish, Danish and

Norwegian all use English for the
button labeled Standard within the
Image Adjustment scan setting.
This is due to the translation of the

word "Standard".
None.
Unable to see Application after

adding to a new Group of Devices.
IP address is incorrect, or you are

using the same device IP in multiple
configurations.
Verify the IP address, and ensure that

it is not being used in other device
groupings.
596
Problem
Possible Cause
"Menu id not found" device message

received when retrieving a form.
Solution
You are using the same device IP in

multiple device configurations.
Remove device IP from other

existing device groupings.
After configuring the IIS application, Multiple versions of the .NET

you get one of the following results: Framework on the computer that is
running IIS, and IIS was installed
An error message that reads:
after .NET Framework 4.0 or before
Could not load type
the Service Model in Windows
'System.ServiceModel.Activation.HttpModule'
Communication Foundation was
from assembly
registered.
'System.ServiceModel
Menus and forms do not appear.
The following line appears
in the logs (file located in IIS
logs (C:\inetpub\logs\LogFiles
\W3SVC1)):
Register the correct version of

ASP.NET:
2014-04-08
16:00:33 ::1
GET /OXPd16Site/
Services.asmx/
js - 80 - ::1
Mozilla/5.0+(Windows
+NT+6.1;
+WOW64)+AppleWebKit/537.36+(KHTML,
+like
+Gecko)+Chrome/33.0.1750.154+Safari/537.36
500 0 0 105
1. Open a command prompt as an

administrator.
2. Type the following command,
and then press Enter:
cd C:\Windows
\Microsoft.NET
\Framework64\v4.0.30319
aspnet_regiis.exe -iru
iisreset
Old configurations do not show the

The new Notable Solutions logo
1. Open the component properties
new Notable Solutions logo icons for icon is not selected in the application
dialog box.
HP Jedi devices and HP OZ devices. form.
2. On the General tab, select the
application and click Edit.
3. In the Icon section, select the
logo icon for your device type
(Jedi or OZ) from the drop-down
list and click OK.
4. Save and restart service manager.
Checking the Device Log
If you have scanned large number of pages and want to monitor device activity and when the device sends the
scanned images to the workflow server, type the following link in the browser and click enter.
https://<deviceIPAddress>/hp/device/sdc?GetLog
After you click enter you will get the following on the browser window:
597
To clear the log, you can enter the following link in the browser and click enter.
https://<deviceIPAddress>/hp/device/sdc?clearlog
After you click on enter you will get the following information on the browser:
598
HP TRIM
Welcome to the HP TRIM component
The HP TRIM component is designed to provide integration to HP TRIM Electronic Document and Record
Management System (EDRMS). The component receives electronically captured documents from the workflow, sets
the properties for the electronically captured documents and then moves the documents into the HP TRIM repository
system.
Getting started
Feature highlights
The main function of the component is to send documents into the HP TRIM system.
The component has the following key features:
Support for different record types.

Renaming document titles.
Setting security levels for documents.
Support for keywords and fields.
Adding notes to the routed documents.
599
How to use HP TRIM

Use this component to send your document into HP TRIM system.
An example of using the HP TRIM component
1. Create a workflow with a capture component of your type, OCR as a process component and the HP TRIM
component as route.
2. Configure the OCR parameters to recognize the text of the capture/scanned documents and
to output the recognized text as .txt file.
3. Configure HP TRIM route component connection parameters. Select the record type, location and other properties
of the new record on the Document tab. Create an external ID and add keywords and fields to the record on the
Attributes tab.
After documents are captured, passed through and recognized by OCR, it performs OCR functionalities specified in
the OCR settings and then routes the processed documents with their specified properties to the HP TRIM
management system.
How to Start HP TRIM Web Services
Follow the steps to configure the HP TRIM system web services.
For a proper operation of the component, the HP TRIM system web services should be installed and configured for
each database.
1. In IIS Manager find the the web service of your HP TRIM database.
Note: Web services should be installed for each HP TRIM database independently.
2. In the web service configuration, find Authentication section.
3. Set the following values for the Authentication properties:
Property
Recommended value
Anonymous Authentication
Disabled
ASP .NET Authentication
Enabled
Windows Authentication
Enabled
4. Set all other authentication kinds, if present, to Disabled.

5. Save changes.
The HP TRIM database web service is configured for a proper operation with the HP TRIM component.
Configuring HP TRIM
The component configuration window has the following tabs:
Tab
Description
General Tab
This tab is used to set connection parameters to the HP

TRIM system.
Document Tab
Specify record properties on this tab.
Attributes tab
Specify additional attributes for a record on this tab.
General tab
This tab is used to set connection parameters to the HP TRIM system.
Option
Activate
Description
option is present only in the eConnector. For more
information, see Conditional Activation.
600
Option
Description
Pass through

This option is present only in the eConnector.
Web service URL
Enter the address of service. You can use HTTP or

HTTPS prefix in the URL. If the prefix is not specified
then HTTP is used by default.
Select this check box to ignore errors when the user

connects to the server using an invalid SSL server
certificate. This check box is available only when the
Web Service URL has an HTTPS prefix.
User name
Enter the user name.

from an RRT at run time.
Password
Enter the password to log in to the system. This field

is available only when the Obtain password via RRT
check box is cleared.
Password RRT

replaced by the actual password at run time.
Timeout
Specify the connection time-out in seconds.
Test connection
Click this button to test the connection with the server.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.
601
Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
602
unary_operation ::+
!
string_constant

603
Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
1Boolean
2, 3Any
604
Symbol
Description
Result type
Operands type
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Document tab
Specify record properties on this tab.
Option
Description
Record type
Enter the record type name. You may select the record
type from the existing list on server, click the browse
button (...) and select the record type in the open
HP TRIM Record Types dialog.
Rename title
Select this check box to rename the record title;

otherwise, a new record will be created with the name of
the input document.
Duplicate record checking
Use this group to check if any record with the same title
or number already exists on the server.
Find record
Define the properties for the record search. This combobox has a predefined set of properties:
In ContainerThe search will be processed in the

specified container.
In Assignee LocationThe search will be processed
in the assignee location.
In Home LocationThe search will be processed in
the home location.
In Owner LocationThe search will be processed
in the owner location.
By NumberThe search will be processed
according to a number, specified by user. Specify the
number in the field next to the combo box.
Note:
The field next to the Find record combo box
is enabled, only when the search is processed
according to a record number.
You may use RRTs instead of predefined
properties. In this case the field next to the
combo box will be enabled.
If it exists
Define the behavior of the component if the duplicate

record exists in the specified place (or a record with
605
Option
Description
the specified record number). This combo box has a
predefined set of properties:
Create new recordSelect this option to create a

new record with the specified title and record type.
Save document as new versionSelect this option
to upload a document as a new version of the existing
record and its properties will be modified.
Overwrite last record versionSelect this option
to replace the last version of the record with the new
one: all the record properties will be changed.
Append index number to document name
Select this option to append a unique index to the
new title and a record with the new title will be
created.
Reject documentSelect this option to reject the
input document.
Container
Specify the container, where a new record will be added:

click browse button (...) to open the Select Container
dialog.
Enclose
Select this check box to enclose a record in the specified

container. This check box is available only when a
container is specified; otherwise, it is disabled.
Assignee
The assignee location name of a record will be written in

this field. This field has three predefined options.
Home location
The home location name of a record will be written in

Owner location
DefaultThe default location for this record type.

Current userThe currently logged on user
location.
SelectThis option opens Locations dialog

location.
SelectThis option opens Locations dialog.
The owner location name of a record will be written in


location.
SelectThis option opens Locations dialog.
Series number
Enter a number of the record of series type. Click the

browse button (...) to open the Find record dialog.
Record class
Specify the record class by choosing one from the

predefined set of classes.
606
Option
Description
Security level
Enter the security level for the record. You can do it

manually or through the HP TRIM Security Levels
dialog box. Click the browse button (...) to open this
dialog box and select a desirable security level. If you
leave this field blank the "no security level" security
level be automatically assigned to the new record.
Classification
Enter the path to the record classification. Click

the browse button (...) to open the HP TRIM
Classifications dialog box.
Notes
Add notes to a new record. They may consist of several

lines.
Keep checked out
Select this check box if you want a record to be checked

out. If this check box is selected then only the currently
logged on user will be able to update the record and it
cannot be finalized.
Finalize record
Select this check box to finalize a record. If this check

box is selected modification of the record will be
forbidden.
HP TRIM Record Types dialog box

Select the record type on this dialog box.
Every record type has the following attributes:
NameA name of the record type with the special icon.
LevelA level of the record type.
Select the record type from the list and click OK or double click the selected record type.
Select Container dialog box
This dialog is used for selection of container.
Option
Root container number
Description
Enter a unique number of container. You may search for
an existing container, click the Find button and locate
the container using the Find Record dialog box.
Note: If a container with the specified number
does not exist a document will be rejected at run
time.
Add sub containers
Use these fields to add a container that does not exist

on the server. You may also use these fields to specify
an existing container via RRTs. Click Add and specify
container properties in the Add Container dialog box:
Container titleEnter a title for the container.

Record typeEnter a record type name for the
container. You may select a record type from the
existing list on the server, click and select a record
type in the open HP TRIM Record Types dialog.
Container levelThis field shows the level of the
selected container.
607
Option
Description
Create container if it does not existSelect this

check box to create a new container.
Find Record dialog box

This dialog box is used for searching for the existing container.
Option
Description
Search by
Select the search method.
Equal to
Enter the word to be searched for. This field is required.

Note: You may leave this field blank if you
select the Assignee, Home location, Owner
location, or Creator search methodsin this
case the currently logged on user will be used as
parameters for the search.
Find
Click this button to begin searching. The search result

will be presented in the tree below.
Locations dialog box

Specify the location for a record in this dialog box.
Option
Description
Search by
Select the search method from the list.
Equal to
Enter the word to be searched for.

Note: If you leave this field blank all the
existing locations will be printed in the list.
The search result is printed in the list below. Click the
desired location to copy its properties into the Identifier
and Name fields.
Location attribute
In this group you may select a location by hand.
Name
Click this option and enter a name of location into the

field. If you choose this option, the Identifier string will
be disabled.
Identifier
Click this option and enter a unique identifier of location

into the field. If you choose this option, the Name string
will be disabled.
Note: On the server multiple locations
may exist with the same name. That is why
Identifier specifying is preferable: in this case
the exactly specified location will be used. If
you specify the Name the first found location
with this name will be used.
Attributes tab
Specify additional attributes for a record on this tab.
Option
External ID
Description
Enter an external identifier of record.
608
Option
Description
Accession number
Enter an accession number of record.
Priority
Specify the record priority.
Keywords
Enter a keyword for the record. Click Add and in

the open Add Keyword dialog enter the path to the
keyword. All the specified keywords will be shown in
this list.
Note: You may specify only those keywords
that already exist on the server. If you specify
a keyword that does not exist on the server a
document will be rejected at run time.
Fields
Add fields for a record.
Ignore fields with values of invalid type
Select this check box to ignore the fields that contain

values of invalid types. If this option is cleared and there
are fields containing values of invalid types, then the
document will be rejected at run time.
Note: If this check box is selected and there are
some obligatory fields containing invalid values,
then the server will appropriate the default
values for these fields.
Component RRTs
Component RRT ID
The RRT ID for this component is HPT.
RRTN
Description
~HPT::FileName~
The original name of the input document.
~HPT::FileExt~
The original extension of the input document.
~HPT::Counter,*~
An automatically generated number which provides

a unique title for a record that is being created,
where * represents the min number of digit positions
that will be used for the counter. For example, ~
HPT::Counter,3~ will be replaced with 001. The
counter value replaced only within the title field provides
a unique record title.
~HPT::GUID~
A unique identifier.
~HPT::RecordNumber,*~
The number of record, where * represents the number

of an uploaded document (0, 1, 2, ). This RRT can be
used only in the subsequent components in the process.
~HPT::FinalTitle,*~
The final name of the uploaded file, where * represents

the index of the uploaded file. This RRT can be used
only in the subsequent components in the process.
609
RRTN
Description
~HPT::FilesCount~
The number of the uploaded files. This RRT can be only

Example usage of the RRTN. If the input document name is La srnit des mondes oublis,
the document is the third one on the server, and it has the .doc extension, then the following
~HPT::FileName~_~HPT::Counter,2~~HPT::FileExt~ will be replaced with "La srnit des mondes
oublis_03.doc".
Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
The component supports the HP TRIM version 7.1.

For a proper operation of the component, the HP TRIM Web service should be installed on the server.
Set the IIS APPPOOL account for HP TRIM Enterprise Studio as a trusted account to impersonate users. To set
the IIS APPPOOL\TRIM account as trusted, complete the following steps:
1. In IIS, create an application pool of TRIM.

2. Add IIS APPPOOL\TRIM as a trusted account in the Miscellaneous section of HP TRIM Enterprise Studio.
The component does not support SharePoint site and SharePoint list record types, although they may be
configured on the server.
610
Problem
When you try to access the newly created or updated
record, the following error message appears:
"You have not permissions for access to created/
updated record. Maybe your location has inappropriate
security level or access control policy. Contact your
administrator."
Description
This error will appear if the record security level is
higher than the security level of the user location that
is used to access the record. The system allows users to
create records with the security levels higher than their
own ones, but in such a case users will not be allowed to
modify these records or to have access to them.
To avoid this problem, make sure that the user security
level is the same or greater than the security level of the
record being created or modified.
Hummingbird/Open Text eDOCS

Welcome to the Hummingbird/Open Text eDOCS component
The purpose of the Hummingbird/Open Text eDOCS route and eConnector components is to store documents into
the Hummingbird/Open Text eDOCS DM server, where records can be identified or searched for, by using database
queries.
The component runs on a client machine that has access to the Hummingbird/Open Text eDOCS DM server. The
client software should be installed on this machine.
This component works with the Hummingbird/Open Text eDOCS DM server versions 5.1.0.5, 5.3.0, 5.3.1 and 6.0.1.
The only difference between the Hummingbird/Open Text eDOCS eConnector and route components is that the
eConnector component has two additional options in the General tab:
Activate check box makes the component active, if selected. If this check box is not selected, the component won't
Pass-through check box makes the document(s) available to the next component in the process, if selected. These
two options are not available in the route component configuration.
Getting started
Feature highlights
The major features of this component are:
Specify the destination parameters: logon library, remote library(optional), folder and rename schema.
Select profile and profile type for the routed documents.
Set typist. You can change the author of the document by using the Impersonate option.
Restrict routed files by specifying a list of file extensions.
Set values of the fields of the routed documents.
How to use Hummingbird/Open Text eDOCS

This component is mainly used to store any type of content from various sources. This component allows you to meet
your regulatory and archival requirements with ease.
The following provides an example of the component common usage scenario: Scan documents from a variety of
MFP devices directly into Hummingbird/Open Text eDOCS DM server.
2. From the component tray, select the desired process components and select the Hummingbird/Open Text eDOCS
route component for storing the scanned document into the Hummingbird/Open Text eDOCS library.
3. In the General tab of the Hummingbird/Open Text eDOCS configuration, define the connection parameters to log
into the server, select library to store documents into and specify the document profile.
611
4. In the Document tab, configure folder and security options.

5. In the Fields tab, configure the fields that will be assigned to the routed document.
With the server running, the walk-up MFP user enters a pre-configured function key on the control panel of the MFP
device, the document with the set attributes is routed directly into Hummingbird/Open Text eDOCS DM server.
Configuring Hummingbird/Open Text eDOCS
The component configuration window consists of three tabs:
Tab
Description
General Tab
Set the general user access attributes of the

Hummingbird/Open Text eDOCS DM server.
Document Tab
Specify document-specific properties in this tab.
Fields Tab
Use this tab to set values of the fields that are created in
the DM Designer by a user on the Hummingbird/Open
Text eDOCS DM server.
General tab
Set the general user access attributes of the Hummingbird/Open Text eDOCS DM server.
Option
Description
Activate

perform any actions during files processing. This option
is only available in the eConnector component.
User name
Enter the user name which is used to connect to the

Hummingbird/Open Text eDOCS DM server.
Note: The specified user must have
permissions to store documents in the desired
library. Each library has its own user list. You
can use RRT values to create dynamic login
based on the user sending documents.
It is mandatory to fill out this text box.
Note: When you use an RRT in the User name
text box, you will be able to connect to the
server only during processing, when the RRT
will be replaced.
Password
Enter the user password for the user name. It is

mandatory to fill out this text box.
Domain
Enter the domain name. This text box should be filled

out depending on what User name you use.
If in the User name field you entered your library

user name, leave this text box blank.
If in the User name field you entered a Windows
Domain LAN account, enter the name of the
Windows Domain.
If in the User name field you entered a NetWare
version 3 LAN account, enter the name of the
NetWare server.
612
Option
Description
Logon type
Select an appropriate logon type. You can select from:
Logon library
If in the User name field you entered a NetWare

version 4 LAN account, enter the name of the
NetWare tree.
Active Directory
Library
NetWare Bindery
NetWare NDS
Enter the library to which the user will connect or click

the
button to open the Select Library dialog box,
which allows you to choose a library from the list of
existing libraries. Please note that the user must have
proper permission levels to access the specified library. It
is mandatory to fill out this text box.
Remote library
Profile type
Enter a remote library. Remote library is a library that

can be accessed after the user has logged on to a logon
library. If you leave this field blank, the documents will
be stored into the logon library, otherwise they will be
stored into the remote library.
Enter the profile type or click the
button to open
the Profile Type dialog box, which allows you to
select one of the profile types that are available on the
Hummingbird/Open Text eDOCS DM server for the
specified user.
Note: The profile type functionality is
available only when you are working with the
Hummingbird/Open Text eDOCS DM server
version 6.0.1. If the component determines that
the version of the client software installed is
lower, for example, 5.1.0.5, then this text box is
not displayed.
Profile
Enter the profile you want to use for storing documents.

The
button next to this text box opens the Select a
Profile dialog box that allows you to choose a profile
from a list. It is mandatory to fill out this text box.
Note: If you are working with the
Hummingbird/Open Text eDOCS DM server
version 6.0.1, you can select only the profiles of
the selected Profile type.
Typist
Enter the name of the user that will become the "Typist"
of the document. Click the
button to open the Typist
dialog box, which allows you to choose a user from a
list of users in the Hummingbird/Open Text eDOCS DM
library.
Note: In the Hummingbird/Open Text eDOCS
DM client, the value of the "Typist" field is
613
Option
Description
displayed as Created by value on the Profile
tab, Editor on the Versions tab, and User value
on the History tab.
Impersonate
When you select this check box, the author of

the document becomes the person entered in the
Impersonate text box instead of the value specified in
User name. With impersonation selected, this user is
given security access as well. You can click the
button. This button opens the Impersonate dialog box
that allows you to choose a user from the drop-down
list of users in the Hummingbird/Open Text eDOCS
DM library. It is mandatory to fill out this text box if the
Impersonate check box is selected.
Rename
Select this check box if you want to rename the

document and enter the schema that will be used for
renaming. If this check box is not selected, and the
library does not accept duplicate names, the document
will fail to store if another document with the same name
already exists in the library.
Pass-through
This check box is available only in the Hummingbird/

Open Text eDOCS eConnector component. If you select
this check box, the Hummingbird/Open Text eDOCS
eConnector component passes the document to the next
Document tab
Specify document-specific properties in this tab.
Option
Description
File
This group of settings allows you to associate file

extensions with file types. The component will send
the documents whose extensions are in the list. Manage
the list of association with the help of the Add, Modify
and Remove buttons. The list of extensions must not
be empty. You can sort the list by clicking on any of the
column headers.
Folder
Enter the folder into which the documents will be routed.

You can click the
button to open the Folders dialog
box, which allows you to select a folder from the tree of
existing folders. If you leave this field blank, the file is
added to the root directory.
Security
This group of check boxes allows you to set permissions.
Inherit from folder
If you select this check box, the document will inherit

the permission of the folder where it is stored.
Full Access for Author/Typist/Impersonator
If you select this check box, the typist, author and

impersonator are granted full access rights to the
document.
614
Fields tab
Use this tab to set values of the fields that are created in the DM Designer by a user on the Hummingbird/Open Text
eDOCS DM server.
The tab displays all fields for the selected profile that are not hidden or read-only. If the field is marked as required it
is also displayed(no matter whether it is hidden or read-only). For each field the following parameters are displayed:
N - number of the field.

Field - name of the field.
ID - internal identifier for the field.
Required - contains "Yes" if this field is required and "No" if it is not required.
Value - value of the field. Only this parameter can be modified.
Select a field and click Edit this button to set the value of the selected field. This button opens the Field Value dialog
box in which you can edit the value of the field. Clicking this button is equivalent to double-clicking on the selected
item.
Note: It is mandatory to specify values of the required fields.
Component RRTs
Component RRT ID
The RRT ID for this component is HUM.
Name
Description
FileName
Counter

found within the destination directory. The counter
value concatenated with a name provides a unique file
name.
ID
The ID number of the document stored in Hummingbird/

Open Text eDOCS DM server. This RRT is present only
for the eConnector component.
Library
The library into which the user logs on. This RRT is
present only for the eConnector component.
RemLib
The remote library associated with the logon library.

This RRT is present only for the eConnector component.
DocName
The document name stored on the server. This RRT is

present only for the eConnector component.
Domain
The domain used to login into Hummingbird/Open Text

eDOCS DM server. This RRT is present only for the
Note:
The ~HUM::FileName~ and ~HUM::Counter~ RRTs can be used only in the Rename text box.
The ~HUM::ID~, ~HUM::Library~, ~HUM::RemLib~, ~HUM::DocName~ and ~HUM::Domain~
RRTs are available only for the subsequent components in the process chain.
615
The RRT phrase ~HUM::FileName~~HUM::Counter~ is replaced by the value "Document5" if the original
file name was "Document" and there are already up to 4 ("Document1" to "Document4") files within the destination
folder path.
This component does not have any SSRTNs.
This component works with the Hummingbird/Open Text eDOCS DM server and client versions 5.1.0.5, 5.3.0,
5.3.1 and 6.0.1.
The component does not work on Windows Server 2008 with the Hummingbird/Open Text eDOCS DM client
version 5.1.0.5 or 6.0.1 since these versions of the client do not support this operating system. It does work,
however, on Windows Server 2008 with the Hummingbird/Open Text eDOCS DM client v5.3.0.
You may add a document to one library at a time. You cannot select multiple libraries.
The component sends only the documents with extensions specified in the File extensions list.
Only Profiles that have the TYPIST_ID field are supported when you are working with the server version
5.1.0.5. Other profiles, such as search profiles, cannot be used.
Certain fields are excluded from the listing of fields. This is because they are used on the dialogs themselves. An
example includes DOCNAME, which refers to the documents name. If this field actually exists on the profile
form, its value is either the original name of the document or the value of the Rename schema. Other excluded
fields are AUTHOR, AUTHOR_ID, SECURITY, TYPIST, APP_ID, TYPIST_ID, and APPLICATION.
The Profile type functionality is available only when you are working with the Hummingbird/Open Text eDOCS
DM server version 6.0.1.
Problem Description
Solution
When you select a folder in the Folders dialog box, click

OK and then reopen this dialog box, another folder is
displayed as selected.
This can happen if the selected folder has several

parents. When you reopen the dialog, the selected folder
is actually the same, but the path to it is different. You
can check that the id of the folder is the same. The
component selects the first folder in the tree with that id.
The DM Connection Wizard of the client fails to connect The probable reason of this problem is that the
to the server.
Distributed COM option in the computer properties
settings is switched OFF.
The possible solution is to switch this option ON. You
can switch this option on in the Component Services
console in Windows Administrative Tools. Follow these
steps:
1. Click Start > Control Panel > Administrative
Tools > Component Services.
2. In Component Services tree, expand Component
Services > Computer.
3. Right-click My Computer and click Properties on
the shortcut menu.
4. On the Default Properties tab, select the Enable
Distributed COM on this computer check box.
616
IBM CM
Welcome to IBM Content Manager 8.4
The IBM Content Manager 8.4 route and eConnector components provide scalable content capture server software
technology to help you capture your corporate business content into databases of IBM Content Manager 8.4 server.
IBM Content Manager improves your organization's efficiency through enhanced collaboration and information
management.
For a proper operation of the component, the client software should be installed and configured on the computer with
the Workflow Server.
First variant of the client software:

IBM Data Server Client Version 9.5
A collection of client application drivers and tools for

DB2 and Informix IDS data servers.
IBM DB2 Content Manager Information

Integrator for Content version 8.4
API for connection to the IBM Content Manager 8.4

server.
Second variant of the client software:

IBM Data Server Client Version 9.5
IBM DB2 Content Manager Enterprise
Edition Client for Windows
version 8.4 (or version 8.4.2)
A collection of client application drivers and tools for

DB2 and Informix IDS data servers.
API for connection to the IBM Content Manager 8.4 or
8.4.2 server.
Getting started
Feature highlights
With the IBM Content Manager 8.4 component you can:
Route documents to the IBM Content Manager 8.4 server to a selected database and folder.
Set properties of routed documents: file type, item type, attributes.
Assign a document routing process to be started on a routed document.
How to use IBM Content Manager 8.4

The following provides an example of common usage scenario: Scan documents from a variety of MFP devices
directly into IBM Content Manager 8.4
1. Design a workflow process by selecting the type of MFP used in scanning of the documents. From the component
tray, select the desired process components and select the IBM Content Manager 8.4 route component for storing
the scanned document into IBM Content Manager 8.4.
2. In the General Tab of the IBM Content Manager 8.4 configuration, define the connection parameters to log into
the IBM Content Manager 8.4 server.
3. In the Document Tab, configure document-specific parameters and select a routing process that will be applied to
the routed document.
4. In the Attribute Values Tab, configure the attributes that will be assigned to the routed document.
6. Run the process.
With the server running, the walk-up MFP user enters a pre-configured function key on the control panel of the MFP
device, the document with the set attributes is routed directly into the specified folder in IBM Content Manager 8.4
database. The specified routing process is applied to the routed document on the IBM Content Manager 8.4 server.
617
Configuring IBM CM
The component configuration window contains three tabs:
Tab
Description
General Tab
Set the parameters to connect to the IBM Content

Manager 8.4 server in this tab.
Document Tab
Set the document-specific parameters in this tab.
Attribute Values Tab
Specify attributes that will be associated with routed

documents in this tab.
You can use RRT in all text boxes of the component configuration except for the Password text box.
General tab
Set the parameters to connect to the IBM Content Manager 8.4 server in this tab.
Option
Description
Activate

perform any actions during files processing. This check
box is present only for the IBM Content Manager 8.4
Database
Enter the name of the database where documents will be

routed.
User name
Enter the user name to access the specified database.
Password
Enter the password for the corresponding username.
Pass-through
Select this check box to make the document(s) available

to the subsequent components. This check box is present
only for the IBM Content Manager 8.4 eConnector
component.
Document tab
Set the document-specific parameters in this tab.
Option
Folder
Description
This text box displays the folder in which documents
will be stored. The folder is displayed in the form
Foldername <folderID>, which identify the folder
name and folder identifier in the IBM Content
Manager 8.4 server. For example, MyFolder
<A1001001A09F19B55855F09534>. Click the
button to open the Select Folder dialog box and select a
folder from the folder tree.
Note:
If you specify a folder identifier manually in the
Select Folder dialog box and the component
cannot determine a corresponding folder (for
example, the identifier is specified via RRT),
then the component will display only the folder
identifier without name in the Folder text box.
618
Option
Description
If you leave the Folder text box empty, then the
documents will be stored in the root folder of
the IBM Content Manager server.
The component works only with folders of the
ICMDRFOLDERS type, which is displayed for
users as Document Routing Folders type.
File type
Specify the file type from the IBM Content Manager

server that you wish to associate with routed documents.
The file types include several variants of audio, image,
and video. You can click the
button to open the
Select File Type dialog box, which shows names,
display names and mime types of the file types available
on the server. It is mandatory to specify file type.
Item type
Select the item type from the IBM Content Manager

server. An item type is a category used to identify a
group of documents and folders stored in the system.
You can click the
button to open the Select Item
Type dialog box, which displays names and descriptions
of the item types available on the server. It is mandatory
to specify item type.
Start documents on process
Select this check box to start a specified document

routing process on documents. A routing process is a
series of steps through which a document is routed.
Routing processes are configured on the IBM Content
Manager server. When you select this check box, the
Process, Owner and Priority text boxes become enabled.
Process
Specify a document routing process to be attached to

the document. You can click the
button to open the
Select Process dialog box, which allows selection of one
of the processes configured on the server. It is mandatory
to fill out this text box if the Start documents on
process check box is selected.
Owner
Specify the owner of the process. It is mandatory to fill

out this text box if the Start documents on process
Priority
Enter a positive integer value in the range of 0 to

2147483647 to specify the priority of the document
routing process. The priority of a document moves
it up or down in the processing order in a systemassigned work list. Documents with higher priority
values are processed before those with lower values.
It is mandatory to fill out this text box if the Start
documents on process check box is selected.
619
Select Folder dialog box

This dialog box allows selection of a folder on the IBM Content Manager server.
Option
Description
Please select a folder
Select a folder from the folder tree displayed in this box.
...or specify a folder identifier
This text box displays the identifier of the selected

folder. You can enter the identifier manually and
use RRT in this text box. If the specified identifier
corresponds to an existing folder and the component can
connect to the server, then the corresponding folder will
be selected automatically in the folder tree.
The selected folder's name and identifier will be displayed in the Folder text box on the Document tab.
Note: If you enter the folder identifier manually and the component cannot determine a corresponding folder
(for example, the identifier is specified via RRT), then the component will display only the folder identifier
without name in the Folder text box.
Attribute Values tab
Specify attributes that will be associated with routed documents in this tab.
This set of attributes depends on the Item Type, specified for the document on the Document tab.
Option
Description
Add
Click this button to add an attribute to the list. This

button opens the Add Attribute dialog box that allows
you to select one of the available attributes and to set
value to it.
Modify
Select an attribute and click this button to set or modify

the value of the selected attribute in the opened Modify
Attribute dialog box.
Remove
Select an attribute and click this button to remove the

selected attribute from the list.
Add/Modify Attribute dialog box

This dialog box allows you to add or modify an attribute.
Option
Name
Value
Description
enter the attribute's name or click the
button to open
the Select Attribute dialog box that displays the list
of attributes related to the Item type that is specified
Document tab, and allows selection of an attribute from
this list.
Enter the attribute's value. If the selected attribute is a
compound one and has child attributes, the
button
becomes enabled. Click this button to open the dialog
box that allows you to set values of the child attributes.
If the selected attribute has a default value and this text
box is left blank, the default value will be assigned
to this attribute. Otherwise, the component will try to
convert the blank value into the format corresponding to
the attribute type.
620
Supported Common Base Attribute Types:
DK_CM_CHAR
DK_CM_DATE
DK_CM_DECIMAL
DK_CM_DOUBLE
DK_CM_INTEGER
DK_CM_SHORT
DK_CM_TIME
DK_CM_TIMESTAMP
DK_CM_VARCHAR
Not supported Base Common Attribute Types:
DK_CM_BLOB
DK_CM_CLOB
The following attribute types will be converted into the formats below:
DATE: YYYY-MM-DD
DECIMAL: (-)XXX.XX (X stands for a digit. The number of digits and the position of the decimal point depend
on the server settings.)
TIME: HH.MM.SS
TIMESTAMP: YYYY-MM-DD-HH.MM.SS.NNNNNN (Year-Month-Day-Hour.Minute.Second.Microseconds).
By Default, the values for the DATE, TIME and TIMESTAMP will take in current time.
Component RRTs
Component RRT ID
The RRT ID for this component is IBM.
RRTN
Description
FileName
FileExt
FilePath
The path to the document on the IBM Content Manager

8.4 server consisting only of the folders. For example:
Folder_0\Folder_1\Folder_2.
PID
Persistent identifier of the uploaded document on the

IBM Content Manager 8.4 server. If the component
receives a batch of several documents, this RRT
represents the string containing PIDs for all uploaded
documents corresponding to the documents inside of the
batch, delimited by semicolon. This RRT applies to the
eConnector component only and is available only for the
subsequent components in the workflow.
PID:*
Persistent identifier of the uploaded document. The

* index should be replaced by a digit. For example:
~IBM::PID:2~. This digit is a number of the
document in the received batch of documents. This RRT
will be replaced with the PID of the uploaded document
621
RRTN
Description
corresponding to the received batch. This RRT applies to
the eConnector component only and is available only for
the subsequent components in the workflow.
URL
URL of the uploaded document.

If the component receives a batch of several documents,
this RRT represents the string containing URLs for
all uploaded documents inside of the batch, delimited
by semicolon. This RRT applies to the eConnector
component only and is available only for the subsequent
components in the workflow.
URL:*
URL of the uploaded document on the IBM Content

Manager 8.4 server. The * index should be replaced
by a digit. For example: ~IBM::URL:2~. This digit
is the number of a document in the received batch of
documents. This RRT will be replaced with the URL of
the uploaded document corresponding to the received
batch. This RRT applies to the eConnector component
only and is available only for the subsequent components
in the workflow.

This component does not support FRTN.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
Day of month as decimal number (01 - 31)
%H
%I
%j
%m
%M
%p
%S
%U

%w
622
SSRTN
Description
%W

%y
%Y
Example usage of the SSRTN :

~IBM::%Y~-~IBM::%m~ will be replaced by 2010-06.
This component works with the IBM Content Manager versions 8.4.0 and 8.4.2.
For a proper operation of the component, the client software should be installed and configured on the computer
with the Workflow Server.
First variant of the client software:
1. IBM Data Server Client Version 9.5 - a collection of client application drivers and tools for DB2 and
Informix IDS data servers.
2. IBM DB2 Content Manager Information Integrator for Content version 8.4 - API for connection to the IBM
Content Manager 8.4 server.
Second variant of the client software:
1. IBM Data Server Client Version 9.5 - a collection of client application drivers and tools for DB2 and
Informix IDS data servers.
2. IBM DB2 Content Manager Enterprise Edition Client for Windows version 8.4 (or version 8.4.2).
The component works only with folders of the ICMDRFOLDERS type, which is displayed for users as
Document Routing Folders type.
No information is available.
IBM CM OnDemand
Welcome to IBM Content Manager OnDemand
The IBM Content Manager OnDemand component allows you to route documents to the IBM Content Manager
OnDemand system. The component essentially creates import files which the IBM Content Manager OnDemand
system can interpret in order to import documents accordingly.
The component can be used both as a route and eConnector component.
Getting Started
Feature highlights
The features for this component include:
Create import files for sending document to the IBM Content Manager OnDemand system.
Define and map meta-data to be imported in the IBM Content Manager OnDemand system.
Configurable application/application group settings.
No client application necessary.
Back-up/failsafe functionality.
623
How to use IDM Content Manager OnDemand

This component routes documents to the IBM Content Manager OnDemand system by creating import files. These
files are then interpreted by the IBM Content Manager OnDemand system and contain the document and any
specified meta-data (fields).
The component does not require a client application in order to function. Instead, all import files are written to a
"share" directory, where the IBM Content Manager OnDemand server picks them up and imports them accordingly.
The configuration dialog of the component allows you to configure all relevant settings quickly and easily on one
screen.
An example of the component usage: Sending captured documents with metadata to the IBM Content Manager
OnDemand system.
1. Configure a workflow with AutoCapture component and IBM Content Manager OnDemand component.
2. In the IBM Content Manager OnDemand configuration set the codepage, application, output path for the import
files, remote path for IBM Content Manager OnDemand service.
3. Configure field values to be passed with RRTs.
4. Run the process.
A user sends documents to the workflow and specifies the field values. The IBM CM OnDemand component
generates 3 import files that contain the input document and configured meta-data. These files are then picked up by
the IBM Content Manager OnDemand service and saved in the specified application with the specified meta-data for
storage.
Configuring IBM Content Manager OnDemand
Configure the main settings of the component.
Option
Description
Activate

option is enabled only in the eConnector component.
Pass through
If this check box is selected, the component will pass

the document to the next component in the process. This
option is enabled only in the eConnector component.
General
Use this group to specify the import file settings.
Codepage
Specify the codepage value for your IBM Content

Manager OnDemand system/application.
Application/Filename
Configure the application group and application name

accordingly. By default, this text box contains the value:
IBM.NSI.DEFAULTAPPGRP.DEFAULTAPP
To configure another application group or application
name, just replace the relevant parts of the string
(between the '.') as required by your application on
the IBM Content Manager OnDemand server side.
The entered value will be used for building names of
three import files. Each file name is followed by a date
stamp .<YYMMDD> and a time stamp .<HHMMSS> in
which leading zeroes are trimmed. The three generated
files have the following extensions:
.ARD.outA file containing the input file content,
624
Option
Description
.ARD.indA file containing the meta-data (fields,

codepage, group file name, comment, and so on.)
.ARDAn empty file that is generated to inform
the IBM Content Manager OnDemand service that
the two above-mentioned files are already copied
\moved to the "shared" folder and are ready to be
imported to the IBM Content Manager OnDemand
storage.
For example, the following 3 files may be generated:
File output path
IBM.NSI.DEFAULTAPPGRP.DEFAULTAPP.201097.122559
Specify the shared folder to which the import files will

be written. IBM Content Manager OnDemand system
can pick up the import files here. You can specify folder
path manually or click
to open the Browse for
Folder dialog box that allows selection of an existing
folder as well as creation of a new one.
Note:
Make sure that the Workflow Server logon
(user) has sufficient rights to access this folder
at service run time.
The specified directory must exist (it will not be
created at run time).
Remote path
This path represents the incoming document import

path from the IBM Content Manager OnDemand server
perspective.
Note: This entry, together with the file name,
represents the GROUP_FILENAME entry
in the import file. The path must end with a
directory separator character (\ or / depending
on your back-end system), for example: /nsi/
scans/.
Backup path
Specify a back-up directory. Import files will be moved

to this directory, should a problem occur. Example: The
network share - specified in the Fileoutput path setting
might not be available.
You can specify back-up path manually or click
to open the Browse for Folder dialog box that allows
selection of an existing folder as well as creation of a
new one.
Note: The specified directory will be created at
run time if does not exist yet.
Fields
Specify the fields (meta-data) that you would like to

import into IBM Content Manager OnDemand along
with your documents.
625
Option
Description
Note: Make sure these fieldnames correspond
to your fields in the IBM Content Manager
OnDemand application.
Enter the field names (as created in your IBM Content
Manager OnDemand application) on the left side
(OnDemand Field Name). Then select the right side
(Value) and enter your desired value here. You can
of course drag & drop RRTs for the values instead of
entering them manually.
Note: We strongly advise that only an IBM Content Manager OnDemand administrator should attempt to
configure the component (due to the specific required knowledge on the IBM Content Manager OnDemand
system side).


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



626
Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
627

Constants
Examples:
628

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
629
Component RRTs
Component RRT ID
The RRT ID for this component is IBD.
Name
Description
FileName
Returns the original file name.
FileExt
Returns the original file extension, such as .txt, .doc, and

so on.
GUID
New GUID value generated by the component.

SSRTN
Description
%a
Abbreviated English weekday name (Sun-Sat)
%A
Full English weekday name (Sunday-Saturday)
%b
Abbreviated English month name (Jan-Dec)
%B
Full English month name (January-December)
%d
Day of month as 2-digit decimal number (01 - 31)
%H
%I
%j
%m
%M
%p
%S
%U

%w
%W

%y
%Y
630

~IBD::%Y~-~IBD::%m~ will be replaced by 2010-06.
Make sure the Workflow Server logon (user) has all required access rights to write documents to the "File output
path" and the "Backup path" directories ("localsystem" is NOT recommended!).
The path specified in the "Remote path" setting must end with a slash (/) or backslash (\) character (depending on
your back-end IBM system). Example: /nsi/scans/incoming/.
The IBM Content Manager OnDemand specific settings (Codepage, Application/Filename, Remote path, Fields)
have to correspond to your IBM Content Manager OnDemand application settings accordingly. The component
cannot verify the correctness of these settings.
IKON DocSend
Welcome to the IKON DocSend component
Use this component to capture documents that are scanned using DocSend into the workflow process. This
component works with any TWAIN compatible scanning device.
IKON DocSend comprises of a server software that runs on the server and a client software that runs on the user
machine. The IKON DocSend client communicates with the IKON DocSend server component to retrieve menu and
form information for presentation on the user's DocSend application. When fully configured, user simply clicks on
the AutoStore button, scan and edit the files, add additional index data to the document. The scanned document along
with the user-entered index data is then processed through the workflow and stored in the route component specified
in the workflow process definition.
This help file describes the configuration of the IKON DocSend component on the workflow server. To configure the
client, refer to the IKON DocSend Client Help.
Getting started
Feature highlights
Select the NT groups and/or users that will be presented with IKON DocSend feature.
Define logical group names for the users/groups that will have access to specific workflows.
Create a menu hierarchy for ease of use.

Use this component to capture documents scanned by the DocSend application into a workflow. The client machine
running the IKON DocSend client communicates with the IKON DocSend server component to retrieve group, menu,
form, and action displays for the DocSend client application.
Create a process with IKON DocSend component
Capture documents via IKON DocSend
component and place the documents in a folder followed by the Folder Store route component. Once the
process is started from the Service Manager interface,
the DocSend user selects AutoStore as the destination on
the Main tab of the DocSend application, scans the files,
and selects the Send Tab. The user is then presented
with the menu items that were configured using this
component.
631
You can choose a form to fill out index data for a file. If there is no need for indexed data, the user selects an action
that would process the files into Folder Store component for storage.
Configuring IKON DocSend
Menu tab
Use this tab to add, edit, or remove component groups, menus, forms, and actions to the IKON DocSend component
in a workflow.
Option
Description
Add
Click this button to create any of the following:
Group
Menu
Form
Action
Edit
Click this button to edit a selected group, menu, form or

action.
Remove
Click this button to remove the selected the group, menu,

form or action.
Group options
The Group command adds a group.
Each group entry requires the following information.
Field Name
Name
Description
name is used strictly as a logical group name and does
not appear on the DocSend application.
This component is equipped with a default group called
Common Group. You may add a menu, form, or action
to the Common Group. Every user receives the menu
options under the common group. A user can scan the
files into the workflow and select a menu, form or action
that is in the Common Group.
Root Menu Title
Enter a menu title. This menu title appears on the

DocSend application. The user should be able to
immediately relate this menu title to the current task.
Member Name
Click Add to enter either a valid domain groups or users

that you want to have access to this menu entry. Click
Remove to delete a selected user or group.
Menu options
Use a menu entry to create a hierarchy of submenus, forms, or actions.
A menu entry guide the DocSend user to select the desired workflow.
Field Name
Name
Description
Enter the name that labels the menu entry.
632
Form options
Create a form when your workflow requires capture of index data. When you add a form, enter values for options on
following tabs:
General Tab
Components Tab
General tab
Field Name
Description
Form Name
The name of the form to be displayed on the DocSend

application hierarchy.
Form Fields
For each field you can configure field attributes:

be any alphanumeric characters. Special characters
(such as ~, &, <, >,%,") are not recommended.
Boolean
Date/Time
String
String list
NShows the field number. You can click the N in
the column header to add a new field to the list.
R (required)Select this check box to require the
user to enter a value in this field.
Help MessageA help button containing a help
message is displayed next to a field if a help message
was provided when the field was configured. This
should be used to guide a user when he/she is
attempting to fill out a form.
P (properties)Set the field attributes by clicking
the properties (...) button in this column.
Add
Click this field to add a new field. Alternatively, you can

click the new field button (N on the first column header).
Once you have added the a field, you can press Tab to
move between columns and add additional fields.
Remove
Click this button to remove selected fields. Click the

field number to select a field. Use Shift-click to extend a
selection or Ctrl-click to add fields to a selection.
Components tab
List of all process components, their description, type, and the configuration button to set their configuration
attributes.
Enable a component and configure options by clicking the configuration button () in the in the C column of the
table.
Date/Time formats
633
Format Representation
Description
%a
abbreviated weekday name
%A
full weekday name
%b
abbreviated month name
%B
full month name
%C
century number
%d
the day of the month (0031)
%e
the day of the month (031)
%H
hour (0023)
%I
hour (0112)
%j
day of the year (000366)
%k
hour (023)
%l
hour (112)
%m
month (0112)
%M
minute (0059)
%n
a newline character
%p
PM or AM
%P
pm or am
%S
second (0059)
%s
number of seconds since Epoch (since Jan 01 1970

00:00:00 UTC)
%t
a tab character
%U, %W, %V
the week number
%u
the day of the week (17, 1 = Sunday)
%y
year without the century (0099)
%Y
year including the century (for example, 1979)
%%
a literal % character
Action options
You can assign an action to a menu entry item when there is no need to assign index fields by the DocSend
application user.
Use actions to allow a user to select a file that does not require any indexing field information to be captured and
applies the file directly in to the workflow process. Depending on the process components and the route component
selected, the files is processed and stored in the designated route component.
For every action you create, you are configuring a distinct workflow treatment based on the process component(s) and
route component that you select.
634
Option
Description
Action Name
Specify the label for an action on a menu.
Components
List of all process components, their description, type,

and the configuration button to set their configuration
attributes.
Enable a component and configure options by clicking
the configuration button () in the in the C column of
the table.
Preferences tab
In this tab, set the location of where the server stores the program files for the job that is processing.
Option
Description
Home Directory

Port Number
Enter the port number used by the IKON DocSend Client

to communicate with the IKON DocSend Server.
This port number must match the port number that is
used in configuring the IKON DocSend Client computer.
Keep
Keep the files in:
Processed FilesSelect this check box to save

copies of captured files to a specified directly after
they are successfully routed. If this option is enabled,
a copy of every file that has been successfully routed
is saved to the directory.
Rejected FilesSelect this check box directory to
save copies of files that are not routed successfully. A
failure could be due to any number of reasons that
can be researched by searching the application
log file entries. Typically, it is beneficial to have
a secondary process that captures files from this
directory and routes warning messages to alert a
system administrator that there is a failure.
The service must have permission to save files to these

directories. You also want to make sure that proper disk
IKON DocSend Component RRTs
Component RRT ID
The RRT ID for this component is IKD.
635
Name
Description
UserName

document(s).
Domain

document(s).
ComputerName
The NetBIOS name of the clients local computer that is

submitting document(s).
PageCount
Return the number of pages that are scanned and sent

through.
PageHeight
Returns the page Height of the image in inches as a float.
PageWidth
Returns the page Width of the image in inches as a float.
Resolution
Returns the resolution of the image in DPI (pixels per

inch). Possible return values are:
72
144
200
300
400
600

The FRTN string ~IKD::%Client ID%~ is replaced by Company if the user types in Company for the field
name called Client ID.
The EFI DocSend Port (such as 8086) cannot be locked by another process. If EFI DocSend fails to start, check
for another process that could be listening on this port.
The special characters &, < or > are not allowed within the menu, form or action button names.
IMAP Capture
Welcome to IMAP Capture
IMAP Capture is a capture component that is capable of retrieving email messages from a mail server that supports
IMAP protocol. The component can work with several mail accounts and allows you to create several classes of
search criteria for every account, each class passing messages to a single workflow. The component receives and
processes messages one at a time.
636
Getting started
Feature highlights
The component offers the following features:
Retrieving email messages from mail servers that support IMAP protocol.
Different search criteria according to which messages are searched for and specifying different workflows for
them.
Various parameters of email messages that can be used in search criteria: subject, from, body, size, date.
Custom IMAP queries to make search criteria more exact.
Creating separate documents for every attachment and sending them into the workflow separately to provide more
flexibility.
Using the IMAP Capture component

Use this component to fetch documents from a mail server via IMAP protocol.
Configuring the IMAP Capture component
Main Configuration window
The component can be configured to process messages from several IMAP accounts. Each account has associated
e-mail classes. An e-mail class specifies the criteria according to which email messages will be searched for in the
account. The exact criteria are defined in the e-Mail Class Configuration dialog box. You can see the order of
accounts and their e-mail classes in the Tree View. Accounts are represented as first level elements and classes as their
children nodes.
One account can have several associated e-mail classes. For example, you can add two or more classes that will
search for messages from different senders and pass them into different workflows.
Option
Description
Add
Click this button to add a new account or e-mail class to

a selected one in the Tree View.
Remove
Click this button to delete a selected account or e-mail

class.
Edit
Click this button to edit a selected account or e-mail

class. Clicking this button displays a menu on which you
can click one of the following:
Account to open the IMAP Account Settings dialog

box.
e-Mail class to open the e-Mail Class
Configuration dialog box.
Up, Down
Use these buttons to move a selected element in the Tree

View up or down.
Collapse all, Expand all, Duplicate
These buttons allow you to collapse or expand the tree of

accounts and to duplicate a selected item.
Accounts processing order
The processing of accounts starts with the first account

and goes down through the list of all account until it
reaches the end, in which case the component continues
checking accounts again from the top, or until the
component detects an account which has a message that
satisfies a criterion of this account.
Top to bottomThe component starts again from

the top after processing the message.
637
Option
Description
CyclicThe component checks all accounts

sequentially and will continue to process accounts in
the list after processing the message.
Checking an account consists of checking the list of

associated e-mail classes in a descending order until
some class matches a new message that meets class
criteria.
Top to bottom
Specifies that every iteration of checking emails starts

with the first account in the list.
Cyclic
Specifies that accounts are checked in sequence.
Home Directory
Specifies the directory where the component temporarily

stores its working files.
Automatically create at run-time
Select this check box to have the component create

the folder specified by Home Directory if it does not
already exist. If you do not select this check box, the
application will prompt to create the folder when you
click OK to close the dialog box.
IMAP Account Settings dialog box

Use this dialog box to configure IMAP account settings.
Option
Description
Name
Enter the alias name associated with the account. This

name will be displayed in the Tree View of the main
configuration window.
Server/Account Settings
This group contains server and account settings:
Server
The name or IP address of the email server.
User Name
The user name that will be used to connect to the mail

server.
Password
The password for this account.
Port Number
The port number that will be used by the component to

establish the connection to the mail server. The default
port for IMAP connection is 143.
This server requires an encrypted secure connection

(SSL)
Check this options if the server requires encrypted

connection. The default port for an IMAP connection
using SSL is 993.
Test Account Settings
Click this button to check the accessibility of the server.
Processed Files
If checked, all successfully processed files will be stored

into the directory specified in the text box below this
option. You can select the directory by clicking on the
button.
Rejected files
If checked, all files that fail to be processed will be

stored in the directory specified in the text box below
this option. You can select the directory by clicking on
the
button.
638
e-Mail Class Configuration dialog box

This configuration dialog box contains options for an e-mail class.
This dialog box consists of two tabs:
General tabAllows you to define the set of criteria according to which email messages will be searched for in
the associated account.
Component tabAllows you to configure the subsequent components in the workflow.
General Tab
Option
Description
Name
The alias name of the class.
Search Location
This group allows setting the location for search.
Inbox
Select this option to search in the Inbox folder in the

account.
Search specific folders/subfolders
Select this option if you want the component to search

messages in specific folders or subfolders. Enter the
semicolon-separated list of folders in the text box next to
the option.
Search all subfolders
If this option is checked, the component will search

messages in the specified folders and in all their
subfolders.
Search criteria
This group allows you to specify search criteria for the

class. All search criteria will be combined with AND
condition. To add a criterion, check the desired check
box and enter the value in the text field next to the check
box. In case of text fields, the component will perform
case-insensitive substring search.
Subject
The string that will be searched in the SUBJECT field.
From
The string that will be searched for in the FROM field.
Body
The string that will be searched for in the body of the

message.
Smaller
Messages with the [RFC-2822] size smaller than the

specified number.
Larger
Messages with the [RFC-2822] size larger than the

specified number.
Newer than
Messages that were received no later than the specified

number of days ago.
Older than
Messages older than the specified number of days.
Custom
You can specify a custom IMAP query in this field. It

will be joined with the other criteria by a logical "AND".
Click the Test Query button to send the test query to the
server to make sure the query is correct.
Create Documents for
In this group of options you can specify which parts

of email messages will be passed to the subsequent
components in the workflow.
639
Option
Description
The options work independently of each other. The total
number of documents depends on which check boxes are
selected:
Attachments adds as many documents as there are

attachments.
Body adds one document.
Html body as MHT adds one document if the
message has HTML body.
Whole e-Mail message as EML adds one document.
Attachments
A new document is created for every attachment.
Body
A new document is created for html or text-plain body

of the messages. If an email message has both html and
plain-text bodies, only html part of the message will be
passed.
Html body as MHT
Check this option to convert html body(including its

related content) of the email message to MHT file and
pass it as a separate document. If the message has no
html body, nothing happens.
Whole e-Mail message as EML
Check this option to convert the email

message(including headers, bodies, related content, all
attachments) to an EML file(also known as MIME) and
pass it as a separate document.
Split Jobs
Options in this group allow you to configure how the

documents created out of an email message will be
grouped and sent into the workflow. The number of
documents depends on the options selected in the Create
Documents for group. By default all documents are sent
into the workflow as a group with associated RRTs.
Split documents to Jobs
Check this option if you want to separate documents for

workflow processing. Each document will be sent to the
subsequent components as a single file along with the
metadata(RRTs).
Add body as document to each Job
If this option is checked, the message body will be added

to each document, except the document created from the
body itself.
Delete message from server
If checked, the component will delete processed

messages from the server.
Components Tab
On this tab you can configure the subsequent components involved in the workflow. Select a component and click
the Configure button to open the configuration window of the component. Refer to the help of the component for
instructions as how to configure it.
Component RRTs
Component RRT ID
The RRT ID for this component is IMA.
640
Reserved Replacement Tag Names(RRTN)

Name
Description
Bcc
A blind carbon-copy recipient's full email address.
Body
The body of an email message in plain-text format. If the

email message has only HTML then it is converted to
the plain-text.
HtmlBody
The body that have the "text/html" content type.
PlainTextBody
The email message body that have the "text/plain"

content type.
BounceAddress
The "return-path" address of the email. Bounces (tha

is, delivery status notifications or DSN's) will go to this
address.
Cc
A carbon-copy recipient's full email address.
Charset
The char set for the entire email.
Date
The date and time in UTC/GMT standard.
FileCount
The number of documents in a Job. The value of this

tag depends on the selected options in the Create
Documents for and Split Jobs groups in the e-Mail
Class Configuration dialog box.
FileNameIndex
File Name by index.
FileSizeIndex
File Size by index.
From
The combined name and email address of the sender,

such as John Smith <JSmith@from.com>
FromAddress
The email address of the sender.
FromName
The name of the sender.
Language
The primary language group for the email. The value for
this field is provided by Chilkat library. See Appendix B
for full list of possible values.
The possible values are:
"latin1" (for English and all Western European

languages)
"central" (for Central European languages such as
Polish, Czech, Hungarian, and so on)
"russian" (for Cyrillic languages)
"greek"
"turkish"
"hebrew"
"arabic"
"baltic"
"thai"
"vietnamese"
"chinese"
"japanese"
641
Name
Description
"korean"
"unknown"
LocalDate
The local date and time of when the email was sent or
created.
Mailer
Identifies the email software that sent the email.
Mailbox
Mailbox (folder/subfolder path) from which the message

has been fetched.
NumAttachments
The number of attachments contained in the email.
NumBcc
The number of blind carbon-copy email recipients.
NumCC
The number of carbon-copy email recipients
NumDaysOld
The number of days old from the current system date/

time.
NumRelatedItems
The number of related items present in this email.

Related items are typically image files (JPEGs or GIFs)
or style sheets (CSS files) that are included with HTML
formatted messages with internal CID hyperlinks.
NumTo
The number of direct email recipients.
ReplyTo
The email address to be used when a recipient replies.
MsgSize
The size in bytes of the email, including all parts and

attachments.
Size
The size in bytes of documents in a Job, that is, in a

group of documents sent into the workflow. The size is
comprised of the sizes of all documents in the Job.
Subject
The email subject.
To
A to recipient's full email address
~IMA::From~ is replaced with the value "TOI Online Editor" <spam.robot@thenewestnews.com> and
~IMA::FromAddress~ with spam.robot@thenewestnews.com
No restrictions have been identified.
No problems have been identified.
Interwoven WorkSite MP
Welcome to the Interwoven WorkSite MP component
Interwoven WorkSite MP provides you with the ability to increase your productivity by enhancing your content
management and collaboration activities. This integration with commonly used applications simplifies content
management activities by providing you with easy access to the documents and other materials. Users can create
642
a new document, open an existing document, save a document as a new version, change profile information and
perform many other document management functions, all without ever leaving their familiar application interface.
The Interwoven WorkSite MP Route and eConnector components allow organizations to further take advantage
of their Interwoven WorkSite MP Systems, by sending documents directly from different sources such as Digital
Senders, Multi-functional devices, Scanners or a POP3 Email account into Interwoven WorkSite MP, offering enough
flexibility to layout this process in a manner that adjusts to the business rules of the organization.
The only difference between the Interwoven WorkSite MP Route and eConnector components is that the Interwoven
WorkSite MP Route component solely stores the files and doesn't pass the files on, as it is the last component in the
process. If activated, the Interwoven WorkSite MPeConnector passes the files to the next component in the process.
Getting started
Feature highlights
The Interwoven WorkSite MP component allows you to store a document and all the profile information
associated with it, such as Name, Description, Version Comments, Security, Tags and Metadata.
Use this component to create Projects, Document Folders and Categories instantly or at run time.
Configuring Interwoven WorkSite MP

General tab
Option
Description
Activate
Check Activate to activate the eConnector. To inactivate

the component, leave the box unchecked. When the
eConnector is inactive, initial files will not be processed.
Server
Server
Enter the name of the WorkSite MP Server you are
connecting to.
Username
Enter the Username of the user that can obtain access to

the WorkSite MP server.
Password
Domain
Enter the domain associated with the Username.
Application Name
Enter the name to be associated with in the Worksite MP

clients when documents are imported.
Library
Enter the Library that will be used to obtain access to on

the server.
Facility
Enter the facility within the library that will be accessed.
Impersonate
Select this option and provide a user for the Impersonate

field to make the owner of the document this user instead
of the user specified in the User field. The user provided
in the Impersonate field is also the user that will be
used to create the destination for the document, if the
destination has not already been created.
643
Destination tab
Enter the destination folder attributes in this tab.
Documents can reside in either Collaboration spaces or Knowledge spaces.
The Collaboration Space provides hierarchical structures to provide better context to the content. This is much like
the actions a user would take, creating various levels of folders on his/her machine or a central file server. In addition
to the hierarchical nature of Collaboration Spaces, security can be applied to this hierarchy as opposed to requiring
the security to be placed on each document. With the extra features of issues, milestones, calendar events, etc., the
Collaboration Space is the ideal area to manage the work-in-progress stage of content.
On the other hand, Knowledge Spaces provide an area to store published content that needs to be accessed by a
wider audience. This information can be stored once but linked to multiple points in a hierarchical category structure.
You can either browse for the destination folder or specify the folder attributes manually: attributes.
Browse for destination folder

Manually specify the destination folder
Browse for a destination

Choose Browse for destination to use an existing destination folder. Next to Root Path, click the browse button ...
to locate an existing destination folder using the Facility Browser. This option provides the benefit that you can add
to other user's folders to which you have access. Furthermore, the database allows folders with the same name to be
added, therefore by using this folder browser, you can designate which folder to choose if multiple folders of the same
name exist.
Note: This onption can only be used if a valid Server, User Name, Password, Domain, Library and
Facility are specified on the General tab, since these are necessary to provide access to the Collaboration
spaces and Knowledge spaces.
Note: If this folder gets deleted at a later time in the database (by administrator), this folder cannot be
retrieved later and the Status Monitor will report an error. If the folder is deleted from the database, then it
should be re-setup in the component configuration. This is because each folder has an id, and if a folder is
deleted, the folder with the specified id cannot be retrieved later and the status monitor will report an error.
Option
Description
Facility Browser
Lists all of the existing Collaboration Spaces and

Knowledge spaces under the Facility that was provided
on the General Tab. Use this to browse and instantly
create Projects and Document Folders under a
Collaboration Space and Categories under a Knowledge
Space.
Appended Path
A path that is appended to the destination selected from

the Facility Browser. It can be an already existing path,
or one that is created at run time. Depending on what
type of Destination that was selected in the Facility
Browser, it will create either a series of Document
Folders, or Categories. If a Collaboration Space,
Document Folder or Project was specified, then the
Appended path will create or search for Document
Folders. If a Knowledge space or a Category was
specified, then the Appended Path will be associated
with Categories.
Example:
644
Option
Description
Path = CollaborationSpace1\
Appended Path = 1\2\3\4
Assuming that the Path "CollaborationSpace1" is a
Collaboration Space, If Document Folder 1 does not
exist, it will create Document Folder 1.
If document Folder 2 does not exist under Document
Folder 1, then it will create it. This will continue until all
of the document Folders have been created (if they do
not already exist).
Path
The path that is selected from the Facility Browser,

which can include any of the following types of
destinations:
Collaboration Space
Knowledge Space
Category (which resides under a Knowledge Space )
Document Folder (which resides under a
Collaboration Space)
Project (which resides under a Collaboration Space).
Manually specify a destination

Choose the Manually Specify Destination option to specify a destination manually.
You can choose to add to:
Knowledge Space
Collaboration Space
Document Folder ID
Document ID
This is effective if the Server, Username, Password, Domain, Library, and Facility on the General tab are NOT
currently set/valid, if multiple WorkSite MP servers will be using the same configuration, or if the WorkSite MP
server is not currently running.
Option
Description
Add to Collaboration Space
This provides you the option to add documents under an

existing Collaboration Space.
Add to Knowledge Space
This provides you the option to add documents under a

specific Knowledge Space.
Path
Specify a hierarchy of Categories under an already

existing Knowledge Space. The path under the
Knowledge Space can be an already existing path, or
one that is created at run time. If this path does not exist,
a series of Sub-Categories will be created under this
Knowledge Space.
Folder ID
Sends documents to the folder that is specified by the

Folder ID generated by WorksiteMP.
645
Option
Document ID
Description
Send documents to a document that already exists,
specified by the Document ID generated by Worksite
MP.
Category properties
Option
Description
Description
Description of the Category
Type
Option of Primary or Secondary Category.
Inherit Security
Select this check box to inherit the security policy from

the parent Category. Otherwise, provide the security
policy that should be set to the Category.
Note: Security cannot be inherited from a
Knowledge Space.
If the Server, Username, Password, Domain, Library,
and Facility on the General tab are valid, and the a
destination was specified through the Facility Browser
under the Browse for Destination, then the list of
available security policies reflect those that are currently
available under the Knowledge Space. Otherwise, it
shows the default list of Public, Private or View.
Metadata
A list of Metadata and Values that can be associated

with this Category through the Object Modeler within
WorkSite MP.
Inherit Metadata
Select this check box to inherit the Metadata from the

parent Category.
A list of Metadata associated with the Category will
be displayed only if the Server, Username, Password,
Domain, Library, and Facility on the General tab are
valid. If the Metadata type is a table/Trustee, and can
take multiple values (if designed to do so within the
Object Modeler of WorkSite MP), then multiple values
within the list can be selected and delimited by a ",".
However, if only a single value can be chosen from a
metadata type, then only one list option can be selected.
If the Metadata type is a Trustee, then all members of the
Collaboration space are displayed for the user.
Link to Categories
Links the document to multiple existing categories.
Link to categories
Displays the categories that are available under the selected parent Knowledge Space.
Option
Additional Categories
Description
If the categories under the Knowledge space cannot be
viewed, then the path of the category can be provided
instead or the Category ID can be given. The list of
Additional Categories are delimited by a semicolon (;).
646
Document Folder properties

Option
Description
Description
Description of the Document Folder.
Inherit Security
Select this check box to inherit the security policy

from the parent Document Folder. Otherwise, provide
the security policy that should be set to the Document
Folder.
Note: Security cannot be inherited from a
Collaboration Space.
If the Server, Username, Password, Domain, Library,
and Facility on the General tab are valid, and the a
destination was specified through the Facility Browser
under the Browse for Destination, then the list of
available security policies reflect those that are currently
available under the Collaboration Space. Otherwise, it
shows the default list of Public, Private or View.
Tags
A list of tags that already exist within the Collaboration

Space that can be associated with this Document Folder.
Use + to display the current tags that are available and
- to remove them from the field. Tags are delimited by
;.
Metadata
A list of Metadata and Values that can be associated with

a Document Folder through the Object Modeler within
WorkSite MP.
Inherit Metadata
Select this check box to inherit the Metadata from the

parent Document Folder.
Note: A list of Metadata associated with the
Document Folder will be displayed only if the
Server, Username, Password, Domain, Library,
and Facility on the General tab are valid. If the
Metadata type is a table/Trustee, and can take
multiple values (if designed to do so within
the Object Modeler of WorkSite MP), then
multiple values within the list can be selected
and delimited by a ",". However, if only a single
value can be chosen from a metadata type,
then only one list option can be selected. If the
Metadata type is a Trustee, then all members
of the Collaboration space are displayed for the
user.
Project properties
Option
Description
Name
Name of project to be created under the Collaboration

Space.
Description
Description of project to be created under the

Collaboration Space.
647
Option
Description
Security
An existing Security Policy under the Collaboration

Space that can be applied to the project.
Tags
A set of tags that already exist within the Collaboration

Space that can be associated with this Project.
Use "+" to display the current tags that are available.
Tags are delimited by a semicolon (;).
Metadata
A list of Metadata and Values that can be associated with

this Project through the Object Modeler within WorkSite
MP.
Project Folder will be displayed only if the
Server, Username, Password, Domain, Library,
and Facility on the General tab are valid. If the
Metadata type is a Trustee, then all members
of the Collaboration space are displayed for the
user.
Destination metadata
Option
Description
Field
The name of the Metadata field.
Column Name
Within the Library Manager, a Metadata table can

have many columns (which were specified within
the Object Modeler). However, there is no primary
column name for each Metadata field within a Metadata
table. Therefore, if the Metadata field chosen is of type
Metadata Table, and the ellipses button is accessible and
a valid Server, Username, Password, Domain, Library,
and Facility on the General tab have been provided, then
when selecting the Value for this type, it will return a
field ID to indicate which field was selected. However, if
access to this ellipses is not given and the Metadata field
is of type Metadata table, then the column name of the
Metadata should be provided and the Value should be the
Value desired under this column.
Value
The value associated with the Metadata field.

For Example: Consider a table named: State that has 3
Columns: Name, Description, and Size.
Within the Library Manager, 2 fields were provided for
this table.
648
Option
Description
First field has: Name - MD, Description - East Coast ,
Size - 28,000
Second field has: Name - VA, Description - East Coast,
Size - 24,000
If the first field is desired to be chosen under table State
and access to the ellipses is given and a list of Values
are provided then, the ID for this field under this table
is given as the Value. However, If access is not given,
then a column Name should be given that distinguishes
the fields, as well as the value under that column. If the
first field is desired to be chosen, then the Column Name
should be Name and the Value should be MD. If the
Column Name is given as Description and the Value is
given as East Coast, then the it randomly picks one of the
first two fields within this table. Therefore, use caution
when selecting a column name.
Document tab
Option
Pass Through Documents
Description
Select this check box to pass the documents to the
subsequent components in your process.
component.
Rename Document
Select this check box if you want to rename the

document.
Description
The description to be set for this document.
Format
The format to set this document once stored. This format

list comes from the Application Formats list in the
Library Manager. To view this list, click on the browse
button (...).
Note: he list of available formats will be
displayed only if the Server, Username,
Password, Domain, Library, and Facility on the
General tab are valid.
Version Comments
Version Comments to be given to the document.
Security
Security policy to be given to the document. Click the

ellipses to view the list of security policies available.
The security policies listed are those specific to either
the Collaboration Space or Knowledge Space chosen.
Otherwise a default list of Public, Private and View are
provided.
Inherit Security:Select this check box to inherit the
security policy from the Document Folder or Category in
which the Document will be stored.
649
Option
Description
Note: A list of available security policies will
be displayed only if the Server, Username,
Password, Domain, Library, and Facility on
the General tab are valid, and Browse for
destination was selected.
Metadata
A list of Metadata and Values that can be associated

with a Document through the Object Modeler within
WorkSite MP.
FieldThe name of the Metadata field.

Column NameWithin the Library Manager, a
Metadata table can have many columns (which were
specified within the Object Modeler). However,
there is no primary column name for each Metadata
field within a Metadata table. Therefore, if the
Metadata field chosen is of type Metadata Table, and
the ellipses button is accessible and a valid Server,
Username, Password, Domain, Library, and Facility
on the General tab have been provided, then when
selecting the Value for this type, it will return a field
ID to indicate which field was selected. However, if
access to this ellipses is not given and the Metadata
field is of type Metadata table, then the column name
of the Metadata should be provided and the Value
should be the Value desired under this column.
ValueThe value associated with the Metadata
field.
For Example:
Consider a table named: State that has 3 Columns:
Name, Description, Size.
Within the Library Manager, 2 fields were provided for
this table.
First field has: Name - MD, Description - East Coast ,
Size - 28,000
Second field has: Name - VA, Description - East Coast,
Size - 24,000
If the first field is desired to be chosen under table State
and access to the ellipses is given and a list of Values
are provided then, the ID for this field under this table
is given as the Value. However, If access is not given,
then a column Name should be given that distinguishes
the fields, as well as the value under that column. If the
first field is desired to be chosen, then the Column Name
should be Name and the Value should be MD. If the
Column Name is given as Description and the Value is
given as East Coast, then it randomly picks one of the
first two fields within this table. Therefore, use caution
when selecting a column name.
Document will be displayed only if the Server,
650
Option
Description
Username, Password, Domain, Library, and
Facility on the General tab are valid. If the
Metadata type is a Trustee, then all members of
the Destination are displayed for the user.
Tags
A set of tags that already exist within the Collaboration

Space or Knowledge space that can be associated with
this Document Folder. Use "+" to display the current tags
that are available.
Note: A list of available Tags will only be
displayed if the Server, Username, Password,
Domain, Library, and Facility on the General
tab are valid and Browse for Destination was
selected to specify the destination.
Tags are delimited by ;.
Interwoven WorkSite MP component RRTs

Component RRT ID
The RRT ID for both the Interwoven WorkSite MP eConnector and Route components is WMP.
Name
Description
FileName
Original Document Name
Counter

Name
Document name
FileExt
Document Extension
FileDesc
Document Description
FileNumber
Document Number stored
FileId
The unique Id associated with the document that is

imported into the Interwoven Worksite MP database.
ContainerId
The unique Id associated with the Document Folder or

Category in Interwoven Worksite MP into which the
document is imported.
FileSize
Size of the Document
651
FileVersion
Document Version
FileComment
Comments associated with the Document
OwnerName
User Name of the Document Owner
OwnerFullName
Full Name of the Document Owner
OwnerDomain
Domain of the Document Owner
OwnerEmail
Email address of the Document Owner
OwnerAddress1
Home address1 of the Document Owner
OwnerAddress2
Home address2 of the Document Owner
OwnerState
Home state of the Document Owner
OwnerCity
Home city of the Document Owner
OwnerPostalCode
Home Postal Code of the Document Owner
OwnerPhone
Home Phone Number of the Document Owner
Library
Library that the Document was stored in
Facility
Facility that the Document was stored in
Date
Date document was created
Day
Day document was created
Month
Day document was created
Year
Year document was created
Hour
Hour document was created
Minute
Minute document was created
Second
Second document was created
Example RRTN usage:

~WMP::FileName~~WMP::Counter~ is replaced by the value Accounting5 if the original file name was
Accounting and there were up to 4 (Document1 to Document4) files already in the destination folder path.
Note: The Reserved RTN values FileName, and Counter can only be used with the Rename field of this
component. In other words, you may not use ~WMP::FileName~ or ~WMP::Counter~ in any other
component than Interwoven WorkSite MP and they must be used with the Rename field of this component
only.
This component does support FRTNs for metadata field names.
Example FRTN usage:
~WMP::%Industry%~ is replaced by Computer if the user types in Computer for the field name called
Industry.
SSRTN
Description
652
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Example SSRTN usage:

~STF::%Y~-~STF::%m~ will be replaced by 2004-10
This component currently only supports Interwoven WorkSite MP 4.1 SP1.
Interwoven WorkSite NT
Welcome to Interwoven WorkSite NT component
Interwoven WorkSite is a Document Management System that offers out-of-the-box, tight integration with
popular Windows applications such as Microsoft Office, WordPerfect, Microsoft Outlook, Lotus Notes and Novell
GroupWise. Users can create a new document, open an existing document, save a document as a new version, change
profile information and perform many other document management functions all without ever leaving their
familiar application interface.
The Interwoven WorkSite Route and eConnector components allow organizations to further take advantage of
their Interwoven WorkSite Systems, by sending documents directly from different sources such as Digital Senders,
Multifunctional devices, Scanners or a POP3 Email account into Interwoven WorkSite, offering enough flexibility to
layout this process in a manner that adjusts to the business rules of the organization.
The only difference between the Interwoven WorkSite Route and eConnector components is that the Interwoven
WorkSite Route component solely stores the files and doesn't pass the files on, as it is the last component in the
process. The Interwoven WorkSite eConnector passes the files to the next component in the process.
653
WorkSite NT client must be installed on the same machine as the server.

This component supports Worksite Service Manager 8.5 SP1 Update 4 and requires installation of DeskSite 8.5 SP2
Update 4 or FileSite 8.5 SP2 Update 4.
Getting started
Feature highlights
The Interwoven WorkSite component allows you to store a document and all the profile information associated
with it, such as Name, Description, Comments, Security, Type, Class, Author, Operator and custom profile
fields that are particular to the Interwoven implementation such as Client and Matter.
This component will also allow you to specify Users and Groups that will have access to the document, as well as
level of access they will have.
Use this component to import any kind of document into Interwoven WorkSite, as long as you set up valid Type
and Class associations for all the documents.

Use the Interwoven WorkSite NT component to extend the capabilities of an Interwoven WorkSite NT system
and provide users with alternate means to store documents. This component, when used in combination with other
Capture and Process components will allow an organization to implement very complex work flows, either involving
interactive participation of the users or unattended environment.
Use SMTP Capture component with Interwoven WorkSite NT Route component in a workflow scenario where users
email documents to a general-purpose Public folder in Interwoven WorkSite. Assume the business process is that we
are only interested in knowing who sent the document along with a brief description of the document. The following
1. An email, with a document attached and a Subject of "Transactions" and a Body of "Transactions from the past
month", is captured through the SMTP Gateway that was configured in the SMTP Capture component.
2. SMTP Capture captures the email and proceeds to detach the document and create Runtime Replacement tags
based on the email headers that can be used by Interwoven WorkSite.
3. The system will proceed to route the document to Interwoven WorkSite NT component.
The administrator has configured Interwoven WorkSite NT with fixed values for each one of the required
parameters, except for the Author field, Document Description and Document Comments. Instead of using
fixed values, RRTs from the SMTP capture component are used. Specifically:
~SMP::From~ (representing the From field of the captured email) will be assigned to the Author.
~SMP::Body~ (representing the message body of the captured email) will be assigned to the Comments.
~SMP::Subject~ (representing the subject of the captured email) will be assigned to the document
Description.
Configuring Interwoven WorkSite NT

General tab
Enter the server and access attributes in this tab.
Option
Description
Activate
Select this check box to activate the component in the

workflow. You can configure the component settings
only after you select this check box.
Server
Enter the name of the WorkSite server for the

connection.
User Name
Enter the user name used for logging on to the WorkSite

server.
Password
Database
Enter the name of an existing database on the server.
654
Option
Description
You can click the browse button (...) to browse for a
database after you specify a valid Server, User Name,
and Password.
Operator

as the operator on all documents that will be stored.
operator after you specify a valid Server, User Name,
Password, and Database.
Author

as the Author on all documents that will be stored.
author after you specify a valid Server, User Name,
Password, and Database.
Destination tab
Enter the destination folder attributes in this tab. You can either browse for the destination folder or manually specify
the destination folder attributes.
Option
Browse for Destination
Description
Click this option to browse for the destination folder.
This option provides the benefit that the user can add to
other user's folders (which they have access to). Also, the
database allows folders with the same name to be added,
therefore by using this folder browser, you can designate
which folder to choose if multiple folders of the same
name exist.
If the folder is sometime later deleted from the database,
it will no longer be retrievable the Status Monitor will
report an error. This setting would then have to be
reconfigured in the component configuration. This is
because the component uses the folder ID from the
database to retrieve the destination. The Status Monitor
reports an error when the component cannot retrieve
folder information corresponding to the ID.
Root Path
Enter the root path for the folder, or click on the browse
button (...) to locate an existing destination folder.
You can only browse for the folders if a valid Server,
User Name, and Password are specified on the General
tab.
Appended Path
Once you select a root path from the browse button,

you can add an appended folder path to the original
folder path. This way, you can create folders or designate
folders at run time.
Manually Specify Destination
Choose this option to specify the destination parameters.
MyWorkspaces
This provides you the option to add documents under

MyWorkspaces.
655
Option
Description
MyFolders
This provides you the option to add documents under

MyFolders.
Path
Specifies the folder path that you can use for

MyWorkspaces or MyFolders. If MyWorkspaces
was selected, then the first folder in the path should be
a workspace. If this workspace does not exist, then the
workspace will be created. Since documents can only be
stored in document folders, you must provide a folder
under this workspace as well. Otherwise, the documents
will be stored in the document worklist.
For example, if you select the MyWorkspace option,
and provide a path of Customers/Pending/, the server
first searches for a workspace called "Customers" and
create the workspace (if it does not already exist). Then,
a document folder called "Pending" is created (if it
does not already exist). A workspace path, such as
"Customers/", can not be specified for MyWorkspaces,
because documents cannot be stored in a workspace.
If you choose the MyFolders option, then any folder
that does not currently exist will be created. Note that
if the Browse for Destination or Manually Specify
Destination option is selected, and no folder path
is entered, then all documents will be stored in the
document worklist.
If at any time multiple folders with the same name
exist at the same folder hierarchy level (except for
when a Root Path is specified under the Browse for
Destination option), then the document will be stored
under a new folder with the same name as that folder
with _AMBIGUOUS appended to the name.
For example, consider if the Root Path under Browse
for Destination is Transactions\, and the Appended
Path is: Customers. Because the "Transactions
\" workspace is specified using the folder browser,
it is okay if multiple folders with Transactions
are available. However, if multiple folders under
Transactions have the name Customers, then a folder
is created with the name "Customers_AMBIGUOUS",
and all documents are placed into this folder. This same
procedure is followed under Manually Specify Folder
for the Path.
Document Folder ID
This option takes the Folder ID (generated by Worksite

NT) and sends the documents into this folder
Appended Path
Specify a path appended to the folder for which the

document folder ID was given. It can already exist or be
created at run time.
Document ID
Send documents to a document that already exists,

specified by the Document ID. The Document ID can be
656
Option
Description
either the Document ID generated by Worksite NT or the
Document Number within the Database.
Use Document Versioning
Select this check box to enable document versioning,

which increments the version number each time a
document is replaced.
Set Properties
Click this button to set properties for the folder path. For
more information, see Folder Properties Dialog Box.
Folder Properties dialog box

Use this dialog box to set properties for folders that will be created at run time.
Set folder properties for folder paths that you have configured as well as folders that have not been created yet. Folder
properties are only set for folders that have not yet been created. To open this dialog box, click the Set Properties
button on the Destination tab of the Interwoven WorkSite NT component configuration dialog box.
Option
Description
Description
Enter a description for the folder if the folder does not

yet exist.
Inherit Folder's Profile Information Fields from

Parent Folder
If a folder is a subfolder of another folder, then checking

this box will copy the parent folder's fields onto this new
folder. This will only happen if a parent folder exists.
Profile Information Fields for Folders
Select the profile fields you wish to set for the folder.
Name is the property field name.

Value is the value associated with the Name.

with a lookup list.
this dialog box.
Note: Note that the fields custom21
custom24 can only accept a date value, as these
fields have been specifically designated as date
fields within Interwoven. The fields custom25
custom28 can only accept a Boolean (True
or False) value, as these fields have been
Interwoven.
657
Note: If the Inherit Folder's Profile Information Fields from Parent Folder check box is selected and
the fields are specified in the profile information field list, then the folder will first inherit the parent folder's
fields and then set the fields given in the list. Any fields in the profile information field list will therefore
overwrite the folder's fields if they were inherited.
Document tab
Option
Pass Through Documents
Description
component.
Rename Document

name in the box. You can use RRTs to define a name.
Description
Enter a description to be assigned to the documents.
Comments
Enter comments to be given to the documents.
Shared As
Sets the level for sharing. Click one of the sharing

options in the box:
Document Security
InheritThe document inherit the permission from

its parent folder. An inherited permission can be
Public, Private or View.
PrivateAllows all users access and modify
documents.
PublicAllows only specified users view
documents.
ViewAllows users see but not modify documents.
Specifies users and groups and sets permissions to access

documents.
Add GroupClick this button to add a group.

In the Add Group dialog box, click the browse
button (...) to locate the group names and specify the
document access level you want to grant to groups.
Add UserClick this button to add a user. In the
Add User dialog box, click the browse button (...) to
locate user names and specify the document access
level you want to grant to users.
RemoveClick to remove a selected user or group
from the list.
The following permissions may be assigned to a user or

group:
No AccessUser cannot access a document.

ReadUser can view or read a document.
Read/WriteUser can read and write to a
document.
Full AccessUser can add, remove, read, and write
a document.
658
Document Attributes dialog box

Use this dialog box to type, class, and profile properties for a document. To open this dialog box, click Set Properties
on the Document tab of the component properties dialog box.
Option
Description
Type
Click on the ellipses to locate the desired extension type

for the file. You can look up the available application
extensions by providing the Server name, User name,
Password, and the name of the Database on the General
tab.
The type must be a valid extension that is set up under
"Type" in the WorkSite database manager/dbadmin.
Class
Click on the ellipses to locate the desired class type for

the file. You can look up the available class types by
providing the Server name, User name, Password, and
the name of the database on the General tab.
Classes are custom-defined categories for identifying and
differentiating documents in the database. This must be
a valid/existing Class that was created in the WorkSite
database manager/dbadmin.
Inherit document's profile information fields from

folder
Check this option to allow the document to inherit the

folder's field values (if the folder exists).
Profile Information Fields for Document
Setup and modify Field information and Subclass

information fields for the document.
If you have entered a valid Class, Server Name,

User Name, Password, and Database on the
General tab, then you can look up the fields that
have been set up in the WorkSite database manager/
dbadmin.
You can add a Subclass to your document, however
only one subclass can be permitted for each
document. If you provide a subclass, then only
profile information fields on the subclass dialog will
be assigned to the document.
Note: Not all of the fields are listed in the
profile information fields on the add file
dialog, therefore all other fields that are
provided in the profile information fields list
on the add file dialog are ignored.
A subclass may or may not be required depending on the

Class that you entered. This should be checked for in the
WorkSite database manager/dbadmin.
When adding fields, an exclamation mark next to the
field indicates that the field is mandatory. If a document
requires a field and the field is not entered, then the
document will not be stored.
659
Interwoven WorkSite NT component RRTs

Component RRT ID
The RRT ID for this component is IM8.
Name
Description
FileName
The name of the document that is imported into the

Interwoven WorkSite database
FileExt
The extension of the document that is imported into the

Interwoven WorkSite database.
FileDesc
The description of the document that is imported into the

FileComment
The comments of the document that is imported into the

FileId
The ID of the document that is imported into the

FileSize
The size of the document that is imported into the

FileVersion
The version of the document placed into the Interwoven

WorkSite database. If the document is being created for
the first time, the version will always be 1. However,
if the document is being replaced and versioning is
enabled, then the new version will be 1 version higher
than the original.
SUBCLASS
The Subclass associated with the document that is

imported into the Interwoven WorkSite database
CUSTOM1

that is imported into the Interwoven WorkSite database.
CUSTOM2
The Custom2Profile field associated with the document

CUSTOM3

CUSTOM4

CUSTOM5

CUSTOM6

CUSTOM7

CUSTOM8

660
Name
Description
CUSTOM9

CUSTOM10

document that is imported into the Interwoven WorkSite
database.
CUSTOM11

CUSTOM12

database.
CUSTOM13

database.
CUSTOM14

database.
CUSTOM15

database.
CUSTOM16

database.
CUSTOM17

database.
CUSTOM18

database.
CUSTOM19

database.
CUSTOM20

database.
CUSTOM21

database.
CUSTOM22

database.
CUSTOM23

database.
661
Name
Description
CUSTOM24

database.
CUSTOM25

database.
CUSTOM26

database.
CUSTOM27

database.
CUSTOM28

database.
CUSTOM29

database.
CUSTOM30

database.
Day
The day the document is imported into the Interwoven

WorkSite database.
DayOfWeek
The day of week the document is imported into the

Interwoven WorkSite database.
DayOfYear
The day of year the document is imported into the

Hour
The hour of the day the document is imported into the

Min
The minute of the hour the document is imported into the

Month
The month of the year the document is imported into the

Year
The year the document is imported into the Interwoven

WorkSite database.
OpName
The name of the Operator that is configured to import

documents into the Interwoven WorkSite database
OpDomain
The domain of the Operator that is configured to import

OpEmail
The email address of the Operator that is configured

to import documents into the Interwoven WorkSite
database.
662
Name
Description
OpPhone
The phone number of the Operator that is configured

database.
OpExt
The extension of the Operator that is configured to

import documents into the Interwoven WorkSite
database.
OpLocation
The location of the Operator that is configured to import

AuthorName
The name of the Author that is configured to import

AuthorDomain
The domain of the Author that is configured to import

AuthorEmail
The email address of the Author that is configured

database.
AuthorPhone
The phone number of the Author that is configured

database.
AuthorExt
The extension of the Author that is configured to import

documents into the Interwoven WorkSite database.
AuthorLocation
The location of the Author that is configured to import

The following example provides some sample usage:

~IM8::FileName~ is replaced with the value Accounting if the original file name was Accounting.
This component does support FRTNs for field names. The following example provides some sample usage for your
reference:
~IM8::%Client%~ is replaced by Government if the user types in Government for the field name called
Client.
Problem Description
Solution
Interwoven WorkSite Error (Document profile is invalid. Check that an invalid field value was not given for the
The field is invalid: ______ ).
associated Field Name. Several of the fields are customdefined categories that have a table associated with a
field of document profile information. Document profile
information fields are configured as lookup fields, which
663
Problem Description
Solution
means that the only information users can enter in these
fields comes from their associated tables.
In addition, The Client/Matter and Practice/Subpractice
tables are special custom tables that allow further
creation of custom categories by which users can identify
and differentiate documents in the databases. The Client/
Matter and Practice/Subpractice tables are distinct from
the other custom tables in one important way: each item
listed in the Client and Practice tables is the parent of a
unique set of Matter or Subpractice table entries. When
a user makes a selection in the Client or Practice fields,
the user should select only the choices available for the
Matter and Subpractice fields that are associated with
the Client or Practice that the user has selected. Refer to
the setup of these tables within the WorkSite database
manager/dbadmin.
IXOS
Welcome to the IXOS component
IXOS provides a complete integration into IXOS application. This component is responsible for creating all necessary
interface files to properly store documents as well as index data into IXOS. The interface also provides the flexibility
to create custom commands as well as dynamic command entries through use of RRT variables.
The IXOS also provides for full support of IXOS SAP interface that allows you to create command files with
attributes and variables necessary to write your files into IXOS with proper links into your SAP system back end.
This component support IXOS eCONServer Batch Import server interface V5.0.
Using the IXOS component
This interface is used to archive any desired documents, including document attributes, transparently in IXOSARCHIVE. The documents are created within the import directories and are then entered in the archive system by the
archive server.
The documents, including the attributes, must be transferred according a defined form. IXOS component allows
creation and transfer of documents according to defined directory on the Archive server referred to as EXT_DIR. The
sub-structure of this directory is predefined and is described in the Batch Import guide from IXOS. Within the IXOS,
the path for EXT_DIR is specified when it is installed. You must point to the same EXT_DIR when you are using
IXOS Component. You must, of course, also ensure that sufficient space is made available in EXT_DIR in order to
transfer external documents.
The IXOS interface allows you to create standard batch import files within the EXT_DIR subdirectory structure.
The EXT_DIR subdirectory is depicted in illustration below. The Component user provides the EXT_DIR root
directory on the EXT_DIR Tab of the IXOS component. The component is responsible for creating the appropriate
subdirectories. For details on the EXT_DIR sub-directory structure see the Batch Import with Attributes guide from
IXOS.
664
The IXOS component creates necessary directory and files under EXT_DIR which includes creation of:
IXATTR fileAll attributes headers and corresponding fields.

COMMAND fileAll commands related to the image files and attributes.
LOG fileEmpty log file created to allow logging by IXOS Batch Import process.
Image file(s)Captured image file in TIFF or PDF format.
This interface also supports SAP R3 attributes and commands as well as Flexible Header structures for free format
creation of IXATTR or COMMAND interface file entries. For details on all attributes and command variables see the
Batch Import with Attributes guide from IXOS.
Note: The user can use RRTs for creating your file entry variables. An example of this use is
~L1B::BARCODE~ within the value field of the IXATTR entry. This type of RRT usage allows all
IXATTR and COMMAND attributes to be dynamically driven from the metadata values.
IXAT TR File Builder tab
This tab is designed to help you create the Attribute File for each job.
The entries within this tab add records to the Attribute file every time new documents are placed into the IXOS
directories. You can select the header and attributes from the predefined list of fields or create attribute entries using
the Flexible formatting option.
The predefined headers and attributes provide the standard set as well as SAP R3 entries to allow development of
SAP integration for IXOS. The Flexible formatting option allows custom attribute lines to be entered and helps in
further customization of the IXOS interface.
You can use all RRTs to create dynamic attribute entries. Examples of dynamic attributes using RRT are listed below:
Enter the following as a Flexible formatting entry:
R3_CLIENT ~L1D::1,1~
The RRT ~L1D::1,1~ represents the first barcode on the first page of the document. If the barcode value was
XXX, then the entry in the attribute file will be:
R3_CLIENT XXX
Use RRTs to create entries within the batch file that link your IXOS batch file entries into other document related
values such as barcodes, user field entries (on devices such as multifunction devices), form field values, zoned OCR
field value, or values available for any other component. This is a powerful feature that allows organizations to create
custom solutions based on their document content capture requirements.
For full description of IXOS attribute entries see IXOS eCONServer Batch Import Server Interface V5.0 for detail
description of all Attribute entries and structure.
665
Command File Builder tab

This tab allows you to create the correct entries within the command file interface.
There are two methods of creating entries.
Method 1: Use predefined headers
This method allows you to select the command entries from a list of defined entries. This interface makes it easy for
you to select from a list of available entries and quickly complete your command line. The Header option entries
allow you to select entries such as COMP with Component Type: PDF. The command entry created as the result
would be:
COMP 1.pg PDF
And the command line entry would be:
COMP 1.pg PDF filename
.
Method 2: Use flexible formatting
The Flexible formatting option allows you to type in your entries and create a complete set of entries based on your
custom requirements. The flexible command formatting allows you to create entries such as:
COMP 1.PDF PDF
Use flexible entries to create custom commands for your IXOS application.
See IXOS eCONServer Batch Import Server Interface V5.0 for a detailed description of all command entries and
structure.
EXT_DIR tab
This tab allows you to specify the EXT_DIR directory eCONServer archive server.
Documents and attributes are transferred to the EXT_DIR directory. The required subdirectories within this server are
automatically created by the server. You must point to the EXT_DIR as defined by the Batch Import Server interface.
Use RRTs to create dynamic EXT_DIR entries such as:
C:\~L1D::1,1~\EXT_DIR
The RRT value ~L1D::1,1~ is generated by the barcode component and represents the first barcode on the first
page of the document and will be replaced with the actual value of the barcode at runtime. For example if the first
barcode on the first page is XXX then the directory used to write the files will be: C:\XXX\EXT_DIR.
Knowledge Package Builder

Welcome to Knowledge Package Builder
This component encapsulates all information related to a batch job into an XML file with the DAT file stored in the
pool path location or a ZIP file. XML schema provides the most effective means of transferring batch-job information
between processing centers such as from a remote site to central servers, between a workstation and a server, or
between two XML enabled applications.
This component creates an XML or ZIP file anywhere within the capture process. Once an XML or ZIP file is
generated it can be stored or transferred to the receiving application using any of the available route components.
Knowledge Package Builder component uses the XML schema published within the published open SDK
documentation.
666
Getting started
Feature highlights
Dynamic creation of XML files, document/image file encapsulation option, unlimited index field, dynamic/static field
value support are some the features of this component.
The Activate check box for this component must be selected for it to be active within a selected process.
Supply the Document name, the Author and any Comments that you would like to add to the document
You may choose to Embed the document For example, if the documents were a TIFF file, you can embed the
TIFF file into the XML.
Select the Include Field Values check box to include the field values from the Knowledge Object.
If you do not want to send the original document as a separate file (outside the XML file), for example, the TIFF
file, you may choose to not to send it.
The most common input file types for this component are PDF files and Word documents. This component is widely
used with PDF Converter, and any Route component. Use this component in conjunction with BizTalk server to
send documents and data into a BizTalk process.
Using Knowledge Package Builder
Knowledge Package Builder (KPB) provides an effective means of encapsulating all content within a process into an
XML or ZIP file and communicating with other XML enabled processes.
You can also use this component to communicate between two Knowledge Package enabled products. The KPB
packs all the information into an XML or ZIP file, while the Knowledge Package Loader (KPL) takes a packed XML
or ZIP file and "Loads" it into the process stream. Use these two component to build, send and load complete job
batches between servers and processes. Here are some examples of how you can use KPB:
Inter-process communication
Use Knowledge Package Builder to generate XML files

and have central servers read and process the queue
Knowledge Objects.
Load balancing
Use Knowledge Package Builder to send jobs between

two servers and distribute the load.
Workstation communication
Generate XML files (using Folder store or Knowledge

Management Queues) and enable other Knowledge
Package Builder applications to read and process the
queue.
Distributed process chaining
Create chained processes (within one or multiple servers)

that run as one integrated processes by passing XML
messages between each other
External application messaging:
Use XML messaging to connect your processing server

and station to external XML messaging platforms such
as MS BizTalk. Use MS BizTalk with your server to
gain further access to all types of back-end applications.
Complete batch job encapsulation
Each XML message is designed to include full and

complete set of batch job information with options to
includes user defined fields, index data and all attached
files.
Distributed load processing
Use XML to distribute the load to multiple servers and

process batch jobs in distributed environment.
This published XML interface schema is designed for application integration. The XML schema allows for direct and
clear encapsulation of files and distribution of information. Refer to the Software Development kit for XML Schema
Definitions.
667
Licensing Knowledge Package Builder

Knowledge Package Builder works in conjunction with Knowledge Package Loader. The Knowledge Package Loader
component requires a special license when used in either one of the following scenarios:
When loading a XML file that is generated from a 3rd-party application.

When loading a XML file from a different AutoStore OEM product.
A Knowledge Package Loader (Extended) license can be managed from the from the Other tab which is located on
the License Manager (located on the menu bar for AutoStore).
Configuring Knowledge Package Builder

General tab
Enter the general XML file attributes here.
Option
Description
Activate
Select this check box to enable this component within

the workflow process. If this component is not activated,
the component will be ignored within the workflow
process.
File name
Enter the name of the XML file to be generated. The

.xml extension must be used. If the embed documents
options is used, the file will be created with the .zip
extension. If this is left blank, a system generated file
name will be used.
Author
Enter the author of the XML document.
Comments
Enter a description for the document or any other

applicable comment.
Workflow name
Enter the workflow name. This name is included in

the XML document and can be passed to and used by
components further down the workflow process.
Embed documents
Select this check box to have the document embedded

into the ZIP file.
Include field values
By referenceSelect this check box to have

documents that are packaged in the .zip file
referenced rather than embedded. If by reference,
then a reference pool path must be entered. This
directory path will be embedded into the XML
document rather than the document itself.
Remove pool files on failureIf processing fails,
documents that are referenced (these documents are
located in the reference pool path) are removed.
Reference pool pathEnter the directory path
where the pool files (documents) will be stored.
These are the documents that are referenced by path
in the zipped file.
Choose whether field values that were entered on the

Fields tab will be placed into the XML document.
Select Include field values to include the field values
that were entered on the Fields tab into the XML
document. If you want to include additional fields to the
668
Option
Description
XML file, you can do so by inserting a name and value
on the Field Values tab. Applications of inserting field
value provides the capability of coding or indexing your
XML documents based on your process parameters.
Remap fields
Fields configured in the capture component will be

included in the XML document. As a result, the fields
can be passed and used further down the workflow
process.
Exclude fields with empty value
Exclude fields that were either configured on the Fields

tab or in the capture component that contain no values
from the XML file.
Delete original documents
Choose whether the original documents will be passed

through the process or removed after the XML file has
been created. If you do not delete original documents,
then your process will add the XML as a new file to
the list of existing files. Note that the Delete original
documents option functions only when the Embed
documents option has been selected.
Field Values tab

You may choose to add or delete fields to the XML document by configuring attributes in this tab.
Option
Description
Insert
Use this button to add a new field value to the XML

document.
Delete
Use this button to remove a field value pair from the list
of field value entries. The field will no longer be a part
of the XML document.
Knowledge Package Builder component RRTs

This component does not generate an RRT, although component parameters can contain RRT strings.

When there is only one single character in the field name, and Embed documents check box is cleared on the
General tab of the component settings, the XML file does not get generated, although Status Monitor indicates XML
file was created successfully. To avoid this problem, do not use a field name that is a single character.
Knowledge Package Loader - Process

Welcome to Knowledge Package Loader Process component
The Knowledge Package Loader Process component unpacks a schema-specified XML file. The file that it unpacks
must have a .xml extension.
669
Getting started
Feature highlights
The Knowledge Package Loader process component allows you to choose whether or not to send the fields to the next
component in the process, and allows you to configure other components within the process.
You can choose whether or not to send the fields from the XML document over to the next component in the
workflow process.
Knowledge Package Builder is commonly used with this component. The Knowledge Package Builder component
creates the XML files while the Knowledge Package Loader component uses the XML files.
The only input to this component is an XML file. This file must have an .xml extension.
This component is a blocking component. A blocking component is one where other components, further down the
workflow process, are configured. To add additional components to your process, open the component settings for
Knowledge Pack Loader, select the component that you want to configure, and then select the Configure button.
Note: Two blocking components cannot be used in one process.
Using Knowledge Package Loader Process
To send an XML file to a client, you wrap the file, using Knowledge Package Builder, and then send the file to the
server queue. The client detects when a file waiting in the queue, so Knowledge Package Loader can then unwrap the
file for further processing.
Configuring Knowledge Package Loader
Knowledge Package Loader options
Option
Description
Configure
Click on this button to configure other components

within the process through this blocking component.
Include fields
Select this check box to include the fields in the

AutoStore-specified XML schema. When this option is
enabled, the XML fields values will be transferred into
the next component, if that component is able to accept
field values. For example, consider a process with the
Send to Database component with a Microsoft Access
table configured with the same field names used in the
processed XML file. If Include fields is selected, the
component will automatically send the XML field values
into the database.
Knowledge Package Loader component RRTs

Component RRT ID
The RRT ID for this component is ASX.
Name
Description
Version
Version number of the XML Schema.
DateCreated
Date the XML file was created
TimeCreated
Time the XML file was created
670
Name
Description
AUTHOR
The author field for the file.
COMMENTS
The comments field entered into the file.

This component does support FRTNs for field names contained within the XML file. The following example
provides some sample usage for your reference:
The RRT string ~ASX::%Client ID%~ is replaced by Notable Solutions Inc. if the user types in Notable
Solutions Inc. for the field name called Client ID.
No SSRTN is supported by this component.
Problem Description
Solution
Configure a component if its name does not appear on

the list of components on the Component tab.
You have to add the component to the process first.

Then, you can configure the component through this
blocking component.
"Duplicate Output destination" error when you run your

process.
If the Include fields check box is selected in the

Knowledge Package Loader options and the subsequent
component in the workflow (for example, Send To
Database) is using the RRT "ASX", the process will fail
with a database error.
It is not possible to place multiple Knowledge Package Loader components one after another in a single process.
Knowledge Package Loader Capture

Welcome to Knowledge Package Loader Capture component
The Knowledge Package Loader Capture component unpacks a schema-specified XML file. The file that it unpacks
must have a .xml extension.
Getting started
Feature highlights
This component provides the following functions:
Document and image file encapsulation

Unlimited index fields
Dynamic and static field value support
This component is normally used with the PDF417 Barcode component.

An XML (.xml) or zipped file acceptable for input.
Using Knowledge Package Loader Capture
You can use this component to:
Poll a directory by specifying the Input and Working directories.
671
Remove or store files based on the success or failure of the process.

Decide whether or not to include the field values of the XML file to be processed.
Configure other components within the workflow process through this component.
Generate XML files into queues and have other servers or OneStep users read and process the queue.
This component is a blocking component. A blocking component is one where other components, further down the
workflow process, are configured. To add components, click the Components (see Components tab). Select the
component that you want to configure and then click the Configure button.
Note: Two blocking components cannot be used within a single process. Also, the working directory and the
input directory should be different. Otherwise, it will result in a never-ending loop.
Configuring Knowledge Package Loader Capture
General tab
Use the General tab to configure general attributes of the Knowledge Package Loader Capture component.
Option
Description
Input directory
Enter the directory where you want to poll for files.

This must be a valid directory and cannot be the same
directory as the working directory.
Working directory
Select the directory from where files will temporarily

be stored while waiting to be processed. This must be a
valid directory cannot be the same directory as the input
directory.
On Success
On Failure
Include Fields
Remove Files deletes the files when the process is

successful.
Move Files moves the files to the specified folder on
success.
Remove files removes the files when the process has
failed.
Move files moves the files to the specified folder on
failure.
If you want to include the field values from the

knowledge object, you may do so by selecting this check
box and the fields will be saved into the XML schema.
When this option is enabled, the XML fields values
will be transferred into the next component, if that
component is able to accept field values. For example,
consider a process with the Send to Database component
with a Microsoft Access table configured with the same
field names used in the processed XML file. If the
Include fields check box is enabled, the component
will automatically send the XML field values into the
database.
Missing .dat file time-out
Specifies the time in seconds until a capture fails

when fields are included and the referring .dat file is
missing.
672
Components tab
Use the Components tab of the Knowledge Package Loader Capture component to configure other components in the
workflow process.
Configure subsequent components in the workflow by clicking a component and then clicking the Configure
button.
Knowledge Package Loader Capture component RRTs

Component RRT ID
The RRT ID for this component is ASX.
Name
Description
Version
Version number of the XML Schema.
DateCreated
Date the XML file was created
TimeCreated
Time the XML file was created
AUTHOR
The author field for the file.
COMMENTS
The comments field entered into the file.

This component does support FRTNs for field names contained within the XML file. The following example
The RRT string ~ASX::%Client ID%~ is replaced by Notable Solutions Inc. if the user types in Notable
Solutions Inc. for the field name called Client ID.
No SSRTN is supported by this component.
Problem Description
Solution
Configure a component if its name doesnt appear on the You have to add the component to the process first.
list of components on the Component tab.
Then, you can configure the component through this
blocking component.
Error encountered when starting the Service.
Make sure the Input Directory exists and is accessible.
"Duplicate Output destination" error when you run your

process.
If the Include Fields is selected on the General tab of

the component settings and the component that follows
in the process (for example, Send To Data Base) is using
the RRT "ASX", the process will fail with a database
error.
The input directory and the working directory specified on the General tab of the component configuration dialog
box cannot be the same directory.
Make sure the input directory and the working directory are valid and accessible directories.
673
If you choose to Move Files on either success or failure, make sure the directories you choose are valid and
accessible directories.
Two or more Knowledge Package Loader components cannot be connected in a single process.
Kodak Scan Station

Welcome to KODAK Scan Station
Kodak Scan Station (KSS) capture component allows direct integration of a Kodak Scan Station device panel with the
AutoStore server.
Getting started
Feature highlights
Secure Communication (via SSL) between the KSS device and the AutoStore server
Optional locking of scanning parameters
Scripting for advanced functionality to perform database look-ups, validation, and more
Style Sheet for customizing the Kodak Scan Station touch screen panel
DOD Cleansing compliant as images cannot be traced on the Kodak device after being deleted
User authentication at the device touch screen panelsupported authentications include Windows NT, Active
Directory, and NetWare authentication.
Scanning mixed mode documents ( B/W, grey scale or color)
Device grouping of the (based on your organizations needs) by department, function, etc.
Multi-Layer menu definition.
Centralized meta-data form definition for a full centralized control over the indexing forms.
Extend the functionality of otherwise static forms by allowing custom VBScripts to be executed on the server
at runtime to update form field values/settings and perform any necessary form field validation based on any
available runtime data.
Using the KODAK Scan Station component

Use this component to capture content from documents scanned with the Kodak Scan Station device and process into
a workflow.
This component allows a direct integration of the KSS device with the application. Additionally, use the scripting
capability provided by this component to create dynamic forms and fields that are connected with your applications.
Validation of form fields can also be done directly against the back-end application databases providing the user with
a quality-control indexing station directly on top of the Kodak scanning device.
This component provides a rich set of form fields to allow the user to capture String, String list, Date, Number and
Boolean field values. Now, creating forms using these devices is very simple and easy to manage since all devices are
centrally controlled from the server.
This implementation is truly an enterprise solution that can provide device grouping, scan setting control from a
single location (no need to log-in to every device), centralized indexing form management, as well as support for
Server Farms and load balancing for larger deployment of devices.
This component allows your devices to access a rich set of AutoStore workflows and reach a document capture
efficiency better than any other product in the marketplace.
Installing Kodak Scan Station
How to install Kodak Scan Station
Use this procedure to install component software on the Kodak Scan Station.
Note: You will need a USB 2.0 flash drive to move files to the Kodak Scan Station.
674
1. Select C:\installation directory\Distributables\Kodak Scan Station 500 or C:

\installation directory\Distributables\Kodak Scan Station 100.
2. Copy the appropriate files for the version of the Kodak Scan Station into the root directory of the USB 2.0 flash
drive:
Device Version
Copy these files
Kodak Scan Station 100
kss.100.xml and kss100update.exe
Kodak Scan Station 500
kss.500.xml and kss500update.exe
3. Shut down and restart the Kodak Scan Station.

4. Depending on the version of the Kodak Scan Station, select Kodak Scan Station 100 or Kodak Scan Station 500
on the Kodak Scan Station interface/
5. Insert the USB 2.0 flash drive into Kodak Scan Station.
6. You will be prompted whether to update the device. Choose Yes.
The following prompt appears: "Administrative configuration on the flash drive does not match the devices
configuration. Do you want to be prompted to update the device configuration?
7. Select Yes.
The following message then appears: "Software has been found, version x.x.x.x. You are currently running version
x.x.x.x. Do you want to install the software?"
8. Click Yes.
The following message then appears: "Please wait while software is being installed. To complete the installation
the device needs to be restarted.
9. Click OK.
This restarts the Kodak Scan Station.
10. Remove USB 2.0 flash drive from the Kodak Scan Station
How to update the Autostore Client for Kodak Scan Station 500
Use this procedure to update software from the Kodak Scan Station console.
Note: Installation of the update may also be done from the AutoStore Process Designer through the Software
Update feature found in the Group option on the Menu tab.
Note: You will need a USB 2.0 flash drive to move files to the Kodak Scan Station.
1. Select C:\install directory\Distributables\Kodak Scan Station 500.
2. For Kodak Scan Station 500, copy the following file onto the root directory of the USB 2.0 flash drive:
NSiKSS500Update.exe.
3. Shut down and restart the Kodak Scan Station.
4. Select Autostore Client on the Kodak Scan Station Interface.
5. Insert the USB 2.0 flash drive into Kodak Scan Station.
The following prompt to update appears: "Update from version 0.00 to version 1.08 OK to update now, cancel to
perform later. Updating in xx seconds."
6. Click OK.
The Kodak Scan Station restarts.
7. Remove the USB 2.0 flash drive from the Kodak Scan Station.
Configuring Kokak Scan Station
Menu tab
Use this tab to add, edit, or remove groups, menus, and forms.
Option
Add
Description
Click Add to create:
Group
675
Option
Description
Menu
Form
Edit
Select the group, menu or form that you want to update

and click Edit.
Remove
Select the group, menu or form that you want to delete

and click Remove.
Group options
Field Name
Description
Name

string describing the name of the group. This name does
not appear on the desktop and it is used strictly as logical
group name. This component is equipped with a default
group called Common Group. You may add Menu and
Form to the Common Group.
Root Menu Title
Enter a string to set the title of the main menu on the

device display.
Use authentication settings
Select this check box to apply authentication settings

to the group dialog. This option is useful when you
want to group devices such that some of them support
authentication and some do not.
Auto Continue
Select this check box to allow for unattended set-up. By

choosing this option, the default choice at each prompt
will be selected. You can select the number of seconds
each prompt will be displayed before automatically
moving on to the next prompt.
Restrict preview to Form/Action
By default, a user has the option of scanning without

selecting a form or action. Selecting this option will
require that a scanning operation occur within a form or
action.
Software Updates
Selecting this option will open the Software Update

dialog box. This option allows a user to select the
method of updating the scanning device. In the new
dialog box you can select two options:
Allow USB Update

Allow UNC Update
Selecting Allow USB Update will allow for software

updates to occur through a USB device. See the Install
section for more information. Selecting Allow UNC
Update allows for software updates to occur directly
from the Universal Naming Convention (UNC) path
designated by your system administrator. A user can
also select the number of minutes before the UNC path
will be checked for a new update.
676
Field Name
Description
Click Add to enter either a valid KSS device IP address
or a host name. Click Ping Address to check the validity
of the IP address or host name. Click Remove to delete a
KSS device.
Members
Menu options
Add a menu to create a hierarchy. The menu entry will simply guide the users to select the desired workflow.
Field Name
Description
Menu
Icon File
Browse to the folder location that contains GIF, PNG, or

JPEG file for this menu entry. The menu icon is 48x48
256 color.
Form options
Add a form when your workflow requires capture of index data. To add a form, fill out the following 3 tabs:
General tab
Scanner Settings tab
Components tab
General tab
Field Name
Description
Form Name
The name of the form to be displayed on the KSS device.
Icon File
Browse to the folder location that contains GIF, PNG,

or JPEG file for this form entry. The Form icon is 48x48
256 color.
Style Sheet:
Enter the name of your style sheet. If you leave this

field blank, the default style sheet is enabled. You can
create a custom XML style sheet to customize the format
of your form, with different font color and size, logos,
etc. as required by your business needs. When a user
right clicks on a file and selects a form, the KSS client
retrieves the form definition from the server in XML
format. This XML formatted file has all the field setting
definitions for the form. The style sheet converts the
XML-formatted form and displays it in an HTML format
on the touch screen of the Scan Station. The custom
XML style sheet will need to provide the appropriate
rendering of the ACForm element as defined in the
AutoCapture XML schema. If there are references in the
custom XML style sheet to external files then you can
enter a "comma" or "semi-colon" separated list of files in
the following order:
Style sheet name

Image file name(s)
Java scripts file name(s)
677
Field Name
Description
Script File
Enter the VBScript name for validating the index data on

the devices.
Form Fields
Add fields by clicking the New field button appearing

as the first column header and labeled with N. Once
you have added the first row, you can tab through to get
additional fields added. For each field you can configure
the field attributes:
Field Namefield name is a string type and can

be any alphanumeric characters. Using special
characters (~, &, <, >,%, ", /, \, :, ?, | ) is not
recommended.
Typethe supported string types are:
Boolean
Date
String
String list
Number
Required (R)Select this check box if the field is
required to be filled.
Validation(V)Select this check box if you want
that the field is validated.
HintDescription field for administrator reference.
PropertiesSet the field attributes by clicking this
button on the rightmost column on each entry.
Scanner settings
Name
Original Type
Description
One Sided
Two Sided
Allow user to change default scan settings: If enabled,

you will see an icon representing this scanner setting
on the device display which allows the user to change
this settings. If this option is disabled, the setting is
"locked", i.e., the user cannot change scan settings
defined for the form.
Resolution
Determines the quality of the scanned image. The image

resolution is defined by the number of dots-per-inch that
are used to create the image. The higher the resolution
the sharper the image. Available resolutions are:
200
300
400
600
300 dpi is optimal for creating text PDF files. Allow

user to change default scan settings: If enabled, you
will see an icon representing this scanner setting on
the device display which allows the user to change
678
Name
Description
Color
The following options are supported:
B/W ATP
B/W iThreshold
Grey
Color

Document Type
Allows you to select from a list of document type to get

the optimum scanner setting for proper documents:
Textselect this when your documents are text

only.
Text and Graphics select this when the image is
printed image.
PhotographSelect this setting when the
documents is image of printing paper

Contrast (min 1 max100)
Enhances the edges contained in an image by adjusting

the difference between black-and-white, and thereby
making an image sharper or softer. In a low contrast
setting, the difference between black and white is small,
so the image is softer. In a high contrast setting, the
difference between black and white is large, so the image
is clearer. Thus, the higher the contrast level, the more
enhancement of the image edges. Allow user to change
default scan settings: If enabled, you will see an icon
representing this scanner setting on the device display
which allows the user to change this settings. If this
option is disabled, the setting is "locked", i.e., the user
cannot change scan settings defined for the form.
Threshold (min 0 max 255)
Converts a grayscale image to a black-and-white image.

A low threshold value produces a lighter image, and can
be used to subdue backgrounds and subtle, unneeded
information. A high threshold value produces a darker
image, and can be used to help pick up faint images.
679
Name
Description
Output Format
TIFF MMR
PDF
JPG

JPEG Quality
Draft
Good
Better
Best
Superior

Components tab
attributes. The configuration button appears in the last column within each row.
Select a component by clicking the leftmost column next to each component and configure the component for this
form by clicking the Configure, i.e. the C button (rightmost column on each row).
Preferences tab
In this tab, you can specify where the program files for the job that is processing will be stored by the server.
Option
Description
Home Directory

Port Number
Enter the port number used by the KSS device to

communicate with the server. The device must be
configured to use the same port number to communicate
with the server. If the device is having problems
communicating with the server, check the port settings
on the server to make sure they match the device port
number. Also make sure there are no firewall equipment
680
Option
Description
blocking the specified port. Note to modify device
settings, open your Internet browser and access the
device configuration settings screen of the device.
SSL Connection Encryption

between the server and the KSS device over an SSL
secure channel.
Keep
The Keep setting allows the workflow to keep the

processed and/or rejected files in the specified directory
upon completion of successful routing. If you enable
this option, all files are stored into the Processed Files
directory at the time when the service successfully
completed writing them into the destination location.
Keep in mind that if this is option is enabled, a copy of
every file that has been routed successfully is saved in
the Processed Files directory. Make sure that proper disk
Rejected Files directory is used for storing any files
that failed to be stored into the final destination location.
The failure could be due to any number of reasons
and it must be researched through searching the server
application log file entries. Typically, it is beneficial to
have a secondary process that takes this directory as an
input and routes messages out to system administrator
and warns them of failure. Note that the service must
have sufficient rights to access this directory.
Authentication tab
Setup the authentication attributes in this tab. The authentication server is running on the KSS device component of
workflow server.
Option
Description
Authentication Type
The supported Authentication Types are:
NoneThe device does not require the user to

authenticate prior to using the network scanning
feature.
WindowsProvides integration with Windows
NTLM authentication.
Active DirectoryProvides integration with
Windows Active Directory for user name and
password settings.
NetWareProvides integration with Novell
NetWare authentication.
LDAP tab
Enter the LDAP attributes in this tab.
681
Option
Accessing the LDAP Server
Description
LDAP ServerEnter the LDAP server against which
you want to authenticate the user.
Root DirectoryEnter the directory from which to
begin the LDAP query. If this field is left blank, the
search starts at the LDAP default directory. Click Find
Root to locate the default root of the LDAP server.
The structure of a directory service is hierarchic and can
be seen as a directory tree: there is a root from where you
can start to other entries. The root can contain containers
(knots) and leaves. Containers themselves can contain
other entries while leaves mark the end of a branch in a
directory tree. Every entry in this directory describes an
object and has specific attributes. Conceptually the root
is the topmost entry in a LDAP hierarchy. This can be
illustrated with the Windows file system: the hard disk
C: is the root, the directories/folders are the containers
and the files are the leaves.
The LDAP standard requires that all LDAP directories
maintain a special entry, called the Root DS Entry,
or Root DSE. This entry provides a set of standard
operational attributes that the user can read to find out
fundamental characteristics of the directory and the
server. The Root DSE can also provide any number of
vendor-specific attributes.
One of the standard operational attributes is
defaultNamingContext. This attribute contains the
distinguished name (DN) of the root of the directory.
In Windows 2000, this is the DN of the Domain
container at the root of the current tree. By reading the
defaultNamingContext attribute from the Root DSE,
you can discover what domain you are logged in to at
run time. When you press the Test button, the domain
you are logged into is displayed.
Note that if the root is left blank when you press the
Test button, the results may differ from when you
actually run the server with KSS component (equipped
with Authentication). A blank root uses the default
value, which is retrieved from the account that you are
logged into the machine as. However, when you run the
server, you are logged in as LocalSystem (or whichever
user name you specify on the Service tab), possibly
yielding different results. For this reason, it is highly
recommended that you either supply the root or log-in
to the service with a user name/password different than
LocalSystem.
Credentials
Enter the LDAP credentials to gain access to LDAP

server to lookup user entries.
AnonymousSelect this check box if you want to log
in to LDAP server as anonymous user without providing
user name and password.
682
Option
Description
Username/passwordEnter the username/password to
access the LDAP server.
Searching the Database
Select from the following options to search the entries in

the address book directory services database:
Active DirectoryWith Windows Active Directory
authentication method, the username is matched against
the field "samAccountName", the Get Email From is
matched against the field "mail", and the Get Display
Name From is matched against the field "displayName".
eDirectoryWith NetWare authentication method use
the eDirectory search to match the Username against the
field "uID",Get Email From against the field "mail",
and the Get Display Name against the field "cn".
CustomUse the custom option when you have
multiple types of authentication. To customize the
search, use this option to create matches against values
that you can define for the following parameters:
Match Username Against

Get Email From
Get Display Name From
Click Reset to reset field values to empty.

Test
To test the settings, click the Test button and enter a

user name as it will be entered on the KSS device. This
verifies that an email address and display name can be
found for the user on the LDAP server.
Kodak Scan Station component RRTs

Component RRT ID
The RRT ID for this component is KSS.
Name
Description
Device Host Name
If available, the host name of the scanning device
Device IP Address
IP address of the scanning device
File Format
Received file format value: TIFF
File Page Count
Number of pages received
File Size
Received file size
Sender Display Name
The authenticated user's display name if Authentication

has been turned on for the scanning device
683
Name
Description
Sender Domain Name
The authenticated user's domain name if Authentication

Sender Email Address
The authenticated user's email address if Authentication

Sender Username
The authenticated user's user name if Authentication has

been turned on for the scanning device

This component supports FRTNs and replacement of field names created during the setup of the Kodak Scan Station
capture component with the values entered in these fields at the device. The following example provides some sample
usage for your reference:
The RRT string ~KSS::%Client ID%~ is replaced by Johnson Co if the user types in Johnson Co for the field
named Client ID.
Name
Description
DT: Weekday Name (A)
Received file date: abbreviated weekday name
DT: Weekday Name (F)
Received file date: full weekday name
DT: Month Name (A)
Received file date: abbreviated month name
DT: Month Name (F)
Received file date: full month name
DT: Day of Month
Received file date: day of month as decimal number

(0131)
DT: Hour (24)
Received file date: hour in 24hour format
DT: Hour (12)
Received file date: hour in 12hour format
DT: Day of Year
Received file date: day of year as decimal number (001

366)
DT: Month
Received file date: month as decimal number (0112)
DT: Minute
Received file date: minute as decimal number (0059)
DT: Locales A.M./P.M.
Received file date: current locales A.M./P.M. indicator

for 12hour clock
DT: Second
Received file date: second as decimal number (0059)
DT: Week of Year (S)
Received file date: week of year as decimal number, with

Sunday as first day of the week (0053
DT: Weekday
Received file date: weekday as decimal number (06;

Sunday is 0)
DT: Week of Year (M)

Monday as first day of the week (0053)
DT: Year
Received file date: year without century, as decimal

number (0099)
684
Name
Description
DT: Year (C)
Received file date: year with century, as decimal number

If you plan to use Form Field Names in the Rename Schema of your subsequent component, you cannot use the
following characters:
/
\
:
?
"
<
>
|
Using one of the following characters is not permitted within the Menu, Form, Group:
&
<
>
Troubleshooting
Problem Description
Solution
Selection of Autostore Client, Kodak Scan Station 100 You will need a USB 2.0 flash drive to move files to the
or Kodak Scan Station 500 on the Kodak Scan Station Kodak Scan Station:
interface results in an unhandled exception:
Select C:\installation
KDSEmbeddedBase Unhandled exception has
directory\Distributables\Kodak
occurred in your application if you click Continue,
Scan Station 500 or C:\installation
the application will ignore this error and attempt
directory\Distributables\Kodak Scan
to continue. If you click Quit, the application will
Station 100
close immediately. The system cannot find the file
If you are using a Kodak Scan Station 100, copy

specified. ***********Exception Text*********
the following files onto the root directory of
System.ComponentModel.Win32Exception:
the USB 2.0 flash drive: kss.100.xml and
The system cannot find the file specified at
kss100update.exe
System.Diagnostic.Process.StartWithShellExecuteEx( ProcessStartInfo
If you are using a Kodak Scan Station 500, copy
startInfo)at System.Diagnostics.Process.Start() at
the following files onto the root directory of
KDSBase.KDSBase.launchApp(String startPath)
the USB 2.0 flash drive: kss.500.xml and
at KDSBase.KDSBase.Launch_Click(Object
kss500update.exe
sender, EventArgs e) at
Shutdown and Restart the Kodak Scan Station

System.Windows.Forms.Control.OnClick(EventArgs e)
at System.Windows.Forms.Button.OnClick(EventArgs e) If you are using a Kodak Scan Station 500, select
at
Kodak Scan Station 500 on the Kodak Scan Station
System.Windows.Forms.Button.OnMouseUp(MouseEventArgsInterface. If you using a Kodak Scan Station 100,
mevent) at
Select Kodak Scan Station 100 on the Kodak Scan
System.Windows.Forms.Control.WmMouseUp(Message& Station Interface.
m, MouseButtons button, Int32 clicks) at
Insert the USB 2.0 flash drive into Kodak Scan
System.Windows.Forms.Control.WndProc(Message&
Station
m) at
You will be asked whether you would like to update,
System.Windows.Forms.ButtonBase.WndProc(Message&
choose Yes.
m) at
The following message will appear:
System.Windows.Forms.Button.WndProc(Message& m)
Administrative configuration on the flash drive does
at
not match the devices configuration. Do you want to
System.Windows.Forms.Control.ControlNativeWindow.OnMessage(Message&m)
685
Problem Description
Solution
at
be prompted to update the device configuration? Yes/
System.Windows.Forms.Control.ControlNativeWindow.WndProc(Message&m)
No.
at
Choose Yes.
System.Windows.Forms.NativeWindow.Callback(IntPtr
The following message will then appear:
hWnd, Int32msg, IntPtr wparam, IntPtr Iparam)
Software has been found, version x.x.x.x. You are
By selecting Continue, another unhandled exception
currently running version x.x.x.x. Do you want
appears:
to install the software? Do you want to install the
r;No process is associated with this object.
software?
Choose Yes.
The following message will then appear:
Please wait while software is being installed. To
complete the installation the device needs to be
restarted. Click on the OK button.
Click OK.
The Kodak Scan Station will restart
Remove the USB 2.0 flash drive from the Kodak
Scan Station
VBScripting
The VBScript feature provides the ability to extend the functionally of otherwise static Forms by allowing custom
VBScripts to be executed on the server at runtime to update form field values/settings and perform any necessary
form field validation based on any available runtime data.
Events
Events
Event
Description
FormLoad
The FormLoad event occurs before a form is displayed

on the device panel.
FieldValidate
The FieldValidate event occurs when a when user

attempts to set a new value for a field on the form.
FormValidate
The FormValidate event occurs when a user sends a

document.
FieldLookUp
The FieldLookup event occurs when a when user

looks up a field on the form.
FormLoad Event
The FormLoad event occurs before a form is displayed on the device panel.
Syntax
Sub FormLoad(Form)
Arguments
Form
The form object that is being loaded.
686
Remarks
Load form fields
Sub FormLoad(Form)
'Add Items To "TO" Field on form
form.Fields.Field("TO").AddListItem
"User1","User1@gMail.com"
end sub
Get device IP
Sub FormLoad (Form)
Form.StatusMsg Form.DeviceIP
End Sub
Get device name
Sub FormLoad(Form)
Form.StatusMsg Form.DeviceName
End Sub
FieldValidate Event
The FieldValidate event occurs when a when user attempts to set a new value for a field on the form.
Syntax
Function FieldValidate(Form, Name, Value)
Arguments
Form
The form object that contains the field that is being validated.
Name
The name of the field that requires validation.
Value
The value of the field that requires validation.
Remarks
You can use this event to perform tasks such as validating user input for a form field. If the return value is empty
string then validation is assumed to have been successful.
Examples
Function FieldValidate(Form, Name, Value)
687
FieldValidate = ""
value for "Amount" field that is greater then 100.
If ( Name ="Amount") Then
If (CInt( Value) > 100) Then
'Return Error Message
FieldValidate = "Amount cannot be greater than 100."
End If
End If
End Function
FormValidate Event
The FormValidate event occurs when a user sends a document.
Syntax
Function FormValidate(Form)
Arguments
Form
The form object that is being sent.
Remarks
You can use this event to perform tasks such as validating user input for a form value. If the return value is empty
Examples
Function FormValidate( Form )
FormValidate = ""
value for "Amount" field that is greater than 100.
'"Amount" field type is number
If (Form.Fields.Field("Amount").Value > 100 ) then
'Return Error Message
FormValidate = "Amount cannot be greater than 100.
End if
End Function
FieldLookup Event
The FieldLookup event occurs when a when user looks up a field on the form.
Syntax
Function FieldLookUp( Form,Name,Value )
Arguments
Form
The form object that contains the field that is being looked up.
Name
The name of the field that is being looked up.
Name
The name of the field that is being looked up.
Value
688
The value of the field that is being looked up.

Examples
Function FieldLookUp( Form,Name,Value )
Form.TraceMsg "FieldLookUp"
Dim rootDSE, domainObject
Set rootDSE = GetObject("LDAP://RootDSE")
DomainContainer = rootDSE.Get("defaultNamingContext")
Set conn = CreateObject("ADODB.Connection")
conn.Provider = "ADSDSOObject"
conn.Open "ADs Provider"
nickname = Value & "*"
ldapStr = "<LDAP://" & DomainContainer & ">;(& (mailnickname=" &
nickname & ")(| (&(objectCategory=person)(objectClass=user)(!(homeMDB=*))
(!(msExchHomeServerName=*)))(&(objectCategory=person)(objectClass=user)(|
(homeMDB=*)(msExchHomeServerName=*))) ));adspath;subtree"
Set rs = conn.Execute(ldapStr)
While Not rs.EOF
Set oUser = GetObject(rs.Fields(0).Value)
For Each email In oUser.proxyAddresses
If InStr(email, "SMTP:") = 1 Or InStr(email, "smtp:") = 1 Then
Form.Fields.Field(Name).AddListItem Right(email, Len(email) 5),Right(email, Len(email) - 5)
End If
Next
rs.MoveNext
Wend
End Function
Form object
Properties
Name
UserName
Description
Returns the authenticated users account name.
This property is only available if authenticated has been
enabled for the device.
EMailAddress
Returns the authenticated users email address.

Remarks

Name
Returns the name of the form.
GUID
Returns the unique ID of the form.
ScanSettings
This returns an object.
Fields
This returns an object. Containers form fields.
DeviceIP
The IP address for the device.
DeviceName
The name for the device.
689
Methods
Name
Description
TraceMsg (Msg)
Displays debug message in status monitor when debug is

turned on.
StatusMsg (Msg)
Displays status messages.
WarningMsg (Msg)
Displays warning message.
ErrorMsg (Msg)
Displays error message.
Form Field object

Property
Description
Count
Number of fields in a container.
Field (name)
This returns field object by name.
Item (index)
This return the field object by index
Form field and item properties will return one of the following objects:
Form field String

Form field String List
Form field Boolean
Form field Date
Form field Number
String object
Table 37: Properties
Name
Type
Value
String
Name
String ( Read Only )
Required
Boolean
Validate
Boolean
HelpMsg
String
String List object

Name
Type
Value
String
Name
String (Read Only)
Required
Boolean
Validate
Boolean
HelpMsg
String
690
Name
Separator
Type
String (Read Only)
Table 39: Method

Name
AddListItem
Table 40: Arguments
Name
Type
Label
String
Value
String
Boolean object
Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
True
String
False
String
Date object
Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
Format
String
691
Number object
Name
Type
Value
number
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
MaxValue
number
MinValue
number
DecimalPlaces
number
Format
String
Scanner settings
The Scanner Settings have the following properties.
Properties
Name
Type
Properties
Value
Example
Resolution
enum
N/A
75=75PDI
100=100DPI
150 = 150 DPI
200 = 200 DPI
240 = 240 DPI
300 = 300 DPI
400 = 400 DPI
600 = 600 DPI
Format
enum
N/A
Form.ScanSettings.Format=2
SCANFORMAT_PDF=0
SCAN_FORMAT_TIF=1
SCANFORMAT_JPEG=2
Form.ScanSettings.Resolution=400
Color
enum
N/A
Form.ScanSettings.Color=0
COLOR_BLACK_WITE_ATP=0
COLOR_BLACK_WHITE_ITHRESHOLD=1
COLOR_COLOR=2
COLOR_GRAY=3
ImageType
enum
N/A
Form.scanSettings.ImageType=1
SCAN_TEXT_TYPE=0
SCAN_PHOTO_TYPE=1
SCAN_TYPE_TEXT_AND_PHOTO=2
Duplex
boolean
N/A
true/false
Form.ScanSettings.Duplex=True
JpegQuality
enum
N/A
Form.ScanSettingsJpegQuality=1
DRAFT=0
692
Name
Type
Properties
Value
Example
GOOD=1
BEST=2
BETTER=3
SUPERIOR=4
Contrast
number (short)
N/A
1-100
Form.ScanSettings.Contrast=60
Threshold
number (short)
N/A
1-255
Form.ScanSettings.Threshold=75
Lock
Object
Form.scansettings.lock.color=true
Form.scansettings.lock.color=false
Lock Object Properties

Name
Type
Color
Boolean
Contrast
Boolean
Duplex
Boolean
JpegQuality
Boolean
Format
Boolean
ImageType
Boolean
Threshold
Boolean
Resolution
Boolean
Konica Minolta iOption

Welcome to Konica Minolta iOption
The Konica Minolta iOption component allows you to capture documents from Konica Minolta devices that support
the device browser and send the documents to any of the route destinations that are supported by the Workflow server.
When scanning documents with the MFP, users can provide information about the documents that can be used to
identify and route the documents appropriately.
The Konica Minolta iOption component provides the following features:

Support for Tree, List, Text, Checkbox, Numeric, Date, Label, Button and Lookup List field types to provide
document indexing flexibility.
destination.
Forms are extensible through VB.NET and C. You can create more interactive forms and validate before a
document is scanned. Integrated editor with IntelliSense makes the creation of scripts easier.
Windows authentication at the MFP panel.
In addition to Windows authentication, custom authentication allows you to configure additional authentication
methods.
693
Device setup and configuration prerequisites

Module prerequisites
For you to configure a device to scan to the workflow server using the Konica Minolta iOption component the device
must support the iOption browser option.
Vista Enterprise Edition prerequisites
In Windows Features, turn on the ASP.NET feature.
Complete the following steps to turn on ASP.NET:

1. In Windows Control Panel switch to Small icons or Large icons view, and open Programs and Features.
2. Click Turn Windows features on or off.
3. In the Windows Features dialog box, expand Internet Information Services > World Wide Web Services >
Application Development Features, and then select the check box next to ASP.NET.
4. Click OK.
Supported devices
For a current list of supported devices visit the Konica Minolta MFDs web page on the Notable Solutions website.
Setting the post-authentication default application
Before setting the default application, enable Scan and Print Release for the device.
1.
2.
3.
4.
Use the Device Registration Service to register the Unified Client and Authentication on the device.
Stop AutoStore.
Make a backup copy of the web.config file located in the KonicaPanelClient folder.
Modify the default application setting:
a) Open the web.config file in a text editor.
b) Find the following line of code:
694
<add key="DefaultApplication" value=""/>

c) Change the value in the code line to the value associated with the Aplication Name property in the device
configuration in DRS.
The following figure shows an example:
Note:
Because this setting is used for all devices, use the same application name for all devices configured in
DRS.
The updated code line appears as:
<add key="DefaultApplication" value="AutoStore-30"/>
d) Save your changes to the web.config file.
5. Start AutoStore.
On the device, after logging into the authentication module, the AutoStore-30 application launches.
How to use the Konica Minolta iOption component
Users can design custom scanning processes through Konica Minolta devices which capture documents and place
these documents in a designated location. This example uses the Konica Minolta iOption capture component and the
Send to Folder route component to create a workflow.
From Toolbox, drag and drop the Konica Minolta iOption capture component and the Send to Folder route
component to the Process Designer.
For additional information on how to create a process, refer to the Server Process section of the Process Designer
help.
For help in setting up the device, configuration and customizing, see the following:
Configure the Konica Minolta iOption capture component by following instructions in Configuring preferences.
Create a form by following instructions in Adding and editing forms in a group.
To manage devices refer to the Device Registration Service help.
695
Configure Konica Minolta iOption settings

The following configuration parameters may be set when using Konica Minolta iOption:
Managing Groups
Preferences
Authentication
Managing groups
A group is composed of the forms that will be displayed at the device panel. Also displayed is a notice whether
authentication will be required. By default there is a single group called the Common Group. If you do not
configure additional groups, all devices will display the forms configured in the "Common Group". You can create
additional groups and assign certain devices to them. In using this method, all devices connecting to the same server
can still be used for different functions.
Adding and Editing Groups
Adding and Editing Forms in a Group
Adding and editing groups
Add a new group

Enable group level authentication
How to add a new group

Note: The Common Group cannot be removed.
1. Click the Groups tab and click Add Group.
2. In Group Settings, type a name for the group in the Name box.
This name does not appear on the MFP display as it is used strictly for identification purposes.
3. If the MFP devices in this group should authenticate the user, select the Require Authentication check box.
4. Add the MFP devices that will be associated to this group by entering the IP Address or host name of the MFP in
the MFP Address list.
Note: Using the network name is preferable because the IP address can change if you are using Dynamic
Host Configuration Protocol (DHCP).
5. Click OK.
6. To edit an existing group double click on the group name or select the group name and click Edit.
7. To remove an existing group, select the group name and click Remove.
How to enable group level authentication
1. Highlight the group and click Edit
2. Click the Authentication tab and select the Requires Authentication check box.
Note: To use the same authentication settings that were configured for authentication globally, select the
Use Global Authentication Settings box.
3. Complete the instructions described in the Authentication topic.
4. Select the General tab.
Completing this procedure displays MFP address/Host Name values for devices.
Menus in a group
Adding a menu to a group
Highlight Common Group or the name of a group and select Add Menu.
A unique name must be entered for the menu name.
696
An icon image may be used for this menu. The icon will be displayed on the device. The icon must conform to the
following specifications:
Image format: PNG or GIF with transparent background

Maximum size: 24 KB
Selecting the Public Access option allows all users to use the form.
Selecting the Restricted Access option allows only users in the Allowed Users/Groups list to use the form. If a user
belongs to a group in the list then this user can see the form (see group membership criteria below).
Group membership criteria
Group membership is determined by the authentication type:
Windows
Custom Script
Determined by the Windows Groups that the user

belongs.
Determined by the Groups collection of the UserInfo
object that represents the authenticated user. For details
on the object model used in authentication scripts see the
Konica Minolta iOption Scripting documentation.
Note: When the authentication type is Windows you can use the browse button () to select Windows
groups or users. The browse button is disabled for all other authentication types.
Adding and editing forms in a group
Add a form when your workflow process requires capturing index data prior to scanning. A user may add, modify,
delete a form or enable authentication at the group level.
Add a basic form on page 697

Restricting Access to a Form on page 699
How to add a dynamic form on page 700
How to add fields to a form on page 701
How to configure, process, and route components on page 701
How to add a Send to Email form on page 702
How to add a Send to Folder form on page 703
How to add a Send to SharePoint form on page 703
How to add a Send to Smarticket form on page 705
How to save a form as a template on page 706
How to create a form from a template on page 706
How to edit a form on page 706
Add a basic form

1. Highlight Common Group and Select Add Form and then Select Basic Form.
2. Type the name of the form in the Name box.
For example: If this form is used to send to the users home directory then you can name the form Scan to Users
Home Directory. The maximum number of characters allowed in the form name is 36.
3. Select Single Touch mode if you do not want the user to enter any information about the document.
This causes the scan to start immediately after the user presses the form button on the device.
4. Configure the default settings for the scanned document.
697
Option
File Type
Description
Indicates the type of the file to save scanned data. The
following file types are supported:
Type of Original
Text: (Default) Scan an original that consists

primarily of text at the optimum level of image
quality. Sharpen the edges of text to improve
legibility.
Text/Photo: Scan an original consisting primarily of
text and photos at the optimum image quality level.
Sharpen the edges of text, and smooth images.
Photo: Scan an original consisting of only photos at
the optimum image quality level.
Dot Matrix Original: Scan an original that consists
primarily of thin or faint text at the optimum
level of image quality. Darken the text to improve
legibility.
Copied Paper: Scan originals containing uniform
density and that are printed on copier or printer, at
the optimum level of image quality.
Indicates the scanning resolution:
Color Mode

scanning documents in color mode.
JPEG: A file format widely used in digital cameras.
Suitable for saving photo data. This type does not
support the saving of multiple pages into one file.
TIFF: This is one kind of versatile image formats.
This type is available for a multipage file that
provides multiple pages in one file.
Indicates the appropriate image quality level for the

original and scan at the optimal level of image quality.
Resolution
PDF: (Default) Save to PDF format.

Compact PDF: Save to a file that has a smaller
size than normal PDF format. We recommend
this format when you want to reduce file size
for sending by e-mail or any other requirement
requiring smaller file sizes.
200x200dpi: Select this option to scan a standard

original.
300x300dpi: (Default) Select this option to scan a
standard original with higher resolution.
400x400dpi: Select this option to scan an original
containing small characters and drawings.
600x600dpi: Select this option to convert an
original into a file of the maximum size. This option
is available when scanning an original such as a
full-color photo, which requires a fine level of
image.
Indicates whether to scan the original in color or black

and white mode:
698
Option
Orientation
Indicates the orientation of the original being scanned.
Simplex/Duplex
TopScans from the top-left corner.

BottomScans starting from the bottom-right
corner.
LeftScans from the left edge.
RightScans from the right edge.
Indicates whether to scan on or both sides of the

original.
Binding Position
Description
Full Color: Scan in full color, regardless of whether
the original is in color or in black.
Gray Scale: Scan in gray scale, regardless of
whether the original is in color or in black and
white. Select this option to scan originals with many
halftones, such as black and white photos.
Black: (Default) Scan originals in black and
white, no shades of gray. Select this option to scan
originals with distinct black and white areas, such
as line drawings.
1-sided: Scan one side of an original.

2-sided: (Default) Scan both sides of an original.
Cover 2-Sided: Scan only one side of the first page
of the original, and scan both sides of the remaining
pages.
When scanning a double-sided original, specify the

binding position of the original in to prevent the
binding position from being reversed between the front
and rear faces.
Auto: (Default) Automatically configures the

binding position of the original. A page margin
position along the long side of the paper is selected
if the original length is 11-11/16 inches (297mm)
or less. A page binding along the short side of the
paper is selected if the original length exceeds
11-11/16 inches (297 mm).
Left: Select this option when the binding position is
set to the left of the original.
Top: Select this option when the binding position is
set to the top of the original.
Restricting Access to a Form

If authentication is required for the group containing this form, then you can restrict which users can use the form.
1. Select either Common Group or the name of the created group and then click Add Menu.
2. Enter a unique name for the menu name.
3. Optional: You can specify an icon image may be displayed for the menu on the device.
Option
Image type
Description
PNG or GIF with transparent background.
699
Option
Dimensions
Maximum size
Description
44x44 pixels
24 KB
4. Specify access to the form.

Public Access
Restricted Access
Allows all users to use the form.

Allows only users in the Allowed Users/Groups list
to use the form. If a user belongs to a group in the list
then this user can see the form (see group membership
criteria below).
Note: When the authentication type is
Windows, you can use the browse button
() to select Windows groups or users.
The browse button is disabled for other
How to add a dynamic form

You can modify the standard behavior of a form by responding to events. Some of the things you can do by enabling
dynamic form are:

Change field contents (for example, load the contents of a list field from a database).
1. Click Common Group, then on the Add Form menu, click one of the forms.
2. In form settings dialog box, select the Enable Dynamic Form check box.
events.
To
Do this
Use an existing script.

Edit a script
Click the browse button (...).

Click the Edit Script Code button to open a script
editor window.
For details about the script editor and the object model
used to respond to create and handle events, click the
help button
in the script editor to view the Konica
Minolta iOption Script documentation.
4. Select check boxes next to form events that must be responded to.
Select check box
Form is loaded
Form is submitted
To
Raises an event every time the user enters the form.
Raises an event every time the user presses Scan in the
form.
5. Select the Run as device logged in user check box if you need the script to run under the authentication context
of the logged on user.
This option is only available if the group requires authentication and the configured authentication mode is
Windows.
700
Caution: Whenever possible, specify user names and passwords in your script. Use this option only
in cases where you need to access a system that requires explicit identification. Use available .Net
technologies such as encrypting to hide the passwords from view when editing the script.
How to add fields to a form
1. Click the Fields tab to view the fields list.
2. In the Name column, type the name of the field.
are not allowed. The maximum number of supported characters for this field is 64.
3. In the Display column, type an alternative text to represent the field in the MFP panel.
If Display column is left empty, then the field name will be used instead.
4. Choose how the data for the field will be collected by selecting an option from the Type column. The following
field types are supported:
Field Type
Usage
Text
Allows users to enter unformatted text into a text box

such as sentences, names, numbers, date, and time.
List
Presents users with a list of choices from which users

Tree
Presents users with choices they can select from in tree

from.
Checkbox
Numeric
Date
Lookup List
Label
Button
Allows users to set yes/no or true/false values by

selecting or clearing a check box.
Allows users to enter numeric values.
Allows users to enter date values based on selected date
formats.
Allow users to dynamically retrieve values from an
ODBC Data Source
Displays informative text on a form.
Allows users to click a button to trigger customized
events on the server that manipulate a form.
You can click the browse button (...) in the last column of the table to configure properties for field. This displays
a properties dialog box with settings for the field type.
5.
Select the check box in the required field
column if the user must enter a value for the field.
6. Select the check box in the notify server on change column to trigger an event when the value of the field
changes.
You can respond to this event in the script that was configured for the dynamic form section in the general tab. For
details on how to respond to form and field events refer to the Konica Minolta iOption Scripting documentation.
7. To remove a field form the form, click in the first column to select the field row, and then press the Delete key.
How to configure, process, and route components
1. Click the Components tab to display the components list, and then click the Properties button.
This displays the configuration window for the component. Refer to the help for the component for instructions to
configure.
2. Select a component by clicking the leftmost column next to each component
3. Click on the browse button (...) in the configure column
to display settings for the component.
701
How to add a Send to Email form

Use a Send to Email form when you need to send the document to an email destination. A Send to Email form is
commonly used in conjunction with the Send to Mail Recipient component.
1. Click Common Group and then click Add Form > Send to Email Form.
2. Configure the name and scan settings for the form in the same way as for a basic form.
3. Click the Send to Email Fields tab and choose from the following options:
Option
Description
Do not show a From field. Use the

authenticated user's email address.
This will use the device logged on user's email address

check box to omit the From field. This is selected if the
user plans to use the email address of the user that is
logged onto the computer.
Show a CC Field
This will show the CC field in which the user can

specify a secondary list of people that will receive the
message.
Show a BCC Field
This will show the BCC field in which the user can
specify people that will receive the message secretly.
Global Address List
Allows the user to search the Global Address List for

addresses that can be added to the To, CC and BCC
fields. In the Display As box, type the display value
for this search option. Note that the Global Address
List that will be searched will be decided based on
following criteria:

authentication code populates the User name and
logged on user.

Exchange Contacts
Select this check box under the Contacts Search

Locations to allow users to search their Microsoft
Exchange contacts folder for addresses that can be
added to the To, CC and BCC fields.
In the Display As box, type the display value for this
search option.

If a secure socket layer (SSL) connection should
be used to connect to the Exchange Server, select
the Use SSL check box. Note that when Use SSL
is checked, if an icon appears on the device panel
702
Option
LDAP Server
Description
it will be the default Konica Minolta icon and not
the AutoStore icon. To have the selected AutoStore
icon displayed on the device panel the default SSL
port number should be changed to 443.
Select this check box under Contacts Search Locations
to allow the users to search an LDAP Server for
fields.
In the Display As box type the display value for

this search option.
In the LDAP Server box type the address or host
name of the LDAP server.
In the Search Root DN box type the distinguished
name for the node where the search should start.
For example: DC=Sales, DC=MyCompany,
DC=com. If this field is left empty then the starting
point of the search will be the root of the directory
tree.
In the Email Address field type the name of the
LDAP attribute that represents the email address.
In the Name Field type the name of the LDAP
attribute that represents the name of the user.
Choose the Login as Anonymous option to
server.
Select the Login with following credentials option
to log on to the LDAP server with the specified
User name and Password.
After you configure LDAP settings, click Test LDAP

to validate the settings.
How to add a Send to Folder form
Use a Send to Folder form when you need to send the document to a folder destination. A Send to Folder form is
commonly used in conjunction with the Send to Folder and Send to Folder eConnector components.
1. Go to the Groups tab. Select the group where you want to add the form to and click Add Form > Send to Folder
Form.
3. Go to the Send to Folder tab and configure the
a) In the Base Directory box enter the location of the directory that the user can browse to select the destination
of the document.
b) In the Default Document Name box, type the default name that will be used for the document name field.
4. Configure the components in the same way as for a basic form.
5. Click OK to save the form.
How to add a Send to SharePoint form
The SharePoint 2007 or SharePoint 2010 component must be installed before you can use a Send to SharePoint form.
Use a Send to SharePoint form when you need to send the document to a SharePoint 2007 or SharePoint 2010
server. This type of form allows users to browse document libraries, folders and list values at the device. A Send
703
to SharePoint form is commonly used in conjunction with the Send to SharePoint 2007/2010 eConnector and route
components.
2. Select the group where you want to add the form to and click Add Form > Send to SharePoint Form.
4. Click the SharePoint Document Library Settings tab and configure the following settings:
Option
Server Version
Description
Specify the correct version:
Server Address
SharePoint 2007
SharePoint Office 365
Enter the path to the SharePoint 2007 or SharePoint

2010 server where you will be storing the documents.
This field can contain "http://" or "https://" followed
by the server name or IP address. For example, both
http://sp2007 or https://192.199.292.255 will work.
The field can also contain only the server address, for
example, sp2007. In this instance, the component will
insert "http://" before the server address automatically.
User name
Enter the user name which will be used to log on to the

server.
If you are using a domain user account to connect to
SharePoint 2007 or SharePoint 2010, enter the user
name with the domain name. For example, enter
domain\SharePoint_username . If you are
logged into the server, you only need to enter the user
name, for example SpUser.
User Password
Enter the user password which will be used to log on to

the server.
Select this check box to allow users to provide a

document name that can be used in the file renaming
schema of the SharePoint 2007 or SharePoint 2010
component.
Site
Enter the name of the SharePoint site where you want

to store the documents.
This can be done either manually or by selecting a
value from the drop-down list. You can specify a subsite of the site by entering its name after the parent
site name followed by "/", for example SubSite1/
SubSite1_1.

at the MFP device panel to log onto the SharePoint
Server.
Document library
Enter the name of the default document library to

which you want to send the documents. This can be
704
Option
Description
done either manually or by selecting a value from the
drop-down list.
Allow user to Change Document Library
Select this check box to allow the document library to

be changed on the device
Default Folder

files will be stored, this can be done either manually
or by browsing to the desired folder. Click the browse
button (...) next to the box to open the Select Folder
dialog box.
Allow user to Change Folder
Select this check box to allow the folder to be changed

on the device. This option is always on if Allow user to
Change Document Library is selected.
Content Type

to the document. This can be done either manually or
by selecting a value from the drop-down list. Note that
the user will only be able to select a Content Type at
assigned to the selected document library; otherwise
the content type is assigned automatically.
Allow user to change Content Type
Select this check box to allow the content type to

be changed at the device. If Allow user to change
Document Library is selected then this option is
always on.
5. Configure the components in the same way as for a basic form.

Use the special RRTs provided to configure a Send to SharePoint 2007 and Send to SharePoint 2010 or a similar
component.
How to add a Send to Smarticket form
The Smarticket component must be installed before you can use this form type.
2. Select the group where you want to add the form to and click Add Form > Send to Smarticket Form.
4. Click the Smarticket Settings tab.
5. Configure Authentication options:
Option
Use authenticated user
credentials for browsing
Username
Description
If this check box is selected and authentication has
been enabled, then user credentials entered at the
MFP device panel will also be used to log onto the
Specifies a user name to be used for accessing the Web
service.
6. For Web Service Address, enter the machine name or IP address where the Web service is located, then click the
Test button to test the address setting.
The address format depends on whether SSL is enabled:
705
SSL
Address
Enabled
https:// server name : port -or-https:// ip address :

port
Not enabled
http:// server name : port -or-http:// ip address : port

7. Under General options:
Option
Display ticket ID with ticket name
Description
Select this check box to display the ticket ID as well
as the ticket name in the list of Smartickets. Clear this
check box to display only the ticket name in the list of
Smartickets.
8. Configure the components in the same way as for a basic form. Use the special RRTs provided to configure a
Smarticket or other component.
2. Right-click the form you want to save, and click Save as Template on the shortcut menu.
3. Enter the location where you want to save the template.
If dynamic form is enabled then you have the option of copying the associated .Net script to the same location
where the template will be saved.
4. Select Save.
If the operation is successful you will see a message indicating that the template was saved.
1.
2.
3.
4.
Click the Groups tab.

Click on the group where you want to add the form.
Click Add Form > From Template.
In the Template file box, enter the location of the template.
This must specify a form template saved previously with Save as Template.
5. In the Dynamic Form script file box, enter the location of the .Net script file associated to the template.
6. Click Create.
How to edit a form
You can perform the following actions to edit forms.

To
Do this
Edit a form
Click the form to select it, then click the Edit button.
You can also either double-click a form or right-click a
form and click Edit.
Cut or Copy a form

shortcut menu.
Paste a form
To paste a form that has been cut or copied, right-click

a group or menu, and click Paste on the shortcut menu.
Delete a form
button.
706
To
Do this
Reorder forms
A form can be moved up or moved down with respect

to how the form is displayed on the device panel.
Right-click the form and click Move Up or Move
Down on the shortcut menu.
Field types
Button field options
A button field displays a button on the form.
Option
Description
Text
Enter the text to display on the button.
Hide Field Label
Controls whether the displayed text for the button is

shown. The default is to hide.
Visible
Controls whether the button is visible on form.
Enabled
Controls whether the button is enabled on form. When it

is not enabled, the button will not trigger events on the
server.

A Checkbox field allows users to select or clear a check box to specify a Boolean true/false state.
Option
Description
True Value

if the check box field is selected.
False Value

if the check box field is cleared.
Checked by Default

initially selected when a user opens the form.
Date field options

A date field allows users to enter dates.
Option
Description
Date format
Specify the return format for date/time data. Use a drop

down list for format examples. For more information, see
Date Formats.
Select this check box to restrict dates to the range

specified in the From and To boxes.
Date formats
Refer to this table for the date formats. There may be more or fewer patterns than those shown in the table.
To select a date range, select the Restrict to date range check box and enter the start and end for the range in the
From and To boxes.
Date type
Device Short Date
Description
language setting.
Examples
12/31/2012 (en-US)
31/12/2012 (fr-FR)
31/12/2012 (es-ES)
707
Date type
Description
Examples
Device Long Date

language setting.

lunes, 31 de diciembre 2012 (esES)
Montag, 31. Dezember 2012 (deDE)
MM/DD/YYYY

delimited.
12/31/2012
MM-DD-YYYY

delimited.
12-31-2012
DD/MM/YYYY

delimited.
31/12/2012
DD-MM-YYYY

delimited.
31-12-2012
YYYY/MM/DD

delimited.
2012/12/31
YYYY-MM-DD

delimited.
2012-12-31
MM.DD.YYYY

delimited.
12.31.2012
DD.MM.YYYY

delimited.
31.12.2012
YYYY.MM.DD

delimited.
2012.12.31
When using the Date field in scripting, day (DD) and year (YYYY) designations must be in lower case. "DD" should
be "dd" and "YYYY" should be "yyyy". For example, when the format MM/DD/YYYY is required in scripting, the
format should actually be MM/dd/yyyy. This applies to all of the date formats that use day (DD) or year (YYYY)
designations.
Label field options
A label field displays a label in a form. Label field options define the appearance of the label in a form.
Option
Description
Text
Enter the text that will be displayed on the device panel.
Hidden
Select this check box to hide the label field from the user.
The label field will not be visible on the device panel.
This is useful for passing data to the workflow without
displaying information on the panel.
Visible
Controls whether the label is visible on form.
Enabled
Controls whether the label is enabled on form. When it

is disabled, the label will appear in italics and will be
grayed-out.
List field options
708
A list field allows users to select from items in a list.

Option
Description
Value
Label

the label that is displayed on an MFP.
Description
This value in this field is displayed in the details section

of the user interface. This option is only available with
device panels that display in color.
Default

items. When this option is selected, the value of the RRT
will be the selected values separated by semicolons (;).
Allows the user to add new values.
Causes the field to raise an event when the user presses

the search button. With device panels that display in
black and white, the button is labeled Search. With
device panels that display in color, the search button is
displayed only as a search icon. You can respond to this
event in the script that was configured for the dynamic
form section in the general tab. For details on how to
respond to form and field events refer to the Konica
Minolta iOption Scripting documentation.
Maximum number for search results to display
Specifies the maximum number results to be listed after

the user presses the search button.
Import Items

reuse fields from a previous list.
Export Items

separated value (CSV) file. This allows you to reuse a
list.

A database lookup field allows users to specify items from a field a database table.
Option
ODBC Data Source
Description
Select the desired ODBC data source.
Only system data sources can be selected as a data
source. If no ODBC Data Source was previously created,
a new ODBC Data Source can be created by selecting
the <New> option.
User ID
Specifies the user ID for connecting to the ODBC data

source. This field is optional. If no entry is made, then
709
Option
Description
the user account running the AutoStore service will be
used.
Password
Specifies the password that corresponds to the User ID
Connect
Check this button to validate the Data Source settings.
Table View
Choose Table/View to select the table or view, and then

specify settings for the specified table or view:

from which values will be loaded into the lookup list
(required).
displayed in the lookup list (optional).
names displayed in the lookup list (optional).
If nothing is entered for Display Column, those values

listed from the Value Column will be displayed.
Additionally, the descriptions from the Description
Column will be displayed in the details section of the
panels that display in color. See List field options for
more information.
Query
Choose this option to require the user to enter a SQL

query. The SQL query will produce the results to
populate the list. For more information on SQL scripting,
see General SQL syntax.
Maximum number of rows to preload

displayed. The maximum number of rows which can
be preloaded is 1000. If more than 1000 rows must be
searched, the user can use the search option located
on the device panel. When Query is chosen, then only
preloaded rows will be searched.
Allows the user to make multiple selections based on the

results populated within the lookup list.
Allows users to insert their own values into the lookup

list.

value is 1000.
General SQL syntax

A simple SQL query:
from <Table>
710
A select statement can also return a single column:
select <ValueField>
from <Table>
A conditional select statement:
from Customers
A conditional select statement using wildcard symbols:
from Customers
SQL wildcard syntax is used with the like operator. The wildcard % is used to specify a wildcard for one or more
character.
Workflow form.
RRT pattern takes the following format: ~KMW::%FieldName%~.
It is important to note that the % symbol used with RRT patterns does not function like the "%" symbol used for
wildcard based searches. With RRT patterns, the entire RRT pattern will be replaced with the field value that was
entered by the user from the Workflow form.
Example:
from Customers
where Customer Name like ~KMW::%Customer%~
In this example, the Workflow form has the RRT pattern "Customer". Once a user enters a value for Customer, ~
KMW::%Customer%~ will get replaced with the value of "Customer".
from Customers
Note that RRT patterns within SQL select statements can be used with other SQL syntax such as wildcard characters.
The following would be a valid SQL statement:
from Customers
where Customer Name like %~KMW::%Customer%~%
711

An numeric field allows users to enter numbers.
Option
Description
Default

device panel.
Minimum

Maximum

Precision
The number of digits after decimal point. If the precision

is set to zero, then the device will only accept whole
number values. If the precision is set to a value greater
than zero, then the user may select the * button on the
device to input a value that requires a decimal point. The
default is 0. The maximum is 5.
Text field options

A text field allows users to enter unformatted text, such as sentences, names, numbers, date and time.
Option
Description
Default

the device panel.
Mode
Select the list type:

text box.
HiddenThe field will not be visible on the control
panel.
Tree field options

A tree field allows users to select items from a tree.
To add the first node, click the Add button. To add additional nodes, click the node that you want to be the parent
node and then click Add. This opens the Add/Edit Tree Item dialog box.
To edit a tree node, click a node and then click Edit. This opens the Add/Edit Tree Item dialog box.
To remove a tree node, click the node and then click Remove. This removes the node and any child nodes.
Table 44: Add/Edit Tree Item options
Option
Description
Display Text
Enter the label for the node.
Value
Enter the value for a tree node. This is the value that will
be sent to the server.
How to configure Konica Minolta iOption preferences
712

2. In the Home Directory box, enter the root directory where the server will create all temporary directories and files
necessary for running the application.
The default is 3348.
4. Select the Use SSL check box to secure the connection for Open API, WebDAV and the web server.
a) From the Choose Certificate option list, select to browse for an existing certificate or to create a new selfsigned certificate.
b) In Certificate Password, enter the password for the certificate.
If you created a self-signed certificate, this value will be automatically entered into the field based on the
information you provided when creating the certificate.
5. In the FTP Port box, enter the port on which the embedded FTP server will be running.
This will be used to receive files from the device over FTP.
6. Select the Processed files check box to keep a copy of all files that are processed without errors.
Enter the directory where these files will be kept.

Important: If this option is enabled, a copy of every file that has been routed successfully is saved in
the Processed Files directory. Make sure that sufficient disk storage is allocated if you select this
option.
7. Select Rejected Files to keep a copy of all files that failed to be process entirely.

Important: The service account for the service must have write permissions on the Processed
Files and Rejected Files directories.
8. In the Open API Port box, enter the port on which the Open API service will be running.
The default is 3351.
A Konica Minolta iOption device registration requires the OpenAPI port setting to be configured. If the device
has problems communicating, ensure the port setting configured here matches the value that is set for the device
through Device Registration Service. Also ensure there is no firewall software or hardware blocking the specified
port and that IP-routing has been set up to allow communication on this port.
9. In the WebDAV Port box, enter the port number on which the embedded WebDAV server will be running.
This references the port that will accept incoming files through HTTP. The default value for an unsecured
connection is 3391. The default value for a secured connection (SSL) is 443.
Authentication
By enabling authentication at this level (by selecting this tab), the user is enabling authentication at a global
level. This authentication procedure will be used for all devices. The user does also have the option of enabling
authentication at the group level.
2. On the drop down menu for Authentication Type, select the authentication method you want to use:
Option
Windows
Description
This will prompt the user for a Windows user
name, domain and password. Enter the default
domain in the Domain box under Windows.
example, if the user is listed as mydomain/user1
713
Option
Custom Scripting
Description
"mydomain", not "mydomain.domain.com".
are validated.
Note: LDAP may be used for authentication of lookup data.

Custom Scripting authentication
1. Configure the prompts that will be used to collect user information.
a) Click the Prompts button.
b) To add a prompt type the name of the prompt in the Name column in the prompt list.
c) In the Display column, type an alternative text to use as the label for the prompt at the MFP.
If the display value is left empty then the prompt name will be used as the label as well.
d) In the Default column, type a default value for the prompt (this is optional).
e)
Select the
Required check box if the user must enter a value for this prompt.
f)
Select the
Masked check box if the prompt text that is displayed at the device panel should be masked for
security.
g) Click OK.
2. Enter the path to the VB.NET script that contains the code that will authenticate the user after he has filled the
prompts at the device.
If you have an existing script you want to use you can click the browse button (...) next to the Script File box.
You can also click the Edit Script Code button to open a script editor window with basic script code.
For details on the script editor window and the object model used to authenticate users please refer to the Konica
Minolta iOption Script help by clicking Help in the script editor window.
3. Select the Use an LDAP search to retrieve additional information check box if you need to look up the email
address and other attributes about the authenticated user.
Note: When windows authentication is selected the email address is retrieved automatically as part of the
authentication, so an LDAP search is not required if only the email address is needed.
4. If you select the Use an LDAP search to retrieve additional information check box, click Configure to enter
the settings for the LDAP search:
Option
LDAP Server
Description
Root DN
Type the distinguished name for the node where

the search should start. For example: DC=Sales,
DC=MyCompany, DC=com. If this field is left empty,
then the starting point of the search will be the root of
the directory tree.
Login as Anonymous
Select this check box to allow anonymous connections

to the LDAP server.
Login with following credentials
Select this check box to log in to the LDAP server with

the specified user name and password.
Directory Type
Select the type of directory that it will be searched, if

an option other than Custom is selected then predefined
attributes will be used to match the authenticated user
name and retrieving the email address.
714
Option
Description
This option configures a variable that can only be

changed by the system administrator. Check with your
system administrator to adjust this settings.
This option configures a variable that can only be

changed by the system administrator. Check with your
system administrator to adjust this settings.
Additional Attributes
Type the name of the user attributes separated by

a semicolon. If no attributes are specified in this
box then only the email address will be retrieved.
These attributes will be available as user attributes
replacement tag names (URTNs). For more information
about URTNs supported by this component, see Konica
Minolta iOption Component RRT.
5. To test the search settings, enter a sample user name in the Username box and click Test.
Using authentication in AutoStore in combination with authentication at the device
Using no authentication (option None in the Authentication tab):
The user will be taken directly to the device menu.

~SenderRRT variables will use device credentials.
Using Windows authentication ~SenderRRT variables will use device credentials and the user will be taken
directly to the device menu in the following cases:
The device has been configured to use Windows authentication.

The device has been configured to use third-party authentication that passes valid Windows credentials (name
and domain). If the domain is not passed, then the user must be in the default domain that has been configured
for Windows authentication.
In any other cases the user will be prompted for credentials.

Using an authentication method based on a Custom Script.
If the custom script has prompts configured, the user will be shown a login screen where the specified prompts
must be re-entered. The associated script will have access to device credentials in addition to the prompt
information (for details on the object model used in authentication scripts see the Konica Minolta iOption
Scripting documentation). ~SenderRRT variables will use credentials based on the results of the script.
If the custom script does not have prompts configured, the initial login screen is skipped and the associated
custom script is invoked immediately and the associated script will have access to the device credentials. If
the result of the script is that authentication is not valid, then the user will see an error message. At this time
the only option for the user will be to Exit. If the authentication is valid, ~SenderRRT variables will use
credentials based on the results of the script execution.
Konica Minolta iOption component RRTs

Component RRT ID
The RRT ID for this component is KMW.
Name
FormName
Description
Name of the form.
715
Name
Description
Sender

This RRT is populated in the following cases:

Authentication has been configured for the device.
SenderEmail
SenderDomain
The authenticated users domain name.

This RRT is populated in the following cases:

authentication.
authentication and the associated Script.NET script
object.
IP
HostName
ServerIP
The IP address of the Konica Minolta iOption

application server associated with the device.
ServerHostName
Host name of the Konica Minolta iOption application

server associated with the device (IIS server host name).
PageCount
Format
FileSize
PDF
JPEG
TIFF
Compact PDF

example provides some examples:
~KMW::%ClientID%~
This is replaced by "Company" if the user types in

"Company" for the field name called "Client ID".

This component supports URTNs and replacement of user attributes specific to the authentication method used. The
following example provides some examples:
If Custom authentication is used and there is a user attribute named "Full Name" with the value" John Doe" then the
RRT will look like:
716
The RRT
~KMW::User,%FullName%~ will be replaced by "John Doe"
Attributes box, then for an authenticated user which displayName is "Jane Doe":
The RRT ~KMW::User,%displayName%~ will be replaced by "Jane Doe"
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Problem Description
Cause
The following error message is

displayed you start the AutoStore
server:
The default port 3348 for Konica

Minolta iOption is being used by
Konica Minolta
iOption: An error
when initializing web
application. Failed
to listen on prefix://
+:3348/ because it
conflicts with an
existing registration.
Solution
Check if the 3348 is being utilized by
If you have Output Manager server
installed on the same machine
as AutoStore server and 3348 is
assigned as Konica Minolta web
service port, either change the
Output Manager server port to 0
(unassigned) or to a value other than
3348.
717
Konica Minolta MFP

Welcome to Konica Minolta MFP
The Konica Minolta MFP Capture component allows users to capture documents from any Konica Minolta MFP that
supports the OpenAPI platform ("Scan to Application with Jobticket function v2.0 and greater). These documents
can then be sent to any of the route destinations that are supported by the Workflow server. When scanning documents
with the MFP, users can provide information about the documents (metadata entered in previously created fields) that
can be used to identify and route the documents appropriately.
The Konica Minolta MFP Capture component provides the following features:
Allow different sets of forms to be used with groups of devices.

Support for List, Text, Checkbox, Numeric, Date/Time, Label, Tree, Folder Browser and Database Lookup field
types to provide document indexing flexibility.
Windows and Novell authentication at the MFP panel.
In addition to Windows and Novell authentication, custom authentication allows you to configure additional
authentication methods (using the .NET scripting interface).
Limit form access based on authentication (Groups, Users).
Ability to create Email, SharePoint, and SMARTicket forms.
Easily manage device groups by using import/export and network device discovery functionality.
Device setup and configuration

Devices are added and managed in the Konica Minolta MFP Device Manager, which can be opened by clicking
the Device Manager button in the Konica Minolta MFP settings dialog box. The Konica Minolta MFP Device
Manager only configures devices for a single task, so different tasks can use different devices. Konica Minolta
devices configured in a task are not shared with other tasks.
Important: After you run the setup package for the 6.0.0.42 update (released in May 2014), you must update
the device list and configuration file for the component. For instructions, see the last item in Troubleshooting
tips.
Device prerequisites
To use a Konica Minolta MFP device with AutoStore, the device must be OpenAPI enabled and OpenAPI
communication needs to be turned on at the device. Make sure the device has the newest possible firmware installed.
The MFP must also support the Scan to Application with Jobticket function of the KM OpenAPI platform (version
2.0 or later).
Sharing devices between tasks
The Konica Minolta Device Manager only manages devices for the current task. Each task saves device information
in its own uniquely named device file. To copy MFPs from one task to another, use the Import and Export
functionality in Device Manager.
For backwards compatibility, if the device file (KMOAPICapture.dat) already exists the first time that you use
this release of the Konica Minolta MFP component, all devices specified in the device file are automatically imported
and saved to a new device file that is only associated with the task. After this one time import, we recommend that
you back up and remove the KMOAPICapture.dat file from the following folder:
C:\Program Files (x86)\NSi\AutoStore Workflow 6\Distributables\Konica

Minolta
If you do use the same device in different tasks, the Open API Application ID setting on the Preferences tab must
be unique to each task. The label specified by the AutoStore Button Text on the MFP setting in the Group options
should also be unique to each task.
718
How to set up device connectivity

You must register the AutoStore application on MFP devices before they can be used to capture documents with the
Konica Minolta MFP component.
Before you perform this task, make sure that the Konica Minolta MFPs are OpenAPI enabled and ready for operation.
Konica Minolta MFP devices can be added and registered while the workflow server is running. There is no need to
restart the server after adding or listing new devices.
1. On the General tab of the Konica Minolta MFP component configuration dialog, click Device Manager.
2. Enter the IP Address and login credentials to register Konica Minolta MFPs on the workflow server (duplicate
entries are not allowed).
You can click the Discover MFPs on the network button to search for MFPs.
Note: When MFPs are located using the Discover MFPs on the network option, the default login name
admin will populate the Admin login name column.
3. You can save changes and register the AutoStore application on any new devices or update registrations on
selected devices.
To
Do this
Save changes to the list and

register AutoStore on new devices.
Update registrations on
selected devices in the list.
Click the Save button.

Select the devices you want to update and click the
Update button.
Note: To reregister the AutoStore application on all devices, click the Device menu, and then click Force
Update.
The Registration Status column will shows the current state of the AutoStore application registration process.
Possible values are: Registered, Found or Similar version app name, Pending, Registered,
Present, and Similar. The column will also information such as application number, function version, and
application name.
4. Click the OK button to complete this task.
After the AutoStore application is registered on a device, the device is able to scan the workflow server when a task is
run.
How to scan a document from a Konica Minolta MFP
Use AutoStore menus and forms on a registered device to capture documents.
1. On the main screen, press the APP button on the left-hand side of the panel and then select AutoStore.
If there are no other applications installed on the device, the button is renamed AutoStore.
2. Select the form to be scanned.
If authentication is turned on, the device must be first authenticated.
3. Enter information in the fields.
4. Press the Scan button to scan the document.
How to remove applications from a Konica Minolta MFP
Use Device Manager to remove applications from a Konica Minolta MFP device.
To change the custom icon for menus and forms in the application, you need to delete the application so that it can be
reregistered on the device. As long as an MFP is listed in the Device Manager, AutoStore will continue restoring the
application button on the MFP managed by the AutoStore server even if an application is deleted by this procedure.
2. In the Application list column for a device, click the browse button (...).
This opens a window listing all the applications (both AutoStore and third-party) registered on the MFP.
3. You can click the Refresh button to refresh the list of applications.
4. Select the application you want to remove.
719
5. Click the Delete button to delete a selected application from the device.
6. If you are prompted whether to remove the application button from the MFP, click Yes.
7. Close the application list dialog.
Deleting the application removes any mappings between the application and hardware keys. To restore key mappings,
press the following sequence of commands on the device console: Utility > Administrator > Register Key
Settings > key number > application or folder.
Note: You will need to enter the administrator password to complete the sequence of commands.
How to remove an MFP from Device Manager
This procedure describes how to remove an MFP from the Konica Minolta MFP Device Manager.
AutoStore will reregister an MFP if you only delete an application without also deleting the device.
2. In the Device Manager window, find the device that you want to delete and click in the first column of the table
to select the entire row.
3. Click the Delete button or press the Delete key.
4. Optional: Device Manager prompts whether to display the Application List dialog box to optionally remove
applications from the MFP device.
a) Click Yes to display the Application List dialog box.
b) Select any application to be removed.
c) Click the Delete button.
5. Click OK.
Completing this procedure removes the MFP from the Device List, and AutoStore will discontinue updating the
AutoStore button on the MFP.
Supported devices
The Konica Minolta MFPs should support the "Scan to Application with Jobticket function of the KM OpenAPI
platform (version 2.0 or later).
Supported Open API Versions and available AutoStore features:
AutoStore
Features/
Open API
version
Assigning
Icons to
Menu
and Form
Buttons
2.0
2.1
2.2
3.0
3.1
3.5
3.6
No
Yes
Yes
Yes
Yes
Yes
Yes
Transmitting No
scanned
files via
WebDAV
Protocol
No
Yes
Yes
Yes
Yes
Yes
PageCount
RRT
No
No
No
No
Yes
Yes
Yes
Field
Change
Event
No
No
No
No
Yes
Yes
Yes
720
AutoStore
Features/
Open API
version
2.0
2.1
2.2
3.0
3.1
3.5
3.6
Tree Field
(requires
Field
Change
Event)
No
No
No
No
Yes
Yes
Yes
Folder
Browser
(requires
Field
Change
Event)
No
No
No
No
Yes
Yes
Yes
E-mail
Sub form
(requires
Field
Change
Event)
No
No
No
No
Yes
Yes
Yes
SharePoint
Sub form
(requires
Field
Change
Event)
No
No
No
No
Yes
Yes
Yes
Note: Refer to the Notable Solutions website for the most recent list of supported devices.
Using the Konica Minolta MFP component
Design and create a process that lets the users scan documents via the Konica Minolta MFP and store the documents
in a network folder. This process consists of the Konica Minolta MFP Capture component and the Send to Folder
Route component.
First drag and drop the Konica Minolta MFP Capture component into the Process Viewer. Next, drag and drop the
Send to Folder Route component into the Process Viewer.
Configure Preferences and Authentication settings for the Konica Minolta MFP Capture component.
Create a form.
Connect a device to the AutoStore server.
When the device is fully configured to connect to the AutoStore server, a list of forms will be displayed at the
device.
Scan a document from the device using one of the configured forms.
Adding icons to a task

You can create icons for Konica Minolta forms. These should be saved in Portable Network Graphics (PNG) format,
48x48 pixels, and 8-bit color density (256 colors). You can use any image editor that supports this format to create an
icon. For instructions on how to create an icon using the PictBear freeware program, see Image Configuration. You
can follow the same general steps to create an icon image with a different image editor.
After you create icons, use the Icon button on the General tab of the Konica Minolta MFP settings to add or edit
icons in a task. When you add an icon to a task, it is copied to a .pnl file. The icon will only be available to forms
721
in that task, although you can add either the .pnl file or the original .png file to other tasks. The Konica Minolta
component stores icon files in its Drop Here folder.
How to add an icon to a task
This procedure describes how to add icons to a task.
1. Double-click the Konica Minolta MFP capture component in a task to open its properties.
2. At the top of the General tab, click the Icons button.
This opens the Icon List dialog box.
3. Click the Add button, and in the Open dialog box click the icon file (.png or .pnl) to add to the task.
Tip: In this dialog box, you can paste PNG image files copied from another folder in Windows Explorer
or My Computer into the Drop Here folder.
4. Click Open to add the file.
5. When you are finished adding files, click OK to close the Icon List dialog box.
After you complete this procedure, you can use an icon for a form by clicking the browse (...) button next to the Form
icon box in the form properties. For details about for options, see Forms.
How to edit or remove icons in a task
This procedure describes edit, replace, or remove an icon in a task.
1. Double-click the Konica Minolta MFP capture component in a task to open its properties.
2. At the top of the General tab, click the Icons button.
This opens the Icon List dialog box.
3. Click the icon file in the list that you want to remove or edit.
To remove the file, click the Remove button.
To replace the icon with a different file, click the Edit button.
4. When you are finished editing or removing files, click OK to close the Icon List dialog box.
How to configure an image
This topic details how to configure an image for the Konica Minolta component using the PictBear freeware software.
Before you perform this procedure, download and install PictBear image editor from the PictBear download web
page.
1. Open the PictBear application.
2. Open the image file.
In this example, we open the file backup_44.png.
3. Magnify the scale to 800%.
4. Click Image > Canvas Size.
5. In the Canvas Size dialog box, change the Width to 48 and Height to 48, then click OK.
6. Click Image > Image Type > Index Color. This displays the Index Color dialog box:
7. Click Edit Palette > Open, and select the file labeled mosel_256_01.plt.
This file can be found in install directory\Distributables\Konica Minolta.
8. Click OK repeatedly until you return to the main window.
9. Click the Magic Wand tool, which is located on the toolbar on the left side of the workspace.
10. In the View window, click the Options tab, and set "Color Range" to 10.
11. In the image window, click the white space to select the entire background.
722
12. Click the Flood Fill tool, which is located on the toolbar on the left side of the workspace.
13. In the Palette window, click the Samples tab and select magenta (R:255, G:0, B:255), which is the first color in
the palette.
14. Click on the white space to change it to magenta.
15. Save your changes (make sure to keep the image in PNG format).
16. The image can now be used in the Konica Minolta component.
For instructions about how to do this, see Adding Icons to a Task.
Configuring the Konica Minolta MFP component
General tab
This tab defines the menu structure that is displayed by the Konica Minolta MFP component.
structure. By default there is a single group called Default Device Group. If no additional groups are configured, all
devices pointed to the workflow server will display the menu structure under the Default Device Group.
connected to the same workflow server for different functions. Drag and drop functionality is available to change the
order of menus and forms that appear on the MFP control panel.
723
Option
Description
Add
Click Add and then click Group, Menu, or Form to add

one of the following:
Group
Menu
Form
Shared Form
Note: Addition of elements is dependent on
whether you click Group, Menu, Application,
Form, or Shared Form on the Add menu.
Edit

Remove

Group options
A group specifies the forms which will be displayed at the device along with the corresponding repository to be used.
Additionally, authentication is enabled on a per-group basis.
To add a group, click any node of the group/menu/form tree and click Add > Group of Devices on the toolbar. To
edit an existing group, click the group and click the Edit button. To remove a group, click the group, and click the
Remove button.
General tab
Option
Description
Name
Specify the name of the group. This name does not

identification and configuration purposes.
Repository Type
Specify one of the two modes used by the component to

send files from the device to the AutoStore server:
FTPFile Transfer Protocol is a standard network

protocol used to transfer files from one host or to
another host over a TCP-based network.
WebDAVWeb Distributed Authoring and
Versioning is an extension of the Hypertext Transfer
Protocol (HTTP) that facilitates managing documents
and files stored on World Wide Web servers.
Select this check box to use authentication preferences

that were set on the Authentication tab located on the
Konica Minolta MFP properties dialog box.
Highest Allowed OpenAPI Client Version
Refers to the client SDK version used on the device.

A version can be selected. Auto Detect is selected by
default. With Auto Detect, the highest OpenAPI Client
version found on the device will be used.
In the MFP Address field, type the IP address for a

device that you want to associate with this group. A
user can also Import and Export lists here or Discover
724
Option
Description
MFPs on the network using the buttons. This option
is only configurable in custom groups and not in the
default group. A device can only belong to one group
other than the default group. The component displays an
error message if you attempt to add a device to a second
group.
AutoStore Button Text on the MFP
Allows for the customization of the text of the AutoStore

application button registered on the MFP.
Type the label that you want to appear on the AutoStore
button on the MFP. If you do not specify a value here,
the label on the button will be AutoStore or AutoStore
Express, depending on the installation package. Before
changing this text make sure that you have unregistered
the application with the old name. Otherwise the MFP
will display two buttons, one with the old name and one
with the new name.
Authentication tab
See Authentication Tab for information about configuring options on the Authentication tab.
Menu options
To add a menu, click an existing group or menu item and then click Add > Menu on the menu bar. To edit an existing
menu, click the menu and click the Edit button. To remove a menu, click the menu, and click the Remove button.
Option
Description
Display Text
The displayed name of the menu.
Menu Icon
The icon that will be associated with the menu. Enter

the path where the image is stored. The image must
be a 48x48 PNG file with 8-bit color depth. See Image
Configuration for more information.
You can right-click a menu and use shortcut commands to Cut, Copy, and Paste menu items. To move a menu item
in the hierarchy, right-click the menu and click Move Up or Move Down.
Forms
Add a form to workflow when the process needs to capture data prior to a scanning process. There are several
different forms that you can use to capture information for different processing and routing options.
Add a form on the Groups tab of the Konica Minolta MFP configuration dialog box. To add a form, first, click a
group or menu node, then click Add > Form on the menu bar, and finally click one of the form types on the menu. To
add a shared form, click Add > Shared Form on the menu bar. To edit an existing form, click the form and click Edit
on the menu bar. To delete a form, click the form and click Remove on the menu bar.
Basic form
To add a basic form to a process, click any group or menu node on the General tab of the Konica Minolta MFP
configuration dialog box, and then click Add > Form > Basic Form on the menu bar. A basic form can be also added
by right-clicking any group or menu node, and clicking the Form > Basic Form on the shortcut menu.
General tab
725
Fields tab
Components tab
General tab
Option
Description
Name

Single Touch Mode

Form Icon

the path where the image is stored. The image must be
a 48x48 PNG file with 8-bit color depth. See Image
Configuration for more information.
Access Control
Scan Settings
Dynamic Form

the form.

document will be rendered in FullColor, Grayscale,
or B&W. If a device can only scan in monochrome
then all scans, regardless of specification, will be
monochrome.
File FormatChoose PDF, Compact PDF, JPEG,
or TIFF.
check box allows the workflow sever to load form

726
Option
Description
Snap-in pathThe path to the source code of

the snap-in created by the built-in snap-in editor.
When the user provides a path, the source file will
be compiled at startup time and will take precedence
over the Snap-In path.
snap-in created by the built-in snap-in editor. When
the user provides a path, the source file will be
compiled at startup time and will take precedence
over the Snap-In path.
Create/Edit Snap-inYou can click this button
to open a code editor window with basic snap-in
code. For details of the code editor window and
the object model used to respond to form and field
events, refer to the Konica Minolta Component SnapIn documentation by clicking Help in the code editor
window.
Raise event when:

enters the form.
Fields tab
Configure the indexing fields that will be presented to the user. Add fields by entering data in the last line, which is
marked in the first column by the asterisk (*).
Column
Description
Name

if the field name is "Field1", the RRT is ~KMO::
%Field1%~.
Display

panel.
Type

to

Database LookupAllow users to choose values
from a database field.
Date/TimeAllow users to enter date and time
727
Column
Description
Folder BrowserAllow users to browse for choices

in a form.
LabelEnter a text label as an index value within a
form. There can be none or several free-form labels
in a form.
ListAllow users to select from a list of choices
be made searchable.
NumericAllow users to enter numbers (with or
TextAllows users to enter plain text.
TreeCreates a tree choice control in a form.
(Required)

section in the General tab.
(Notify server)

(Properties)
Components tab
browse button (...) in the C (configure) column for a row. This opens the configuration dialog box for the component.
Email form
Use an Email form when you need to send the document to an email destination. An Email form is commonly used in
conjunction with the Send to SMTP and Send to Exchange Route components.
An email form can be added by right-clicking any Group or Menu node, pointing to Add and then clicking Email
form. An email form can also be added by clicking any Group or Menu, clicking the Add menu, pointing to Form,
and then clicking Email Form.
Refer to the Basic Form Options to configure settings on the General, Fields, and Components tabs.
Option
Description

"From" field.
Show CC Field

Show BCC Field

secretly.
728
Option
LDAP Server
Description
CC and BCC fields.
A user may enter specific email addresses for To, CC
and BCC on the device console. The user may also
search for email address within the domain by pressing
Search. The user may search for a specific name by
selecting the Address button and entering that name and
then selecting Search. Once an email address is selected,
the email address is appended to the entries for To, CC or
BCC.
Search Root

with "LDAP://".
For more information to Search Root Patterns.
Authentication
Specifies credentials for the email server.
TypeThe type of authentication for accessing the

email server.
Anonymous
Windows
SSL
Simple
UsernameAn authorized user name on the email
server.
PasswordThe password associated with the user
name.
Name Attribute
Enter the name of the LDAP attribute that represents

the display name of the user. In an Active Directory
environment this attribute is typically "cn" or
"displayName". When a value is found the display text
for the item is retrieved from this attribute.
Email Attribute
Enter the name of the LDAP attribute that contains

the email address. In an Active Directory environment
this attribute is typically "mail". When a value is
used the email address that is passed to the server is
retrieved from this attribute, a valid value for a Windows
environment LDAP would be "mail". (LDAP attribute
names can vary depending on the LDAP implementation
and configuration).
Note: If the LDAP server is an Active
Directory server, then NTLM authentication
will be used.
Test Search Pattern
To test search settings, enter a search term in this box,

then click Test.
You can use the * wildcard character in the search
pattern. Examples of search patterns:
729
Option
Description
EmptyReturns all available entries.

abcReturns entries which start with "abc".
*xyzReturns entries which end with "xyz"
*klm*Returns entries which have "klm" anywhere
in the content.

Directory domain.

Directory domain.

Empty
empty.
Result
Server belongs.

Example: LDAP://
empty.
directory server.
Example: LDAP://


used
server.
directory server.
Example: LDAP://
Standard LDAP: 389

LDAP over SSL: 636
SharePoint form
730
A SharePoint form can be added by clicking any group or menu node, and then clicking Add > Form > SharePoint
Form on the menu bar. A SharePoint form can be also added by right-clicking any group or menu, and then clicking
Add > Form > SharePoint Form on the shortcut menu.
Refer to the Basic Form Options to configure settings on the General, Fields, and Components tabs.
Option
Description
Server Address

Version
Authentication
SharePoint 2007
Domain\Username: Enter the domain and user name

that will be used to log on to the SharePoint Server in
the format domain \ username .
Password: Enter the password for the specified user
name.
Use MFP user credentials whenever possible:
When this check box is selected, user logon
credentials from the device will be used to log on to
the SharePoint Server.
Site

documents will be stored. The user can enter the name
of the SharePoint site or select from the drop-down
box. The user can specify a sub-site using the following
format: parent-site/sub-site.
To allow the SharePoint site to be changed at run time,
select the Allow to Change check box.
Document Library

documents will be sent. The user can enter the document
library or select from the drop-down box.
To allow the document library to be changed at run time,
select the Allow to Change check box.
Default Folder

files will be stored. The user can enter the location of the
default folder or browse to select the default folder.
Enable All Fields in Library
Select this check box to enable all SharePoint Fields. If

this option is not selected, individual SharePoint fields
can be selected. These selected SharePoint fields will be
displayed on the MFP.
Button Size
Options are Large, Medium and Small.
Field Count:
Shows the number of fields that will appear on the form.

These include both standard fields for the form type and
fields defined on the Fields tab.
731
Smarticket form
Use a Smarticket form to capture and process Smartickets with a Konica Minolta MFP.
A Smarticket form can be added by right-clicking any Group or Menu node, pointing to Add, pointing to Form, and
then clicking Smarticket Form. A Smarticket form can also be added by clicking any Group or Menu, clicking the
Add menu, pointing to Form, and then clicking Smarticket Form.
Refer to Basic Form to configure settings on the General, Fields, and Components tabs.
Click the Smarticket Settings tab and configure the Authentication, Web Service, and General options:
Option
Authentication
Description
Web Service

accessing the Web service.
Smarticket Web service.
Enter the machine name or IP address where the Web
service is located, then click the Test button to test
the address setting.

is enabled:
SSL enabled
https://server
name:port
-orhttps://ip
address:port
SSL not enabled
http://server
name:port
-orhttp://ip
address:port
732
Option
Description
General
Field Count
Shows the number of fields that are defined to be

displayed on the form.

Smartickets.
Shared form
A shared form is a form that can be used in more than one menu and group.
Shared forms can be managed through the shared forms management Form List dialog box. Any of the four basic
form types (Basic, Sharepoint, Email or Smarticket) can be shared.
To add a shared form to a group or menu, right-click the group or menu, and click Add > Shared Form on the
shortcut menu. In the Form List dialog box, click the form that you want to add to the group or menu, and then click
the OK button.
Option
Form List
Description
The Form List table shows the following information:
Display NameShows the names of shared forms

that have been defined for the component.
# of RefsShows the number of menus and groups
that contain each shared form.
Add
Creates a new shared form. Choose one of the four form

types to use for the shared form.
Remove
Removes the selected shared form.
Edit
Edits the selected shared form.
Refs
Opens the References to Shared Form dialog box,

which lists the groups and menus that contain the shared
form. To remove a reference, click the reference and then
click the group or menu in the list, and then click the
Remove button.
Shared forms can be managed by clicking the Shared Forms button on the menu bar of the Konica Minolta MFP
configuration dialog box. You can use the Shared Forms button to view, add, and edit shared forms, but it will not
add a selected form to a group or menu. To do that you need to use the shortcut menu command.
Field types
Text field options
Option
Description
Default

the device panel.
Mode
SimpleThe field will be displayed as a simple text

box.
ReadOnlyThe user cannot edit the field.
733
Option
Description
MaskedThe text in the field will be masked.

panel.
Maximum Characters

32767.
Type
The suggested list type that will be presented to the user.
NoneNo suggestion list.

ListUsers can select from a list of values.
SearchAllows users to enter a search string that
matches values. Users can enter an exact string to
match a particular value, use the * wildcard character
to return all values containing a substring, or leave
the value blank to return all values.
Raise Search Even
Select this check box to raise an even when a search is

performed.
Button Size
Specifies the size of the suggestion list or search button.
Large
Medium
Small
Button Name
Specifies the name of the suggestion list or search

button.
Prepopulated Values
Provides space to enter suggested values. Type in the

Prepopulated Values column to enter or replace a value
in the list. The search is not case-sensitive.

Option
Description
Default Value

device panel.
Required
Select this check box to require that a user enter a value

into this field before a scan can be initiated. The default
value, if specified, satisfies this requirement.
Maximum Value

Minimum Value

Enable Grouping
Select this check box to specify that the non-fractional

part of a number should be grouped. For example, select
this check box to show one million as 1,000,000, or
clear this check box to shown one million as 1000000.
734
Option
Description
Group Separator
Specifies the character used when grouping the digits.

For example, set this option to "." to display one million
as 1.000.000. This setting is ignored if grouping is
disabled.
Grouping Digits
Specifies the number of digits that are grouped between

group separators when the Enable Grouping check box
is selected. The default number of digits is 3.
Decimal Places
The number of digits after decimal point. The default

number of digits is 0.
Decimal Separator

For example, if the decimal separator is a comma, the
number ten and twenty-five hundredths is displayed as
10,25. This setting is ignored when Decimal Places is
set to 0.
Format String
The format string allows custom formatting of a field

using the Format String Entity Characters .
Format String Entity Characters

Use numeric string entity characters to in the Format String box to custom format content in a numeric field. These
character are parsed to format a number field. Other characters in the Format String box are interpreted literally and
may be added before or after the entity characters in a numeric string definition.
Characters
Description





all characters.
735
Examples:
The format $,0.00;$(,0.00) yields the following numeric strings:
1 -> $1.00
5654.35 -> $5,654.34
-6000.34 -> $(6,000.34)
6.5 -> 6.5%

-0.5 -> -0.5%
0 -> 0.0%
Note: The dollar sign "$", the percent sign "%", and the parentheses "(" and ")" shown in the examples are
not entity characters, so they are interpreted literally.
Date/Time field options

A date/time field allows users to enter dates.
Option
Description
Default
Enter the default for the field or select the Default to

"now" check box to default the date to the current date
and time. If a default value is entered, the format must
match the Mode selected.
Default to "now"
Select this check box to show the current time on the

console for the default time.
Mode
Click one of the modes:
Return format
DateResults in yyyy/MM/dd
Date and TimeResults in yyyy/MM/dd
HH:mm
TimeResults in HH:mm
Date and TimeResults in yyyy/MM/dd
HH:mm zzz
Specify the return format for date/time data. Use a drop

down list for format examples. Using the elements of
this format, the user can specify a return format of
MM/dd/yyyy , MM-dd-yyyy " or MM.dd.yyyy
. Any delimiter or separator may be chosen. For more
information on custom date and time format strings see
Custom Date and Time Format Strings.
Examples:
DD, MM dd, yy is Monday, January 03, 2009

yy-mm-dd hh:mm is 2009-01-03 05:35
h:mm TT is 3:35 PM
Custom date and time format strings

Custom date and time format strings format dates in Date/Time fields.
Format specifier
d
Description
Represents the day of the month as a number from 1
through 31. A single-digit day is formatted without a
leading zero.
736
Format specifier
Description
dd
Represents the day of the month as a number from

01 through 31. A single-digit day is formatted with a
leading zero.
ddd
Represents the abbreviated name of the day of the week
dddd (plus any number of additional d specifiers)
Represents the full name of the day of the week

a date and time value. If the f format specifier is used
without other format specifiers, it is interpreted as the f
standard date and time format specifier.
ff

in a date and time value.
fff

a date and time value.

a date and time value. Nothing is displayed if the digit
is zero. If the F format specifier is used without other
format specifiers, it is interpreted as the F standard date
and time format specifier.
FF

in a date and time value. However, trailing zeros or two
FFF

a date and time value. However, trailing zeros or three
g, gg (plus any number of additional g specifiers)
Represents the period or era, for example, A.D.

Formatting ignores this specifier if the date to be
formatted does not have an associated period or era
string.

a single-digit hour is formatted without a leading zero.
For example, given a time of 5:43, this custom format
specifier displays "5".
hh, hh (plus any number of additional h specifiers)

a single-digit hour is formatted with a leading zero.
737
Format specifier
Description
For example, given a time of 5:43, this format specifier
displays "05".
Represents the hour as a number from 0 through 23, that

is, the hour as represented by a zero-based 24-hour clock
that counts the hours since midnight. A single-digit hour
HH, HH (plus any number of additional H specifiers)

that is, the hour as represented by a zero-based 24-hour
clock that counts the hours since midnight. A single-digit
hour is formatted with a leading zero.

mm, mm (plus any number of additional m specifiers)

Represents the month as a number from 1 through 12. A

single-digit month is formatted without a leading zero.
MM
Represents the month as a number from 01 through 12.

A single-digit month is formatted with a leading zero.
MMM
Represents the abbreviated name of the month
MMMM
Represents the full name of the month

ss, ss (plus any number of additional s specifiers)

Represents the first character of the AM/PM designator.

The AM designator is used if the hour in the time being
formatted is less than 12. Otherwise, the PM designator
is used.
tt, tt (plus any number of additional t specifiers)
Represents the AM/PM designator. The AM designator

is used if the hour in the time being formatted is less than
12. Otherwise, the PM designator is used.
Represents the year as a one or two-digit number. If the

year has more than two digits, only the two low-order
digits appear in the result. If the first digit of a two-digit
year begins with a zero (for example, 2008), the number
yy
Represents the year as a two-digit number. If the year

has more than two digits, only the two low-order digits
738
Format specifier
Description
appear in the result. If the two-digit year has fewer than
two significant digits, the number is padded with leading
zeros to achieve two digits.
yyy
Represents the year with a minimum of three digits. If

the year has more than three significant digits, they are
included in the result string. If the year has fewer than
three digits, the number is padded with leading zeros to
achieve three digits.
yyyy
Represents the year as a four-digit number. If the year

has more than four digits, only the four low-order digits
appear in the result. If the year has fewer than four digits,
the number is padded with leading zeros to achieve four
digits.
yyyyy (plus any number of additional y specifiers)
Represents the year as a five-digit number. If the year

has more than five digits, only the five low-order digits
appear in the result. If the year has fewer than five digits,
the number is padded with leading zeroes to achieve five
digits. If there are additional y specifiers, the number
is padded with as many leading zeroes as necessary to
achieve the number of y specifiers.
zzz
Represents hours and minutes offset from UTC. If this is

a time stamp such as 1/01/2012 1:30:23 PM -07:00, then
07:00 is represented by zzz.
Represents the time separator. This separator is used to

differentiate hours, minutes, and seconds.
Represents the date separator. This separator is used to

differentiate years, months, and days.
"
Represents a quoted string (quotation mark). Displays

the literal value of any string between two quotation
marks (").
'
Represents a quoted string (apostrophe). Displays the

literal value of any string between two apostrophe (')
characters.
%c
Represents the result associated with a c custom format

specifier, when the custom date and time format string
consists solely of that custom format specifier. That is,
to use the d, f, F, h, m, s, t, y, z, H, or M custom format
specifier by itself, the application should specify %d, %f,
%F, %h, %m, %s, %t, %y, %z, %H, or %M.
\c
Represents the escape character, and displays the

character "c" as a literal when that character is preceded
by the escape character (\).
List field options
739

Option
Description
Value
Label

the label.
Default
Raise Lookup Event
Raise an event when a user performs a search on this

field.
Button Size
Specify the button size for the field:
Large
Medium
Small

items from the first 20 items in the list. When this option
is selected, the value of the RRT will be the selected
values separated by semicolons (;).
Import from file

reuse a list.
Export to file

Delete All
Click this button to delete all items from the list.
Label field options

Option
Description
Text
Enter the text that will be displayed on the device panel.
Hidden
Select this check box to hide the label field from the user.
The label field will not be visible on the device panel.
This is useful for passing data to the workflow without
displaying information on the panel.
Tree field options

To add the first node, right-click the empty box and click Add Root Node. To add additional nodes, right-click the
box and select one of the following:
Add Root Node Adds an additional root node to the tree.

Add Adds an additional node to a selected node.
To edit a tree node, right-click a selected node and click Edit.

To remove a tree node, right-click a selected node and click Remove.
740
Option
Description
Value of the Node
Enter the value for a tree node. By

default, the path of the node will be
used as a value.
Default Selected Node
Select this check box to make a

selected node the default
Button Size
Select the button size for the field:
Large
Medium
Small
Raise Search Event
Select this check box to raise an

event when a search is performed on
the field.
Path Separator
Enter a path separator. This delimits

node values in the value returned by
the field RRT. The RRT value returns
the hierarchy of node values that
define the selection made by a user.
For example, if the path separator
is '\' and the user selects user selects
the node with the value "Grandchild
node" then the RRT returns the value
hierarchy "Root node\Child node
\Grandchild node".
Folder Browser field options

A folder browser field allows users to select documents in a selected folder.
Option
Folder path
Description
Enter the complete path to a folder on a device or click
the browse button (...) to open the Browse for Folder
dialog box to select a folder.
In the Browse for Folder dialog box, you must select
from the starting folder path on a device and then click
OK to add each additional folder in a path until the target
folder is reached.
For example, if the target folder path is C:\install
\folder1\folder2 and the field is configured with
the folder path of C:\install, then click the browse
button and select "C:\install" and click OK to start at C:
\install. To extend the folder path, you must click
the browse button again to select "folder1" and click
OK, and then click the browse button a third time to
select "folder2" and click OK.
Button Size
Large
Medium
Small
741
Database Lookup field options

Option
Description
Connection String
Specify the path to the database. Click the browse button

(...)and select the desired path. Click Connect to connect
to the data source.
Connection Status
Show the status for the connection after you click

Connect.
Table View
Choose Table/View to select the table/view. For Value

Column, select the name of the column from which
values will be loaded into the lookup list. For Display
Column, select the name of the column which will
provide the names which will be displayed in the lookup
list. For more information on SQL scripting syntax see
General SQL Syntax.
Query
Choose this option to enter a SQL query. The SQL query

will produce the results to populate the list. Entries for
in the SQL query.
Button Size
Large
Medium
Small
General SQL syntax

A simple SQL query:
from <Table>
The Konica Minolta component requires that the first column be the value for the list item and the second column be
the display for the list item.
select <ValueField>
from <Table>
from Customers
742

from Customers
where Customer Name like _red
In this example, all customers where Customer Name ends with the text red will be returned. For example,
customers where Customer Name is Fred, Cred, 1red or $red will be returned.
from Customers
SQL wildcard syntax is used with the like operator. The wildcard _ is used to specify a wildcard for one character.
The wildcard % is used to specify a wildcard for one or more character.
AutoStore form.
RRT pattern takes the following format: ~KMO::%AutostoreFormFieldName%~.
It is important to note that the % symbol used with RRT patterns does not function like the % symbol used for
entered by the user from the AutoStore form. The AutoStore form field should be configured to generate a change
event to provide a value for replacement.
Example 1:
from Customers
where Customer Name like ~KMO::%patternFld%~
In this example, the AutoStore form has the RRT pattern patternFld. Once a user enters a value for patternFld,
~KMO::%patternFld%~ will get replaced with the value of patternFld.
If the user entered Johnson at the MFP for patternFld, the resulting query would be:
from Customers
Note that RRT patterns within SQL select statements can be used with other SQL syntax such as wildcard characters.
The following would be a valid SQL statement:
from Customers
where Customer Name like %~KMO::%patternFld%~%
743
Using self-referencing RRT Patterns

If the database lookup field has a SQL statement that contains a self-referencing RRT pattern, then a text field with
the Search option will be used instead of a list field.
select Customer Name
from Customers
where Customer Name like %~KMO::%thisDbLookupFieldName%~%
RRT will take the value the user has typed before pressing the Search button.
Important: When you use self-referencing RRT style patterns as demonstrated above, the select statement
should return only one column.
A checkbox field allows users to select or clear a check box to specify a Boolean Yes/No or True/False state.
Option
Description
True button label

if the check box field is selected. "Yes" is the default
value.
False button label

if the check box field is cleared. "No" is the default
value.
Checked by default
Select this check box if you want the True button to be

Preferences tab
Option
Description
Home Directory
Enter the root directory where the server will create all
temporary directories and files necessary for running
the application. The service account for the service
must have full control (read & write permission) of this
directory.
Server Address
Enter the server name or IP address of the server which

will be used by the Konica Minolta MFP to connect to
the AutoStore server. The component will try to detect
the server automatically. In instances where the network
configuration is complex, it will likely be necessary to
enter the server name or IP address.
Application Port
Enter the port number used to run the embedded KM

Open API Server. The entry references the port to be
used when accessing the web user-interface URL. The
default value for an unsecured connection is 50001 and
for a secured connection (SSL) is 50003.
Use SSL
Select this check box to require the Konica Minolta

OpenAPI server and the WebDAV server to run as
secured connections (SSL).
Open API Application ID
Select the Application ID for the Open API Application.

When a Open API application is registered on the MFP,
744
Option
Description
it uses a unique ID to distinguished it from other Open
API applications.
For example, when working with two AutoStore servers,
one of the AutoStore servers would be able to remove
both Open API Application's on the MFP, even if
the application is registered by the second AutoStore
server. Using different Application ID's provides a
solution to this situation. With one server, the default ID
"AutoStore" is used. For additional servers, use preset
ID's of "AutoStore1" through "AutoStore9".
Session Timeout
Specifies the number of minutes until a session times

out if AutoStore server does not receive any events from
the MFP. At the end of this interval, the server deletes
all data associated with a session including RRT values
and field values entered before the user pressed the Start
button.
The default value for this option is 15 minutes. You
may want to increase this value if you experience or
anticipate users spending more than the specified number
of minutes between pressing the Scan hardware button
and the Finish scan software button, as no events are
received from the MFP between pressing these two
buttons.
WebDAV Port
Enter the port number used to run the embedded

WebDAV server. The entry references the port which
will accept incoming files through HTTP. The default
value for an unsecured connection is 8080 and for a
secured connection (SSL) is 443.
Encryption
Select this check box to turn on encryption functionality.

Documents and meta-data will be encrypted upon
scanning and decrypted on the server.
FTP Port
Enter the port number used to run the embedded FTP

server. The entry references the port which will accept
incoming files through FTP. The default value 2121.
SSL is not supported. This will use a passive FTP port.
Note that the Konica Minolta MFP devices require their
OpenAPI port settings to be configured.
If the device has problems communicating with the
server, ensure the port settings on the server and the
device match. Also ensure there is no firewall software
or hardware blocking the specified port and that IProuting has been set-up to allow communication on this
port.
Processed Files
processed without errors. Enter the directory where these
files will be stored. Note that if this option is selected,
a copy of every file that has been routed successfully
is saved in the Processed Files directory. Make sure
that sufficient disk storage is allocated when using this
745
Option
Description
option. The service account for the service must have
write permission to this directory.
Rejected Files
Select this check box to keep a copy of all files that were
not processed. Enter the directory where these files will
be stored. The service account for the service must have
write permissions to this directory.
Authentication tab
The authentication type and parameters are specified on this tab.
Option
Authentication Type
Description

you select this option, configure the NetWare
CustomPluginAdministrator defines prompts
for authentication for a custom application. After
you select this option, configure the Plug-in
Note: When authentication is enabled, the Use
SSL option located on the Preferences tab is
automatically selected.



environment:

WinNT://AutoStore_server_NETBIOS_name.
format LDAP://ldap_server:port. Check
ports:
Standard LDAP: 389
746
Option
Description

LDAP over SSL: 636
3269


workflow server.
the Active Directory or LDAP server. If you do not
select this check box, the connection will not be
encrypted. To use this option, a server certificate for
the LDAP server has to be installed on the server.
Directory Server will attempt to connect to the
DNS server in order to resolve the IP address of the
Workflow server.


Note: If the device uses its own/custom
OpenAPI authentication application, the user
name is passed to the server and made available
in the corresponding RRT.
When CustomPlugin is selected for Authentication

Type, the administrator defines prompts that are
displayed to the user. An event is sent to the server when
a user logs in. The administrator must provide the .NET
plug-in DLL that responds to the event.
Snap-In pathThis is the path to the compiled

compiled assembly.
Create/Edit Snap-InClick this button to create
available with this component. For details about the
code editor window and the object model, click the
747
Option
Description
Help button in the code editor to refer to the KonicaMinolta Capture Component Snap-in Documentation.
PromptEnter the prompts that will be displayed
to the user.
Use MFP Authentication to obtain User Credentials
NameThe name of the prompt. This is also

serves as the reference to the prompt. It is used to
access the collection of prompts in the script.
LabelThe label that will be displayed on the
MFP for the prompt. If no label is given, the
Name will be used.
DefaultThe default value for the prompt.
RequiredIf the option is checked, an entry for
the prompt is mandatory.
MaskedIf the option is selected, the text box
for the prompt will be in masked mode.
Select this check box to prevent the AutoStore

authentication dialog box from being displayed on
the MFP if MFP native authentication or third-party
authentication is used (such as card authentication), but
at the same time allows the use of custom authentication
scripting capabilities for authorization purposes.
This can be useful when the MFP is using third-party
card authentication. In the authentication script we are
checking whether the provided user name belongs to a
certain group and we want to be able to use the name of
this group in the Restricted Access section of the form.
In order to achieve this, we need to:
1. Select custom authentication.
2. Enable Use MFP Authentication to obtain User
Credentials by checking the box.
3. Create a snap-in script.
4. Perform the necessary checks inside "authenticate"
method (the user name is passed as a parameter).
5. Add the desired group name to the Groups collection
of UserInfo object.
6. Use the desired group name in the Restricted Access
section of the form.
Use LDAP Search to Retrieve Email

Lookup Settings dialog box. For information about
specifying the LDAP server settings, see LDAP Lookup
Settings Dialog Box.
748

LDAP server.
Option
Description
Search Root

with LDAP://.
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636

Authentication

Directory Search

Address From.
Test Lookup




Empty
Result
AutoStore server is running will be
used.
Server belongs.

used.

749
Result
Example: LDAP://

Example: LDAP://

used.

specified server.
Example: LDAP://
RRT Format tab

Option
Description

Time Stamp
The list on the right shows some examples of date time

formats. You can drag & drop to fill out format strings or
press the < button.
Descriptions of format strings can be found in Custom
Date and Time Format Strings.
File Size Format
Obtain Device Host Name
Select this check box to get the device host name for the
Device Host Name RRT. If this check box is cleared, the
Device Host Name RRT returns an empty string.
Konica Minolta MFP component RRTs

Component RRT ID
The RRT ID for this component is KMO.
750
Name
Description
Batch ID
The ID of the received batch
Color Depth
Color depth of the document (B&W, Grayscale, Full

Color,)
Device Host Name
Host name of the device from where a batch has been

received.
Device IP
IP address of the device from where a batch has been

received
Device MAC
The MAC address of the device from where a batch has

been received
Device Model Name
Model name of the device from where a batch has been

received
File Format
Format of the document (Tiff, JPEG, PDF or

CompactPDF)
File Size
Size of the received file
Form ID
The GUID of the form select at the network scanner
Form Name
The name of the form select at the network scanner
Job ID
MFP internal Job ID
Number Of Files
Number of documents received in a batch
Page Count
Number of Pages received in a single document
Received Time
The time at which the batch has been received
Resolution
The resolution of the document (200dpi, 300dpi, )
Sender Email
The email address of the user authenticated on the device
Sender Username
The name of the user authenticated on the device
Session ID
The session ID created when the batch was created

~KMO::%Client ID%~ is replaced by Company if the user types in Company for the field name called
Client ID.
following example provides some sample usage for your reference:
If Custom authentication is used and there is a user attribute named FullName with the value "John Doe", the RRT
~KMO::User,%FullName%~ will be replaced by John Doe.
If an LDAP Search is used to retrieve additional attributes, and you entered displayName on the Additional
Attributes box, then for an authenticated user with the displayName set to Jane Doe, the RRT ~KMO::User,
%displayName%~ will be replaced by Jane Doe.
751

Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Problem Description
Solution
The device does not get registered and the AutoStore

button does not appear on the device panel.
Make sure the AutoStore server is running (with a

process that contains the Konica Minolta MFP Capture
component) and make sure the corresponding device was
added to the list of devices (using the device manager
application). Furthermore make sure the device IP
address is listed in the correct group (if the Common
Group is not being used). If this still does not fix this
issue please check the network connectivity between
the device and the AutoStore server, especially: router
settings, fire wall settings, port settings, IP-routing, and
so forth.
The device registers correctly and I can see the

AutoStore button on the panel. Pressing the AutoStore
button displays Connecting to server until the
connection times out.
This is most likely a network issue. Check the network

connectivity between the devices and the AutoStore
server, especially: router settings, firewall settings, port
settings and IP-routing.
752
Problem Description
Solution
Devices get registered correctly and I can see the forms

at the device. I can fill out all the fields but get a Check
Protocol error on the screen after scanning.
Make sure you have the latest firmware installed on the

MFP. Check if the encryption is enabled with repository
type WEBDAV.
WebDAV repository is selected and after scanning

documents at the device, there is a Protocol error
displayed on the device.
Check if the encryption is enabled with repository type

WEBDAV.Disable Encryption or switch the repository
type to FTP.
If you get these error messages in the batch log:
You are using custom script authentication and you have

not configured the prompts which is used to collect user
information. Please configure the prompts.
Error Konica Minolta MFP: Object

reference not set to an instance of
an object.
Error Konica Minolta MFP: at
KMOAPICapture.OAPIDeviceManager.onEventAuthenticate(Object
sender, AuthenticateEventArgs e)
A message is displayed on the device panel: Now

remote operating. Please do not turn
off the power.
The web page of the MFP is open and you are logged in
to the device as an administrator. Log out and close the
web page of the device.
Authentication is not displayed on the device even when

you have enabled the windows authentication type.
Make sure you have enabled the Required

Authentication option at the group level.
SSL is enabled on the component and the files are

not getting processed to the WEBDAV server. An
Error Message is displayed on the device: Server
Connection Error.
Make sure that the SSL port number on the component

and the SSL port number on the WEBDAV Server are
the same.
The application is not getting registered on the device.
Enter device credentials (Administrator logon and

Administrator password).These are mandatory fields. If
the Open API Logon and Open API Password are set on
the device, they need to be set on the Device Manager as
well.
An error is displayed on the device panel: No Forms

are available for this menu.
User is restricted from accessing that form. Please

confirm that the user belongs to the group that has access
to the form.
After user clicks Update or Save in the Konica Minolta The device manager cannot reach the device or the
MFP Device Manager, the Registration Status column AutoStore Server is not running.
displays Pending.
After user clicks Update or Save in the Konica Minolta The AutoStore server is running but the device cannot be
MFP Device Manager, the Registration Status column reached. The device should be turned on and properly
displays Submitted for Processing.
connected to the AutoStore server or the network.
To unregister the application from the device.
1. Run the Device Manager Application. Device

Manager can be accessed from the main
configuration dialog for the Konica Minolta
AutoStore component.
2. Click the browse button (...) under the application
list.
3. Select the application to be deleted.
4. Click the Delete button.
While registration you get this warning in status monitor The device is turned off or the IP on the MFP has
Warning: Konica Minolta MFP: ipaddress changed.
753
Problem Description
Solution
could not be reached. Please make sure

the device is available in the network
and operational.
You have set scan settings, File Format as Compact
PDF and Color Mode as Black on the component. The
options have changed on the device.
You cannot simultaneously specify Compact PDF and

Black.
You have set scan settings, File Format as JPEG and

Color Mode as Black on the component. The options
have changed on the device.
You cannot simultaneously specify JPEG and Black.
Cannot register or connect to the MFP
Make sure that the IP address is listed for the Server

Address on the Preferences tab on the component.

Error Konica Minolta MFP: Syntax
error (missing operator) in query
expression 'ValueField'.
The query is not modified in the Database Lookup

field. It still displays the prototype query.

Warning: Konica Minolta
MFP: Job is not complete.
00206B6B09D8101010164955_2.kmcf file
is missing.
WEBDAV with encryption is ON ...switch to FTP or

disable encryption.
A protocol error occurs while you are scanning using

WEBDAV mode and files are not sent to AutoStore.
Encryption is enabled on the component. On some

devices WEBDAV with encryption doesn't work.
Either clear Encryption or switch to FTP.
Files are sent from older MFPs (500 and 750) in the
wrong format. The file ends in .jpg, although the 750
cannot scan to a .jpg.
The file is actually in PDF format. If you change the

extension of the received file to .pdf, you may then
open it.
While configuring SharePoint form (Pressing Connect

button), if an error message box is displayed Error
Retrieving sites. Could not load file
or assembly 'Sharepoint2010CCW'....
SharePoint 2010 Add-on is not installed.
Error code -2 is displayed on the device while you

are accessing a SharePoint form.
Authentication is not configured and the check box

Use the Authenticated User Credentials is checked
and the option Allow to change is selected. Since
authentication is not configured, there is an attempt to
log on to SharePoint using the user name public. Either
configure authentication or clear the Allow to Change
option.
An orphaned AutoStore button is displayed on the

device.
Steps to remove the orphaned button (Assume the name

of the button is "AutoStore2":
1. Create a custom group
2. Add the IP address of the MFP that has the orphaned
button.
3. Enter AutoStore2 for the AutoStore Button text
field.
4. Run AutoStore server.
5. Go to Device Manager and select Unregister
application for the MFP that has the orphaned button
754
Problem Description
Solution
6. Select the MFP and click Update.
When a menu and a form are added at the same nesting

level, the form is nested one additional level down on the
device display even though this added form resides at the
same nesting level when configuring properties for the
component.
Forms and menus cannot reside at the same nesting

level on the device display. When a form and menu are
added on the same nesting level, the form will always be
pushed down one-level on the device display.
Unable to scan after enabling the Windows firewall.
Ports 6000-6200 are data ports used by the Konica

Minolta component FTP server in passive mode. These
ports are hard coded. In order to use FTP protocol for file
transferring, this port range has to be opened.
Konica Minolta MFP capture component does not

function after applying the 6.0.0.42 update.
After you run the setup package, follow these steps

to update the device list and configuration file for the
component:
1. In AutoStore Workflow 6 Process Designer, stop
the AutoStore service.
2. Update the component from Software Updates.
3. Open the AutoStore configuration (.cfg) file
that contains the Konica Minolta MFP capture
component.
4. In the Konica Minolta MFP configuration dialog
box, click the Device Manager button.
Note: Do not update or refresh devices.
5. Click OK in the Device Manager dialog box,
and then click OK in the Konica Minolta MFP
6. Save your changes to the AutoStore configuration
(.cfg) file.
7. Back up and then remove the
KMOAPICapture.dat file from C:\Program
Files (x86)\NSi\AutoStore Workflow
6\Distributables\Konica Minolta.
8. Start the AutoStore service.
Kyocera MFP (HyPAS)

Welcome to the Kyocera MFP (HyPAS) component
The Kyocera MFP (HyPAS) component allows you to capture documents from a Kyocera and send the documents
to any of the route destinations that are supported by the workflow server. When scanning documents with the MFP,
users can provide information about the documents that can be used to identify and route the documents appropriately.
The Kyocera MFP (HyPAS) component provides the following features:
Allow different set of menus and forms to be used with groups of devices.
Support for Tree, List, Text, Checkbox field types to provide document indexing flexibility.
destination.
755
Forms are extensible through .NET VBScripts. You can create more interactive forms and validate before a
document is scanned. Integrated editor with IntelliSense makes the creation of scripts easier.
authentication methods.
Allow only certain users to have access to a form or a menu.

Design and create a process that lets the users scan in documents via the Kyocera device and store the documents to a
network folder. This simple process consists of the Kyocera MFP (HyPAS) capture component and the Send to Folder
route component.
First drag and drop the Kyocera MFP (HyPAS) capture component to the Process Designer. Next, drag and drop the
Send to Folder route component into the Process Viewer. For details of how to create a process, please refer to the
Server Process section of the Process Designer help file.
Configure the Kyocera MFP (HyPAS) component preferences described in Preferences tab.
Configure the Kyocera MFP (HyPAS) component authentication settings described in Authentication Tab.
Manage groups and create menus by creating and configuring groups and menus as described in Groups Tab.
Create forms as described in Forms.
Connect a device to the server by following the instructions in Device Setup and Configuration. When the
device is fully configured to connect to the Server, you will see the list of forms when you enter the associated
application.
To scan a document from the device using one of the configured forms, follow the instructions in Scanning a
Document from the Device.
Kyocera MFP (HyPAS) Component configuration

Groups tab
This tab is used to add and configure groups, menus, and forms for the Kyocera MFP (HyPAS) component.
Devices can be grouped based on their IP address or hostname. Each group of devices can have its own menu
devices pointed to the workflow server will display the menu structure under the Common Group.
Option
Description
Add Group
Add Menu

menu item.
Add Form
Select a group or menu, and click this button to add a

form.
Edit

menu, or form.
Remove

menu, or form.
756
Groups
A group contains forms that will be displayed at the device panel. Authentication can be required for a group.
By default there is a single group called the Common Group. If you do not configure additional groups, all devices
will display the forms configured in the "Common Group". You can create additional groups and assign certain
devices to them; this way even though all devices are connecting to the same server they can be used for different
functions.
Groups are added and edited on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog box.
To add a group, click the Add Group button on the menu bar of the Groups tab.
To edit an existing group, click the group, and then click the Edit button on the menu bar.
To delete a group, click the group on the Groups tab, and then click the Delete button on the menu bar. The
Common Group cannot be deleted.
To copy or paste a copied form or menu into a group, right-click the group and click Paste.
Table 46: Group Settings

Option
Description
Name
Type a name for the group in this box. This is used only
for identification and does not appear on the MFP device
console.
Select this check box to require MFP devices in the

group to authenticate users.
Use SSL to Connect to Device Services
Select this check box for devices to use SSL to connect

to the AutoStore server. The SSL option must also be
enabled on an MFP devices, or the SSL connection will
fail.
Device Services Require Authentication
Select this check box to require credentials for

connecting to the device scan web service. The following
parameters are required for authentication:
Authentication TypeThis can be either Local or

Network.
UsernameSpecifies the user name to pass when
authenticating.
PasswordSpecifies the password to use when
authenticating.
Note: If Network or Local Authentication
is enabled on the MFP device, the same
authentication mode must be selected under
Device Services Requires Authentication.
Users will not be able to scan unless valid
credentials are entered.
Associated Devices
Add the MFP devices that will be associated to this

group by entering the IP Address or host name of the
MFP in the under HostName/IP Address. The MFP
address list must contain at least one MFP.
Tip: The network name is preferable unless
the devices are assigned fixed IP addresses. IP
addresses can change when they are assigned
using the Dynamic Host Configuration Protocol
(DHCP).
757
Menus
Menus allow users to access forms that capture data for the Kyocera MFP (HyPAS) component.
Add and edit menus on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog box.
To add a menu, click the group or menu where you want to add a menu, and click Add Menu on the menu bar of
the Groups tab. Then in the Menu Properties dialog box, configure properties for the menu.
To edit an existing menu, click the menu and click Edit on the menu bar.
To delete a menu, click the menu and click Remove on the menu bar.
You can right-click and use shortcut menu commands to Cut, Copy, Paste, Move Up, and Move Down menus that
appear on the Groups tab.
Table 47: Menu Properties
Option
Description
Menu Name
Type a name for the menu. The name of the menu must
be different from other menus and forms at the same
level.
Public Access
Choose this option to allow unrestricted access to the

menu.
Restricted Access
Choose this option to restrict access to specified users.
Allowed Users/Groups
Specifies groups or users that have access to the form for

Restricted Access. You can click the browse button (...)
to specify users or groups.
Forms
Add a form to Kyocera MFP (HyPAS) workflow when the process needs to capture data prior to a scanning
documents. There are several form types that you can use to capture information for different processing and routing
options.
Add and edit forms on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog box.
To add a form to a workflow, first click a group or menu node where you want to add the form, then click Add
Form on the menu bar of the Groups tab, and on the menu click the form type that you want to add.
This displays the configuration dialog box for the selected form type.
To edit a form, click the form and click Edit on the menu bar.
To remove a form, click the form and click Remove on the menu bar.
Right-click and use shortcut menu commands to Cut, Copy, Paste, Move Up, and Move Down forms.
.
Basic form
Use the Basic form captures general information for a basic workflow.
Basic forms are added and edited on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog box.
To add a basic form to a process, click a group or menu node then click Add Form > Basic Form on the menu
bar.
Configure options for a basic form on the General, Fields, and Components tabs in the Form Settings dialog
box.
When you set up any type of form, the following three tabs must be configured in the Form Settings dialog box:
General Tab
Fields Tab
Components Tab
758
General Tab Options

Option
Description
Name

Icon

the path where the image is stored. The image must be
64x64 pixels, saved to a PNG or JPEG file that is no
larger than 24 KB.
Single Touch mode
Select this check box to begin the scanning process

immediately after a user selects the form. The user is not
prompted for selections of any kind.
Access Control
Scan Settings

the form.
This table lists all the available scan settings and

specifies the default value for each setting. The default
value is used when a user does not change a setting at the
device panel.
The Setting column identifies the setting to be
configured, the Options column specifies the default
setting for an option. Select the Allow Changes check
box to allow users to change a scan setting at the device
panel. This check box is initially selected for all scan
settings.
This table allows you to configure the following scan
settings:
File FormatChoose PDF, TIFF, JPEG, or High

Compression PDF.
Only TIFF and PDF are compatible with black and
white. File format is changed from JPEG or High
Compression PDF to TIFF when Color Mode is set
to "Auto (Color/B&W)" or "Black & White".
When PDF High Compression is selected, the default

Resolution can only be set to 300 dpi.
Resolution is changed to 300 dpi when File Format
is set to "High Compression PDF".
Original ImageSpecifies the scanning mode.
Choose Text+Photo, Photo, Text, or for OCR.
759
Option
Description
Original Image is changed from OCR to Text when

Color Mode is set to "Auto Color (Color/Gray)",
"Full Color" or "Grayscale". These settings are not
compatible with OCR.
Color ModeSpecifies the color mode. Options
are Auto (Color/Gray), Auto (Color/B&W), Full
Color, Grayscale, Black & White.
Book OriginalSpecifies the printed page size
and binding type. This can be turned Off (the default
setting) or set to one of the following values:
Ledger-Left
Ledger-Right
Letter-Left
Letter-Right
A3-Left
A3-Right
A4-Left
A4-Right
B4-Left
B4-Right
B5-Left
B5-Right
8K-Left
8K-Right
2-Sided OriginalSpecifies the default number of
sides to be scanned, either One Side for single sided
originals or Two Sides for duplex scanning.
Original OrientationSpecifies the orientation
of scanned pages, either Top Edge Top or Top Edge
Left.
Continuous ScanSet this to On to prompt the
user for additional pages after completing each batch
of pages. All of the pages will be captured to a single
file.
Mixed SizeSet this to Same Width for originals
that vary in height but not width or to Different
Width for originals that may vary width. Leave
this set to Off (the default setting) if all pages of a
document are the same size.
PDF Encryption
Click this button to open the PDF Encryption Settings

dialog box to enable and configure encryption for the
PDF or High compression PDF file format. For more
information, see PDF Encryption Settings.
Dynamic Form

form can be modified by responding to events. Select
this check box to allow the workflow server to load
scripts. Here are some examples of what enabling
760
Option
Description
Change field contents (for example, load the

contents of a list field from a database).
Validate field contents before a document is
captured by the server.
Script pathSpecifies path to the .NET script
(.vb) that contains code to respond to form and field
a file. You can also click the Edit Script button to
open a script editor window with basic script code.
Edit Script CodeYou can click this button to
open the script in the Edit Script Contents script
editor. If no script is specified in the Script path box,
the script editor creates a new script with basic script
code. For details about the script editor and the object
model used to respond to form and field events, click
the help button in the code editor window to view
to the Kyocera MFP (HyPAS) Capture Component
Scripting help.
Raise event when:
enters the form.
user presses Scan button in the form.
Run as device logged in userSelect this check
box to run the script under the authentication context
of the logged in user. This option should be used
only where you need to access a system that requires
explicit identification. Whenever possible specify
user name and passwords in your script. (You can
use available .NET technologies such as encrypting
to hide the passwords from view when editing the
script.)
Note: The Run as device logged in

user option is only available if the group
requires authentication and the configured
authentication mode is Windows.
Fields Tab Options
Configure the indexing fields that will be presented to the user. Add a new field by typing in the empty Name box on
the last row. Delete a field by clicking in the first column to select the field and then pressing the Delete key on the
computer keyboard.
Column
Name
Description
within this form. This name is displayed for the field
on the device panel. The field name labels the RRT
761
Column
Description
if the field name is "Field1", the RRT is ~K20::
%Field1%~.
The name can be any combination of alphanumeric
characters. Spaces and special characters (for example,
~, !, @, , $, %) are not allowed.
Display
The label that represents the field in the MFP panel. The
field name is used if this column is left empty.
Type

to
TextAllows a user to enter plain text.

DateAllows a user to enter date and time
be made searchable.
CheckboxAllows a user to select an option in a
form.
(Required)

(Properties)
Components Tab Options

This tab lists process and route components in the workflow. Configure a component for this form by clicking
the browse button (...) in the (Configure) column for a row. This opens the configuration dialog box for the
component. You can click the Help button in the configuration dialog box for component instructions.
Field
Description
Name
Shows the name of a component.
Description
Briefly describes what the component does.
Type
Shows whether the component is a Process or Route

component.
(Configure)
Click the browse button (...) to open the settings dialog

box for a component. You can click the Help button in
the component settings dialog box to view the help for
the component.
762
PDF Encryption Settings dialog box

Use this dialog box to configure setting for PDF encryption. When encryption is enabled, a password is required to
open or edit an encrypted file.
Option
Description
Enable
Select this check box to enable PDF encryption for PDF

or high compression PDF file formats. You can select
Enable and enter passwords for either (or both) opening
or editing PDF files.
Password
Specifies the password used for to open or edit encrypted

PDF files. Retype the password in the Re-enter
Password box.
This entry is unavailable if you select the Prompt User
at Scan Time check box for either opening or editing
PDF files.
Prompt User at Scan Time
Select this check box to display prompt the user working

at the device panel to enter a password for opening or
editing an encrypted PDF file. The PDF Encryption
Password prompt appears for PDF or High compression
PDF file formats before the scan progress dialog when
the user presses Scan.
Copying Text and Images
Specifies whether text and images may be copied in PDF

documents. Choose Enable to allow them to be copied or
Disable to prevent them from being copied.
Changes Allowed
Specifies whether changes may be made to PDF

documents. You can choose from the following:
None
Comments Only
Any except extracting pages
Page layout except extracting pages (when 40-bit
encryption is selected)
Insertion, Deletion, Rotation (when 128-bit
encryption is selected)
Printing Allowed
Specifies whether PDF documents may be printed.

Choose Allowed or Not Allowed.
Encryption Level
Specifies 40-bit or 128-bit encryption:
40 bitCompatible with Adobe 4.0 and above

(Default)
128 bitCompatible with Adobe 5.0 and above
Note: Users cannot enable PDF encryption from the MFP device panel. It can only be enabled in the
component settings. There is no Encrypt button on the Send screen of the MFP device.
Send to Folder form
Send to Folder forms are added and edited on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog
box.
To add a Send to Folder form, click a group or menu and click Add Form > Send to Folder Form.
763
In the Send to Folder Form Settings dialog box, configure options on the General, Fields, and Components
tabs the same way as for a Basic Form.
On the Send to Folder Fields tab, configure the Send to Folder form options.
Send to Folder Fields Options

Option
Description
Base Directory

browse to select the destination of the document.
Type the default value that will be used for the document
name field.
Tip: You can use the RRTs provided for the document name and destination directory to configure a Send to
Folder or similar component.
Email form
commonly used in conjunction with the Send to SMTP and Send to Exchange Route components.
Send to Email forms are added and edited on the Groups tab of the Kyocera MFP (HyPAS) configuration dialog
box.
To add a Send to Email form, click a group or menu on the Groups tab of the Kyocera MFP (HyPAS)
configuration dialog box, and click Add Form > Send to Email Form on the menu bar.
In the Send to Email Form Settings dialog box, configure options on the General, Fields, and Components tabs
the same way as for a Basic Form.
On the Send to Email Fields tab, configure the Send to Email form options.
Send to Email Fields Options

Option
Description
Do not show a From field
Select this check box to omit the From field and use the
email address for the user that is logged into the device
as the value for the From field.
Show CC Field
Select this check box to show the CC field in which

Show BCC Field
Select this check box to show the BCC field in which the
user can specify recipients so other recipients cannot see
them.
Global Address List
Select this check box to allow the users to search the

Global Address List for addresses that can be added
to the To, CC, and BCC fields. Regardless of which
Global Address List is used, the service account for the
workflow service must have permissions to perform the
search.

option. This should be a user friendly value that
describes this search location, for example Global
Address List.
The Global Address List that will be searched will be

decided based on the following criteria:
764
Option
Description
Exchange Contacts
Select this check box to allow users to search their

Microsoft Exchange contacts folder for addresses that
can be added to the To, CC and BCC fields.
LDAP Server

associated to the device logged in user.
authentication code populates the User name and
logged in user.
If there is no logged in user, then the search will be

describes this search location, for example My
Contacts.
ServerType the IP address or host name of the
Exchange server . Contact your system administrator
if you are uncertain of what to put here.
Use SSLSelect this check box if a secure socket
layer (SSL) connection is required to connect to the
Exchange server.

LDAP Directory for addresses that can be added to the
To, CC and BCC fields.
A user may enter specific email addresses for To, CC
and BCC on the device console. The user may also
search for email address within the domain by pressing
Search. The user may search for a specific name by
selecting the Address button and entering that name and
then selecting Search. Once an email address is selected,
the email address is appended to the entries for To, CC or
BCC.

describes this search location.
LDAP ServerType the IP address or host name of
the LDAP server . Contact your system administrator
if you are uncertain of what to put here.
Search Root DNType the distinguished name
for the entry in the LDAP directory where the search
is to begin. A DN is made up of attribute=value
pairs separated by commas, such as CN=Users,
is the root of the directory tree.
Email Address fieldType the name of the
LDAP attribute that contains the email address.
765
Option
Description
LDAP attribute names vary depending on the LDAP

implementation and configuration. In an Active
Directory environment this attribute is typically
mail. When a value is used then the email address
that is passed to the server is retrieved from this
attribute, a valid value for a windows environment
LDAP would be mail.
Name fieldType the name of the LDAP attribute
that represents the display name of the user. In
an Active Directory environment this attribute is
typically cn or displayName. When a value is
found the display text for the item is retrieved from
this attribute.
Tip: The name of the LDAP attributes
can vary depending on the LDAP directory
implementation. To find out which attributes
apply to your environment, you should refer to
the documentation for your LDAP directory and
look for available attributes for the LDAP object
of class person.
Login as anonymous
Select this check box to establish an anonymous

connection to the LDAP server.
Choose this option to log onto the LDAP server using

will be used.
Test LDAP
To test the LDAP search settings, click this button. In

the LDAP Search Test window, type a search term in
the Search Criteria box, and click Find Contacts. If
maximum of 25). Otherwise, an error is returned by the
test.
Note: Successful matches for the search will be
the LDAP objects for which the Email Address
field or Name field attribute begins with the
specified criteria.
Specified the maximum number of contents to return

from the LDAP server. Set this option to return field to
the number of contacts that the search will return.
Tip: You can use the special RRTs provided for the email fields (From, To, CC, BCC, Subject and Message)
to configure options in process or routing components (such as Send to SMTP) in the workflow.
Send to SharePoint form
Use a Send to SharePoint form to send documents to a SharePoint 2007, 2010, or 2013 server.
Use a Send to SharePoint form to allow the user to browse document libraries, folders and list values at the device.
A Send to SharePoint form is commonly used in conjunction with the Send to SharePoint 2007/2010 eConnector and
route components.
766
Add forms on the Groups tab of the configuration dialog box. To add a Send to SharePoint form, click any group or
menu, then click Add Form > Send to SharePoint Form on the menu bar to open the Send to SharePoint Form
Settings dialog box. In this dialog box, configure settings on the General, Fields, Components, and SharePoint
Document Library Settings tabs.
Note: This form type requires that SharePoint be installed on the AutoStore server.
SharePoint Document Library Settings tab
Option
Description
Server Version
Server Address
SharePoint 2007
Select SharePoint 2010 - Native Services if you are

using a SharePoint 2013 server.

server address.
User Name
on to the SharePoint Server in the format domain \
User Password


Site

Document Library

767
Option
Description
Library check box.
Default Folder

folder.
Content Type

Form templates
Form templates allow you to configure a form once and reuse the same settings in multiple workflows.
Form templates contain the complete form definition and settings for a form in XML format. The Kyocera MFP
(HyPAS) component saves form templates to a file with the .xml file extension.
Creating a Form Template
To save an existing form as a form template, right-click the form on the General tab of the Kyocera MFP (HyPAS)
settings dialog box, and click Save as Template on the shortcut menu. This displays the Save Form as Template
dialog box with the following options.
Option
Description
Location
Enter the path to the folder where you want to save the
template file. You can can click the browse button (...) to
locate a folder.
Template Name
Type the name of the template file in this box. Take care
to omit the .xml extension from the file name, as the
component appends the .xml extension to the name that
you enter here.
Save a copy of the dynamic script in the same

location
Select this check box to save a copy of the .NET script

(.vb) file associated with the form to the same location
that you are saving the form template file. This option is
only available when the Enable Dynamic Form option
is selected and a script is specified on the General tab of
the Form Settings.
768
Using a Form Template

To use a form template to add a form to a workflow, click the group or menu node where you want to add a form on
the General tab of the Kyocera MFP (HyPAS) settings dialog box, and then click Add Form > From Template on
the menu bar. This displays the Create Form from Template dialog box with the following options.
Option
Description
Template file
Enter the full path to the form template (.xml) file. You
can click the browse button (...) to locate the file. This
is a form template saved previously with the Save as
Template command.
Dynamic Form script file
Enter the full path to the .NET script (.vb) file if a

dynamic form is associated with the template. If a
form is associated with the template and you do not
specify the script file here, you will have to configure
the Dynamic Form options in the Form Settings before
you can finish adding the form to the workflow.
After you click OK in this dialog box, the Kyocera MFP (HyPAS) component opens the template settings for the
form in the Form Settings dialog box. The form initially has the same name as the template form appended by "Template". You can change the name and adjust other settings before you click OK to finish adding the form to the
selected group or menu.
Field types
Option
Description
Value if checked

if the Checkbox field is selected. "1" is the default value.
Value if not checked

if the Checkbox field is cleared. "0" is the default value.
Checked by default
Select this check box if you want the True button to be

Date/time field options

A date/time field allows users to enter dates.
Option
Date Format
Description
Select one of the date formats.
Short Date (mm/dd/yyyy)

Long date (Day, Month, dd, yyyy)
MM/DD/YYYY
MM-DD-YYYY
DD/MM/YYYY
DD-MM-YYYY
YYYY/MM/DD
YYYY-MM-DD
Select this check box and specify From and To dates to

restrict date entries to a range.
List field options

769

To add a value to the list field, type in the blank Value box in the last row of the table. To remove a value, click in the
first column to select the value, and then press the Delete key on the computer keyboard.
Option
Description
Value
Label

the label.
Default
Raise Lookup Event
Raise an event when a user performs a search on this

field.

will be the selected values separated by semicolons (;).
Select this check box to allow users to enter a value that

is not in the list.
Display Search Options
Select this check box to allow the user to search the list
for an item that starts with specified criteria.
Raise event after pressing the find buttonSelect

this check box to send an event to the server when the
user presses the Find button in the search dialog at
the MFP.
This option is only available if Enable Dynamic
Form is selected on the General tab. You can
respond to an event in the script specified in the
Dynamic Form options.
Specifies the maximum number of result items to
display in the list.

Option
Description
Default

device panel. If Minimum or Maximum values are
specified, then this value must fall in the specified range.
Minimum
Specifies the minimum value permitted in the field. For

example, a value of 10 for this option would allow all
values greater than or equal to ten.
Maximum
Specifies the maximum value permitted in the field. For

example, a value of 50 for this option would permit
any value less than or equal to fifty.
770
Option
Description
Precision
The number of positions after the decimal point that

can be specified for this number. The default is 0. The
maximum value allowed for precision is 5.
The values for Default, Minimum and Maximum value can be in the range:
-79,228,162,514,264,337,593,543,950,335 to 79,228,162,514,264,337,593,543,950,335.
Text field options
Option
Description
Default

the device panel.
Mode
Maximum Length

text box. This is the initial setting.
panel.

255.
Tree field options

Perform the following actions in the Tree Properties dialog box.
To add the first node, click the Add button and configure options in the Add/Edit Tree Item dialog box.
To add additional node, click a node in the tree, click the Add button.
To edit a node in the tree, click the node and click the Edit button, and configure options in the Add/Edit Tree
Item dialog box..
To remove a node from the tree, click the node and click the Remove button.
Table 48: Add/Edit Tree Item settings

Option
Description
Display Text
Type the label of the tree item. This is what the user will
see in the device panel when navigating the tree.
Value
Type the value of the item. This is the value that will be
sent to the server.
Preferences tab
Option
Home Directory
Description
Specifies the root directory where the server create
all temporary directories and files necessary used by
the Kyocera MFP (HyPAS) component. The service
account for the AutoStore service must have full control
permission in this directory.
771
Option
Description
Port Number
Specifies the port the Kyocera MFP (HyPAS) component

uses to communicate with Kyocera MFP devices. The
Kyocera device must be configured to use this port
number to connect to the server. If the Kyocera device is
having problems communicating with the server, check
that the port on the device matches the port number
shown here. Also make sure there is no firewall software
or hardware blocking the specified port. The default
value for this port is 3250.
Port Number for SSL
Specifies the port number the Kyocera MFP (HyPAS)

component uses for encrypted communication with
Kyocera devices using the SSL protocol.
Processed files
files will be kept. You can click the browse button (...)
to locate a folder. The service account for the AutoStore
service must have write permission to this folder.
saved in the Processed files directory. Make
sure that proper disk storage is allocated when
using this option.
Rejected Files
Select this check box to keep a copy of all files that

failed to be process entirely. Enter the directory where
(...) to locate a folder. The service account for the
AutoStore service must have write permission to this
folder.
Authentication tab
Authentication requires MFP users to provide valid credentials to send documents to the workflow server. The
authentication settings are configured for the server, and they can be enabled or disabled for any group of MFPs.
Option
Authentication Type
Description
Choose the authentication method to be used by the
component.
Windows

WindowsUses Windows authentication.
NetWareUses NetWare authentication.
Custom ScriptThe administrator has full control
over the prompts presented to the user and validation
of user entries.
In the Domain box, enter the default domain used for

Windows authentication.
Enter only the domain name without the top-level
domain designator (.com, .net, or .org). For example, If
the user is mydomain/user1 (or user1@domain.com in
772
Option
Description
UPN format), the domain should be mydomain, not
mydomain.com.
NetWare

Custom Script
NDS TreeEnter the default nDS tree.

The administrator defines prompts that are displayed to

the user. An event is sent to the server when a user logs
in. The administrator must provide the .NET plug-in
DLL that responds to the event.
Script File PathSpecifies the path to the VB.NET

script that contains the code to authenticate the user.
You can click the browse button (...) to locate the
script file.
Edit Script CodeClick this button to open a
script editor window with basic script code. For
details on the script editor window and the object
model used to authenticate users, click the help
button in the script editor refer view the Kyocera
MFP (HyPAS) Capture Component Scripting
documentation.
PromptClick this button to open the
Authentication Prompts window and configure the
prompts that will be displayed to the user. For each
prompt, configure the following fields:
User Info Lookup
NameThe name of the prompt. This is also

serves as the reference to the prompt. It is used to
access the collection of prompts in the script.
DisplayThe label that will be displayed on
the MFP for the prompt. If no label is given, the
Name is used.
DefaultThe default value for the prompt.
(required)Select this check box to make the
entry mandatory for the prompt.
(masked)Select this check box to mask the
text that is entered for the prompt at the device
panel should be masked for security.
You can configure an LDAP search to retrieve additional

information about the authenticated user, such as their
email and full name. To enable this feature, select the
Use an LDAP Search to retrieve additional user
information check box. Click the Configure button
to open the LDAP Lookup Settings dialog box to
configure settings for the LDAP server.
Note: When "Windows" is selected as the
Authentication Type, the email address
is retrieved automatically as part of the
773
Option
Description
authentication, so an LDAP search is not
required if you only need the email address.

LDAP server.
Option
Description
LDAP Server
Root DN
Enter the distinguished name for the node where

the search should start. No value is required if
Windows authentication is used. A DN is made up of
attribute=value pairs separated by commas. The value
must begin with LDAP:// in the following format:
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636

Login as anonymous


Directory Search
In the Directory Type box, select the type of directory to

be searched.
Active Directory or eDirectoryKnown

predefined attributes will be used to match the
authenticated user name and retrieving the email
address.
CustomIndicate which attribute is going to be
used to identify a match against the authenticated
user in the Match username against box. You must
also provide the LDAP attribute that contains the
email address of the user in the Get email address
from box.
To retrieve other information about the user in addition

to the email address, you can specify additional LDAP
attributes in the Additional attributes box. Type the
name of these LDAP attributes separated by a semicolon.
These attributes will be available as User Attributes
Replacement Tag Names (URTNs). Only the email
address will be retrieved if this box is left empty. For
774
Option
Description
details about Kyocera MFP (HyPAS) URTNs, see
Kyocera MFP (HyPAS) Component RRTs.
Test Lookup

the User name box and click the Test button.

Active Directory domain. User name




Empty
Result
used.
Server belongs.

Auto Store server is running will be
used.
Example: LDAP://
Example: LDAP://

used.

specified server.
Example: LDAP://
Kyocera MFP (HyPAS) component RRTs

Component RRT ID
The RRT ID for this component is K20.
Name
Description
FormName
Sender

775
Name
Description
Note: This RRT is populated in any of the
following cases:
The component has been configured to use

an authentication method other than None.
The device authentication is turned on.
SenderEmail
SenderDomain
The domain name of the authenticated user.

This RRT is populated in both the following cases:

authentication.
authentication and the associated .NET script
object.
IP
HostName
Format
FileSize
Tiff (TIFF file)

PDF
JPEG

The RRT ~K20::%Client ID%~ is replaced by Company if the user types in Company for the field name
called Client ID.
If Custom authentication is used and there is a user attribute named "FullName" with the value "John Doe" then the
RRT will be ~K20::User,%FullName%~ and it will be replaced by "John Doe".
If an LDAP Search is used to retrieve additional attributes, and you entered "displayName" on the Additional
Attributes box, then for an authenticated user with displayName set to "Jane Doe", the RRT ~K20::User,
%displayName%~ will be replaced by Jane Doe.
This component supports all the Date/Time tag names listed in the following table:
Name
%a
Description
776
Name
Description
%A
Full weekday name
%b
%B
Full month name
%d
Day of month as decimal number (01 to 31)
%H
Hour in 24-hour format (00 to 23)
%I
Hour in 12-hour format (01 to 12)
%j
Day of year as decimal number (001 to 366)
%m
Month as decimal number (01 to 12)
%M
Minute as decimal number (00 to 59)
%p
%S
Second as decimal number (00 to 59)
%U

day of week (00 to 53)
%w
Weekday as decimal number (0 to 6; Sunday is 0)
%W

day of week (00 to 53)
%y
Year without century, as decimal number (00 to 99)
%Y

Procedures in this section describe how to install, license, configure, reconfigure the KYOcapture application on a
device and how to scan documents.
Note: In order to complete the procedures in this section, you will need J03_E000003003.pkg
(Version J03_E000.003.003), which is located on the AutoStore server in the
installation_directory\Distributables\Kyocera MFP (HyPAS) folder.
Installing the KYOcapture MFP Application
Licensing the KYOcapture Application
Configuring KYOcapture for the first time
Changing a configuration
Scanning a document from the device
How to install the KYOcapture MFP application
In order to complete the steps that are outlined below, you will need J03_E000003003.pkg (Version
J03_E000.003.003), which is located in the installation_directory\Distributables\Kyocera
MFP (HyPAS) folder.
1. Select an empty USB flash drive for installation of KYOcapture, and copy the installation file to the USB flash
drive.
2. At the MFP operation panel, open System Menu by pressing the System Menu button at the top-left corner of the
MFP panel.
3. Scroll to next page and press the Application button.
If the MFP device prompts for authentication, authenticate with an administrator account.
777
The application screen lists all applications installed on the MFP.
4. The application already has an entry for the KYOCapture application, then select the entry and press the Details
button to verify the version. If a previous version is currently installed, then prceed through the following steps to
update the application.
5. Press the Add button to open Application-Add screen.
6. Insert the USB flash drive into USB slot at the side of the panel.
Within a few seconds, the MFP will display KYOcapture in the list of applications found on the USB flash drive.
778
7. Select KYOcapture and press the Install button.

8. When prompted to confirm, press Yes.
The MFP will confirm that the application installed correctly. Then, press the Remove Memory button. After the
MFP confirms that it is safe to remove the USB memory device, remove it from the MFP.
Note: If an existing version of the KYOCapture application was already installed on the device, then the
Type/Result of Installation column will show Upgrade program indicating that the current version will
be updated.
9. Press the Close button to exit back to Application page.
After you complete this procedure, follow the procedure How to license the KYOcapture application on page 779
to license the application.
How to license the KYOcapture application
1. In the Applications page, KYOcapture will be displayed as shown:
2. Select KYOcapture and press the License On button.
779
3.
4.
5.
6.
7.
When you are prompted to confirm licensing, press the Yes button.
Press the Close button to exit back to the System Menu screen.
Turn the MFP off and then back on.
After the MFP restarts, wait a few minutes for the MFP to load applications.
Press the Application hardware key to view installed applications.
The KYOcapture button should appear as shown here:
780
After you complete this procedure, follow the procedure Configuring the KYOcapture Application for the First Time
to configure the application.
How to configure the KYOcapture application for the first time
1. Open the Applications by pressing the Application button on the panel.
2. Press KYOcapture button on the Applications screen.
KYOcapture will prompt for authentication.
3. Log on as an Administrator.
The default administrator account on TASKalfa MFP is Admin with password=Admin (with the uppercase "A").
After authentication succeeds, the KYOcapture configuration screen will appear. After authentication succeeds,
the KYOcapture configuration screen will appear.
4. In the configuration screen, enter the IP address and port number for the KYOcapture server.
5. Press OK button register the settings.
When the data is submitted, the device will attempt to connect to the KYOcapture server. If it is successful, it displays
the menus and forms configured on the KYOcapture server. Otherwise, it shows a communication error page.
How to change a configuration
1. KYOcapture application allows changing the server IP address or port number following the occurrence of a
communication error.
781
A communication error could result from any of the following:

Server is off-line (either turned off or service is not running)
MFP is not connected to the network (network cable is disconnected)
Registered IP address or port number is incorrect
Other network connectivity issues
2. Exit the communication error screen by pressing the OK button
3. Restart the KYOcapture application.
The application displays the Confirm Settings screen as shown:
782
4. Press the Confirm Settings button at the bottom of the page.

KYOcapture configuration screen with current values is displayed.
5. Change the values and press the OK button to register the new values.
How to scan a document from a device

1. Go to the applications screen by pressing the Applications button in the device panel.
2. Press the KyoCapture button.
783
3. If you are prompted to authenticate, enter your user information and press Login. If authentication is not required,
proceed to the next step.
You are only prompted to authenticate if authentication is required for the group to which this MFP belongs.
4. Place the document you want to scan in the scan feeder or plate.
5. Select the form you want to use for scanning the document.
6. Enter the form values.
7. Press the Start button (the Green MFP button).
Supported devices
For a current list of supported devices, visit the Notable Solutions website.
LAN Fax
Welcome to the LAN Fax component
The LAN Fax component supports faxing capabilities using a third-party LAN fax server. The LAN Fax component
communicates with the network fax server via a common directory folder using HP Scanfax technology. This folder
can be a network folder as long as the LAN fax component and the LAN fax server both have read and write access to
it.
Although not required, it is recommended that the LAN fax server be installed and the common folder established,
before configuring the LAN Fax settings.
Getting started
Feature highlights
Send faxes using a LAN fax server.

Capture documents from remote sites using any Scanner, any Multi-functional device or Digital Copiers and route
images to any of the supported fax servers.
Creates billing account numbers for fax billing records.
Note: JPG and PDF formats are not supported by the LAN Fax component.
Using the LAN Fax component

Copy-to-Fax
Connect all your network enabled Digital Copiers to your

enterprise Fax Servers.
Scan-to-Fax
Connect your desktop scanner directly to enterprise Fax

Server.
Email-to-Fax
Capture documents using POP3 or SMTPCapture and

route them to enterprise Fax Server for processing.
Directory-to-Fax
XML-to-Fax
Use VBScript
Poll a directory and push each file into Fax Server. If

you are designing a process that would capture files
from a Poll Directory component, and route to LAN Fax
component, make sure to use a Data Interchange process
component after the Poll directory component.
Receive XML documents and send via fax.
Use VBScript to lookup fax address books and integrate
with your back-end fax database address books.
784
LAN FAX examples

You may use RRTs for specifying field values referring to fax parameters, such as phone numbers.
[POLL] -> [any process] -> [LAN Fax]
[ANY Blocking component source]
->[any process]->[LAN Fax]
[POLL] ->[Data interchange]>[any process]->[LAN Fax]
Does not allow use of RRTs for the fields required for the
LAN Fax module, such as the phone number.
Works fine if the fields are created by the blocking
component and RRTs are enabled.
The Data Interchange will create the ability to set field
values (such as the phone number and name) using RRTs.
Licensing LAN Fax

Three types of licenses are available for this component:
Evaluation
Licensed
Expired
Configuring LAN Fax

General tab
This tab specifies basic information required to send a fax from your LAN fax server.
Option
Description
Fax Number
Enter a comma-separated list of fax numbers.
Billing Account
If a billing code is supported by the fax server, you

can enter it here. Billing codes are typically used for
accounting purposes. This field is optional.
Description
You can enter a description of the fax here. This field is

optional.
Scanner Name
You can enter the scanner name from which the fax is
originating. This field is optional.
User Name
In order to send a fax through a specific user account

on the LAN fax server, enter a user name that exactly
matches the user LAN account on the LAN fax server.
This field is optional. Faxes sent without a user name
will be faxed out from the default user account for the
LAN fax server.
Fax Settings tab

This tab sets the attributes associated with how the fax is sent. Depending on the LAN fax server, not all the settings
might apply.
Option
Error Correcting Mode
Description
Select this check box to enable Error Correction.
Most fax machines have a feature called ECM (error
correction mode). EMC enables the machines to continue
transmission or reception despite minor (and usually
intermittent) problems with the quality of the telephone
line connection. When the quality of the telephone line
connection is poor, transmission time will increase as
785
Option
Description
the two machines repeat data signals in an attempt to
complete the transmission.
Retry
Enter a value between 1 and 99 To retry a failed fax

transmission (as when the LAN fax server encounters a
busy signal).
Enter 0 to not attempt to retry fax transmission when
there is a failed transmission.
Interval
If you have enabled Retry for failed fax transmissions,

choose the number of minutes the LAN fax server should
wait between retry attempts. Enter an integer between 1
and 60.
Resolution
Select the quality of the fax by clicking a resolution in

the list box.
Maximum Transmission Speed
The maximum baud rate at which you want faxes to

be transmitted. The LAN fax server may also limit the
transmission speed.
Check your LAN fax server hardware and software
specifications.
LAN Fax Inbox tab

On this tab, specify where fax documents are stored.
Option
Folder Path
Description
The fully qualified path of the common folder that will
be used to place fax data in order to communicate with
the LAN fax server.
This folder can be a Network folder as long
as this LAN Fax component and the LAN fax
server software both have read and write access
to it. If the folder is a network folder, enter the
Microsoft Windows UNC (Universal Naming
Convention) locator for the folder (for example,\
\my_server\my_share_drive\my_share_folder
).
Alternately, you may click the browse button (...) to
locate a folder.
Overwrite Existing File
Check this box to overwrite files with the same name.
Rename File
Check this box to rename the output file based on the

rename schema settings.
Schema
Enter the schema name used to reformat the output file

name. You can use Runtime Replacement Tags (RRT)
to dynamically set the value of the schema. Note that
spaces are not valid in the file-naming Schema.
786
LAN Fax component RRTs

Component RRT ID
The RRT ID for this component is LFX
The following table describes the reserved RTN values for the Schema field of this component.
Name
Description
FileName
Counter

names found within a directory. The counter value
FileExt
Original file extension value
For example, the RRT ~LFX::FileName~~LFX::Counter~ is replaced with the value Document5 if the
original Schema name is Document and there are 4 (Document1 to Document4) files already within the destination
folder path.
This component does not support FRTNs and replacement of field names with metadata values.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
Current locales A.M./P.M. indicator for the 12-hour

clock.
%S
%U

day of week (0053)
%w
Weekday as decimal number (06 where Sunday is 0)
787
SSRTN
Description
%W

day of week (0053)
%y
%Y
For example, ~LFX::%Y~-~LFX::%m~ will be replaced by 2005-9

Problem Description
A fax document could not be sent to the recipient.
Solution
HPF files are not written to the destination directory
Verify that the number entered is a valid fax

destination.
Check the LAN fax server's log for details
Make sure you are using UNC and not mapped drives for
your folder path. Mapped drives are not supported. Also
make sure the server has read and write permission to the
folder.
The LAN fax server validates the destination fax numbers. This component does not notify the user of invalid fax
number, however, the LAN fax server activity log does show the invalid fax numbers.
JPG and PDF formats are not supported by the LAN Fax component.
The LAN Fax component can be used to send faxes using one of the following supported LAN fax servers:
Any Way Office EDITION

AVT Makers of RightFAX
Biscom FAXCOM
CASTELLE FaxPress
Com-EM-Tex
David by Tobit Software
Esker Faxgate
Esker LanFax
FACSys Fax Messaging Gateway
Faxination
FAXmaker
FaxNow!
FaxPlus/OpenFAXport by 3Com
Ferrari electronic
Gold-Fax
Hexar FaxSwitch
Imecom Integral FaxMerkur (SCH Technologies)
MRS Unified Messaging System
Object-Fax
Omtool
RTEFAX
Tobit FaxWare
TOPCALL
Zetafax
788
If you are designing a process that would capture files from a Poll Directory component, and route to LAN Fax
component, make sure to use a Data Interchange process component after the Poll Directory component.
Laserfiche
Welcome to Laserfiche component
Use the Laserfiche eConnector and Laserfiche Route components to process and store documents into Laserfiche
Document Management System. Laserfiche users can efficiently store content from a variety of sources into a
Laserfiche repository. Once the content is captured, it becomes available for retrieval and collaboration across the
network within the organization.
Now you can design and implement workflows that capture paper and electronic documents from variety of sources
such as MFP devices, network/local folders, PC desktop, POP3 email servers to manage and store your documents
into Laserfiche.
The component can be use both as a process or route component.
This component supports Laserfiche Client and Server versions 7.2.1, 8.0.2, 8.1.1, 8.2.1, 8.3.1 and 9.0.1.
Getting started
Feature highlights
The Laserfiche eConnector and Route components provide the following features:
Automation of document routing into Laserfiche document management system.

Adding metadata to documents for indexing.
Dynamic folder creation and storing documents into various repositories.
Adding tags to documents.
Ability to index all pages of document.
Renaming documents.
Recognizing text in image files.
Extracting text from electronic documents.
How to use the Laserfiche component

This procedure steps through and example of how to capture electronic documents from a local/network folder
directly into a Laserfiche repository.
1.
2.
3.
4.
Create a workflow process with the Multi-Poll capture component.

Drag any process components you want to use and the Laserfiche route component into the workflow.
Configure the Laserfiche component to assign document fields, depending on the selected document type.
Save and run the process.
The document with the set attributes is routed directly into the Laserfiche repository.
Laserfiche Configuration window
Tab
Description
General Tab
Enter the general attributes of the Laserfiche repository

where you want the documents to be saved.
Document Tab
Enter the document attributes on this tab.
Fields Tab
Configure the fields that will be assigned to a routed

document on this tab.
789
Tab
Description
Use this tab to set the OCR properties for the text or to
activate the text extraction from electronic documents.
Text Tab
General tab
Enter the general attributes of the Laserfiche repository where you want the documents to be saved.
Option
Description
Activate

Conditional Activation). This option is only available in
the eConnector (process) component.
Server
Enter the name of the server on which the repository

is located. Server address should be entered without
protocol prefix; for example, MyLaseficheServer.
This option is required.
User
Enter a user name to connect to the repository. This

option is required.
Password
Enter the password of the user name.
Repository
Enter the Laserfiche repository. Click the browse button

(...) to select a repository. This option is required.
Template
Choose a template to associate with the documents.

Click the browse button (...) to select a template. This
option is optional.
Note: Templates allow users to attach a
variety of metadata to documents, which makes
documents easier to find.
Volume
Choose a volume to associate with documents. Click the

browse button (...) to select a volume. This is a required
option.
Pass-through
Select this check box to pass documents on to the next

component in the process. This option is only available
in the eConnector (process) component.

790
Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
791
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
792

Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
1Boolean
2, 3Any
793
Symbol
Description
Result type
Operands type
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Document tab
Enter the document attributes on this tab.
Option
Description
Rename

rename schema in the schema field. If this check box is
selected but the schema field is left blank, the default
schema ~LFC::FileName~_~LFC::Counter~
will be used.
Folder Type
Select the desired type of the folder. There are two types
available:
Folder
LaserficheFolder
RecordFolder
Enter the folder into which the documents will be

stored. You can click the browse button (...) to select an
existing folder. If the entered folder does not exist on the
server, it will be created. If the folder is not specified,
the documents will be stored in the root folder of the
repository.
Note: You cannot create a file and a folder with
the same names on one level. It is the Laserfiche
Server restriction.
Note: The type of the selected folder should
match the folder type specified in the Type
field; otherwise, documents will be rejected.
794
Option
Schedule
Description
Specify a schedule for document retention. You can enter
the schedule manually or click the browse button to open
a Select a Schedule dialog box, that allows selecting a
desired schedule in the list box got from the server.
You can specify schedule only for documents stored in
folders of the RecordFolder type.
Note: If this field is left blank, documents will
inherit the schedule of the parent folder.
Tags
Choose tags that you would like to apply to documents.

Use the Add button to add a new tag and the Remove
button to remove a selected tag.
Index all pages
Select this option to index documents as they are created.

Note: If a repository has been configured
to Always index on document creation, the
documents will be always indexed. However,
if this option is not configured for a Laserfiche
repository, a user can choose whether to
index the newly created documents. (For
more information, refer to the Laserfiche
Administration Console help file.)
Fields tab
Configure the fields that will be assigned to a routed document on this tab. If you selected a template, this tab
automatically displays the list of fields specific to the selected template.
The list of fields displays the following parameters of the field:
Option
Description
Name
Required
If this parameter has the value Yes, then it is mandatory

to set a value for the corresponding field when
modifying document field data.
Type
Specify a field data type, that is the type of data that can
be stored in the field. The available data types are listed
below:
CharThis type of field accepts any alphanumeric

ASCII character.
Long IntegerThis type of field accepts integers
equal to or less than 3,999,999,999.
IntegerThis type of field accepts integers equal to
or less than 64,999.
DateThis type of field accepts a date value.
Date values will be formatted according to the short
date format defined in the Regional and Language
Options dialog box, which can be found in the
Windows Control Panel. For example, using the
English (United States) setting, December 25, 2004
would appear as 12/25/2004; however, using the
795
Option
Description
English (United Kingdom) setting, it would appear as

25/12/2004.
Date/TimeThis type of field accepts a date and
time. Date values will be formatted according to the
Window's short date format. Time values will be
formatted according to the Window's time format.
Both of these formats are defined in the Regional and
Language Options dialog box, which can be found in
the Windows Control Panel. For example, using the
English (United States) setting, December 25, 2004
would appear as 12/25/2004; however, using the
English (United Kingdom) setting, it would appear as
25/12/2004.
NumberThis type of field accepts a decimal
number with equal to or less than 13 digits before the
point and 5 decimal places.
TimeThis type of field accepts time in the format
HH:MM:SS. The time value is displayed in the list in
the HH:MM:SS AM/PM format. For example, if the
user specifies 0:09:03, the value will be displayed as
12:09:03 PM.
ListThis type of field accepts list of values that
have been previously configured by Laserfiche
Server administrator. You can choose one of the
available lists on the server.
BLOBThis type of field accepts Binary Large
Object. This type of fields presents only on the
Laserfiche Server versions 8.0.2 and later and is
not supported by the component. Therefore it is not
recommended to select this type of field because
there is no possibility to assign a value to it. If you
select this field, this field will be ignored by the
component at run time.
Multiple
If this parameter has the value Yes, then it is possible to

assign several values to the field. If this parameter has
the value No, the field can take only one value. Only the
fields on the Laserfiche Server versions 8.0.2 and later
can have Multiple property.
Value
The value of the field. A default value is displayed, if

available.
Edit
Select a field from the list and click this button to edit the
selected field value. This button opens a dialog in which
you can edit the field value. If the selected field has the
Multiple property, the Edit button opens the Multiple
Field dialog box.
Clean
Select a field from the list and click this button to delete
the value of the selected field.
Add
Click this button to add a new field to the list. This

button opens the Choose Fields dialog box.
796
Option
Description
Note: The Add button is available only when
you are connected to the Laserfiche Server
versions 8.0.2 or later. When you are connected
to the Laserfiche Server version 7.2.1, you
can assign only the fields from the specified
template to the routed document.
Remove
Select a field from the list and click this button to

remove the selected field from the list.
Choose Fields dialog box

Use this dialog box to select a field from the list of the available fields on the server.
The selected field will be added to the list of documents fields.
For each available field, the dialog displays:
Option
Description
Name
Type
The type of data that can be stored in the field.
Multiple Field dialog box

Use this dialog box to assign several values to the field that has a Multiple property.
This dialog box displays the field name and the list of values.
Note: Only the fields on the Laserfiche Server versions 8.0.2 or later can have a Multiple property.
Option
Description
Add
Click this button to assign a new value to the list of field

values.
Edit
Select a value and click this button to edit the selected

value.
Remove
Select a value and click this button to remove the

selected value from the list.
Text tab
Use this tab to set the OCR properties for the text or to activate the text extraction from electronic documents.
Option
Description
OCR
Select this check box to activate the recognition

properties group.
Language
Select the language of the text that will be recognized.
Decolumnize text
Select this check box to decolumnize the recognized text.

Note: This option is available since the
Laserfiche Client version 7.2.
Automatically rotate image
Select this check box if you want the image to be

automatically rotated for the proper text recognition.
797
Option
Description
Optimization priority
Specify the optimization mode from the list.

Extract text from electronic documents
Select this check box if you want to extract a text from

electronic documents.
Laserfiche component RRTs

Component RRT ID
The RRT ID for this component is LFC.
Name
Description
~LFC::FileName~
~LFC::Counter~

found within the destination directory. The counter value
concatenated with the name provides a unique file name.
~LFC::ID~
Unique ID of a document stored into Laserfiche. This is

applicable to Laserfiche eConnector.
The RRT scheme ~LFC::FileName~~LFC::Counter~ is replaced with the value "Document5" if the
original file name was "Document" and there were up to 4 Document files (Document1, Document2, Document3,
Document4) files already in the destination folder path.
This component does not support Date/Time tag names.
This component supports Laserfiche Client and Server versions 7.2.1, 8.0.2, 8.1.1, 8.2.1, 8.3.1 and 9.0.1.
Laserfiche Client has to be installed on the machine that is running this component. The version of the Laserfiche
Client should be the same as the version of Laserfiche Server.
When you are connected to the Laserfiche Server version 7.2.1, you can assign only the fields from the specified
Template to the routed document.
The BLOB field type that presents on the Laserfiche Server versions 8.0.2 and higher is not supported by the
component. Therefore, it is not recommended to select this type of field because there is no possibility to assign
value to it. If you select this field, this field will be ignored by the component at run time.
You cannot create a file and a folder with the same names on one level. This is the Laserfiche server restriction.
The component does not suport work with domain accounts.
Schedule functionatity is available since the Server version 8.2.
798
Server versions less then 8.1 require specifying Record Series code, when the user sends documents to a Record
Folder. The format is \RS_code RS_name\additional_path , where RS_code is a Record Series code,
RS_name a Record Series name, and additional_path the path to the desired folder.
Problem
Solution
You are unable to connect to Laserfiche through Process

Designer.
Make sure that you have a valid username and password.

Make sure that the client is working correctly by opening
the Laserfiche Client and connecting to the server
outside of this workflow application.
The Status Monitor displays the following messages:
These messages appear when the Laserfiche server is

unavailable or when there is no network connection to
the server. Make sure that you can connect to the server.
Error Laserfiche: Unknown error

Error Laserfiche: Error: Server not found.
Lexmark MFP
Welcome to the Lexmark capture component
The Lexmark capture component allows direct integration of Lexmark MFPs with the workflow server. This
component provides key functionality such as:
Multilayer menu definition for ease of use and quick indexing

Centralized meta-data form definition providing full centralized control over the indexing forms
Support for various meta-data field types such as Text, Numeric, Date/Time, List and Label field types
Support for Single Touch Scan when there is no need to enter document meta-data at the MFP panel
Support for various Scan Setting parameters; option to allow the user change the scan setting at the MFP panel
Device groupings allow devices to be grouped into functional or organizational groups
profiling information
Windows and Novell authentication at the MFP panel
authentication methods
Getting started
Supported devices
AutoStore support Framework versions 1.x, 2.x or 3.x of the Lexmark device software. The following devices are
supported.
Devices using Framework 1.x
Devices using
Framework 2.x (Note that
autostoreclient.fls
used here can be used with
devices using Framework 3.x)
X644e
X651de
X746de, X748de, X748dte
X646e
X652de
X792de, X792dte
X646dte
X654de
X925de
X85xe
X656de
C925de
T64x+4600
X658de
X950de, X952de
799
Devices using
Framework 2.x (Note that
autostoreclient.fls
used here can be used with
devices using Framework 3.x)
X646ef
X738de
X952dte
X772e
X736de
X954de
X782e
X734de
X954dhe
X940e
X738dte
X548dte
X945e
X466dwe
6500e
X466dte
X466de
X464de
X463de
X860de
X862de
X862dte
X864de
X864dhe
For the current list of supported devices, visit the Notable Solutions website.
Installing and configuring the Lexmark Client software
How to the install Lexmark client software
Specify the client software from the Lexmark device setup page.
1. Access the device setup web page by typing the following URL in your browser: http://device_ip_address.
2. Click the Settings on the left of the screen
3. In Other Settings, click Embedded Solutions.
4. Click the System tab and click Info.
Note the framework version.
5. Click Install, and click Browse.
6. Navigate to the correct Lexmark client folder:
For Lexmark framework version 1.2, navigate to:
C:/NSi_installation_directory/AutoStore Workflow6/Distributables/Lexmark/
eSF 1.2
For Lexmark framework versions 2.x and 3.x, navigate to:
C:/NSi_installation_directory/AutoStore Workflow6/Distributables/Lexmark/
eSF 2.0
7. Select the file autostoreclient.fls.
8. Click Start Install.
800
How to configure the Lexmark client to use the AutoStore server

The client configuration must specify the network address for the AutoStore server that runs the workflow that
contains the Lexmark MFP capture component.
1. Access the device setup web page by typing the following URL in your browser:
2.
3.
4.
5.
6.
http://device_ip_address
Click Settings on the left of the screen.
In Other Settings, click Embedded Solutions.
Click the Solutions tab and click AutoStore Client.
Click Configure.
In AutoStore Server URL, insert the URL address for the AutoStore server that is running the workflow
containing the Lexmark MFP component.
If you are uncertain of the address for the server, see How to Determine the Host Name or IP Address of the
AutoStore Server.
7. Click Test.
Note: If the test fails, the workflow service may not be running. Use the AutoStore Workflow Process
Designer to ensure that the workflow service is running.
How to determine the host name or IP address of the AutoStore server
You can use this procedure to determine the network address for the AutoStore server.
1. Create a new configuration file within AutoStore Workflow Process Designer and add the Lexmark MFP capture
component.
2. Right-click the Lexmark MFP component in the workflow, and Properties on the shortcut menu.
4. Copy the Server URL and replace "localhost" with either the host name or IP address of the server. To find the
address, open a Command Prompt window on the server and enter one of the following:
To get the host name, enter hostname after the prompt.

To get the IP address, enter ipconfig after the prompt.
How to assign a solution ID to the AutoStore client (eSF 2.0)

You may have to configure the solution ID for the eSF 2.0 client.
Perform this task for the eSF 2.0 client.
1. Access the devices setup web page by typing the following URL in your browser:
2. Click Settings on the left of the screen.
4. Click the Solutions tab and click AutoStore Client.
5. Click Configure.
6. Select a value for Function ID in the list.
By default it is Solution 5. If you do not have any particular reason to change it (only in case there is another
third party application for Lexmark MFP that uses the same function ID for its own purposes) leave it as Solution
5.
7. Restart the device if Function ID is changed from Solution 5 to another value.
How to configure authentication on the Lexmark MFP (eSF 2.0)
Use this procedure to configure AutoStore authentication on an eSF 2.0 client.
After installing and configuring Lexmark Client Software on MFP <link to the Installing and Configuring
the Lexmark Client software> AutoStore authentication Module gets registered in the Lexmark MFP system
automatically.
801
1. Access the devices setup web page by typing the following URL in your browser:
2. Click Settings on the left of the screen.
3. In Other Settings, click Security.
4. Click Edit Security Setup.
5. Click Security Templates.
6. Click Add a Security Template.
7. Enter AutoStore in the Security Template Name text box, select AutoStoreAuthModule for Authentication
Setup, and click Save Template.
Notice that Security Template with the name AutoStore has just been created.
8. Click Return to Edit Security Setups.
9. Click Access Controls.
10. Click an "AutoStore" value in the Solution 5 list.
If you assigned different Function ID when you were configuring the AutoStore client link to Assign Solution Id to
AutoStore client, and then select appropriate drop down list.
How to test the Lexmark MFP
1. Access the panel on the Lexmark MFP.
2. Select the AutoStore icon.
3. Verify that the Lexmark MFP component is accessible from the Lexmark MFP panel.
Configuring the Lexmark capture component
General tab
Lexmark devices can be grouped based on their IP address or hostname. Each group of devices can have its own
menu structure. By default there is a single group called the Default Device Group. If no additional groups are
configured, all devices pointed to the workflow server will display the menu structure under the Default Device
Group. There is a Default Menu and a Default Form in this group which can be removed. Additional device groups
can be created and devices assigned to them. Using this framework you can use devices connected to the same
workflow server for different functions.
Use menu bar or shortcut menu commands to add, edit, or remove groups, menus, and forms. You can drag items to
change the order of menus and forms that appear on the MFP control panel. You may also create custom menus and
shared forms. A shared form is a form which can be used within different menus. You can create a shared form much
as you would create a regular form but reference it in more than one menu.
Table 49: Menu bar commands on the General tab
Option
Add
Description
Click this menu and then click a command to add one of
the following.
Group of Devices
Menu
Form
Shared Form
Edit

menu, or form.
Remove

menu, or form.
802
Group
A group contains forms and that will be displayed at the device panel for specified groups of devices.
By default there is a single group called the Default Device Group. If you do not configure additional groups, all
devices will display the forms configured in the "Default Device Group". You can create additional groups and assign
certain devices to them. This allows devices are connecting to the same server to be used for different functions.
Groups are added and edited on the General tab of the Lexmark MFP configuration dialog box.
To add a group, click Add > Group on the menu bar of the General tab.
To edit an existing group, click the group, and then click the Edit button on the menu bar.
To delete a group, click the group, and then click the Remove button on the menu bar. The Default Device Group
cannot be deleted.
To copy or paste a copied form or menu into a group, right-click the group and click Paste.
Table 50: Group Settings

Option
Description
Display Text

as a logical group name.
Associated MFPs
In the MFP IP Address/Host name column, enter the

IP address or the host name of devices that belong to this
group. Press Ping to validate the hostname/IP address of
the MFP.
Select this check box to use authentication defined

for the component. Clear this check box to define
authentication settings for the group on the
Authentication tab.
For information about settings on the Authentication
tab, see Authentication Tab.
Menu
Menus allow users to access forms that capture data for the Lexmark MFP component.
Add and edit menus on the Groups tab of the Lexmark MFP configuration dialog box.
To add a menu, click the group or menu where you want to add a menu, and click Add > Menu on the menu bar
of the General tab. Then in the Menu Properties dialog box, configure properties for the menu.
To edit an existing menu, click the menu and click Edit on the menu bar.
To delete a menu, click the menu and click Remove on the menu bar.
You can right-click and use shortcut menu commands to Cut, Copy, Paste, menus that appear on the Groups tab.
You can click and drag a menu to reposition it.
Table 51: Menu Properties
Option
Description
Display Text
Enter the name of the menu that will be displayed on the

MFP panel.
Normal
Enter the full path to the file for the image that will be
displayed on the MFP panel. This image is the icon that
is displayed prior to the user pressing that icon on the
803
Option
Description
MFP panel. If no image is selected, the default image on
the MFP panel will be used.
Pressed
Enter the full path to the file for the image that will be
displayed on the device after the user has pressed the
icon. You can click the browse button (...) to locate an
image file. This image replaces the Normal image on
the MFP panel after the user has presses it. If no image
is selected, the default image on the MFP panel will be
used.
Form
When setting up a form the following four tabs must be configured:
General Tab
Fields Tab
Components Tab
Appearance Tab
General Tab
Option
Description
Display Name

form.
Single Touch Scan
Select this check box if you do not want the user to enter
option, the scan operation will start immediately after the
user presses the "form" button on the device.
Access Control
Access to the form can be control with the following

options:
Scan Settings
Public Allows unrestricted public access to the

form.
Restricted AccessRestricts access to users or
groups listed. Users can also search for users and
groups by checking.
Active Directory IntegratedAccessing the active
directory to authenticate users.
This table lists all of the available scan settings.

Configure settings in the four columns:
The Parameter column shows a configurable scan

setting. Settings are grouped under Basic Options
and Advanced Options. You can scroll the list up or
down to see additional options.
In the Value column you can set default scan settings,
which will be used if the user does not change
the setting at the device panel. See the Lexmark
User Guide for a detailed description of each scan
parameter.
804
Option
Description
Select the Locked checked box to prevent users from

changing a setting at the MFP device panel. Select
the Locked check box next to Basic Options to
prevent users from changing any of the basic options.
Select Default to use the default setting supplied
by the MFP device. You cannot set values for a
parameters while the Default check box is selected.
Note: The Default selection overrides the
Locked setting, so selecting both Locked
and Default is not any different result than
just selecting the Default check box. The
user may still define different scan settings
for parameters at the MFP console.
Settings for Basic Options:
Page SizeSelect from the list of available page

sizes.
SidesSpecifies Simplex (one-sided), Duplex Short
Edge (two-sided, bound on short edge) and Duplex
Long Edge (two-side, bound on long edge).
document, either portrait or landscape.
ResolutionResolution in dpi (dots per inch) of the
scan.
File FormatFile format of the scanned document
(TIFF, JPEG, PDF, RAW (2.0), Secure PDF, XPS).
Multi-Page TiffSpecifies whether the TIFF file
contains a single page image or a multi-page images
(subfiles).
available color mode. The target document will be
rendered in Black and White (grayscale) or Color. If
no value is specified, Color will be used. If the device
is only able to scan in monochrome then all scans
will be monochrome, regardless of the setting here.
Mono Bit DepthSpecifies bit depth and used only
when Color Mode is set to Black and White. This
setting is ignored if Color Mode is set to Color and
bit-depth will be set to 24-bit. This setting is only
available with devices using Framework versions 2.x.
For previous versions, use the Composition setting.
CompositionSpecifies the image composition of
the job. The image composition defines the bit depth,
number of planes, and color space of the image data
to be generated by the job. Not all combinations of
image composition, file format and compression
are valid for Framework versions 1.x. This setting
is not used and has no effect for devices running
Framework versions 2.x.
Content Contents of the target document.
CompressionSpecify different formats for
compression of the scanned image. Not available
with devices using Framework versions 2.x.
805
Option
Description
Settings for Advanced Options:
Note: Not all Lexmark MFPs support these
options. Refer to the user manual for a device
for more information.
Custom JobAllows a user to concatenate sets of

original scan jobs into one single job. Jobs may from
different sources and different settings.
DarknessThe darkness level of the scan with (1)
being the lightest and (9) the darkest.
Edge Erase (Top, Left, Right, Bottom)Specifies
the amount of image data to erase at either the top,
left, right or bottom of the original image window.
This option allows the user to eliminate unwanted
marks along the edge of the target document.
Scan Preview (hard drive)When enabled, the
user will see a thumbnail of the image scanned. With
flatbed devices, a thumbnail will be displayed for
each page scanned. For ADF devices, a thumbnail
will be displayed for only the first page.
Background RemovalSpecify the background
removal level of a scan. Higher values change lighter
shades to white. A value of zero (0) is neutral.
Color Dropout (2.0)Turns the selected color to
white in order to aid with forms processing functions.
Also turns dark marks and notations to black. This
setting only affects grayscale jobs.
Color Dropout Threshold (2.0)Specify the
threshold for shades to become either black or
white. By increasing the threshold, darker shades
become black while lighter shades become white. By
decreasing the threshold, darker shades become white
while lighter shades become black.
ContrastSpecify the contrast level of the scan.
Higher values results in more contrast.
JPEG QualityThe amount of image quality
and detail to be retained by the JPEG compression
algorithm.
SourceSpecify the scanning source.
Negative Image (2.0)Specify whether the image
produced by the scan is to be inverted.
Shadow DetailSpecifies the black-point level of
the scan.
Scan Edge to EdgeSpecify whether target
document will be scanned from edge to edge or only
within the specified margins.
SharpnessSpecify the sharpness of the image.
Increasing the value may be useful for blurry text.
Decreasing the value may be useful for patterns.
Action Button Text (2.0)Specify the text to
be displayed on the Action button. If no text is
specified, the default text for the action is used.
806
Option
Description
Dynamic Form
One Page CopySpecify whether scanner scans an

entire job at one time or one page.
Pdf Password (1.2 on X940e, X945e)User
can specify a password to use for secure PDF. File
Format must be set to SECURE PDF. This setting
does not apply to Framework versions 2.x.
Pdf Algorithm (1.2 on X940e, X945e)Specify
the encryption algorithm to use with secure PDF.
File Format must be set to SECURE PDF. With
Framework versions 2.x, the encryption algorithm is
selected automatically.
Restart Job (1.2 and older)Specify whether the
job must be resubmitted when the job is canceled for
any reason. This setting does not apply to Framework
versions 2.x. For Framework versions 2.x, the user
can use Scanner Jam Recovery instead of this
setting.
Scan Recovery (1.2 and older)Specify whether
a job resumes immediately after the MFP devices
jams. Successfully scanned pages will be preserved
and scanning will resume after the last good page. If
setting is not selected, the job will not resume after
the MFP device jam.
Scanner Jam Recovery (2.0)Specify whether the
full or partial job must be resubmitted when the job is
canceled for any reason. If Page-level is selected and
the entire job must be restarted, then the job must be
resubmitted. The Page-level setting saves all properly
scanned pages but all pages after the first jammed
must be resubmitted.
Standard behavior of a form can be modified by

responding to events.
Enable Dynamic FormThis check box allows the

workflow sever to load form snap-ins. Here are some
examples of what enabling dynamic forms can do:

Change field contents, for example, load the
contents of a list field from a database)
Snap-in pathSpecifies the full path to the
compiled snap-in (.NET assembly) that contains the
code to respond to form and field events. If you have
an existing snap-in to use, click the browse button
(...) to locate the file.
Source PathSpecifies the full path to the source
code of the snap-in. This path is used by code editor
to compile the snap-in only during design time.
Create/Edit Snap-inYou can click this button
to open a code editor window with basic snap-in
code. For details of the code editor window and
807
Option
Description
the object model used to respond to form and field

events, click Help in the code editor window to
refer to the Lexmark Capture Component Snap-in
Documentation.
Raise event when Form is loadedCheck this
check box to cause the form to initiate an event every
time the user enters the form.
Raise event when Form is submittedSelect this
check box to make the form to initiate an event every
time the user presses Scan button for the form.
Fields Tab
Option
Description
Name

within this form. This name is displayed for the field
on the device panel. The field name labels the RRT
if the field name is "Field1", the RRT is ~K20::
%Field1%~. The name can be any combination of
alphanumeric characters. Spaces and special characters
(for example, ~, !, @, , $, %) are not allowed.
Display
The text that labels a field on the device panel.
Type

TextAllows a user to enter plain text.

IntegerAllows a user to enter integers (whole
numbers only).
be made searchable.
N (notify server)
Select the check box in this column to trigger an event

when the value of the field changes. You can respond
to this event in the snap-in that was configured for the
dynamic form section in the General tab. For details
on how to respond to form and field events, refer to the
Lexmark Capture Component Snap-in Documentation.
P (properties)
Click the browse button (...) in this column to edit

properties for a particular field type.
808
Components Tab
Configure the component for this form by clicking the configuration button (...) in the last C column of the table.
Clicking this button for a component displays its configuration window. For more information about configuring a
component, click the Help button in the component configuration window.
Appearance Tab
Field Name
Description
Description

form.
Scan Button Label
Enter the text that will appear on the scan button on the
display panel for the device.
Button Images
NormalEnter the location of the image that will

be displayed on the MFP panel (this image will be
the icon that is displayed prior to the user pressing
that icon on the MFP panel). If no image is selected,
the default image on the MFP panel will be used.
PressedEnter the location of the image that
will be displayed on the device once the user has
pressed the icon (this image will be displayed for a
corresponding icon once the user has selected that
icon; that is, the image used will change from the one
specified in the Normal field to the one specified in
the Pressed field). If no image is selected, the default
image on the MFP panel will be used.
Shared form
A shared form is exactly the same as a regular form with the exception that any specific shared form can be
referenced multiple times. This option allows the user to create one shared form and reference the same form in
another group or menu.
Field Name
Form List
Description
The list box shows existing shared forms.
Display NameShows the name of a form.

# of RefsShows the number of groups or menus
that reference a form.
Add
Select Add to create and customize a shared form. For

information on creating and customizing a form, see the
Form help page.
Remove
Click this button to delete the selected shared form.
Edit
Click this button to edit and customize the selected

shared form.
Refs
Click this button to display information on the number of

references a shared form may have. This allows you to
manage different groups or menus that reference a shared
form.
809
Field Name
Description
Note: A shared form may not have any
references. That is, a shared form can be created
without being placed within a group or menu.
Field types
Text field options
Option
Description
Default
The default value that will appear on the MFP panel.
Required

Default value, if specified, satisfies this requirement.
Password
Select this check box to mask text in this field when it

displayed or entered on the device panel. The default
value is false.
Max Length
The maximum length of the text string allowed.
Min Length
The minimum length of the text string allowed.
Regular Expression
Specify the format that a user must follow when entering

text. The entered value by the user will be validated
against this expression.
Error Message
The error message that will be displayed on the device

panel when the entered value does not follow the format
specified by the regular expression.
Integer field options

An integer field allows users to enter integers (whole numbers).
Option
Description
Default Value
Required

Default value, if specified, satisfies this requirement.
Password

displayed or entered on the device panel.
Maximum Value
The maximum allowed integer value.
Minimum Value
The minimum allowed integer value.
Error Message (2.0 only)
The error message which will be displayed on the device

panel when the user enters an incorrect value.

A numeric field allows users to enter numbers.
Option
Default
Description
The default text that will appear on the MFP device
panel.
810
Option
Description
Max Length
The maximum number of characters allowed for the text.
Min Length
The minimum number of characters allowed for the text.
Required

specified, satisfies this requirement.
Password

displayed or entered on the device panel.
Regular Expression

a numeric value. The entered value by the user will be
validated against this expression.
Error Message

Keyboard Type
Specify the keyboard type that will be displayed on the

device panel.
List field options

To add a value to the list field, type in the blank Value box in the last row of the table. To remove a value, click in the
first column to select the value, and then press the Delete key on the computer keyboard.
Option
Description
Value
Label

column.
Selected
Select list items that will be preselected when a user

activates the form. If Allow Multiple Selection is
checked, you can preselect multiple list items. If it is not
selected, then you can only preselect one list item.

will be the selected values separated by Item Separator.
Display Search Option
Select this check box to allow the user to search the list.
Delete All
Apply Search Pattern to Current ListSelect

this check box to allow the user to search through
the elements that have been added to the list field
type. If Apply Search Pattern to Current List is
not selected and the user attempts to search through
the elements of the list field type, the search must
be implementing through custom scripting. This
option is only available if Display Search Option is
selected.
Click this button to delete all values from the list.
811
Option
Description
Import
Specify a comma separated list (CSV) file to import

previously saved values into the list.
Export
Click this button to export the current list into a comma

separated list (CSV) file.
Tree field options

Perform the following actions in the Tree Field Properties dialog box.
To add a root node, right-click in the box, and click Add Root Node on the shortcut menu. Then, in the Tree
Node dialog box, enter the Label and Value for the node item.
To add a node under an existing node, right-click a node in the tree, click Add. Then, in the Tree Node dialog box,
enter the Label and Value for the node item.
To edit a node in the tree, right-click the node and click the Edit button.
To remove a node from the tree, right-click the node and click Remove.
Table 52: Tree Field Properties

Option
Description
Value of the Node
Shows the value for a selected node.
Defaulted Selected Node
Specify the node which will be selected by default on the

device when a user activates a form.
Path Separator
Specifies the character inserted between the node labels

in a node path.
Table 53: Tree Node settings

Option
Description
Label
see in the device panel when navigating the tree.
Value
sent to the server.
Preferences tab
processed.
Server
Specify the web server captures scanned document images and associated metadata using HTTP or HTTPS. This
allows a web application or service to directly receive the data rather than monitoring for a file to appear at a
Option
Description
Server URL
The HTTP URL from which the data will be retrieved by

the workflow.
Server SSL URL
The HTTPS (SSL) URL from which the data will be

retrieved by the workflow.
812
Option
Description
SSL Certificate
The certificate by which data can be retrieved by the

workflow server, when using HTTPS (SSL).
Home Folder

Keep
Option
Processed Files
Description
option.
Rejected Files

Note: The service account for the service must have write permissions on the Processed Files and Rejected
Files directories.
RRT's Format tab
Option
Description
# of 'Received Time' RRTs
Specifies the number of RRTs that represent Received

Time. For example if you set this value to 2, then 2 sets
of RRTs (representing the Scan Time Stamp) will be
Received Time list
The box on the left lists the Received Time RRTs and
allows you to configure the date-time for each one.
Date/time formats list
The box on the right lists examples of date time formats.

You can drag entries from this list to assemble a format
strings for a Received Time RRT. For details about date/
time formatting, see Custom DateTime format strings.
File Size Format
Specify the unit in which the File Size RRT will be

represented:
Byte
KB
MB
GB
813
Custom date-time format strings

formats are not available on all devices. The following elements are supported:
Format specifier
Description

dd

EEE

panel.
EEEE

control panel.

MM

MMM

example Jan, Feb).
MMMM

January, February).
yy
yyyy

twelve-hour time.
hh

HH

mm

added.
Displays the A.M./P.M. designator for the time.
All other alphabetic characters are invalid. Symbols and numeric characters, however, are untouched. A few
examples:
814
EEEE, MMMM dd, yyyyMonday, January 03, 2009

yyyy-MM-dd HH:mm2009-01-03 15:35
hh:mm a3:35 P.M.
Authentication tab
Authentication requires MFP users to provide valid credentials to send documents to the workflow server. The
authentication settings are configured for the server, and they can be enabled or disabled for any group of MFPs.
Option
Authentication Type
Description
Choose the authentication method to be used by the
component.

StandardUses Windows Active Directory or other
LDAP server for authentication.
NetwareUses NetWare authentication.
CustomPluginThe administrator has full control
over the prompts presented to the user and validation
of user entries.
In the Server or LDAP Path box, enter the Active

Directory server name or IP address or the LDAP path
for authentication.
Two types of bind are available:

authentication is within the same domain, the Server
or LDAP path can be left blank.
Simple bind - Enter the Server or LDAP path
(LDAP://server name,5000)
For either bind, you can configure the following options:
Fast BindIf disabled, the Active Directory Server

returns all the user attributes to the workflow server.
Server BindIf disabled, the Active Directory
Server tries to connect to DNS server to resolve the
IP address of the workflow server.
Use SSLIf disabled, the connection between
LDAP and Workflow server is not encrypted. To use
SSL option you must have a server certificate for the
ADAM service . If verifying against another domain,
enter the server name and port number (LDAP://
server name,5001). Click Test to verify that
the user name created on the server authenticates
successfully.
Refer to the Microsoft web site for information about

setting the LDAP Bind options.
NetWare

NDS TreeEnter the default nDS tree.

The administrator defines prompts that are displayed to

the user.
815
Option
Description
User Info Lookup
Snap-in pathSpecifies the path to the compiled

snap-in (.NET assembly) that contains the custom
authentication code. You can click the browse button
(...) to locate the snap-in file.
Source path Path to the source code of the snapin. This path is used by code editor to compile the
snap-in only during design time.
Create/Edit SnapinClick this button to open
a code editor window with basic snap-in code.
For details of the code editor window and the
object model, please refer to the Lexmark Capture
Component Snap-in Documentation by clicking the
Help button in the code editor window.
You can configure an LDAP search to retrieve additional

information about the authenticated user, such as their
email and full name. To enable this feature, select
the Use LDAP Search to retrieve additional user
information check box. Click the Configure button
to open the LDAP Lookup Settings dialog box to
configure settings for the LDAP server. For more
information, see LDAP Lookup Settings.
Note: When "Standard" is selected as the
Authentication Type, the email address
is retrieved automatically as part of the
authentication, so an LDAP search is not
required if you only need the email address.
Test Lookup

the Username box and click the Test button.

Obtaining a certificate
the Microsoft website. To install a Certificate authority select the Certificate services check box.
1.
2.
3.
4.
5.
6.
7.

816
8. In the Friendly name text box, write the full DNS name of the server.
\MachineKeys.
32. Type the DNS name of your server in the server box.
ADAM).
34. Select the SSL check box and click OK.
817

LDAP server.
Option
Description
LDAP Server
Root DN
Enter the distinguished name for the node where

the search should start. No value is required if
Windows authentication is used. A DN is made up of
attribute=value pairs separated by commas. The value
must begin with LDAP:// in the following format:
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636

Login as anonymous


Directory Search
In the Directory Type box, select the type of directory to

be searched.
Active Directory or eDirectoryKnown

predefined attributes will be used to match the
authenticated user name and retrieving the email
address.
CustomIndicate which attribute is going to be
used to identify a match against the authenticated
user in the Match username against box. You must
also provide the LDAP attribute that contains the
email address of the user in the Get email address
from box.
To retrieve other information about the user in addition

to the email address, you can specify additional LDAP
attributes in the Additional attributes box. Type the
name of these LDAP attributes separated by a semicolon.
Replacement Tag Names (URTNs). Only the email
address will be retrieved if this box is left empty. For
818
Option
Description
details about Kyocera MFP (HyPAS) URTNs, see
Lexmark MFP Component RRTs.
Test Lookup

the User name box and click the Test button.





Empty
Result
used.
Server belongs.

Auto Store server is running will be
used.
Example: LDAP://
Example: LDAP://

used.

specified server.
Example: LDAP://
Lexmark MFP component RRTs

Component RRT ID
The RRT ID for this component is LXM.
Name
Description
Number of Files
Number of documents received in a batch.
File Size
Size of the received file.
819
Name
Description
Form ID
The GUID of the form selected at the network scanner.
Batch ID
The GUID of the received batch.
Sender Username
The name of the user authenticated on the device.
Sender E-mail
The email address of the user authenticated on the

device.
Device IP

received.
Device Host Name
Host Name of the device from which a batch has been

received.
Device Domain Name

been received.
Device MAC Address
The network MAC address (UAA) of the device.
Device Model Number
The model name of the printer.
The serial name of the device.

Lotus Notes Domino

Welcome to Lotus Notes/Domino component
Notes/Domino Store is a destination component that can be used to store information of any kind, text, graphics, and
scanned images, even sound and digital movies in company repositories called databases within the Lotus Notes/
Domino system.
Each database stores two kinds of information for each document:
Document content
Metadata or properties
This is the file you create using applications such as

word processors or spreadsheets.
Refers to descriptive characteristics, such as the
documents type, format, title, subject, keywords, and
author.
Getting started
Feature highlights
Use this component to store documents within the Notes/Domino system.

Use the search field to update/add document content or metadata to an existing record in the Notes/Domino
database.
Using the Lotus Notes/Domino component

The following is a common usage scenario:
820
The MFP devices can be configured with a Notes/Domino button, where, by pressing this button, images are scanned
in and then stored in a designated database in the Notes/Domino System.
Licensing
There are no special levels of licensing for this component.
Configuring the Lotus Notes/Domino component
General tab
Select the following options from this tab:
Option
Description
Server
Optional input, if the database is remote, this is reference

to a server on which the database is located.
Password
Enter the password for the current User ID that is being

used by the Notes/Domino system to log in to a database.
Database Name
Enter the file name of an existing database.
Form Name
Enter the title of a form note in the selected database.
Attachment Field
Enter the field within the selected form that incoming

document content/file will be stored in.
Rename File
Check this box if you want the output file to be renamed

based on the Rename Schema settings.
Schema
Enter the Schema name for the output file name. You can
use Runtime Replacement Tags (RRTs) to dynamically
set the value of the schema.
Calculate Computed Fields
When this checkbox is selected, the server will trigger a

recalculation of field formulas after a record is created
or updated. This allows the predesigned field formulas
to recalculate all related field forms upon creation of a
record.
Ignore Validation Errors
Select this checkbox to allow the server to ignore any

field validation errors that might be caused. If you do
not select this checkbox, any field validation error will
cause a failure in creation of a record. You can only
select this checkbox if Calculate Computed Fields and
Validation Formulas in the Form is selected.
Field Values tab

This tab allows you to select the following options:
Option
Add
Description
Click this button to assign values to fields of the selected
form. You can select the search key if you want a search
of the notes database prior to creation of a new record.
821
Option
Description
If the search of the database returns only one record
matching the search key, the incoming document content
and metadata is added to the existing record.
If the search returns more than one match, a new record
will be created in the database.
Modify
Click this button to modify field values of the selected

form.
Remove
Click this button to delete field values of the selected

form.
Set Field Value on Search
When search keys are used, if a matching document

is found, then the any existing field in the record is
replaced with the field values in the current job.
Component RRTs
Component RRT ID
The RRT ID for this component is LND
Name
Description
FileName
Counter

FileExt
~LND::FileName~~LND::Counter~ - replaced with the value Document5 if the original file name was
Document and there were up to 4 (Document1 to Document4) files.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
822
SSRTN
Description
%c
Date and time representation appropriate for locale
%d
%H
%I
%j
%m
%M
%p
Current locales A.M./P.M. indicator for -hour clock
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%x
Date representation for current locale
%X
Time representation for current locale
%y
%Y

The RRT string ~LND::%Y~-~LND::%m~ will be replaced by 2003-9.
Problem Description
Component displays the message Unable to
find path to server or Server is not
responding.
Solution
There are a few different situations that might prevent
this component from connecting to a particular Notes
server:
The server is temporarily unavailable. If you can't

connect to the same server using the Notes client, but
you have been able to connect to that server in the
past, this is the most likely reason.
The server is not reachable through any of the
network ports that are enabled for the current
location. If you can't connect to the same server using
the Notes client, and you've never connected to that
server before, this might be the problem. Contact
your Notes administrator to determine which port(s)
you need to use.
The server is not reachable through the network port
used by this component. If you can connect to the
same server using the Notes client, this is the most
likely reason. This happens because the Notes client
will use all available network ports when trying to
823
Problem Description
Solution
reach a server, while this component use only one
port, typically the first one enabled for the current
location. You can do the following to enable a
network port:
Reorder the ports so that the port you need to access
the server is listed first. To do this, you can click File >
Tools > User Preferences > Ports in the Notes client, or
you can edit notes.ini and reorder the ports specified
by the Ports= entry.
Cannot create documents in the database.
If you can't create a document, open the Lotus Notes

client and click File > Database > Access Control to
see the Access Control List for the database that contains
the document. To create a document, you must have an
access level of Depositor access or greater. In addition
to having this level of access, you must also select the
option Create documents.
This component must be installed on a computer that has either the Lotus Notes client or the Lotus Notes\Domino
server installed.
The path to the Lotus Notes\Domino directory must be on the system path.
This component uses the Notes ID specified in the Notes initialization file (notes.ini) when attempting to log
on to the Lotus Notes\Domino server.
Multi-Poll
Welcome to the Multi-Poll component
Multi-Poll is a Capture component that lets you batch load files into your applications using a polling algorithm that
can be customized by different parameters: Priority, wild-card mask, Traverse flag and As One flag. Using Multi-Poll,
you can import documents of any format, from any shared network drive, process the content, and store them into its
supported document and database management system.
The Multi-Poll component is designed to capture documents and then move them from the Input Directory to the
Working Directory before introducing them into the process.
Getting started
Feature highlights
The following lists the major features of this component:
Maintains a list of input folders, either local or network shared resources, to poll from.
Has a configurable search engine.
Is a blocking component and maintains a set of configurations of dependent components.
Supports Runtime Replacement Tags (RRTs).
Has a flexible user interface.
Using the Multi-Poll component

Use this component to capture files from multiple folders into an workflow.
Common usage scenarios:
Creating and saving a process with Multi-Poll component.
824
1. Fill out the Folders tab with the folders you want to poll (with the root input folders). Use right mouse click.
Check the Traverse option if you want the component to search through all subfolders. Check the Concurrent
option if you want all files in one subfolder to be captured at one poll. Increase the Priority field of those
folders which is less important to poll.
2. Configure the number and format of date-time RRTs on RRTs' Format tab if you need them.
3. Create as many configurations as needed on the Configurations tab to store configurations of process and
route components. Configure process and store components for each configuration. Use RRTs if needed. In
most cases one configuration is enough. Associate each folder to its own configuration if needed (Folders tab,
configuration column)
4. Check the working folder on Misc tab. Change it if necessary.
Starting the process from the Service Manager interface.
Renaming the subfolder under a root input folder to the name matching Excluding Mask on Misc tab, to prevent
searching in it (such as, "Dir1" to "_Dir1").
Configuration walkthrough
This example demonstrates how to create a process that takes all files from a list of folders and its subfolders and puts
them to another folder structure according to when the file was last modified. The target folder tree will be organized
hierarchically by year>month>day.
1. In the AutoStore Process Designer, click File > New, and set Perform this task to create a new configuration,
and set the task frequency to 1 second.
2. Drag the Multi-Poll capture component and the Send to Folder route component into the configuration.
3. Double-click the Multi-Poll component, and on the Folders tab, click Add Folders and add folders to the
component.
In our example we have the following source folder structure in C:\tmp\in:
825
We want to poll Folder1Folder6, but not c:\tmp\in itself. After we add c:\tmp\in, the component scans the
entire folder structure and adds it to the folder list:
4. Remove the first row from the list and select the Traverse check box:
826
5. Switch to RRTs' Format tab, increase Last Write Time RRTs to 3, and enter the following formats:
RRT
Value
Last Write Time 1
yyyy
Last Write Time 2
MMMM
Last Write Time 3
dd
827
6. Switch to Configurations tab and configure the Send to Folder component with the following parameters (use
Multi-Poll and Send To Folder RRTs from the Available RRTs dialog box):
Option
Value
Folder Path
C:\tmp\out\~FPP::FileLastWriteTime1~
\~FPP::FileLastWriteTime2~
\~FPP::FileLastWriteTime3~
Rename File
Select this check box.
Schema
~STF::FileName~_~STF::Counter~~STF::FileExt~
7. Click the OK button in the Send To Folder component configuration dialog box.
8. Press the OK button in Multi-Poll configuration dialog box.
9. Click File > Save and name the file MultiPollDemo.cfg.
10. Start the process from the Service Manager interface.
11. Copy any folder structure under the folders Folder1Folder6, and see the result in c:\tmp\out.
The result should look something like this:
828
Configuring the Multi-Poll component

Description of the search engine
During the initialization, the Multi-Poll component separates root input folders into different queues according to the
Priority value. All folders with a priority of 1 will go to queue 1, folders with a priority of 2 will go to queue 2 and
so on.
At the time of each polling, the component will either perform the search through the list of queues until it finds a file
that matches the Mask value or the component will look through all root input folders to find nothing. If the Traverse
option is checked the component will search in subfolders of the root input folders as well. If the component finds a
folder with files and the Concurrent flag is checked it returns all files in that folder (but not files in any subfolder).
The search is performed in the following order:
The component gets the input folder from the queue with the highest Priority and puts that folder on the end of this
queue.
The component then checks the folder for any files:
If files are available, then the file with the earliest creation date is picked up.
Note that a creation date is when the file is created or copied (not moved) to the folder.
If the Concurrent flag is checked, all files in the folder only (not the subfolder) are picked up.
If the folder does not contain files and the Traverse option is checked, the component continues to search its
subfolders.
829
If all the subfolders of this input folder are empty, the component will get the next input folder of this queue
and will put it on the end of this queue.
If the component looked through the entire queue and did not find anything, the component will look through the
queue with the next highest Priority value.
If the component has looked through all the queues without finding any documents, the component returns an
empty list of files and terminates the search.
Warning: The component deletes any empty subfolder in the input folder.
Folders tab
This tab provides the list of input folders and specify the polling criteria.
Option
Description
Add Folders
Click this button to add root input folders to the list. You
can browse for an existing folder or create a new folder.
Include Subfolders
Click this button to open the Include Subfolders

Options dialog box, in which you can configure the
following options:
Include SubfoldersSelect this check box to add

subfolders of the folders in the list and treat them as
independent root folder.
Remember this choiceSelect this check box to
perform this action on any folders that are added later
on.
Copy
Copies selected data from the grid to the Windows

Clipboard.
Paste
Pastes data to the grid from the Windows clipboard.
Multiple cells can be selected and copied onto the

clipboard.
Selected cells can be filled with the same value by
copying this value to the clipboard, then selecting
multiple cells and pasting.
If the clipboard contains tabular data, it can be
pasted into the grid by right-clicking on the desired
cell. This cell should be in the left top corner of the
desired area.
Remove Folders
Delete input folders from the list. Select an entire row to

delete it.
Name
Specifies names of folders.
Traverse
Each folder must have a unique name.

By default the name of the directory is loaded.
When duplicate folder names are added using the
Add Folders... menu item or by copying and pasting
of rows, the folder name will automatically be
changed to a unique folder name by appending 3
digits to the end of the name: 001, 002 etc.
Select this check box to poll the subfolders of this input

folder for documents.
830
Option
Mask
Description
Used by the polling algorithm to search and obtain
only the files that it matches. A mask can be either
simple or complicated. A simple mask can use wildcard symbols: ?(any one character) and *(any number of
characters).
A complicated mask is composed of any number of
simple masks joined with the "\" character.
Examples of simple masks:
m??p*.tifAll files beginning with "m", with the

4th character "p" and extension "tif".
*.*All files.
Examples of complicated masks:
simple_mask\simple_mask
simple_mask\simple_mask\simple_mask
You can make use of this mask when you use the
Traverse flag, and the last simple mask always relates
to files and first n-1 masks to the first, second and etc...
subfolder of the input folder.
For example this mask "m*\11*.pdf" will return only
files that match the mask 11*.pdf in the directory that
matches the mask m*.
Priority
This field is used by the polling algorithm to group the

input folders to queues. The folders with the highest
priority (which is the lowest integer number) is polled
first. Priority is specified by any integer number greater
than 0.
Concurrent Poll
Select this check box to have the search engine finds

files in a folder under the root input folder. It will return
all files in that folder (only in that folder, not in its
subfolders) as one job. If this check box is cleared, the
search engine will return only the first file.
Configuration
Specify which configuration should be used for this

specific folder from the list of configurations that were
created under the Configurations Tab. Each input folder
can use its own configuration of process and store
components.
Path
Points to the full path of the folder. Each Path can be

local, or point to a network shared resource in UNC
format.
Examples:
c:\somefolder\anotherfolder
\\server\shared_resource\folder
Points to the full path of the folder. Each Path can be

local, or point to a network shared resource in UNC
format.
831
Option
Description
UNC paths should be entered manually. Local paths can
be provided by clicking the browse button (...) to open
the Browse for Folder dialog box.
Configurations tab
This tab saves component configurations for input folders.
Configurations for components in the workflow may be created for each input folder. Each configuration loads the
process and route components that were provided in the workflow. Any number of configurations for the components
can be provided and later specified for each folder.
Option
Names
Description
This list identifies the configurations. To add a
configuration to the list, click the empty row and
type a unique name. To configure components for a
configuration, select the configuration name and the
configure components in the Component list.
The shortcut menu provides commands that act
on configurations. To perform a command on a
configuration, first click in the first column and select
one or more rows, then right-click the selection to access
the following commands:
Copy Names from Folder NamesCopies

the names of folders listed on the folders tab to
the configuration list, so you can quickly name a
configuration for each folder.
CopyCopies a selected rows to the Windows
Clipboard.
PastePastes copied rows to the list. Pasted
names are appended with three digits (for example,
Config001, Config002) to avoid duplicate names.
Delete Rows Deletes selected configurations from
the list.
Caution: If you delete a configuration, all root
input folders associated with this configurations
will be deleted too.
Ordinal number for a component in the workflow.
Component
The name of a component in the workflow.
Description
The description associated with a component.
Type
The type of component (Process or Route).
C (configure)
Click the browse button (...) in this column to display the

configuration dialog for a component in the workflow,
so that you can activate or configure the component for
a configuration. Opening the configuration dialog for
a component also opens the Available RRTs window.
You can click and drag or use Ctrl+C (copy) and Ctrl
+V (paste) to add an RRT to a field in a component
832
RRTs' Format tab

This tab allows you to configure the format of RRTs that represent date and time
Option
Description
Creation Time
Specifies the number of RRTs that will represent the

creation time for files. Each RRT appears in the adjacent
list as Creation Time n where n is an ordinal number
from 1 to the number of RRTs specified in this box.
Last Write Time
Specifies the number of RRTs that will represent the last

write time for files. Each RRT appears in the adjacent
list as Last Write Time n where n is an ordinal number
Capture Time
Specifies the number of RRTs that will represent the

capture time for files. Each RRT appears in the adjacent
list as Capture Time n where n is an ordinal number
RRT list
This box lists the quantity of creation, last write time,

and capture time RRTs specified in the # of RRTs boxes.
In the text boxes, enter the a date-time format to define
each RRT. You can type a date/time format string in a
box or drag date/time formats from the list. You can also
click a format in the list and click the
copy it to an RRT definition.
button to
For more information about date time strings, see Date

Time Format Strings.
File Size Format
Specifies the unit in which the File Size RRT

(~FPP::FileSize~) will be measured (byte, KB,
MB, or GB).
Custom date-time format strings

Format specifier
Description

dd

EEE

panel.
EEEE

control panel.
833
Format specifier
Description

MM

MMM

example Jan, Feb).
MMMM

January, February).
yy
yyyy

twelve-hour time.
hh

HH

mm

added.
All other alphabetic characters are invalid. Symbols and numeric characters, however, are untouched. A few
examples:

yyyy-MM-dd HH:mm2009-01-03 15:35
hh:mm a3:35 P.M.
Misc tab
Option
Description
Excluding Mask
If any subfolder of the root input folder matches this

mask, the search engine will not search in this subfolder
or in any of its subfolders.
Remove Subfolders
If this check box is selected, the Multi-Poll component

will remove any empty directory located under root
directories. Root directories will not be removed.
Working Folder
Specifies where the file should be copied to before it will

be passed to the workflow.
The usage of this directory is to remove documents
from the input directory so that the document will not be
picked up again. All documents in the input directory
834
Option
Description
are processed. Therefore, when you remove a document
and place it into the working directory, it prevents the
infinite processing of the same document.
Keep
To determine where your files are stored, select the

desired check boxes:
Processed FilesSpecifies the location where

captured files are stored upon the completion of
successful routing. If you select this check box,
all files are copied to the Processed Files
directory when the service successfully completes
writing them to the route location. The server must
have write permissions to this directory.
Caution: If this option is selected, a copy of
every file that has been successfully routed
is saved to the specified directory. Make sure
that adequate disk space is allocated for this
directory.
Rejected FilesSpecifies the location used to store
any files that were not successfully routed to the
final routing location. The server must have write
permissions to this directory.
A failure could from various reasons and must
be researched by reviewing the program log file
entries. We recommend that you have a secondary
process that takes this directory as an input and routes
messages to the system administrator to warn of
failures.
Working Directory
Specifies the working directory for the Multi-Poll

component to process files. The server must have write
permissions to this location.
Multi-Poll component RRTs

Component RRT ID
The RRT ID for this component is FPP.
Name
Description
File Name
One fileThe name of the captured file

Multiple filesThe name of folder where files are
located
File Extension
One fileThe extension of the captured file

Multiple filesThe extension of the folder where
files are located
835
Name
Description
File Name without Extension
The file name without the extension.
File Full Name
One fileThe name of the captured file including

the path.
Multiple filesThe name of the folder where the
captured files are located including the path.
File Path
One fileThe path of the captured file.

Multiple filesThe path of the folder where the
captured files are located.
File Size
One fileSize of the captured file.

Multiple filesTotal size of the files in the captured
group.
Number of Files
Number of files in the captured group.
Folder Name
Name of the root input folder from where the group was
captured.
Folder Path
Path of the root input folder from where the group was
captured.
File Creation Time X
File Last Write Time X
File Capture Time X
One fileThe time when the captured file was

created.
Multiple filesThis RRT has no meaning for a
group of files.
One fileThe time when the captured file was
modified last time.
group of files.
One fileThe time when the file was captured.
group of files.

If you select the Traverse option on a root folder, do not include its subfolders in the list
When you remove a configuration from the left grid on Configurations tab, all folders associated with this
configuration will also be removed from the folder list.
The component deletes any empty subfolder in the input folder. If you do not want them to be deleted include
them in the folder list and clear Traverse option of the parent folder.
836
Multi Router
MultiRouter
Multi-Router component
The Multi Router configuration screen lists the destination components available for your process. Use Multi Router
to select one Route (destination) component from the list of available components.
Configuring the Multi-Router component
Multi-Router dialog box
The Multi-Router dialog box allows you to activate and configure a route component for use in a workflow.
Option
Description
Name
Specifies names of route components that are available

for use in an AutoStore workflow. You can activate a
single component for use in a form. The currently active
component is highlighted in this list. If a component is
currently active, it becomes inactive when you activate a
different component.
C (configure)
Click the button in this column to open the configuration

dialog box for a component to activate and configure the
component as the destination for a workflow. The button
for the currently active component displays an icon
that indicates that the component has been configured for
use in the workflow.
For information about configuring a component, click
the Help button in the component configuration dialog
box to display the component help.
Notification component
Welcome to Notification component
This component is to notify the user of the status of a job. The status can be success or failure. The component can be
configured to send email messages with or without attachments associated with the job based on the status of the job.
The Email notification can be configured such that it could be sent upon success and/or failure of a job.
The Notification component uses an SMTP server to send notifications. The SMTP server may reside locally on the
machine where the process is running or may be located remotely as long as it is accessible to the AutoStore server
that is processing the workflow.
Getting started
Feature highlights
Following is a highlight of the feature of this component.
Send email notification messages upon success or failure of a process.

Include attachments in the notification email message.
Define multiple recipients of the notification email message.
Set the From and Subject fields, as well as the Notification message field.
Use RRTs to capture job related information within the message body.
837
Using the Notification component

Use this component when a user needs to know the status of a job, in order to decide the subsequent action.
The position of the Notification component in a process impacts the attachments that are sent in the notification
email, as the attachment files to the notification email message come from the components immediately before the
notification component.
For example, if a process has MFP capture component and a Fine Reader OCR and you configure the notification
component to send attachment with email, the documents that get attached to the notification email is the documents
that is processed by the Fine Reader OCR and received from MFP Source Component.
Configuring the Notification component
Notification Options Configuration dialog box
This dialog box configures when and how notifications sent.
Option
Description
Notify on success
Select this check box to activate the email notification

when the process has completed successfully. This
opens the On failure notification dialog box, in which
you specify the email attributes for sending success
notification emails.
Notify on failure
Select this check box to activate the email notification

when the process fails (for example, the document was
not saved, or FTP failed with the file). This opens the On
failure notification dialog box, in which you specify the
email attributes for sending failure notification emails.
SMTP Server
Enter the appropriate SMTP Server network name or IP

address. This SMTP Server is used for the confirmation
email notification.
SMTP Port
Specifies the port that the SMTP server uses to

communicate with clients. This option is initially set to
the SMTP default port 25.
User name
Specifies the user name to log on to the SMTP server.

You do not need to specify a user name if it is not
required.
Password
Enter the password to log on to the SMTP server. You do

not need to specify a password if it is not required.
On Success/Failure Notification dialog box

Concept definition.
Option
Recipients
Description
Specify the SMTP email addresses for individuals that
are to be notified of the job status
You may enter multiple recipients separated by the semicolon (;).
From
Enter the sender address for emails. This field needs

to conform with the requirements of the SMTP server
838
Option
Description
used. For instance the value often must be a valid email
address that belongs to a certain domain.
Subject
Specify the subject of the notification email message.
Message
Provides the body text of the email message that is to be

sent out.
Include documents as attachments
Select this box if you want to attach documents to the

email confirmation notification.
What gets attached to the email notification message is
dependent on the position of the component in a process.
Refer to the example described in Using Notification
component.
If you do not select this check box, the position of
the component in the process with respect to other
components is irrelevant.
Notification component RRTs

This component does not generate Runtime Replacement Tags (RRTs). However you can use RRTs to set any of the
options when you configure the component.
Problem
Solution
Files are not attached to the email notification
Check the position of the Notification component in

the process. Make sure this component is placed where
you would like an attachment to be obtained. The
attachment comes from the component immediately
before the notification component.
It is taking too long to receive the email message
Check the SMTP server does not have a delay in

processing the message. The SMTP server used to
deliver the notification might not do so immediately after
receipt of a message. It might be configured to wait a
certain amount of time before sending the message.
OPOCR component
Welcome to the OP OCR component
The OCR component is an optical text recognition system that recognizes text set in practically any font. The
component accepts image files as input and creates searchable data files in one of the supported formats or passes the
recognized text as RRTs to the next component in the process. In particular, this component can produce searchable
PDF and PDF/A files using the PDF and PDF/A standard file definitions.
The component's characteristic features are high-recognition accuracy and low sensitivity to print defects. These
features are the result of special recognition technology that is based on the principles of Integral Purposeful Adaptive
(IPA) perception, which is fully implemented in the OCR component.
You can use various formatting and detection parameters to optimize OCR for your needs.
839
Getting Started
Feature highlights
The OCR component provides the following features:
Recognize text in practically any font.

Save output OCR text as a searchable data file in one or several of 10 supported formats or as RRT.
Use Zoned OCR and save recognized zone values as RRTs or/and as CSV files.
Set the image-preprocessing options for better recognition results.
Using the OCR component

The OCR component is used for recognition of images in different formats, such as TIFF and PDF. Recognition
results can be saved in a file and/or passed along in RRTs.
How to recognize text in scanned documents
Scan documents from a variety of MFP devices, recognize text from images, and send the searchable PDF files into a
specified folder.
1. Create a workflow using an MFP component to scan documents, the OCR component, and the Send to Folder
route component.
2. Activate the OCR component on the General tab of the component configuration dialog box.
For more information, see:
General tab on page 841

3. On the General tab, select to output OCR text to a File in PDF
General Tab
4. Configure the PDF settings as necessary on the PDF tab.
PDF Tab
5. In the Setup Zoned OCR dialog box, create a zone for recognition of the document title on the first page of each
document, choosing the corresponding settings in the Pages tab.
Setup zoned OCR

Pages tab
6. Pass the zone value as an RRT for the Send to Folder component to use in the document rename schema.
Component RRTs
When the walk-up MFP user enters a preconfigured function key on the control panel of the MFP device, the PDF
document with the corresponding title as a name is routed directly into the specified folder.
How to recognize text in faxed documents
Receive Fax from fax-server, recognize text and store the files for archival purposes.
1. Create a workflow using the Right Fax capture component, the OCR component, and the Send to Folder route
component.
2. Activate the OCR component on the General tab of the component configuration dialog box.
General tab on page 841
The files with the recognized text from faxes will be archived in the specified folder.
Configuring OCR
The component configuration window consists of the two tabs.
840
General tab
Use this tab to set general OCR attributes.
Option
Description
Activate

to a condition (see Conditional Activation).
Pass through
Set this option to "Yes" to pass the original document to

subsequent components in the workflow. You can use
conditions in this field (see Conditional Activation).
Note: If you enter an invalid condition into
Pass through box, the activation is "Yes" by
default.
Input files
Defines the file types that the component will process.
Enter a wildcard character and extension (such

as *.pdf) to define a file type. Separate
entries using a comma (,) or semicolon (;). By
default this box lists the following file types:
*.pdf;*.tif;*.tiff;*.jpg;*.jpeg;*.jfif;*.bmp;*.pcx;*.dcx;*.jp2;*.jpc;*.j2c;*.
You can use the following wildcard characters to specify
file types:
Languages
*Any string of characters.

?Any single character.
Select the language of the text to be recognized from the

list. If necessary, multiple languages may be entered by
separating language names with a comma. You can use
RRTs in this field to define language recognition at run
time.
Note: RRTs used in this text box should be
replaced with internal language names. To view
internal language names, expand a language
category node in the Select language dialog
box and select a language. The internal name
appears at the bottom of the dialog box.
Recognition mode
Select the mode of recognition, that is, a desired balance

of speed/errors rate. There are three recognition modes
available:
Full mode - the recognition will be slow, but the error

rate will be the least possible.
Balanced mode - the middle level mode between Full
and Fast modes.
Fast mode - select this check box to provide 2-2.5
times faster recognition speed at the cost of a
moderately increased error rate (1.5-2 times more
errors). On good print quality texts with simple
layouts, the OCR component makes an average of
1-2 errors per page, and such moderate increase in
error rate can be easily tolerated in many cases, such
as full text indexing with "fuzzy" searches.
841
Option
Description
Output OCR text as
This group allows you to specify how to output the

recognized text.
File
Select this check box if you want to save recognized

text as a file. The file is passed to the subsequent
components.
Specify the file format for saving the recognition results
manually or by selecting it from the drop-down list.
Possible formats are TXT, CSV, HTML, PDF, PDF/
A, RTF, DOCX, XLS, XLSX. If needed, multiple file
formats may be entered with a "," separating formats.
You can use RRTs from another component in this box.
Specify the parameters of the output file in the Format
Settings dialog box (see Format Settings).
Set up output file
Click this button to open Format settings dialog box.
Run-time replacement ~FRO::OCRText~
Select this check box to save recognized text as the

~FRO::OCRText~ Runtime Replacement Tag.
Zoned OCR
Select this check box to use zoned OCR. Recognized

fields will be output as RRTs or/and as CSV files.
Set up zoned OCR
Click this button to configure settings for a zoned OCR.

This button is enabled only if the Zoned OCR check
box is selected. This button opens the Setup Zoned OCR
dialog box.
Note: It is mandatory to select at least one of
the check boxes in the Output OCR text as
group.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.
842

Expression
Description
~FRO::PagesCount~ < 50

file of the OCR component is less than 50. Use this in
subsequent steps in a workflow because the page count is
unknown at this point in the workflow.
"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
843
operation_mul ::*
/
unary_operation ::+
!
string_constant
844


Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
1Boolean
2, 3Any
845
Symbol
Description
Result type
Operands type
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Languages dialog box

Use this dialog box to configure languages that will be used during recognition.
This dialog box contains a table with a list of languages that are recognized.
Option
Description
Add
Click this button to add a new language into the list. This
button opens a Select Language dialog box.
Edit
Select a language in the list and click this button if you

want to change the language to another; for example, if
you want to change the local version of the language,
that is, Dutch to Dutch (Belgium).
Remove
Select a language in the list and click this button to

remove it. The removed language will no longer be
recognized at run time.
Select Language dialog box

Use this dialog box to add languages to the language list for recognition.
To view supported languages, expand a language node.
Select a language and click OK to add the language to the language list in the Languages dialog box.
Format Settings dialog box
This dialog box allows you to configure the settings for the selected file format.
This dialog box consists of the following format tabs:
Tab
Description
RTF/DOCX tab
Use this tab to set the parameters for saving the

recognized text as an RTF or DOCX file.
PDF tab

recognized text as a PDF file.
846
Tab
Description
PDF/A tab

recognized text as a PDF/A file.
HTML tab

recognized text as an HTML file.
TXT tab

recognized text as a .TXT file.
CSV tab

recognized text into a CSV file.
XLS/XLSX tab

recognized text as an .XLS/.XLSX file.
PPTX tab

recognized text into a PPTX file.
Note: By default, the tab for the format that is selected in the General tab is opened.
RTF/DOCX tab
Use this tab to set the parameters for saving the recognized text as an RTF or DOCX file.
Field name
Retain layout
Description
This combo box allows you to specify if the page layout
should be retained partly or completely. Select one of the
following options:
Remove all formatting this option retains only the

structure of tables and arrangement into paragraphs.
Retain font and font size this option retains the
structure of tables, arrangement into paragraphs, font,
and font size.
Maintain original formatting (limited edition)
this option produces a document that maintains
the formatting of the original. This option is
recommended for documents with complex layouts,
such as promotion booklets.
Note: This option limits the ability to
change the text and formatting of the output
document.
Preserve original formatting (easy editing) this
option produces a document that preserves the
original format and text flow but allows easy editing.
Keep line breaks
Set this option if you want the original arrangement of

lines to be retained in the RTF format.
Keep page breaks
Set this option if you want the original document page

arrangement to be retained in the RTF format.
Keep text color
Set this option if you want the original character color

and the background color to be retained.
Keep pictures
Select this check box if you want to keep pictures in the

output file.
847
Field name
Picture formats
Description
Select a color image format for exporting to an RTF file
with embedded pictures:
Reduce picture resolution to
AutoFormat is defined automatically.

JPEGExports images in color JPEG format.
PNGExports images in color PNG format.
Convert to gray JPEGExports images in gray
JPEG format.
Convert to gray PNGExports images in gray PNG
format.
Convert to B&W PNGExports images in black
and white PNG format.
You may reduce the image resolution without actually

loosing the visual image quality. Enter the necessary
resolution value in this text box or select from the drop
down list.
Note:
JPEG quality
If you enter a higher resolution value than

the source one in the Reduce picture
resolution to field, this value will be
ignored; the pictures will be saved using the
source resolution.
Usually, the value of 150 dpi is suitable.
If a PDF file has been added to the batch,
when exporting it to PDF, PDF/A, HTML,
RTF or PPT formats the resolution of
pictures will not exceed 300 dpi.
This property specifies the value of the JPEG quality for

color pictures saved in RTF format in percent. The socalled "quality loss" algorithm is used to compress the
image, that is, the compressing technology is based on
averaging the groups of pixels, so that a whole region is
saved as a single number and not as a large number of
numbers that describe each pixel. The higher the value
you specify in this field, the higher will be the quality of
the image you save. The default value for this property is
50%.
Note: This value is ignored for PNG pictures.
RTF/DOCX fields
Click this button to set the RTF/DOCX fields in the

opened RTF/DOCX Fields dialog box.
RTF/DOCX Fields dialog box

Use this dialog box to set the values for the properties and fields of RTF/DOCX documents.
You can set the values of the following properties:
Author
Keywords
Subject
Title
848
You can use one or several available RRTs in each of these fields.
Note: The component's own RRTs should be used only in combination with a blocking component. Also it is
necessary to save and reload configuration, before zones' RRTs appear in the Available RRTs window.
PDF tab
Use this tab to set the parameters for saving the recognized text as a PDF file.
Field name
Save mode
Description
Specify the save mode for the PDF export in the combo
box. You can select one of the following alternatives:
Export scenario
Text and pictures - The recognized text is saved as

text, and the pictures - as pictures.
Text under the page image - The page image is saved.
The recognized text is put below it. This option is
useful if you export your text to document archives:
the full page layout is retained and the full-text search
is available if you save in this mode.
Page image only - Only the page image is saved.
Select a scenario of export to PDF format. Export

scenarios optimize export to PDF for some parameters
(quality, size of the file, and/or speed of export). The
following scenarios are available:
Balanced (between quality, size and the time of

processing)
Best image quality
Minimum size of the resulting file
Highest speed of processing
Custom export scenario
Note: When you select a predefined export
scenario, the Color picture formats, JPEG
quality, MRC extended settings and Tagged
PDF are disabled at configuring and ignored at
run time. If you want to specify the values for
these options manually, please select Custom
export scenario in this combo box.
Use Mixed Raster Content (MRC)
Select this check box if you want to use MRC while

exporting.
Color picture formats
This property specifies the image format to be used

during export to a PDF file with embedded color
pictures. Select one or several of the following values:

JPEG2000Exports images in color JPEG2000
format.
JPEG format.
Convert to gray JPEG2000Exports images in gray
JPEG2000 format.
Convert to B&WExports images in black and
white format.
849
Field name
Description
Note: Sometimes, when you select the JPEG
color picture format, the component saves the
image with JPEG and ZIP compression.
Black&white picture formats

during export to a PDF file with embedded black&white
CCITT4 images will be exported using the

CCITT4 compression algorithm. If this value is set,
the JPEG quality settings are ignored.
JBIG2 Lossless images will be exported
in black&white using the JBIG2 compression
algorithm.

resolution value in this field.
Note:

source resolution.
JPEG quality
This property specifies the quality (1-100%) of the color

or gray pictures that are saved in the JPEG format in
the output document. The pictures in such format are
saved with a quality loss, so the higher is the value
your specify, the closer will be the output picture to the
original. However a high quality value may result in a
big size of the output document.
Background quality
Specify a value to control the quality of the background,

which typically contains graphics and shading.
Color mask quality
Specify a value to control the quality of the foreground,

which typically contains text.
Encrypt
Select this check box if you want to encrypt the

document while PDF export.
Encryption
Click this button to open the PDF Encryption dialog box

that allows you to set encryption parameters of the PDF
file during export.
PDF fields
Click this button to open PDF fields dialog box that

allows you to set the PDF fields.
850
Field name
Advanced Settings
Description
Click this button to configure advanced settings for PDF
export. This button opens PDF Advanced Settings
dialog box.
Note: When the input image has PDF format and you do not use renaming schema in the process, the
output PDF file will be automatically renamed according to schema: document_name0001.pdf, where
document_name is the input file name.
PDF Encryption dialog box
In this dialog box you can set encryption parameters of the PDF file during export.
Option
Description
Use AES
Select this check box to enable high (128-bit AES)

encryption level. Note that Acrobat 6.0 (or earlier) users
cannot open PDF documents with this encryption level.
This property is checked OFF by default.
Key length
Set the length of the encryption key. It can be 40, 48, 56,
64, 72, 80, 88, 96, 104, 112, 120, 128 bit. This property
is 40 bit by default. This field is enabled only if the Use
AES check box is not selected.
Note: When you set the key length to more
than 40 bit and then open the output PDF
file with Adobe Acrobat, the key length in
Document Properties window will be displayed
as 128 bit, since Adobe Acrobat displays
correctly only two key length values: 40 bit or
128 bit. To display other key length correctly
use some other PDF viewer.
Owner password
Enter owner password. Opening the document with

the correct owner password (assuming it is not the
same as the user password) allows full (owner) access
to the document. This unlimited access includes the
ability to change the document's passwords and access
permissions.
Via RRT
Select this check box to obtain owner password via RRT.

Enter the password RRT in the text box that becomes
enabled.
Note: If you are entering owner or user
password in Via RRT text box, this password is
not encrypted.
User password
Enter user password. Opening the document with the

correct user password (or opening a document that does
not have a user password) allows additional operations
to be performed according to the user access permissions
specified in the Permissions group.
Via RRT
Select this check box to obtain user password via RRT.

Enter the password RRT in the text box that becomes
enabled.
851
Option
Description
Note: If you are entering owner or user
password in Via RRT text box, this password is
not encrypted.
Permissions group allows you to specify the user access permissions. The following permissions may be set:
Option
Description
Add notations
Adding or modifying text annotations and interactive

form fields. In this case "Commenting" and "Form field
Fill-in or Signing" security properties of the output file
are ON.
Assemble document
Assembling the document: inserting, rotating, or

deleting pages and creating navigation elements such as
bookmarks or thumbnail images.
Extract text and graphics
Copying or otherwise extracting text and graphics

from the document. In this case "Content copying or
Extraction" and "Content Accessibility Enabled" security
properties of the output file are ON.
Fill form fields
Filling out forms (that is, filling out existing interactive

form fields) and signing the document (which amounts to
filling out existing signature fields, a type of interactive
form field). In this case "Form field Fill-in or Signing"
security property of the output file is ON.
Modify content
Modifying the contents of the document. In this case

"Changing the document" and "Document assembly"
security properties of the output file are ON.
Print
printing the document.
Print in high resolution
Printing to a representation from which a faithful digital

copy of the PDF content could be generated. Disallowing
such printing may result in degradation of output
quality. This permission may be set only when the Print
permission is selected.
PDF Fields dialog box

Use this dialog box to specify standard PDF metadata to be set in the generated documents.
The following fields can be specified in this dialog box:
Author
Application
Keywords
PDF Producer
Subject
Title
You can use one or several available RRTs in each of those fields.
Note: The component RRTs should be used only in combination with a blocking component. Save and reload
the configuration to show zone RRTs in the Available RRTs window.
PDF Advanced Settings dialog box
852
Configure advanced settings for PDF export in this dialog box.

Option
Description
Embed fonts
If this check box is selected, fonts will be embedded

during export to PDF. This check box is selected by
default.
Note: This check box is disabled, when Text
under the page image and Page image only Save
mode are selected on PDF tab.
Tagged PDF
If this check box is selected, the recognized text will

be exported to tagged PDF. Tagged PDF is a particular
use of structured PDF that allows page content to
be extracted and used for various purposes such as
the reflow of text and graphics, conversion to file
formats such as HTML, and accessibility to the visually
impaired. This property is checked OFF by default.
Write links
The property specifies that the hyperlinks must be

retained during export of the recognized text into
PDF format. This property is checked OFF by default
for the compatibility with the previous version of
the component. If this property is checked OFF the
hyperlinks are exported as text.
PDF/A tab
Use this tab to set the parameters for saving the recognized text as a PDF/A file.
Field name
Save mode
Description
Specify the save mode for the PDF/A export in the
combo box. You can select one of the following
alternatives:
Export scenario
Text and pictures - The recognized text is saved as

text, and the pictures - as pictures.
Text under the page image - The page image is saved.
The recognized text is put below it. This option is
useful if you export your text to document archives:
the full page layout is retained and the full-text search
is available if you save in this mode.
Page image only - Only the page image is saved.
Select a scenario of export to PDF/A format. Export

scenarios optimize export to PDF/A for some parameters
(quality, size of the file, and/or speed of export). The
following scenarios are available:
Balanced (between quality, size and the time of

processing)
Best image quality
Minimum size of the resulting file
Highest speed of processing
Custom export scenario
Note: When you select a predefined export
scenario, the Color picture formats, JPEG
853
Field name
Description
quality, MRC extended settings are disabled at
configuring and ignored at run time. If you want
to specify the values for these options manually,
please select Custom export scenario in this
combo box.
Use Mixed Raster Content (MRC)
Select this check box if you want to use MRC while

exporting.
PDF/A export formats
Select a desired PDF/A format for files being exported.

The following formats are available:
PDF/A-1a format
PDF/A-1b format
PDF/A-2a format
PDF/A-2u format
This property specifies the image format for exporting to

a PDF file with embedded color pictures:

JPEG2000Exports images in color JPEG2000
format.
JPEG format.
Convert to gray JPEG2000Exports images in gray
JPEG2000 format.
Convert to B&WExports images in black and
white format.
Note: Sometimes, when you select the JPEG
color picture format, the component saves the
image with JPEG and ZIP compression.
Black&white picture formats

during export to a PDF file with embedded black&white
CCITT4 images will be exported using the

CCITT4 compression algorithm. If this value is set,
the JPEG quality settings are ignored.
JBIG2 Lossless images will be exported
in black&white using the JBIG2 compression
algorithm.

Note:

source resolution.
854
Field name
Description

JPEG quality
This property specifies the quality (1-100%) of the color

or gray pictures that are saved in the JPEG format in
the output document. The pictures in such format are
saved with a quality loss, so the higher is the value
your specify, the closer will be the output picture to the
original. However a high quality value may result in a
big size of the output document.
Background quality
Specify a value to control the quality of the background,

which typically contains graphics and shading.
Color mask quality
Specify a value to control the quality of the foreground,

which typically contains text.
PDF/A fields
This button opens the PDF/A Fields dialog box, where

the user can set up PDF/A fields for exported files.
Advanced Settings
Click this button to configure advanced settings for PDF/

A export in the open PDF/A Advanced Settings dialog
box.
Note: Consider the interaction between different format settings. For example, if the Convert to gray JPEG
property is selected and the Page image only mode is ON, then whole pages of the output document will be
exported in gray JPEG format.
When the input image has PDF format and you do not use renaming schema in the process, the output PDF/A
file will be automatically renamed according to schema: document_name0001.pdf, where document_name is
the input file name.
PDF/A Fields dialog box
Use this dialog box to specify standard PDF/A metadata to be set in the generated documents.
The following fields can be specified:
Author
Application
Keywords
PDF Producer
Subject
Title
PDF/A Advanced Settings dialog box
Configure advanced settings for PDF/A export in this dialog box.
Option
Write links
Description
Select this check box if you want the hyperlinks to be
retained during export of the recognized text into PDF/
855
Option
Description
A format. If this option is not selected, the hyperlinks are
exported as text. By default this option is not selected.
Tagged PDF
If this check box is selected, the recognized text will

be exported to tagged PDF. Tagged PDF allows page
content to be extracted and used for purposes such
as the reflow of text and graphics, conversion to file
formats such as HTML, and accessibility to the visually
impaired.
The option is active when you select PDF/A-1b format
or PDF/A-2u format from the PDF/A export format
drop-down list box.
HTML tab
Use this tab to set the parameters for saving the recognized text as an HTML file.
Field name
Format
Description
Synthesis mode
Simple (compatible with all browsers)If you

set this option, the HTML 3 format is used. The
document layout is retained approximately: first-line
indent and indents in tables are not retained. This
HTML format is supported by all browsers (Netscape
Navigator, Internet Explorer 3.0 and later).
Full (CSS)If you set this option, the HTML 4
format is used. It supports any type of the document
layout retention. The built-in style sheet is used.
This option allows you to specify if the page layout

should be retained partly or completely. Select one of the
following options:
Retain paragraphs and fontsRetains the structure

of tables, arrangement into paragraphs, font, and font
size.
Retain full document logical structureRetains
the layout in full: arrangement into paragraphs, font
and font size, columns, text direction, text color, the
structure of tables.
Retain only paragraphsRetains only the structure
of tables and arrangement into paragraphs.
Note: This option appears when you select
Simple from the Format drop-down list
box.
Keep line breaks

lines to be retained, otherwise, the text is formatted in a
single line in the HTML file.
Keep text color
Set this option if you want the original character color

to be retained. If the Retain only paragraphs is selected
in Synthesis mode combo box, then this check box is
disabled.
856
Field name
Use solid line as page breaks
Description
The original arrangement of pages is retained, and pages
are separated by a solid line.
Note: This option is only available, when
Format option is set to Simple.
Keep pictures
Select this check box to save the pictures together with

the recognized text.
Picture formats
Select a color image format for exporting to an HTML

file with embedded pictures:

ColorExports images in color.
GrayExports images in gray.
B&WExports images in black and white.
Sometimes you may want to reduce the image resolution.

For example, HTML files are usually viewed in a
browser, so there is no sense to save high-resolution
pictures in such files. So, you may reduce the image
resolution (so reducing the HTML file size) without
actually loosing the visual image quality: enter the
necessary resolution value in this field.
Note:
JPEG quality

source resolution.

color pictures saved in HTML format in percent. The socalled "quality loss" algorithm is used to compress the
averaging the groups of pixels, so that a whole region is
saved as a single number and not as a large number of
50%.
HTML fields
Click to open HTML Fields dialog box to set property

values.
Note: When HTML is used as the output file
format, you get an HTML file and some images
that the HTML file references. Renaming the
857
Field name
Description
images breaks the internal links. Do not use
the rename schema when exporting to HTML
format.
HTML Fields dialog box

Use this dialog box to set the properties for the HTML document.
You can use an RRT or type a value for the Title property to set the title for the output HTML document.
TXT tab
Use this tab to set the parameters for saving the recognized text as a .TXT file.
Field name
Encoding type
Description
Specify a desired type of encoding that will be used
during export to TXT:
Code page
Simple (one byte) Select this type and then select

an encoding in the Code page combo box.
UTF-8 Select this type to encode the TXT page in
UTF-8.
UTF-16 Select this type to encode the TXT page
in UTF-16.
Select the desired code page from the list.

Note: When Simple encoding type is selected,
then Code page combo box is enabled;
otherwise, it is disabled.
Retain layout
Select this check box if you want to keep the layout of

the original document. When this check box is selected,
Keep line breaks and Use blank line as paragraph
separator options are disabled at configuring and
ignored at run time.
Keep line breaks

lines to be retained in the .txt file, otherwise the text
will be formatted in a single line in the .txt file.
Use blank line as paragraph separator
Set this option if you want the paragraphs to be separated

by blank lines in the .txt file.
Use page break character (#12) as page separator

arrangement to be retained in text (.txt) file format.
CSV tab
Use this tab to set the parameters for saving the recognized text into a CSV file.
Field name
Encoding type
Description
Specify a desired type of encoding that will be used
during export to CSV:
Simple Select this type and then select an

encoding in the Code page combo box.
858
Field name
Description
Code page
UTF-8 Select this type to encode the CSV page in

UTF-8.
UTF-16 Select this type to encode the CSV page
in UTF-16.
Select the desired code page from the list.

Note: When Simple is selected, then Code
page combo box is enabled; otherwise, it is
disabled.
Use page break character (#12) as page separator

arrangement to be retained in CSV format.
Field separator
Specifies the character that separates the fields in the

CSV file.
XLS/XLSX tab
Use this tab to set the parameters for saving the recognized text as an .XLS/.XLSX file.
Field name
Description
Keep text color
If this check box is selected, the original colors of text

are retained during export of the recognized text to
XLSX format. By default, this option is OFF. This option
is ignored when exporting to XLS format.
Remove formatting
Set this option to remove formatting for the text exported

in XLS/XLSX format.
Keep pages on same work sheet
Set this option to place every page of the input document

to a worksheet inside the same output document. This
option is applicable only to the export into XSLX format.
XLS/XSLX fields
Click this button to set the XLS fields in the opened XLS/
XLSX Fields dialog.
XLS/XLSX Fields dialog box

This dialog box allows you to set the properties or fields of the XLS/XLSX document.
You can set the values of the following properties:
Author
Keywords
Subject
Title
Note:
The component own RRTs should be used only in combination with a blocking component. Also it is
necessary to save and reload configuration, before zone RRTs appear in "Available RRTs" window.
When multipage text is inserted in one of the XLS fields, then all fields in an output XSL file become empty.
This does not occur for one page text.
PPTX tab
Use this tab to set the parameters for saving the recognized text into a PPTX file.
859
Field name
Description
Keep line breaks
Set this option if you want the original arrangement into

lines to be retained, otherwise the text will be formatted
in a single line in the PPTX file.
Select a color image format which will be used during

export to a PPTX file with embedded pictures. This
property can have one or several of the following values:

PNGExports images in color PNG format.
JPEG format.
Convert to gray PNGExports images in gray PNG
format.
Convert to B&W PNGExports images in black
and white PNG format.

Note:
JPEG quality
If you enter a higher resolution value

than the source one in the Reduce picture
resolution to field, this value will be ignored;
the pictures will be saved using the original
resolution.
or RTF formats the resolution of pictures
will not exceed 300 dpi.

color pictures saved in PPTX format in percent. The socalled "quality loss" algorithm is used to compress the
averaging the groups of pixels, so that a whole region
is saved as a single number and not as a big amount of
50%.
Keep text color
Retains the original text color in the output PPTX file.
PPTX fields
Click to set PPTX output property values in the PPTX

Fields dialog box.
PPTX Fields dialog box

This dialog box allows you to set the properties or fields of the PPT document.
860
You can set the values of the following options:

Author
Keywords
Subject
Title
Note: The component RRTs should be used only in combination with a blocking component. Also it is
necessary to save and reload configuration before zone RRTs appear in Available RRTs window.
Setup Zoned OCR dialog box
Set up specific zones to be processed during recognition on this dialog box.You can preview the document that is
similar in structure to the documents that will be processed, navigate through its pages (if it is a multipage document)
and select zones for recognition. During processing the component will try to recognize each zone, and if any text is
found it will be assigned to an appropriate RRT. The text can be also saved into a CSV file.
Image pane
Image pane displays the image and allows you to navigate through its pages (if it is a multipage document) and select
zones. The image is displayed after applying preprocessing options specified in the Advanced tab. Select any number
of zones by holding down the right mouse button and dragging the pointer.
In the right-top area of the dialog you can read the following information: zones on the selected page to recognize
with their alignment, zones that will not be recognized on this page.
Preview buttons
Buttons at the top-left of zones' editor are used for previewing input images.
Button
Description
This section is used for zooming the image in/out.
Use these buttons to set up image alignment: fit to
screen, fit to width, fit to height.
Use this button to enter selection mode, in which you can
select one or more zones.
Use this button to enter creation mode, in which you can
create new text zones.
Use this button to remove selected zones.
Image
Select an image and a page for displaying in the preview pane.
Option
Image file
Page
Description
Enter the path to the image file.
Select the page number in this field or use
and
navigation buttons for page selection. These buttons

are enabled only if the document contains more than one
page.
861
Zone
Set parameters for a specific zone. If no zone is active, the section is disabled. The zone may be chosen with the
mouse cursor in the preview pane or from a drop-down list.
Option
Description
Name
Enter the zone name. Every zone must have a unique

name. The names are used for RRTs. You can use any
symbols in the names of zones except for the sequence
'//' and all new line characters. Equal names and empty
names are prohibited.
Type
Specify the type of the recognized block. You can select

Analyze contentMeans that the component will

try to analyze the content of the zone. This is the
default value.
Barcode blockDesignates a barcode block. It
corresponds to an image zone recognized as barcode.
Text blockDesignates a text block. It corresponds
to an image zone recognized as formatted text.
Tabs
Tab
Description
Pages Tab
This tab allows you to specify pages of the input

document on which the zones should be recognized.
Validation tab
This tab allows you to set verification of the found zone

values. Only those values are considered to be found
within a zone that meet the validation criteria for that
zone, otherwise they will be ignored.
Location tab
This tab allows modifying the selected zone coordinates

and preferable measure unit.
Export zones to a CSV fileSelect this check box if you want to export the recognized zones' names and values
into a CSV file. By default this box is unchecked.
Pages tab
This tab allows you to specify how to recognize zones in case of a multi-page document.
You can select one of the following values:
Value
Description
Recognize zone on all pages
The component will look for a zone on all pages in the

input file.
Recognize zone on odd pages only
The component will look for a zone only on odd pages in

the input file.
Recognize zone on even pages only
The component will look for a zone only on even pages

in the input file.
Recognize zone on pages with numbers
When this property is selected, the text field is enabled

and the user should specify the numbers of pages to
recognize. It can be, for example, 2,4,6..9,11.. To specify
862
Value
Description
the range the ".." is used. When the ".." stands at the end,
it means "and till the last page".
Option
And on the last page
Description
This check box is enabled only if the Recognize zone on
pages with numbers option is selected. If this check box
is selected, the zone will be recognized on defined pages
and on the last page of image file.
Validation tab
Set verification of the found zone values on this tab. Only those values are considered to be found within a zone,
which meet the validation criteria for that zone, otherwise they will be ignored.
Type of validation drop down list allows you to select one of the following values:
Type
No validation
Description
This option is set by default. Zone values are not
validated.
Note: The resulting RRT will contain an empty
string, if the zone contains unrecognizable
characters; if the zone does not contain
anything, then there will be no value passed to
the resulting RRT.
Contains something
This option says that the zone must contain some valid
value depending on zone type. If no valid value is found
in the zone, it is identified as empty.
Note: If the zone does not contain anything or
its content is unrecognizable, then there will be
no value passed to the resulting RRT.
Matches wildcard
This option allows using wild cards to validate those

zone values which satisfy the defined pattern.
Notice:
Wildcard
Description
any value of any

length
any single character
[A]
any single alphabetic

character
[]
any single numeric

character
[A], [A]
any letter or a number
Note: If you want symbols such as *?[]\ to be

interpreted as characters (not as wild cards), use
the slash as the escape character: \*, \?, \[, \], \\.
863
Type
Description
For example, to interpret the symbols in the
string [a*b]*c as literal characters, use the
following expression: \[a\*b\]\*c.
Matches regular expression
This option says that the zone value must match a regular
expression. All standard operations are allowed: ., *, +, |,
[], ^, $ ? and grouping with ().
Notice:
Regular
expression
a
Description
a where a is any
symbol excluding
symbols (|)[].*+^$\?
For example: f is
character "f; 5 is
character "5.
\a
a where a is any
symbol including (|)
[].*+^$\?
To represent any
symbol "as is,
precede it with a the
backslash character.
You can use the
backslash and an
escape character
to interpret special
characters literally,
including characters
inside of CharSet.
To include the
backslash character
( \ ) as a literal
character, prefix it
with the backslash ( \
\ ).
For example: \*
means character
"* and \a means
character "a.
Any single symbol.

For example:
expression 11.5
corresponds to such
combinations of
characters as "1135,
"11f5, "11_5.
864
Type
Description
Regular
expression
RegExp
Description
Any regular
expression RegExp.
For instance, 112
represents sequence
"112, which can be
found inside a string
(not the whole string
only!).
RegExp1|RegExp2
Any one of
expressions
RegExp1 or
RegExp2
For example,
expression 1|3
validates any of
symbols "1 or "3.
Note: The
concatenation
has
priority in
comparison
with
alternation
construct.
This
means that
combination
12.5|78
corresponds
not to
"12(any
number)
(then 5 or
7)8", but it
corresponds
to "(12(any
number)5) or
(78)". So, the
representations
of this
example can
be: "1235",
"12f5", "78".
RegExp+
Regular expression
RegExp repeated one
or more times.
865
Type
Description
Regular
expression
Description
Use this expression
to find sequences of
desired characters
For example, (1|
3)+ will find
expressions (1|3), (1|
3)(1|3).
RegExp*
Regular expression
RegExp repeated
zero or more times.
RegExp?
Regular expression
RegExp repeated
zero or one time.
RegExp1RegExp2
Sequence of two
expressions:
RegExp1 then
RegExp2.
For example, (1|3)
(11.5) corresponds
to such combinations
as "11175, "311t5.
Beginning of string.
Use this symbol
to find strings
which begin with
predefined regular
expression. The
desired expression
must follow ^ sign.
For example:
Expression ^1
corresponds to
all strings which
begin with "1;
^(1|3)All
strings which
begin with "1 or
"3.
End of string.
Use this symbol
to find strings
which end with
predefined regular
expression. The
866
Type
Description
Regular
expression
Description
desired expression
must precede $ sign.
Expression ^RegExp
$ corresponds to the
whole string only.
For example:
[CharSet]
Expression 5$
corresponds to all
strings which end
with "5;
(1|3)$ All
strings which end
with "1 or "3;
^(a|c)..123.
$ represents
whole strings
which begin with
"a or "c then
have any two
characters, then
sequence "123
and end with
any character:
"age123y,
"cat1234.
Any single symbol

belonging to
a character set
CharSet.
The CharSet
is specified as a
character string and
includes all symbols
of the string. The
order of characters
doesn't matter. A
"- sign inside of
the CharSet has a
special meaning and
is used to represent a
characters interval.
For example,
expression [12ae34] means the
same as [12abcde34],
it stands for any
character "1, "2,
867
Type
Description
Regular
expression
Description
"3, "4, "a, "b, "c,
"d or "e.
[^CharSet]
Any symbol not

belonging to manifold
CharSet.
For example,
[^12a-e34]
means any character
excluding "1, "2,
"3, "4, "a, "b, "c,
"d and "e.
Note: Other
symbols
inside
brackets are
considered
as characters
but not
special
symbols.
For instance,
[$] is not a
symbol of
end of string
but it is a
character "$.
Symbol ^
must stand
right after
"[", otherwise
it means just
a character
"^.
Validated by external script
Zones will be verified by the use of the defined VB

script. Input the path to the script in the Script file
name field or browse the script. The script receives the
following data at input:
sValueThe zone value with line feed

sTrimmedValueThe zone value without line feed
sFileNameInput file name
nPageNumberPage number
If the zone is validated, it returns value "TRUE" or

"YES" for string variable RRV. If validation fails, the
script returns "FALSE" for RRV. Example of the
validation script:
868
Type
Description
val =
sValue
fn =
sFileName
num =
nPageNum
if
sTrimmed
Value =
"Vinci" then
RRV =
"TRUE"
else
RRV =
"FALSE"
Contains substring
end if
This option says that the zone value must contain the
specified text. If the text is not found in the zone, it is
identified as empty.
Zone is required This option means that if there is no value found (or no value matches validation criteria, if
validation is on) within this zone, or if the external script returns "FALSE", the job should be rejected.
Use default value if not found or invalidThis option means that if no valid values in the zone are found (does not
apply to required zones), or if the external script returns FALSE, then the specified default value will be the value of
that zone. If the zone is required, default value for it is disabled.
Location tab
On this tab you can modify the selected zone coordinates and preferable measure unit.
Option
Description
Left
Modify the left coordinate of the zone.
Top
Modify the top coordinate of the zone.
Right
Modify the right coordinate of the zone.
Bottom
Modify the bottom coordinate of the zone.
Unit types
Set the units that are used to represent the coordinates of

the zone. If you specify the type of units, the coordinates
are recalculated and the zone is stored in the same place.
You can select one of the following values:
Millimeters
Inches/100
Pixels
869
Advanced tab
Use this tab to configure image recognition settings.
Option
Description
Page analysis
This group allows you to set the parameters for page

layout analysis.
Detect barcodes
If this check box is selected, barcodes are detected and

recognized during the page layout analysis.
Remove texture
Select this check box to remove the background noise

from a temporary image used for recognition. The source
image remains unaffected.
Image pre-processing
This group allows you to set the options for better

recognition results. These options are applied to images
before recognition. You can preview them in the Setup
Zoned OCR dialog box.
Despeckle
Select this check box to remove small noise from the

image before recognition.
Deskew
Select this check box to rotate an image to compensate

for skewing for better and faster recognition.
Detect orientation
If this option is checked on, the page orientation is

detected during layout analysis, and if it differs from
normal, the image will be rotated automatically.
Rotate by
If this option is checked on, the image will be rotated.

Specify the angle of rotation as 90, 180 or 270 degrees.
The option is disabled if the Detect orientation option is
switched on.
Component RRTs
Component RRT ID
The RRT ID for this component is FRO.
RRTN
Description
~FRO::OCRText~
Text recognized on all pages of the input document.
~FRO::PagesCount~
Count of pages in the original document.
~FRO::OCRText~ is replaced with the OCR text of the document from the OCR engine. This RRT can be only
used within the component's settings.
The following table describes the field RTN values for this component.
870
FRTN
Description
~FRO::%Zone Name%~
Text recognized in the zone "ZoneName". This RRT is

replaced with the first valid value found in the zone.
~FRO::%Zone Name%.PageNumber~
Text recognized in the zone "ZoneName" on the page

with number "PageNumber".
The value of PageNumber can be:
A positive valueThe RRT is replaced with
the text recognized in the zone on the page with
this number (starts from 1). That is, ~FRO::
%zoneName%.1~
A negative valueThe RRT is replaced by the text
recognized in the zone on the page with this number
(starts from the end). -1 means last page, -2 means
the page before last, that is ~FRO::%zoneName
%.-1~
*The RRT is replaced by the concatenated text of
the zone on all pages, that is, ~FRO::%zoneName
%.*~
~FRO::%Zone Name%.pages~
Pages where the zone was found. For example, if the

"ZoneName" zone is found on 1,2,5,6,9 pages, the RRT
is replaced by the following list: 1,2,5,6,9.
Examples of usage of the above FRTN include:

~FRO::%zone1%.1~ is replaced with the text recognized in the zone "zone1" on the first page of the document.
This component does not generate Special Set Replacement Tags Names.
The OCR component supports image files in the following formats:

Format
Description
PDF
Files in PDF format (Version 1.7 or earlier)
BMP
2-bitUncompressed black and white

4- and 8-bitUncompressed Palette, RLE
compressed Palette
16-bitUncompressed, Uncompressed Mask
24-bitUncompressed
32-bitUncompressed, Uncompressed Mask
PCX, DCX
Black and white

2-, 4- and 8-bit Palette
24 bit color
JPEG
Gray, color
JPEG 2000
Gray, color
871
Format
Description
JBIG2
Black and white
TIFF
Black and whiteUncompressed, CCITT3,

CCITT3FAX, CCITT4, Packbits, ZIP, LZW
GrayUncompressed, Packbits, JPEG, ZIP, LZW
24-bit Coloruncompressed, JPEG, ZIP, LZW
1-, 4-, 8- bit paletteUncompressed, Packbits,
ZIP, LZW
Multi image TIFF
GIF
Black and white - LZW-compressed

2-, 3-, 4-, 5-, 6-, 7-, 8-bit palette LZWcompressed
PNG
Black and white, gray, color
The resolution of input image should not be less than 300 dpi for correct recognition.
When multipage text is inserted in one of the XLS fields, then all fields in the output XSL file become empty. This
does not occur for one page text.
This component extracts only text and graphic information from the input document and does not extract
metadata. Therefore, if the original PDF document has bookmarks, hyperlinks, interactive elements, annotations,
and so on, the component will not export these elements to the output document.
Sometimes, when you select the JPEG color picture format for PDF and PDF\A, the component saves the image
with JPEG and ZIP compression.
If the original document contains both color (or gray) and black-and-white pages and the output PDF or PDF\A
file's mode is Text under the page image, then the JPEG quality value will be ignored for the entire document.
In such cases the component will save color pages with 100% JPEG quality. A corresponding warning message
will appear at run-time, unless the specified picture format is CCITT4, which does not use JPEG quality. If the
format is CCITT4 then color pages will be converted into black-and-white.
The component does not convert color PDF images to grayscale and black-and-white ones when is used on the
workflow server 6.0.
Problem description
Poor-quality OCR results
Solution
Inaccuracies in the OCR process can have many causes.
It is recommended that you perform an analysis of types
of paper, scanners, and resolution levels to optimize your
OCR results before setting up OCR processes.
The following are some common tips for increasing
OCR accuracy.
1. File formatColor documents do not capture image
details accurately. When the process input is a color
image, you achieve lower-quality OCR documents.
Review your color document requirements and
consider higher-resolution scanning to increase
accuracy.
2. Document qualityLow-quality paper documents
are another major cause of lower OCR accuracy.
Lower-quality documents generally increase the error
rate for OCR. When working with such documents,
872
Problem description
Solution
consider the following factors to increase your OCR
accuracy:
Try to discover ways to get higher-quality paper

documents.
Consider a scanner with different scanner bulb
color, which might work better with the paper
color of your document.
Test a higher-level scan resolution.
Consider using the image process in advance of
OCR to clean up the image.
When you export file to HTML format, the images are

not displayed in the output file.
This problem may appear when you use renaming

schema. When HTML is used as the output file format,
you get an HTML file and some images to which the
HTML file references. If you rename the images then
the internal links will be broken. Therefore, the rename
schema should not be used when exporting to HTML
format.
Some setting of the output document has a value

different from the specified one.
Make sure that this setting was specified correctly. If

a setting was defined incorrectly or uses an RRT that
was replaced with the incorrect value, the component
replaces the incorrect value by the default value at run
time, if the default value exists.
When using the Zoned OCR Matches wildcard

validation setting on a zip code with 5 numbers, the
validation might fail.
Use [#][#][#][#][#] to validate the zip code.
When using the Zoned OCR Matches regular

expression validation setting on a zip code with 5
numbers, the validation fails if you use multipliers {...}.
Use the following to validate the zip code:

(0|1|2|3|4|5|6|7|8|9)(0|1|2|3|4|5|6|7|
8|9)(0|1|2|3|4|5|6|7|8|9)(0|1|2|3|4|5|
6|7|8|9)(0|1|2|3|4|5|6|7|8|9)
OpenForms 360
Welcome to OpenForms 360
The OpenForms 360 capture and route components feature an integration between the AutoStore Server and the
OpenForms 360 system that includes:
OpenForms 360 Server

OpenForms 360 Professional
OpenForms 360 Validation
This integration provides flexible, scalable, and a cost-effective capture, processing and archival of documents.
Use OpenForms 360 route component to route scanned documents from a variety of MFPs and digital copiers to the
OpenForms 360 Professional for form recognition and data extraction. After being processed, the documents and
associated data are retrieved by the OpenForms 360 capture component and forwarded to the next component in the
AutoStore workflow for processing and storing in the desired Document or Database Management Systems. If the
extracted data has to be validated by a person, the processed documents are forwarded to OpenForms 360 Validation
prior to be retrieved by the OpenForms 360 capture component.
873
Before you start working with the OpenForms 360, you must configure the OpenForms 360 Server using the
OpenForms 360 Server Configurator (see OpenForms 360 Server Configurator help)
A thorough understanding of OpenForms 360 Validation as well as OpenForms 360 Professional is required. You
must have this software configured prior to setting up an OpenForms 360-based AutoStore workflow.
Feature highlights
OpenForms 360 components provide the ability to:
Route scanned documents from a variety of MFPs and digital copiers to OpenForms 360 Professional for form
recognition and data extraction.
Retrieve documents processed by OpenForms 360 Professional and forward them to the next component for
further processing.
Customize the design of a document processing workflow based on document template setting.
Extract table values from scanned documents and place them into appropriate RRTs.
Getting started
Why use the OpenForms 360 components?
Because processing time varies depending on the size of a document and the type of processing it requires, your
workflow may be slowed down dramatically. This can happen, for example, due to a very large document that has to
undergo not only a form recognition process but also a human-validation. The asynchronous design of OpenForms
360 capture and route components provide for a faster document processing by allowing the OpenForms 360 capture
component to retrieve the processed documents from the OpenForms 360 Server and send them to the next workflow
component for further processing immediately.
This is achieved by means of a two-process workflow that you design in the AutoStore Process Designer (APD).
The first process starts with any capture component available in AutoStore and ends with the OpenForms 360 route
component that routes captured content to the OpenForms 360 Server. The second process starts with the OpenForms
360 capture component that retrieves all documents ready for further processing from the OpenForms 360 Server and
ends with any process and/or route component available in AutoStore.
Before you begin
Authentication methods
The OpenForms 360 Server supports two methods of authentication:
Kerberos (Windows)
Username/Password
The following authentication clients use any of these two methods to authenticate against the OpenForms 360 Server:
OpenForms 360 components (reside on AutoStore Server)

OpenForms 360 Validation (resides on a validation station computer)
OpenForms 360 Professional (resides on OpenForms 360 Server)
When utilizing the Username/Password authentication method, authentication clients store the user name and
password information encrypted locally, and use this information each time they need to call the OpenForms 360
Server.
Using the Username/Password authentication requires HTTPS transport. Therefore, a security certificate must be
installed on the OpenForms 360 Server. See Security Certificate Installation.
When utilizing the Kerberos (windows) authentication method, authentication clients apply the credentials of the user
account under which a process is currently running. Thus, AutoStore uses the credentials of the user account under
which the AutoStore service is running, the validation station uses the credentials of the currently logged in user, and
OpenForms 360 Professional uses the credentials of the user account under which Load Manager Monitor service is
running.
For the configuration of OpenForms 360 utilizing the Kerberos authentication, use the URL provided in the URL
with Kerberos authentication field (referred to as Kerberos URL). For the Username and Password authentication
874
method use the URL provided in the URL with username and password authentication field of the Server tab of
OpenForms 360 Server Configurator.
The message Connected as: domainname\user indicates a successful connection to the server.
Note: When connecting to the OpenForms 360 Server, utilizing the Kerberos (Windows) authentication,
you may be denied the access and see the message Access Denied after pressing the Check button in the
Connection dialog of any authentication client. The reason for this is the discrepancy between the following
user accounts:
The user account of the currently logged-in user.

The user account under which the service that is currently being configured will be run at run time.
The Route Component User account and the Capture Component User account you configured in
OpenForms 360 Server Configurator for running the AutoStore processes.
Using OpenForms 360 for the first time

Prerequisites
Prior to configuring the OpenForms 360 components the following software must be successfully installed and fully
configured on your machine:
AutoStore (refer to the AutoStore help files)

The OpenForms 360 Server (refer to the OpenForms 360 Server Configurator help files, the OpenForms 360
Professional or OpenForms 360 Administrators Guide).
OpenForms 360 Professional (refer to the OpenForms 360 Professional help files).
OpenForms 360 Validation (refer to the OpenForms 360 Validation help files).
For an outline to configuration the software (other than AutoStore) refer to the quick guide entitled Instruction for
Deployment and Configuration of OpenForms 360.
How to perform initial configuration of the OpenForms 360 components
This procedure assumes that all OpenForms 360 and AutoStore software is installed on one machine.
Both AutoStore processes (route and capture) are administered by one user who has administrative rights on his/her
machine.
1. Open AutoStore Process Designer and create a process including the OpenForms 360 route component.
2. Double-click the OpenForms 360 Route icon to launch the component.
3. In the Sitemap tab of the route component, select the project file (.sitemap) located on the shared file resource
of File Server.
4. Select the Use Validation check box.
5. Switch to the Connection tab.
6. Depending on the authentication method, use the appropriate URL.
7. If using the Username and Password authentication method, enter the username and password of the Route
Component User configured using OpenForms 360 Server Configurator.
8. Click Check to verify the setting.
See notes in the topic Authentication Methods.
9. Save the configuration.
10. While still in the same AutoStore workflow, create a new process that includes the OpenForms 360 capture
component.
11. Double-click the OpenForms 360 Capture icon to launch the component.
12. Switch to the General tab, and depending on the authentication method, use the appropriate URL.
13. If using the Username and Password authentication method, enter the username and password of the Capture
Component User configured using Open Forms 360 Server Configurator.
14. Click Check to verify the setting.
See notes in the topic Authentication Methods.
875
15. On the Configurations tab, add the same project file (.sitemap) that you added when configuring the route
component.
16. Click OK.
17. Save the configuration.
18. Click Tools > Service Manager, and then select the current configuration file from the AutoStore Script list.
19. If you are using the Kerberos authentication method, enter the credentials of either of the following users in the
Log On NT As section.
Route Component User
Capture Component User
20. Click Apply and then click Start to start the service.
If you are using the Username and Password authentication method, the AutoStore service can be logged in
under the Local System account or under any user account that has rights to run this service.
Configuring the OpenForms 360 component
Route component
The OpenForms 360 route component serves as an interface between AutoStore Server and OpenForms 360
Professional. It routes scanned images to the OpenForms 360 Server which dispatches them to OpenForms 360
Professional for form recognition and data extraction.
To configure the OpenForms 360 route component, double-click on the component icon in the AutoStore Process
Designer to open the configuration dialog box.
The configuration dialog box of the OpenForms 360 route component has the following tabs:
Tab
Description
SiteMap tab
Settings on this tab configure SiteMap file parameters.
Connection tab
Settings on this tab enable a connection to the

OpenForms 360 Server.
Custom Fields tab
Options on this tab specify metadata relevant to the

Batch that can be retrieved from the OpenForms
360 Server database by the OpenForms 360 Capture
component after the scanned documents are processed.
SiteMap tab
Settings on this tab configure SiteMap file parameters.
Option
SiteMap File
Description
Correct processing of an image and satisfactory
extraction results require a reference to a project file
that is saved as a SITEMAP file on any file server.
The SiteMap project file refers to the schema created
during project configuration in OpenForms 360 SiteMap
Designer as a result of class and type definition. A
schema of a project defines the types of documents and
fields included in these documents. The schema is used
by the OpenForms 360 Professional recognition system
to perform form recognition and data extraction.
To select a SiteMap project file, use the browse button
next to the SiteMap File field. A project tree appears on
the right side of the tab. The project tree is a projection
of the schema file.
876
Option
Description
Note: For detailed information on how to create
a project using OpenForms SiteMap Designer,
refer to OpenForms 360 SiteMap Designer
help files. For detailed information about type
and class definition, refer to OpenForms 360
Extraction Design Studio help files.
Batch Name
A Batch is a combination of the following data:
TIFF files routed from the OpenForms 360 route

component to the Open Forms 360 Server.
A reference to an OpenForms 360 SiteMap Designer
project.
Set of conditions under which the batch will be sent
to Validation.
You can give each Batch a name. To do so, type in

a name in the Batch Name field or use one of the
available RRTs, such as "File Name". A processed image
file will appear under this name in the list of tasks in
OpenForms 360 Validation dialog box.
The value entered in this field will be used in the Batch

Name RRT listed in the list of the Available RRTs of
the OpenForms 360 Capture component.
877
Option
Description
If the Batch Name field is left empty, the existing file

name will be used as the batch name.
Validation Usage
This option determines whether the data extracted from

the documents as a result of form recognition should
be validated. This is accomplished by selecting the Use
Validation check box so that the project tree becomes
editable in the right half of the tab, and setting the
Confidence Level value. To type in the desired value
(0-100), select a node from the project tree and click it
once.
Never Send to validationRegardless of

recognition results the batch will be sent directly to
capture component.
Always Send to ValidationRegardless of
recognition results the batch will be sent to Validation
station for review
Conditional ValidationThe decision about
sending the batch to Validation Station will be made
based on the comparison of the recognition results
with the conditions set in the right half of the tab.
878
Option
Description
Setting the Conditions for Sending the Batch to
Validation Station
During the recognition process each field in the batch is
assigned the state and confidence level State can be: OK,
Reject, Empty and so on. Confidence level is generated
by the extraction engine in case the state of the field was
OK.
There are several conditions that can be set:
Ensure OKPass if the field is present and the state

of recognition is "OK". Otherwise send the batch to
Validation.
IgnorePass regardless of the field sate.
Ensure nn% of confidencePass if the field is
present, its state is "OK" and the confidence level
at least nn%, otherwise send the batch to Validation
station.
DefaultApply the parent condition. Pass if the
field is empty.
Ensure the document is NOT presentDo not pass
if the document of the marked type is present in the
batch.
Connection tab
Settings on this tab enable a connection to the OpenForms 360 Server.
Option
OpenForms 360 Server URL
Description
Enter the URL depending on your environment. If using
the Kerberos URL, enter the URL copied from the URL
with Kerberos authentication field of OpenForms 360
Server Configurator. For the Username and Password
authentication method, use the URL provided in the
URL with username and password authentication
field of OpenForms 360 Server Configurator.
For more details refer to the OpenForms 360 Server
Configurator help files.
Authentication
The OpenForms 360 Server supports two methods of

authentication:
Username and PasswordSelect this method

if using Username and Password method of
authentication. The OpenForms 360 route component
will connect to the server using the log-in data of the
current user.
Kerberos (Windows)Select this method if using
the Kerberos method of authentication. Selecting
this option activates the Domain/Username and the
Password field, where you can enter the required login information.
Enter the server path. You can copy and paste it from the
URL with user name and password authentication
879
Option
Description
field of OpenForms 360 Configurator if you intend to
select the User Name/Password authentication method.
Copy it from the URL with Kerberos authentication
field of the OpenForms 360 Server Configurator if
you intend to use the Windows authentication method.
Check
Click this button to verify that the URL is valid. If it

is, the following message will be displayed below the
OpenForms 360 Server URL field: Connected as:
Computername\user.
For a successful connection to the server the following
requirements must be satisfied if the Windows
authentication method is selected:
The user logging on to the OpenForms 360 Server

must be included in the Validators list.
Users included in the Validators list and users
logging on to the OpenForms 360 Server from the
OpenForms 360 Validation must use the same user
account/
The user logging in to the OpenForms 360 Server
must have permissions to access the server.
Custom Fields tab

Options on this tab specify metadata relevant to the Batch that can be retrieved from the OpenForms 360 Server
database by the OpenForms 360 Capture component after the scanned documents are processed.
Enter the information into the fields under Name and Value.
To populate the fields, make them editable by clicking on the field until you see the courser blinking. The either type
in or drag and drop the desired RRT on to the appropriate field. You can create any number of entries in this table.
Use unique names. You can use any of the RRTs provided by the capture component you included in your AutoStore
workflow.
In the picture below, AutoCapture component RRTs are used:
Computer Name=~ACC::ComputerName~
UserName=~ACC::Domain~\~ACC::UserName~
880
The data entered in the custom fields is stored in OpenForms 360 database along with a batch. The OpenForms 360
Capture component will access this information using the Custom Field RRT (~OF2::[<Name>]~) available in
the OpenForms 360 Capture component.
To get the values that you entered in the custom fields of the OpenForms 360 Route component, use the RRT entitled
Custom Field when configuring the route component in an AutoStore process, such as Folder Store. Manually
replace the Name value in the square brackets with the actual name you entered in the Name field on the Custom
Field tab of the OpenForms 360 Route component. The name will be replaced with the appropriate value from the
respective Value field on the Custom Field tab of the OpenForms 360 Route component.
For the example above you will get the following results:
881
~OF2::[ComputerName]~ will return the name of the computer where the route process took place.
~OF2::[UserName]~ will return Domain\User of the route process.
OpenForms route component RRTs

Name
Description
Batch ID
The ID that was assigned to a batch by the OpenForms

360 Server.
Batch Name
The name that was assigned to a batch by the

OpenForms 360 Route component.
Batch Guid
Internal GUID that was assigned to a batch by the

Capture component
The OpenForms 360 capture component retrieves processed images from the OpenForms 360 Server as soon as
they are ready for further processing and hands them over to the next workflow component. The capture component
identifies such documents by the status "Validated" (see online help for OpenForms 360 Validation). This status is
assigned to a Task in two different ways: automatically, by the OpenForms 360 Server after the image was processed
by the OpenForms 360 Professional, or manually either by the user upon validating the document or, if necessary, by
an administrator in the OpenForms 360 Validation run in administrative mode.
The capture component is configured by options on the following tabs:
Tab
Description
General tab
This tab provides general options to configure the

OpenForms 360 capture component.
Configurations tab
This tab is divided into two parts that configure the

SiteMap Tree View and the Component Grid.
Output Data tab
Settings on this tab permit configuration of additional

capture component processing attributes.
General tab
This tab provides general options to configure the OpenForms 360 capture component.
Option
Description
OpenForms 360 Server URL
Allows entering the server path. You can copy it from

either the URL with Kerberos authentication field of
OpenForms 360 Server Configurator or from the
URL with user name and password authentication field
of the same software. Otherwise, consult with server
administrator if you need the above information.
Authentication
Select the authentication method appropriate for your

environment:
WindowsChoose this option if you use the

Kerberos authentication method. The OpenForms
360 capture component will connect to the server
using the system log-in data of the current user.
Username and PasswordChoose this option if the
Username/Password authentication is used. Selecting
this option activates the Domain/Username and the
882
Option
Description
Password field, where you can enter the required login information.
Keep
Processed FilesSpecifies the folder where you

want to store files that have been successfully
retrieved from the OpenForms 360 server by the
OpenForms 360 capture component. This setting is
optional.
Important: If this option is active, a
copy of every file that has been captured
successfully is saved into this directory. You
must therefore make sure that sufficient disk
Rejected FilesSpecifies folder where you want
to store files that failed to be retrieved from the
OpenForms 360 Server by the OpenForms 360
capture component. The failure can be due to a
number of reasons and must be researched through
searching the application log file entries. If no
folder is specified for the rejected files, the file
continues to display the status "Capturing" in the
OpenForms 360 Server repository, which leads to
the file getting "lost". The administrator can change
the status manually to "Validated" thus enabling the
OpenForms 360 capture component to retrieve it
from the server (for more information about Batch
status, see the OpenForms 360 Validation help). This
setting is optional.
Note: Typically, it is beneficial to have a
secondary process that takes this folder as
an input and routes messages out to system
administrator to warn of failure.
Working Folder
Specifies an existing folder where the files will be saved

under a temporary name if the Processed Files folder or
Rejected Files folder are not specified.
Configurations tab
This tab is divided into two parts that configure the SiteMap Tree View and the Component Grid.
SiteMap Tree View
The Project Tree View is located on the left side of the tab. It provides a short-cut menu with the following
commands:
Command
Description
Add SiteMap
Allows you to add a projects previously created using

OpenForms 360 Sitemap Designer.
Delete SiteMap
Allows you to delete a project from the tree.
Clear Configuration
Allows you to clear the existing configuration.
883
Component Grid
The Component Grid is located on the right side of the tab. Here the next components in the AutoStore workflow
(route or process) are listed. To configure the component, select Default or a project to which the configuration is to
be applied and click the C configuration button in the component grid to open the configuration dialog box of the
selected workflow component.
This also opens the Available RRTs window displaying two lists of available RRTs: OpenForms 360 capture
component's RRTs and those of the next selected AutoStore workflow component, for example Send to Folder. Click
one of the title bars to see the list of each component's available RRTs.
1. You can use any of the OpenForms 360 capture component RRTs in any field of the configured component.
2. To move desirable RRTs to the appropriate field, either drag-and-drop or press CTRL-C or CTRL-V.
3. After you complete the configuration, click OK.
The selected node or sub-node of the project tree will be furnished with a red check mark indicating that it has
been configured.
Note: If a sub-node of the project tree is not configured, the configuration of the parent node is used.
Output Data tab
Settings on this tab permit configuration of additional capture component processing attributes.
Option
Saving the XML File
Description
The XML file generated by OpenForms 360 Professional
contains extracted data from a processed document. You
can save it to a folder of your choice. If not saved, this
file is stored in a temporary folder and is automatically
deleted later.
To save the XML file, select the Save Output XML
Files to Folder check box and browse to the desired
storage location using the browse button.
Selecting Table RRT Format
This option permits you to determine format in which

the values that replace the Table RRTs at run time will be
presented. XML and CSV formats are available.
XMLSelect this option to ensure that the values that
replace Table RRTs at run time will be presented in XML
format. If you select this option, the row ID text field
with the default value "row" becomes available. You
can change the default value to any other value. This
value will be used in the XML file as the name of the
tag that indicates the rows of the table contained in the
document.
The following example shall illustrate the above
explanation. Assume that your document is an invoice
that contains the following table called "Invoice Items".
Item No
Item
Name
Item
Quantity
Price
in USD
Pen
1.99
Pencil
0.75
884
Option
Description
If you select the XML formatting option, the values
replacing this RRT will be coded in XML as follows:
<InvoiceItems>
<row><ItemNo>1</
ItemNo><ItemName>pen</
ItemName><ItemQuantity>1</
ItemQuantity><PriceInUSD>1.99</
PriceInUSD></row>
<row><ItemNo>2</
ItemNo><ItemName>Pencil</
ItemName><ItemQuantity>1</
ItemQuantity><PriceInUSD>0.75</
PriceInUSD></row>
</InvoiceItems>
CSV with HeadersSelect this option to ensure that
the headers of the columns of the above table will be
included when replacing the RRT. Consequently, in this
format, values of the above table will appear as follows:
Item No,Item Name,Item
Quantity,Price in USD< cr>
1,Pen,1,1.99<cr>2,Pencil,1,0.75
CSV without HeadersSelect this option to ensure
that the headers of each column of the above table will
not be included during the replacement of the RRT.
Consequently, in this format, the values of the above
table will appear as follows:
1,Pen,1,1.99<cr>2,Pencil,1,0.75
OpenForms 360 capture component RRTs

Component RRT ID
The RRT ID for this component is OF2.
Name
Description
Schema Name
Returns the name of the file that contains the XSD

schema of the project to which the current image
belongs.
Schema Path
Returns the full path including file name of the file that
contains the XSD schema of the project to which the
current image belongs.
885
Name
Description
Project Name
Returns the name of the project to which the current

image.
Document Type
Returns the type of the document which has been

assigned to the image by OpenForms 360 Professional.
Document Type ID
Returns the type ID of a currently processed document

assigned to each document type described in the XSD
schema file by the OpenForms 360 capture component
during AutoStore process design time. The component
uses this ID to identify the document in the AutoStore
configuration file.
Configuration ID
Returns the ID of a configuration applied to a currently

processed document. The OpenForms 360 capture
component assigns this ID to each configuration of
dependent components (process and route components in
the current workflow) during AutoStore process design
time.
Batch ID
ID that was assigned to a batch by the OpenForms 360

Server.
Batch Name
The name that was assigned to a batch by the

OpenForms 360 Route component.
The RTT string ~OF2:DocType is replaced with the value "Invoice" if the current document is of the type
"Invoice".
OpenForms 360 capture component supports FRTNs and replacement of field names with values of these fields.
An example of a field name used within an RRT is "InvoiceDate" or ~OF2::%InvoiceDate%~.
If an invoice is dated March 23, 2010, at run time this FRTN will be replaced by the value of the field "Invoice
Date", that is, March 23, 2010.
Another example of a field name used within an RRT is "Invoice Items Table" or ~OF2::
%InvoiceItems.Table%~.
This RRT will be replaced by the values of the entire table.
OpenForms 360 supports SSRTN and replacement of the object attribute.
The object is a table and its attribute is the total number of rows that it consists of.
~OF2::%InvoiceItems.RowCount%~
This RRT will be replaced by the value of the total number of rows of a table called "Invoice Items" by the
OpenForms 360 component.
Security certificate installation
Security certificates encrypt the communication between the server and the client thus providing a secure
communication between OpenForms 360 Server and its clients, OpenForms 360 components and OpenForms 360
886
Validation station. In order for the connection to be created the Security Certificates must be installed on both the
server side and the client side:
Task
Description
Install the server certificate
Complete this procedure to install a security certificate

on the server side.
Client certificate installation
Use the server site certificate to install the client

security certificate after completing the server certificate
installation.
How to install the server certificate

Complete this procedure to install a security certificate on the server side.
1. Start the Microsoft Management Console.
Click Start > Run and type mmc to open the Console1 window.
2. To add the Certificates snap-in that will manage certificates for the computer account, click File > Add/Remove
snap-in.
3. In the Available snap-ins box, click Certificates, and then click Add.
4. In the Certificates snap-in dialog box, click Computer account, and then click Next.
5. In the Select Computer dialog box, click Local computer, and then click Finish, and then click OK.
6. Make sure that a certificate with the DNS name of the server is installed in the Personal folder.
7. If the certificate is not there, request a new certificate or import the .cer file issued by any Certification
Authority (CA) for this computer.
a) To request a certificate from the CA that is currently installed in the domain, right-click the Personal folder.
b) In the shortcut click All Tasks > Request New Certificate.
887
c) Click Next.
d) Select computer as the Certificate Type.
e) Give the new certificate any friendly name (for example, OpenForms 360 Certificate) and click Next.
f) To complete the process, click Finish.
The name of the certificate should be identical to the DNS name of the server.
8. Export this certificate to the .cer file without private key and install it on the client side.
a) Right-click the installed certificate and click All Tasks > Export.
b) Select the Do not export the private key option.
c) Select any format (for example, DER encoded binary x.509).
d) Give any name (for example, server_cert.cer).
You can click the Browse button if necessary.
e) Click Finish to complete the process.
How to install the client certificate
Use the server site certificate to install the client security certificate after completing the server certificate installation.
Because the client security certificate is installed for the current client user, such as a validator working with
OpenForms 360 Validation, the certificate must be installed on the client side only after the configuration of the
OpenForms 360 Server is completed.
1. Log in to the client machine as a user. In the case of OpenForms 360 Validation, log in as a user who will run the
application.
In the case of AutoStore Server, log in as a user whose account will be used to run the route or the capture process.
2. Start the Microsoft Management Console.
3.
4.
5.
6.
7.
Click Start > Run and type mmc to open the Console1 window.
To add the Certificates snap-in that will manage certificates for the computer account, click File > Add/Remove
snap-in.
In the Available snap-ins box, click Certificates, and then click Add.
In the Certificates snap-in dialog box, click Computer account, and then click Next.
In the Select Computer dialog box, click Local computer, and then click Finish, and then click OK.
Import the certificate (.cer file) in the Trusted People folder.
a) Click Certificate - Current User to expand the folder tree.
b) Right-click the Trusted People folder, and click All Tasks > Import.
c) Click Next and browse to the certificate location.
d) Click Next, and select the Place all certificates in the following store option.
The certificate store should be Trusted People.
e) Click Next and then click Finish.
Occasionally you may encounter a situation with the OpenForms 360 components where they may not function
properly. Refer to the information in this chapter to help you resolve the situation before calling Technical Support.
Tip: Meeting all hardware and software requirements can help you avoid problems.
Problem
Possible Cause
Solution
SITEMAP files are sometimes not

listed in the Open browsing window.
A file type other than the Pro files

Select one of the following file types:
or the All files type is selected in the
Files of Type box in the Open dialog Pro files
All files
box.

displayed when you are attempting
A file other than .sitemap was

selected during the configuration
Select the appropriate

.sitemap file.
888
Problem
Possible Cause
to launch the OpenForms 360 route

component:
The SiteMap file does not contain a
reference to a schema file
The OpenForms 360 Validation

does not list any files although the
OpenForms 360 Server service is
running and the SITEMAP file has
been selected.
Solution
of the OpenForms 360 route
component.
Files are corrupt or missing in the
SiteMap project.
A project is not assigned to the
appropriate Validator.
The Validator is not listed in the
Validators list.
One project is assigned to two
Validators with one of them
processing the batch.
Perform one or all of the following:

displayed after you click the Check
button on the Connection tab of the
OpenForms 360 route component:
Add the project to the appropriate

Validator.
Add the Validator to the
Validators list in the OpenForms
360 Server Confgurator and
assign the appropriate SitmeMap
project to the Validator. Save the
changes in the configuration.
Restart the OpenForms 360
Server service.
To see whether one project is
assigned to two Validators,
check for the status of the files
of the project in question in the
database. It should be changed by
one of the users assigned to the
same project.
The https:// URL was entered

without selecting the Username/
Password authentication method.
Select the Username/Password

authentication method and populate
the activated Domain/Username
and the Password fields with the
credentials of the user previously
specified in the Route component
user field of the OpenForms 360
Server Configurator.
The net.tcp:// URL was entered

while the Username/Password
authentication method was selected.
Select the Windows authentication

method.
The connection was not established

with the OpenForms 360 Server or
the Service is not running.
Perform one or all of the following:
The provided URI scheme 'https' is

invalid; expected 'net.tcp'. Parameter
name: via
displayed after you click the Check
button on the Connection tab of the
OpenForms 360 route component:
Make sure the desired project is

not corrupt.
The provided URI scheme 'net.tcp' is

invalid; expected 'https'. Parameter
name: via
While connecting to the OpenForms
360 Server the following error is
displayed:
Could not connect to https://
ofserver.test.com:8080/OpenForms.
TCP error code 10061: No
connection could be made because
the target machine actively refused
it. Unable to connect to the remote
server. No connection could be made
because the target machine actively
refused it.

Server service.
Verify that a valid data is entered
in the UserName/Password
field.
Verify that the URL entered is
valid.
Verify that you can ping to the
889
Problem
Possible Cause
Solution
While connecting to the OpenForms

360 Server the following error is
displayed:
The user does not exist.
Verify that the OpenForms 360

Server configuration file is saved
and the service is restarted.
Create a new user or select the

appropriate one from the list of the
existing users.
An unsecured or incorrectly secured

fault was received from the other
party. See the inner FaultException
for the fault code and detail. At least
one security token in the message
could not be validated.
Only images in TIFF format are supported by OpenForms 360. The PackBits, Fax3 and Fax4 compression types are
supported. LZW compression is supported for binary images.
File Format
Bits per Pixel
File Format Description
FILE_TIF_PACKBITS
1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32
Tagged Image File Format with

PackBits Compression and RGB
color space.
FILE_TIF_PACKBITS_CMYK
24, 32

PackBits Compression and CMYK
color space.
FILE_TIF_PACKBITS_YCC
24
[95] Tagged Image File Format with

PackBits Compression and color
YCbCr space.
FILE_TIFX_FAX_G4
TIFF-FX format, compressed using

CCITT group 4.
FILE_TIFX_FAX_G3_1D

CCITT group 3, 1 dimension.
FILE_TIFX_FAX_G3_2D

CCITT group 3, 2 dimensions.
FILE_TIFLZW
1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32, 48, 64 Tagged Image File Format with LZW
Compression and RGB color space.
FILE_TIFLZW_CMYK
24, 32
Tagged Image File Format with LZW

Compression and CMYK color space
FILE_TIFLZW_YCC
24

LZW Compression and YCbCr color
space.
890
OpenForms 360 Server Configurator

Welcome to OpenForms 360 Server Configurator
OpenForms 360 Server Configurator is a tool used to configure the OpenForms 360 Server, which enables the
correct operation of OpenForms 360 that includes OpenForms 360 Professional recognition system, the OpenForms
360 capture and the route components as well as OpenForms 360 Validation. Each configuration can be stored in a
file for later use.
A thorough understanding of OpenForms 360 Sitemap Designer, OpenForms 360 Validation is required. You must
have this software configured prior to setting up an OpenForms 360-based AutoStore workflow.
Feature highlights
With OpenForms 360 Server Configurator you can do the following:
Configure the OpenForms 360 Server.

Manage database repository.
Apply permissions to the database repository and internal directories (storage folder, plug-in folder).
Manage lists of users associated with a project.
Activate license for OpenForms 360.
Getting started
Prerequisites
Following prerequisites must be met before OpenForms 360 Server Configurator can be used to configure the
OpenForms 360 Server:
The user under which OpenForms 360 is going to create a repository must be granted DBA permission to that
database.
Create a Windows Group (for example OpenFormsGroup) using Active Directory Users and Computers (in the
domain environment) or Computer Management (in the workgroup environment) Snap-In.
Create a user account for capture and route components (for example, AutoStoreUser).
Create a user account for each Validator (for example, Validator1 and Validator2).
Create two folders to serve as Storage folder, and Plug-in folder.
Set up a file share resource on File Server with read permissions for Windows Group and deploy the projects
created by OpenForms 360 Professional there. (For detailed information on how to create a project, refer to the
OpenForms 360 Sitemap Designer manual.)
Install security certificates on both the server and the client sides if you use the user name and password
authentication method.
Authentication methods
The OpenForms 360 Server supports two methods of authentication:
User name and Password
Kerberos (Windows)
Using this method of authentication requires HTTPS

transport; therefore you must install a certificate on
When using this method of authentication clients apply
the credentials of the user under which the process is run
to authenticate against the server.
The OpenForms 360 Server has the following authentication clients that use any of the above two authentication
methods:
OpenForms 360 components (reside on AutoStore Server)Applies the credentials of the user under which the
AutoStore service is run.
891
OpenForms 360 Validation (resides on Validation station)Applies the credentials of currently logged on user
are used.
OpenForms 360 Professional (resides on OpenForms 360 Server)Applies the credentials of the user under
which Captaris Load Manager Service is run are used.
For the Kerberos authentication use the URL in the URL with Kerberos authentication field (referred to as
Kerberos URL).
For the User name and Password authentication method, use the URL provided in the URL with username and
password authentication field of the Server tab.
Initial configuration of OpenForms 360 Server

Steps in this topic demonstrate a sample configuration of the OpenForms 360 Server.
1. Locate and launch OpenForms 360 Server Configurator tool by double-clicking the
OpenFormsServer.Configurator.exe executable file.
2. In OpenForms 360 Server Configurator, enter Database Connection String in the Connection String field by
using the Browse button to open the Connection Properties dialog box for configuring the connection properties.
3. In the Connection Properties dialog box select the server from the Server name list box (machinename\ART).
4. To connect to the database, select the OpenFormsDB database from the Select or enter a database name list box.
If you gave the database a different name during customized SQL Installation use that database name.
5. Click the Test Connection button to verify that the data connection is valid.
After a few seconds, the following message should appear: Test connection succeeded.
6. If you encounter an error during this test, check the settings, and make any necessary changes.
7. Click OK.
If the Repository Version states the number x.x.x.x indicating that OpenForms 360 Server Configurator
connected to the existing database and found a repository with the displayed version number. If no repository
exists create a new one by pressing Create Repository button.
8. Select the previously created Windows Group.
9. In the Users tab, select an existing AutoStoreUser in the Route Component User field as well as in the Capture
Component field.
10. In the Validators list, add users who will be connecting to the OpenForms 360 Server from OpenForms 360
Validation (for example, Validator1 and Validator2).
11. Add the projects located on previously created file share resource.
To do so, right-click on the user and click Add SiteMap.
12. Save the configuration on C:\Program Files\NSI\OpenForms 360 Server
\OpenFormsServer.Service.exe.config or to the folder that contains
OpenFormsServer.Configurator.exe resides.
13. Make sure that the OpenFormsServer.Service.exe service is logged on as Local System account.
14. Start or restart the service.
Menus
File menu
The OpenForms 360 Server Configurator provides a standard Windows File menu with standard commands such
as New, Open, and Save. These commands are duplicated on the File Menu toolbar.
Save asAllows you to save a configuration file to a new file.
Tools menu
The Tool menu provides the following commands:
892
Command Name
Clear database
Description
Clears the database of files displaying the following
statuses:
Clear storage folder
Captured
Rejected
Lost
Erroneous
Failed to Capture
Separated
Clears all files from storage folder that do not have a

reference to them in the database
Note: The storage folder should be empty as
it serves only as a temporary storage location
for all image files during processing time when
the OpenForms 360 Route component places
them there before the OpenForms 360 Capture
component retrieves them from this folder.
License manager
Allows to view the status of the OpenForms 360 license

or to install a new license via the AutoStore License
Manager.
Refer to the AutoStore License Manager help for further
details.
For detailed information about individual statuses, please refer to the OpenForms 360 Validation online help.
Help menu
On the Help menu you can also access the OpenForms 360 Server Configurator help files by clicking Manual.
To view OpenForms 360 licensing information, click Help > About.
To open a topic corresponding to a specific feature of the application, place the cursor on the feature or item that you
want to get help on and press the F1 key.
File Menu toolbar
The File toolbar of the OpenForms 360 Server Configurator duplicates the New, Open, Save commands of the
File menu and provides standard operations with files.
Configuring the OpenForms 360 Server
To configure the OpenForms 360 Server, populate all required fields and select the appropriate settings in the
following two tabs:
Server tab
Users tab
Note: All fields except the Validators field of OpenForms 360 Server Configurator are required fields.
Server Tab
The Server tab allows the configuration of the following groups of settings:
Database properties
Folders and permissions
893
Web service
Polling Interval
Enable separation of multipage batches
Queue size
Cache size
Database properties
The Database Properties option group allows you to select a database, create a repository and apply database
permissions to individual users and groups of users working on a project. Configure the following settings:
Setting Name
Description
Connection String
In the Connection String field, specify the path to the

database containing a repository containing all batches to
be processed by OpenForms 360 Professional. To do so,
click the ellipses button and select the desired database
in the Connection Properties dialog box.
Repository Version
>
Informs you about the status of the database. The
following status values may be displayed:
x.x.x.x Current version number of the

existing repository.
Repository was not foundOpenForms
360 Server Configurator succeeded in connecting to
the database but was not able to find a repository.
ConnectingOpenForms 360 Server
Configurator is in the process of connecting to the
database
FailedOpenForms 360 Server Configurator
failed to connect to database. The failure to connect
to the repository could be caused by any one of the
following:
Create Repository
The SQL Server (SQLEXPRESS) service is not

running.
The data base exists but does not contain a
repository.
OpenForms 360 Server Configurator is linked
to a database that was deleted or is corrupted.
The connection to the database server fails.
There is not enough space on the database server
to create a repository.
Old Repository: x.x.x.x OpenForms
360 Server Configurator found the repository but
its version number is below the expected version
number.
Unknown version: x.x.x.x OpenForms
360 Server Configurator found the repository but
its version is unknown (higher than the expected
version number).
Allows you to create a repository. Click this button if the

Repository Version value states Repository was
894
Setting Name
Description
not found to create a repository in the database to
which the connection string is pointing.
Apply Database Permissions
Allows you to add Validators, Route Component User,

and Capture Component User, all configured on the
Users tab to the list of database repository users.
Folders and Permissions

The Folders and Permissions group includes the following settings to be configured:
Setting Name
Description
Windows Group
Select a previously created group to serve as the

Windows group. To do so, click the ellipses next to the
field and select an Active Directory group in the Select
User or Groups dialog box.
Storage Folder
Browse to the folder where you would like the

documents routed by the OpenForms 360 route
component to be stored before they are forwarded
to the OpenForms 360 Professional engine for form
recognition and data extraction.
Plug-in Folder
Browse to the folder where you want the OpenForms

360 Server plug-ins to be stored.
For detailed information about OpenForms 360 plugin, refer to the OpenForms 360 Validation help or to the
OpenForms 360 Validation Administrators Guide.
Apply folder permissions
Click this button to grant users included in the Windows

Group access rights to the Plug-in Folder and the
Storage Folder.
Web service
Populate the following fields:
Field Name
Description
URL with Kerberos authentication
This field is populated by default with a URL where

the host name is set to the DNS name of the current
computer. If you do not have any special requirements
for the port number and other parts of this URL, do not
change this setting.
URL with username and password authentication
This field is populated by default with a URL where

the host name is set to the DNS name of the current
computer. If you do not have any special requirements
for port number and other parts of this URL, do not
change this setting.
SSL Certificate
Specify which certificate to use with HTTPS (with

OpenForms 360 version 2.0 the certificate name does not
need to have a certain name and it can be any name.)
895
Field Name
Description
Max Request Length (in KB)
In this field,type in a number of kilobytes to specify the

maximum request length. By default this property is set
to 122880 KB which would allow uploads of 120 MB.
Execution Timeout (in seconds)
In this field, specify a maximum amount of time for a

request sent to the server to be answered. The timeout is
initiated if the set time limit is exceeded. By default the
execution timeout is set to 600 sec.
Polling Interval
Polling Interval specifies how often the OpenForms 360 Server will poll the current state of the internal database
looking for new tasks posted by the OpenForms 360 route component. If there is a new task in the database, the server
marks it as ready to be validated or as captured, depending on the settings of the OpenForms 360 route component.
To set the polling interval, type in the amount of time in milliseconds in the Polling Interval (in seconds) box.
Enable separation of multipage batches
Selecting this check box allows the OpenForms 360 Server to split a processed batch of documents if some of the
processed documents require user validation. If for example, a processed batch contains 10 documents where 3
documents require user validation the OpenForms 360 Server splits the batch into two batches: one with 7 documents
and the other with 3 documents.
Queue Size
The value for queue size specifies the maximum number of batches OpenForms 360 Server is allowed to submit to
the DOKuStar engine for parallel processing. It allows loading as many DOKuStar cluster nodes with batches as
would be necessary.
For example, suppose the DOKuStar engine has five cluster nodes. This means that the DOKuStar engine can
simultaneously process only five batches. Now suppose that OpenForms 360 Server submitted seven batcheswith
each batch being submitted within a short period of timeso short of a time that the submitted batches have not been
processed yet. Five of the batches will be handled by DOKustar cluster nodes while the remaining two batches will
exist in a Pending state until one of the cluster nodes finishes its work.
This parameter is designed to limit the number of pending batches. It is advisable to set Queue size slightly greater
than the number of DOKuStar cluster nodes to ensure that all cluster nodes are working when necessary.
Note: Setting a queue size to too high a value will not make the cluster nodes work any faster. It instead only
increases the number of pending batches, which consumes more memory.
Cache Size
Cache size specifies the number of batches that the DOKuStar engine will keep in its cache. DOKuStar engine cache
is a temporary folder usually located at C:\Users\DOKuStar Load manager user\AppData\Local
\Temp\DOKuStar Professional\3.0\Cache\project name and contains all data extracted from the
batch during processing including SingleClick data (all text recognized by OCR) which is used by Validation Station.
While DOKuStar engine keeps processing new batches, old batches are deleted from the cache and consequently
their SingleClick data is no longer available for Validation. If Validator did not have time to validate the batch before
its Single Click data was deleted, all text recognized by OCR will be lost for the Validator.This will not prevent
Validating the batch because extracted data stays intact.
The general guideline is to keep the cache size greater than the amount of batches in the To Validate state.
896
Connection Properties dialog box

To open the Connection Properties dialog box, click the browse button (...) on the Server tab next to the
Connection String field.
1. In the Server Name box, type or select the server local machine name\SQLEXPRESS if the SQL Server
is installed in Windows mode. Click the Refresh button for updating the list, in case a new source of data has
become available.
2. In the option group Log on to the Server, select the log-on option as necessary for your environment from the
following two options:
Use Windows AuthenticationChoose this option if you want to the clients of OpenForms 360 Server to use
the Kerberos authentication method to authenticate against the server.
Use SQL Server authenticationChoose this option if the OpenForms 360 Server, the OpenForms 360
components and the OpenForms 360 Validation reside in different Windows domains and the User name and
Password authentication method is to be used.
3. To connect to the data base, click Select or enter database name and enter the name of the database in the text field
or select it from the list, then click OK.
4. Click Test Connection to verify that the data connection is valid. After a few seconds, the following message
appears: Test connection succeeded.
If you encounter an error during this test, check the settings, and make any necessary changes.
5. Click OK to finish.
Selecting User or Group dialog boxes
Selecting User or Group is performed in either the Select Group or the Select User dialog boxes.
In the dialog boxes, do the following:
1. Select an object type. To do so, click the Object Types button. In the Object Types dialog box, select Users or
Groups. Click OK.
2. Select the location from where you want the user or the group to be added. To do so, click the Locations button.
Click OK.
3. To add a user account to this group, under Enter the object names to select, type the name of the user account or
group account that you want to add to the group, and then click OK
4. Verify that the name is entered correctly by clicking the Check Names button.
5. For advanced options, expand the dialog box by clicking the Advanced button.
Users Tab
On this tab, configure the following settings:
Option
Description
Route Component User
Use the Select User dialog box to specify a user whose

credentials will be used by the OpenForms 360 route
component to connect to the OpenForms 360 Server.
Capture Component User
Specifies a user whose credentials will be used by the

OpenForms 360 capture component to the OpenForms
360 Server.
Validators
Validators are users who perform correction and/or

validation on the extracted data using OpenForms 360
Validation.
To add a Validator, right-click the empty field to open

a shortcut menu. Click Add User or Groups. In the
Select Users or Groups dialog box, select a user or a
user group.
897
Option
Description
Add to Windows Group
To assign a project to a Validator, click AddSiteMap

on the short-cut menu and select the SITEMAP file
of the project that you would like to assign to the
selected Validator.
To remove any of the users, groups or projects, rightclick the selected item and click Remove.
To allow Validators, the route component user and the

capture component user to access the storage folder
and plug-in folder, include them in the Windows Group
by clicking the Add to Windows Group button at the
bottom of the Users tab.
Saving your configuration

All settings are stored in a configuration file that is stored in the same location as the OpenForms 360
Server.exe file. The configuration file must be named according to the following template:
OpenForms Service name.config
For example, if the file name of OpenForms 360 Server is OpenFormsServer.Service.exethen the
configuration file must have the following name:
OpenFormsServer.Service.exe.config
Note: OpenForms 360 Server is run as a Windows service. Restart the server after completing the
configuration process.
Licensing
Distributed license system
Licensing in OpenForms 360 is based on the volume counters. When a document is processed by the extraction
engine, the engine decides which license items to use and how many license units are consumed from each license
item. It does that for every page of the document. After assessing the costs it contacts a license server and issues a
command to decrement the assessed units from the volume counter of the selected license item. The license server
keeps track of every license item and the number of remaining units.
For example, a document with one page which contains two fields and one table. The document is classified as either
an Invoice or Letter. When extraction engine processes this document it finds two fields and one table to be
extracted and that the document needs to be classified as Invoice. Based on this assessment it consumes 1 unit from
the OpenForms360 Classification license, 1 unit from the OpenForms360 Extraction 3 Fields license, and 1 unit
from the OpenForms360 Extraction Tables license. The extraction engine contacts a license server and subtracts 1
point from each of these thee license item volume counters.
The license system is designed to act in distributed environment. It can consist of one or several license servers. Each
license server holds a table like the following:
<license Item 1>
<License Level>
<Volume Left>
<license Item 2>
<License Level>
<Volume Left>
<license Item 3>
<License Level>
<Volume Left>
Any of the license servers can be used as a primary license server, a backup license server, or both primary and
backup servers. The only difference between these two roles is what is using the server.
The primary license server is the one referenced by OpenForms360 Sitemap Professional and ultimately by the
extraction engine.
898
The backup license server is referenced by a primary license server. If the primary license server is out of volume
for a particular license item it will relay the request to a backup license server.
How to specify the primary license server for OpenForms360 Sitemap Professional
Follow the steps in this procedure to point OpenForms360 Sitemap Professional to a primary license server.
1. In the OpenForms 360 Sitemap Designer, click Tools > OpenForms 360 Server.
This opens the OpenForms 360 connection options dialog box.
2. Enter the server path for the primary server.
You can copy and paste it from the URL with user name and password authentication field of OpenForms
360 Configurator if you intend to select the User name and password authentication method.
Copy it from the URL with Kerberos authentication field of the OpenForms 360 Server Configurator if you
intend to use the Windows authentication method.
3. Select the appropriate authentication method:
Option
Windows
User name/Password
Description
Select this option if you use the Kerberos method of
authentication.
Select this option if you use the user name and
password authentication method.
4. Click the Check button to verify the correctness of information entered.

If your settings are correct, a message line will appear below the OpenForms 360 Server URL field showing the
user name used to connect to the server and the status of the server license.
5. Click OK.
How to point a primary license server to a backup license server
Follow the steps in this procedure to point a primary license server to a backup license server.
1.
2.
3.
4.
Open the OpenForms 360 Server configurator.

Click the Backup License Servers tab.
Click Add.
Enter the server path for the backup server.
You can copy and paste it from the URL with user name and password authentication field of OpenForms
360 Configurator of the backup server if you intend to select the User name and password authentication
method.
Alternatively, you can copy it from the URL with Kerberos authentication field of the OpenForms 360
Server Configurator of the backup server if you intend to use the Windows authentication method.
Option
Windows
User name/Password
Description
authentication.
Select this option if you use the user name and
password authentication method.

7. Click OK.
License installation
You can install a license either by the web licensing or by email licensing.
899
How to use web licensing to install a license

You can update or add licenses using web licensing.
1.
2.
3.
4.
5.
Open OpenForms 360 Server configurator.

Click Tools > License File > Create request.
Click Tools > Web License.
If you are a new user, register your user information. Otherwise, use your login information to log into the
website.
Note: Email addresses from free email services, such as Google or Hotmail, cannot be used.
6. Enter all of the required information on the Web License form and upload the request file that was created.
7. Click Submit.
An activated license file is sent by email.
8. Save the license file in the email message, and record the file location.
9. In the OpenForms 360 Server configurator, click Tools > License File > Load Keys.
10. Open the activated license file that was saved in step 8, and click OK to apply the license.
How to use email licensing to install a license
You can update or add licenses from a different computer using email.
1.
2.
3.
4.
Open OpenForms 360 Server configurator.

Click Tools > License File > Create request.
On a computer with email access, send the file generated in step 3 to the appropriate recipient in charge of issuing
licenses for your enterprise, with subject line Activation Request.
A license file will be sent back to you by email.
5. Save the license file in the email message, and record the file location.
6. In the OpenForms 360 Server configurator, click Tools > License File > Load Keys.
7. Open the activated license file that was saved in step 5, and click OK to apply the license.
Licensing information
To view detailed information about the currently used license in OpenForms 360 Server Configurator, click Help >
About.
In the OpenForms 360 Server Configurator window, license information is presented in the following four
columns:
Column
Description
License
Displays a list of types of existing OpenForms 360

licenses.
Level/Mode
Displays the level of the currently used license. Each

level allows 2,500 pages per month or 30,000 pages per
year.
This also displays whether this item is monthly or yearly
volumn:
Monthly based volume gets automatically reset every

month.
Yearly based volume gets automatically reset every
year.
900
Column
Max (local)
Description
Displays the maximum amount of pages per month
provided by the current level for each type of license on
a local server.
In the case of OpenForms 360 Validation the value
in this column indicates the allowed number of
validation stations connected to OpenForms 360 Server
synchronously. It is equal to the level of this license.
In the case of OpenForms 360 ART the value in this
column indicates the allowed number of ART stations
connected to OpenForms 360 Server synchronously. It is
equal to the level of this license.
Left (local)
The remaining volumn on the local server. OpenForms

360 Professional decrements this counter according to
the specifications in the SITEMAP file and the license
used. If the extraction engine processed a page that
according to the SITEMAP file contains one field
and the current license allows recognition of one field
per page, the engine will decrement the counter for
the OpenForms 360 Extraction 1 Field per page
license by one. If according to the SITEMAP file, the
engine processed a page with more than one field, it will
decrement the counter for the available license with the
next highest number of fields allowed per page.
If field x license is not available, then field x+1 gets

subtracted. If field x has a Battery license then the
Battery field gets subtracted after the field x license
are exhausted. It goes on until the OpenForms 360
Extraction unlimited fields per page licenses.
If the engine processed more fields per page than
allowed by the current license, it returns a license
error.
In the case of OpenForms 360 Validation the value in
this column indicates the number of OpenForms 360
Validation stations that can be connected in addition
to those that are already online.
In the case of OpenForms 360 ART the value in this
column indicates the number of OpenForms 360 ART
stations that can be connected in addition to those
that are already connected.
Battery (local)
Regular licenses are reset on a monthly or yearly basis.

Battery can be bought if the systems runs out of volume
before it is time to reset the regular volume. This column
shows how much volume left in a battery. If both regular
and battery volumes are present, the regular volume is
consumed first, because the battery does not expire.
Max (total)
If backup license servers are configured, it shows a sum

of Max(local) and all Max(local) on backup servers
Left (total)
If backup license servers are configured, it shows a sum

of Left(local) and all Left(local) on backup servers.
901
The lower part of the window provides information about the active licensed clients, that is, OpenForms 360
Validation currently being used. The information includes the machine name and the time when a batch was last
loaded.
Types of OpenForms 360 licenses
The following table provides detailed description of each type of license:
License Type
Description
OpenForms 360 Classification
Allows classification of pages.
OpenForms 360 Extraction 1 Field per page
Allows classification of pages.
OpenForms 360 Extraction 3 Fields per page
Allows recognition of 3 fields per page.
Allows recognition of 4 to 6 fields per page.
Allows recognition of 7 to 10 fields per page.
OpenForms 360 Extraction Unlimited Fields per page Allows recognition of more than 10 fields per page.
OpenForms 360 Extraction Tables
Allows recognition of tables.
OpenForms 360 Extraction Address
Allows recognition of address fields.
OpenForms 360 Extraction Through Text File

Lookup
Allows recognition of fields by means of lookup in a text

file.
OpenForms 360 Extraction HandPrint
Allows recognition of hand print font.
OpenForms 360 Extraction Invoice Headers
Allows recognition using invoice header data operators.
OpenForms 360 Extraction Invoice Headers with

Line Items
Allows recognition using invoice header data operator

and invoice line item operator.
License for the OpenForms 360 Validation.
OpenForms 360 ART
License for the OpenForms 360 ART
The licenses also include Battery licenses for every License Type. If a certain license type expires and battery
licenses are available, then the battery field license gets subtracted.
The Battery licenses are set to "zero for evaluation licenses.
Using OpenForms 360 license API
Licenses
Volume licenses
Volume licenses are used to keep track of the number of

pages have been recognized under the certain license.The
following are the different kinds of volume licenses
available:
DOKuStar_Classify
DOKuStar_Index_1_Field
DOKuStar_Reader
DOKuStar_Option_Table
DOKuStar_Option_FuzzyDb
DOKuStar_Option_HandPrint
902
A checkout license
DOKuStar_Option_Address
DOKuStar_Option_Invoice
DOKuStar_Option_InvoiceLineItems
A checkout license is used to keep track of the number of

clients that are connected while using this license.
DOKuStar_Validation
Web calls
For Volume Licenses
int BatteryVolume ( string license )

Shows how many pages left for given license in
battery mode.
int RegularVolume ( string license )
Shows how many pages left for given license in
regular mode (based on monthly or yearly plan).
int MaxVolume ( string license ) Shows
the maximum number of pages allowed to use for the
current level of the license un regular mode.
For Checkout Licenses
int ActiveClients ( string license )

Shows the number of clients who checked out the
given license.
int MaxClients ( string license ) Shows
the maximum number of clients allowed to check out
the given license.
How to use WebCalls

1. The OpenForms 360 service should be running.
2. Create a project in Microsoft Visual Studio 2010.
3. Add service reference to the project, type the following address in the Address field, and click Go.
http://OpenForms_server:8000/OpenForms/MEX
903
4. Give the namespace a name.

For example OFWebClient.
5. Use the following code to connect and query the methods:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.ServiceModel;
namespace WebCallsTest {
public partial class Form1 : Form {
public const string
cDS_Classify = "DOKuStar_Classify",
cDS_Index_1_Field = "DOKuStar_Index_1_Field",
cDS_Reader = "DOKuStar_Reader",
cDS_Option_Table = "DOKuStar_Option_Table",
cDS_Option_FuzzyDb = "DOKuStar_Option_FuzzyDb",
cDS_Option_HandPrint = "DOKuStar_Option_HandPrint",
cDS_Option_Address = "DOKuStar_Option_Address",
cDS_Option_Invoice = "DOKuStar_Option_Invoice",
cDS_Option_InvoiceLineItems = "DOKuStar_Option_InvoiceLineItems",
cDS_Validation = "DOKuStar_Validation",
cDS_ART = "DOKuStar_ART";
public Form1() {
InitializeComponent();
}
904
private void Form1_Load(object sender, EventArgs e) {

urlTextBox.Text = "net.tcp://nsi-sergeyr1.md.nsius.com:8081/
OpenForms";
licenseComboBox.Items.Add(cDS_Classify);
licenseComboBox.Items.Add(cDS_Index_1_Field);
licenseComboBox.Items.Add(cDS_Reader);
licenseComboBox.Items.Add(cDS_Option_Table);
licenseComboBox.Items.Add(cDS_Option_FuzzyDb);
licenseComboBox.Items.Add(cDS_Option_HandPrint);
licenseComboBox.Items.Add(cDS_Option_Address);
licenseComboBox.Items.Add(cDS_Option_Invoice);
licenseComboBox.Items.Add(cDS_Option_InvoiceLineItems);
licenseComboBox.Items.Add(cDS_Validation);
licenseComboBox.Items.Add(cDS_ART);
}
private void licenseComboBox_SelectedIndexChanged(object sender,
EventArgs e) {
NetTcpBinding netTcpBinding = new NetTcpBinding();
netTcpBinding.TransferMode = TransferMode.Streamed;
OFWebClient.OpenFormsWCFServiceClient ws = new
OFWebClient.OpenFormsWCFServiceClient(netTcpBinding, new
EndpointAddress(urlTextBox.Text));
regularCountTextBox.Text =
ws.RegularVolume(licenseComboBox.SelectedItem.ToString()).ToString();
batteryCountTextBox.Text =
ws.BatteryVolume(licenseComboBox.SelectedItem.ToString()).ToString();
ActiveClientsTextBox.Text =
ws.ActiveClients(licenseComboBox.SelectedItem.ToString()).ToString();
maxClientsTextBox.Text =
ws.MaxClients(licenseComboBox.SelectedItem.ToString()).ToString();
maxVolumeTextBox.Text =
ws.MaxVolume(licenseComboBox.SelectedItem.ToString()).ToString();
}
}
}
Security certificate installation
Security certificates encrypt the communication between the server and the client thus providing a secure
communication between OpenForms 360 Server and its clients, OpenForms 360 components and OpenForms 360
Validation. For a successful connection, install both the server security certificate and the client security certificate.
Server certificate installation
Complete the steps in this procedure to install a security certificate on the server.
1. Open the Microsoft Management Console.
To do this, click Start > Run and type mmc.
If you are prompted to allow the program to make changes to the computer, click Yes.
2. Add the Certificates snap-in to the console. This will manage certificates for the computer account.
a) To do this, click File > Add/Remove snap-in.
b) In the Available snap-ins box, click Certificates, and then click Add.
c) Click Computer account, then click Next.
d) Click Local computer, then click Finish.
e) Click OK.
905
3. Expand the Console Root > Certificates > Certificates folder, and make sure that a certificate with the DNS
name of the server is installed in the Personal folder.
4. If the certificate is not there, request a new certificate or import the .cer file issued by any Certification Authority
(CA) for this computer.
a) To request a certificate from the CA that is currently installed in the domain, right-click the Personal folder.
b) In the shortcut menu, point to All Tasksand clickRequest New Certificate.
c) Click Next.
d) Select computer as the Certificate Type.
e) Give the new certificate any friendly name (for example, OpenForms 360 Certificate), and click
Next.
f) To complete the process, click Finish.
The name of the certificate should be identical to the DNS name of the server.
5. Export this certificate to the .cer file without private key and install it on the client side.
a) To do this, right-click the installed certificate, and click All Tasks > Export.
b) Select the No do not export the private key option.
c) Select any format (such as DER encoded binary x.509).
d) Give the certificate a name (such as server_cert.cer)
e) Click Finish to complete the process.
How to install the client certificate
Because the client security certificate is installed for the current client user, for example, Validator working with
OpenForms 360 Validation, the certificate must be installed on the client side only after the configuration of the
OpenForms 360 Server is completed.
To install the client security certificate, use the certificate you have created on the server site (see Server Certificate
Installation).
1. Log in to the client machine as a user.
For OpenForms 360 Validation, log in as a user who will run the application. For AutoStore Server, log in as a
user whose account will be used to run the route or the capture process.
2. Run Microsoft Management Console.
To do this, click Start > Run and type mmc.
3. Add the Certificates snap-in to manage certificates for the computer account.
a) Click File > Add/Remove snap-in.
b) In the Available snap-ins box, select Certificates.
c) Click the Add button.
d) Click My user account, then click Finish.
e) Click OK.
4. Import the certificate (.cer file) into the Trusted People folder.
a) To do this, first expand the Certificate - Current User folder.
b) Right-click the Trusted People folder, and click All Tasks > Import.
c) Click Next.
d) Click the Browse button, locate the certificate, then click Next.
e) Click Place all certificates in the following store.
The Certificate store should show Trusted People.
f) Click Next, and then click Finish.
Only images in TIFF format are supported by OpenForms 360. The following compression types PackBits, Fax3 and
Fax4 are supported.
906
In addition, LZW compression is supported for binary images.

File Format
Bits per Pixel
File Format Description
FILE_TIF_PACKBITS
1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32

PackBits Compression and RGB
color space
FILE_TIF_PACKBITS_CMYK
24, 32

PackBits Compression and CMYK
color space.
FILE_TIF_PACKBITS_YCC
24
[95] Tagged Image File Format with

PackBits Compression and color
YCbCr space.
FILE_TIFX_FAX_G4

CCITT group 4.
FILE_TIFX_FAX_G3_1D

CCITT group 3, 1 dimension.
FILE_TIFX_FAX_G3_2D

CCITT group 3, 2 dimensions.
FILE_TIFLZW
1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32, 48, 64 Tagged Image File Format with LZW
Compression and RGB color space.
FILE_TIFLZW_CMYK
24, 32

LZW Compression and CMYK color
space.
FILE_TIFLZW_YCC
24

LZW Compression and YCbCr color
space.
Occasionally you may encounter a situation with the OpenForms 360 components where they may not function
properly. Refer to the information in this chapter to help you resolve the situation before calling Technical Support.
Problem
Possible Cause
Solution
The following error message

is displayed at any time
during the installation:
Error registering
OpenFormsCapture.dll
or Error registering
OpenFormsRoute.dll.
The installation of .NET Framework 1. Reinstall .NET Framework.

3.0 failed.
2. Uninstall OpenForms 360
components and reinstall them.
During the configuration of the

OpenForms 360 server the SQL
Server databases are not listed in the
Select or enter the database name
field of OpenForms 360 Server
Configurator.
The Firewall is ON.

The SQL Server Remote
connection is set as local only.
Turn OFF the Firewall and see if the

SQL Server databases are listed if
it is a local server. If the Firewall is
turned off and the databases are still
not listed, complete the following:
1. Click Programs > Microsoft
SQL Server 2005 >
Configuration Tools >
SQL Server Surface Area
Configuration.
907
Problem
Possible Cause
Solution
2. Select the Surface Area
Configuration for services and
connections.
3. Select the SQL Express or the
instance that you are using and
select the 'remote connections'
node.
4. Click the Local and remote
connection radio button.
5. Click the Using both TCP/IP
and named pipes radio button.
6. Apply the changes and see if you
can see the SQL server databases.
Note: This fix is given only
with an assumption that the
SQL Server was installed
properly without any errors
and the server is listed in
your domain.
The Windows group browser

displays groups only from group
scope - Domain Local and Group
Type - Security while the other
groups are not listed.
The Windows group filters all other There is no fix for this instance. This
groups besides group scope - Domain is by design.
Local and Group Type Security.
An error message appears as you

attempt to save a configuration
in OpenForms 360 Server
Configurator and a red exclamation
mark is on either one of the Web
Service text fields.
1. The URL for Kerberos

authentication is the same as
the URL for the user name and
password authentication.
2. The URL for the Kerberos
authentication starts with net.tcp.
3. The URL for the user name and
password authentication starts
with https.
The URL for Kerberos authentication

and the URL for a user name and
password authentication cannot be
the same. The URL for Kerberos
should start with net.tcp. The URL
for user name and password should
be https.
Note: Changes made in the
Validators list do not require
restarting the service.
You have not populated all required

The following error message
fields.
appears as you attempt to save a
configuration in OpenForms 360
Server Configurator: There are
input errors on the form.
The configuration has not
been saved
Locate the red exclamations mark

and enter the related data.
The connection between the

AutoStore service, OpenForms 360
Professional or OpenForms 360
Validation fails after some changes
were made in OpenForms 360 server
Configurator.
Perform the following:
Changes made in the Server

tab of OpenForms 360 Server
Configurator were either not saved
or after making the changes the
OpenForms 360 server service was
not restarted in order to implement
the changes.
1. Restart the OpenForms 360

server service.
2. Reconnect to the OpenForms 360
Server.
908
Problem
Possible Cause
Solution
When adding a user or group to the

Validators list in the OpenForms
360 Server Configurator window,
only users are listed but not groups.
The group check box is not selected

in the Object types.
The OpenForms 360 Server service

cannot be started.
Check that the OpenForms 360

The OpenForms 360 Server
Server config file is saved at
config file has not been saved at
install_Directory\OpenFormsinstall_directory\OpenForms
360 Server\. Also check that the
360 Server\.
database server is running, and the
The connection to the database server database can be connected. Check
was lost.
the Event Viewer for any errors.
The following error is displayed after The OpenForms 360 Server service
you click Tools > License anager:
is not running.
System.Runtime.InteropServices.COMException
(0x80004005): Error
HRESULT E_FAIL has been
returned from a call to a
COM component.
When you are selecting a user, click

Object types and select the group
checkbox. All groups should be
listed along with the users.
Perform the following steps:

1. Close the OpenForms 360
Server Configurator form.
2. Open a Windows Command
Prompt window.
3. Change the directory to
install_directory\OpenForms
360 Server\
4. Run the following command:
OpenFormsServer.Service.exe
\u
This command uninstalls the
OpenForms 360 Server service.
5. Then run the the following
command:
OpenFormsServer.Service.exe
\i
This command installs the
OpenForms 360 Server service.
The shortcut menu does not appear

after you right-click a field.
The connection to the database

has been lost or the database is not
properly attached.
Reconnect to the database.
When you save the OpenForms

You connected to the server but did
360 Server configuration, the
not connect to the database.
following error message is displayed:
Start Index cannot be
larger than length of
string. Parameter name:
startIndex
Click the browse button next to the

Connection String field and select the
server name from the Server Name
list box. Then select the database
from the Select or enter a database
name list box.
The link in the Connection

You are connecting to the Master
String field is as follows: Data
database by default, because the
Source=machine_name\ART;Integrated
database is not attached.
Security=True
After you connect to the SQL Server,

attach the database and make sure
that the Connection String field
displays the database name so that
Initial Catalog displays Data
Source=machine_name\ART;Initial
909
Problem
Possible Cause
Solution
Catalog=OpenFormsDB;Integrated
Security=True.
When connecting to OpenForms

360 Server through OpenForms
360 Validation or OpenForms 360
Professional, you get the following
error message:
The socket connection was aborted.
This could be caused by an error
processing your message or a
receive timeout being exceeded by
the remote host, or an underlying
network resource issue. Local socket
timeout was '00:00:59.3906250'.
An existing connection was forcibly
closed by the remote host
The OpenForms 360 Server service

is not running.
Start the OpenForms 360 Server

service.
When connecting to the OpenForms

360 Server through OpenForms 360
Validation and you get the following
error message: Access Denied
The reason for the message is one of

the following:
Perform one of the following

corrections:
You have successfully connected to

the OpenForms 360 Server through
OpenForms 360 Validation but
cannot view any files under Batch
list.
The currently logged-in user is

not listed in the Validators list.
The OpenForms 360 Server
service is not running.
The currently logged-in user has
lost access permissions.
One of the following could be the

cause:
During the configuration of

the OpenForms 360 server the
Sitemap file was not assigned
by being added to the currently
logged-in user.
Upon the recognition process the
files were marked as "validated"
and retrieved by the OpenForms
360 Capture component. These
files will not be visible in the
OpenForms 360 Validation.
Make sure the Validator is added

to the Validators list in the
OpenForms 360 Server OR.
Server configurator OR.
Log off and log back on to restore
the validators permissions.
Make sure the desired Sitemap

project is added to the currently
logged-in user.

Welcome to OpenForms 360 Validation
What is OpenForms 360 Validation?
OpenForms 360 Validation is a system independent product for indexing, capturing and editing of data in DMS
applications. A powerful document model is integrated and complex data structures like tables are supported by
OpenForms 360 Validation.
910
In addition, Microsoft Visual Basic for Applications (VBA) is embedded into OpenForms 360 Validation as a
programming interface. This allows users to write Visual Basic scripts to perform tasks such as automatic document
type and field selection and comparison and verification of data.
Using OpenForms 360 Validation
OpenForms 360 Validation is used to validate and edit data in a workflow. OpenForms 360 Validation allows the
testing and editing respectively of complex data structures like table fields and elements of addresses (Free Form
Validating/Editing) and allows the processing of field alternatives. Of course simple index fields, document classes,
and types will be processed by OpenForms 360 Validation. In addition, OpenForms 360 Validation has embedded
Microsoft Visual Basic for Applications (VBA) as a programming interface. This allows users to write Visual Basic
scripts to perform automatic tasks such as document type and/or field selections, comparisons, and verifications.
OpenForms 360 Validation interface
There are three modes of the OpenForms 360 Validation interface:
Administrator Mode
Use this mode to develop project specific scripts for

importing/exporting of data as well as scripts controlling
Automatic Mode or supporting User Mode at run time.
Automatic Mode
Validation is performed automatically by Visual Basic for

Applications (VBA) scripts without any user interaction.
For example, automatically sorting and inserting data
into index fields.
User Mode
Provides an interface where validations are performed

manually.
The denotations of the menus, commands, hints and so on of the OpenForms 360 Validation interface (Administrator
Mode, User Mode) will be displayed in the language that has been selected during installation.
Starting OpenForms 360 Validation

Starting OpenForms 360 Validation in Administrator mode
To be able to develop project specific scripts you have to execute OpenForms 360 Validation in Administrator
Mode. To do this, OpenForms 360 Validation must be started from a DOS prompt with the command line parameter
a:
Open a DOS box and change to the \bin directory in the installation directory of OpenForms 360 Validation. Enter
dsval.exe a .
It is also possible to start OpenForms 360 Validation in Administrator Mode by using the script file
StartValidation.vbs. You will find this script in the OpenForms 360 Validation \Examples
\Start_AdminMode directory.
When Validation is started from a command prompt or through the script file, an empty OpenForms 360 Validation
window appears.
To create a new OpenForms 360 Validation project file, click File > New, or click File > Open to open an existing
OpenForms 360 Validation project file with extension .vpj.
In contrast to the User Mode of OpenForms 360 Validation, the button for the Visual Basic Editor (VBA editor) is
enabled in the tool bar. On the left bottom of the program window you will see the tabs Documents and Schema.
Additional functions of OpenForms 360 Validation running in Administrator Mode for developing scripts are
described in detail in the OpenForms 360 Validation Programming Manual.
911
Starting OpenForms 360 Validation in automatic mode

To execute OpenForms 360 Validation in Automatic Mode, OpenForms 360 Validation must be started from a DOS
prompt with the command line parameter i and the according project-file. Open a DOS box and change to the
\bin directory in the directory where OpenForms 360 Validation resides. Enter dsval.exe i project .
This will start OpenForms 360 Validation with the respective project but without a user interface. The validation will
be done automatically, provided, that the respective project is supported by a script.
Starting OpenForms 360 Validation in user mode
OpenForms 360 Validation can be started in User Mode by using the command OpenForms 360 Validation of the
OpenForms 360 Validation program folder or by a shortcut on the desktop, if one was created during installation.
When the program is started, an empty OpenForms 360 Validation window appears. The Visual Basic Editor
button in the tool bar is disabled, and you will see no tabs on the left bottom of the window.
In User Mode you cannot create new OpenForms 360 Validation projects, you can only process (open) existing
batches.
For validating click File > Open. An open dialog box appears that allows to select and open an OpenForms 360
Validation project file with extension .vpj.
When a project file is opened, the project is loaded by OpenForms 360 Validation. You will see the project
specification in the title bar:
The next step is to attach data to the project. This will be done by a script file, corresponding to the currently loaded
project.
If a user clicks File > Import Data, the data to be processed will be imported. You can click File > Export Data to
save the data.
How to control data import and export is described in detail in the OpenForms 360 Validation Programming Manual.
Screen layout
The following figure shows the screen layout of OpenForms 360 Validation. A project has already been loaded and
data are attached to the project.
912
913
Note that the main window may not look exactly like the one shown in Figure 3-1 in your installation. Most
window elements can be shown or hidden. Also control views or toolbars may appear at different positions, because
OpenForms 360 Validation allows you to resize, move, or undock most windows.
While processing great tables, it will be helpful to switch to Table Mode for a better view. The following picture
shows the screen layout of OpenForms 360 Validation in Table Mode:
914
915
Menu bar
File menu
Edit menu
View menu
Navigate menu
Image menu
Tools menu
Help menu
File menu
The File menu contains commands for processing OpenForms 360 Validation project files.
Command
Description
Connect
Establishes a connection with the OpenForms 360 server

and displays the list of documents to be validated in the
Custom window.
OpenForms 360 Connection Options
Opens a dialog box in which you can configure the

settings to be used when connecting to the server.
Disconnect
Disconnects the program from the server. The task list

will disappear from the left pane of the Custom window.
New
Creates a new validation project file with the extension

.vpj.
Open
Loads an existing project file.
Close
Terminates processing of the currently loaded project.
Save
Saves the currently processed project file.
Import Data and
Attaches documents to the currently loaded project.
Export Data
Saves data for the currently loaded project.
Exit
Terminates OpenForms 360 Validation.

Note: The New and Save are only available in Administrator Mode.
How to configure OpenForms 360 connection options

Perform this procedure to configure the parameters for connecting to the OpenForms 360 server.
1. Click File > OpenForms 360 Connection Options.
2. In the OpenForms 360 Server URL field of the dialog box, enter the server path.
Copy it from the URL with user name and password authentication field of OpenForms 360 Server
Configurator if you intend to select the User Name/Password authentication method.
Copy it from the URL with Kerberos authentication field of the OpenForms 360 Server Configurator if
you intend to use the Windows authentication method.
Option
Windows
User name/Password
Description
authentication.
Select this option if you use the Username and
Password authentication method.
916

5. Click OK.
The program will remember this configuration and use it next time to connect to the server. To view the list of tasks,
you will only have to click Connect in the File menu of OpenForms 360 Validation.
Edit menu
This menu offers normal edit functions for document types and index fields, such as Undo, Cut, Copy, Paste, Delete,
Delete Document. It also includes special edit functions for table processing, such as Insert Row Above, Insert Row
Below and Delete Row. It is also possible to toggle the Field Mode of document types and index fields.
View menu
This menu allows to show or hide the different windows of the user interface and to enable or disable the different
toolbars. The Toolbars command opens a sub-menu that allows to show or hide toolbars. The Extended Field
Source command expands the Field Source window so that the window shows an extended area of the document.
If the option is activated a box is displayed around the shown image. The Reset Layout command allows to restore
the default appearance (overall look) of the OpenForms 360 Validation screen layout. The Table Mode command
can be used to switch to a special layout during the processing of large tables. As default all windows, except the
Custom window, are visible and all toolbars enabled. If the Custom window is enabled, it is docked at the bottom of
the Validation window.
Navigate menu
This menu allows to navigate through documents, index fields and sources with commands like Document First,
Document Next, Document Prev, Document Last, Field Next, and so forth.
In case of alternatives, the commands Alternative Prev and Alternative Next allow to navigate through the provided
alternatives.
Image menu
This menu allows you to control the document representation in the Image window. The image displayed in the
window can be enlarged, reduced, or adjusted to the Image Window. It can also be centered or rotated by 90 degrees.
The command Scale to Gray allows you to display the image in binary or gray scale mode.
Tools menu
This menu shows the following commands:
Command
Description
Visual Basic Editor
Starts the VBA studio. For details about this

programming interface, refer to the OpenForms 360
Validation Programming Manual.
Save Workspace
Saves an application specific layout of the Validation

user interface.
Load Workspace
Restores a saved application specific layout of the

Validation user interface.
OpenForms 360 Options
Allows an administrator to manage all options available

in OpenForms 360 Validation (User Mode). This
command opens a dialog box where you can configure
the batch list filtering options.
OpenForms 360 Options Manager
Manage the OpenForms 360 options.
Options
Opens the DOKuStar Validation Options dialog box.

Select the Single Click Entry enabled check box to
917
Command
Description
enable or disable the functions of SnapIt function. The
remaining options control the behavior of Single Click
Entry functions and are described in Using the Mouse
(Single Click Entry).
Note: The following commands are only available in Administrator Mode: Visual Basic Editor, Load
Workspace, Save Workspace, OpenForms 360 Options ..., and OpenForms 360 Options Manager.
OpenForms 360 Options Manager
This dialog box allows you to perform following actions:
Action
Description
Add a user
Click this button to add a new user to the list of the

existing users. The Select Users dialog box opens. Here,
click Locations select the appropriate domain and click
OK. In the Enter the object names to select window,
type in the desired user name and click Check Names.
Click OK.
Delete user
To remove a user from the list of existing users, first

select the user from the user list and then click the Delete
users button.
Copy options from one user to the other users
To copy user's options configuration to all other users

or to one other user in the User column, from the dropdown list, select a user whose options configuration
you want to copy. In the User column, select a user
or users to whom you would like to apply the selected
options configuration. Clickthe Copy Options From
button. Now all users selected from the user list in the
User column have the options configuration of the user
selected from the drop-down list.
Customize the batch list for each user
To customize the tasks list for each user, select the

desired user and click the configuration button in the
button in the C column next to the User column. In the
OpenForms 360 Options dialog box, perform necessary
adjustments.
Help menu
Allows you to view version information in the About box.
Toolbars
The toolbar icons provide shortcuts for frequently needed menu commands. The buttons (or the group of buttons) can
be separately switched on/off or dragged to another position for easy access.
If the mouse cursor rests on a button of a toolbar, a tooltip text shows you the function of the button. This tooltip text
you will also see in the status bar of OpenForms 360 Validation.
Standard toolbar
918
This toolbar contains buttons for commands of the File, Edit, Tools and Help menus. In detail you will find the
following commands:
Create a OpenForms 360 Validation project

Open an existing Batch
Save the OpenForms 360 Validation project
Close the open Batch
Cut or copy a selection to the Clipboard
Paste contents of the Clipboard
Delete the selection
Delete a document
Show the Visual Basic for Application Editor
Display program information, version number and copyright
Image toolbar
This toolbar contains buttons for commands of the Image Menu which will affect the Image Window. In detail you
will find the following commands:
Zoom in
Zoom out
Fit in window
Fit to height
Fit to width
Center image
Rotate the image 90 to the left *)
Rotate the image 90 to the right *)
Toggle gray scaled / binarized image
Note: If the image is rotated this will also change the presentation in the Field Source Window.
Navigation toolbar
This toolbar contains command buttons of the Navigation menu. On document, field and source levels you will find
in detail the following commands:
Activate first element

Activate previous element
Activate next element
Activate last element
All navigation buttons will observe specified document or field filters, that is, only those documents or fields will be
shown that satisfy the specified filters.
The source navigation buttons will only take effect for documents consisting of several pages. They only allow to
navigate within the current document. So the Activate next source button will activate the first page of the current
document, if pressed on the last page. In the same way the Activate previous source button will activate the last page
of the current document, if used on the first page.
Furthermore you will find special command buttons for table editing like:
Insert new table row above current position

Insert new table row below current position
919
Delete active table row
And the toggle button for:
Toggling edit mode between Document Mode and Field Mode.
Document Filter toolbar

With this toolbar the document types to be editable will be selected. The drop-down list of this toolbar shows all
document types of the current project and the keyword all. If a document type is selected, only this type will be
editable in the Edit or Project Window. Other document types will be skipped.
Field Filter toolbar
The Field Filter toolbar is significant if a recognition server module precedes OpenForms 360 Validation. The dropdown list of this toolbar shows the result properties of index fields of a preceding recognition like:
All
OK
Empty
Reject
Error
Empty/Reject/Error
If a property other than All is selected from the drop-down list, only index fields with the selected property will be
editable; other index fields will be skipped.
Field Confidence Filter toolbar
The Field Confidence Filter toolbar is also significant if a recognition server module precedes OpenForms 360
Validation. The drop-down list of this toolbar shows an editable list of values.
If a recognition module returns a confidence value for recognition results, you can select a value. In this case, only
index fields with a confidence value less or equal than the given value can be processed, other index fields will be
skipped.
Alternatives toolbar
This toolbar is also significant if a recognition server module precedes OpenForms 360 Validation and the recognition
produces more than one result. If a recognition server produces one or more alternative values for a result, all
available alternatives will be found in the drop-down list of this toolbar. Selecting a value from this list will replace
the value in the Edit window. In many cases, this will be much more convenient than editing a whole term.
Document Change toolbar
This toolbar allows the user to rename a selected document type. The drop down list of this toolbar shows all
documents types of the project.
Selecting a document type in the Project or Edit window and clicking on a document type from a drop down list will
rename the type.
Note: If a document type is renamed, the values of all index fields of the document will be lost.
920
Custom toolbar
To display the Custom toolbar, click View > Toolbars > Custom. The following two buttons can be used to speed up
the validation process:
Validate and Load NextClick this button to accept changes applied to a currently opened document, to close it
and to load the next document in the list of tasks.
Reject and Load NextClick this button to close a currently opened document and automatically load the next
in the tasks list. The changes applied to the document will not be saved. The document will not be forwarded to
the next component in the AutoStore process.
These commands can be accessed on the short-cut menu when you right-click in the left pane of the Custom window.
Status bar
On the bottom of the OpenForms 360 Validation window you will find the status bar. The status bar shows the current
document of the batch, that is processed by OpenForms 360 Validation, for a better orientation.
View windows
The View windows, considered together, will give a good survey of the currently processed document and the project
structure. The windows are described in the following topics:
Project Explorer
Image window
Source window
(Table) Edit window
Fields window
(Table) Information window
Project Explorer
This window shows the structure of document types of the currently processed project in a tree view representation.
The pages are represented by sub-nodes showing the image file name.
921
To navigate in this window, use the commands of the Navigate menu or the respective buttons of the Navigation
toolbar.
Single document types can be deleted, joined or split using the context menu of the document type node.
A document type can be renamed to another document type of the current project. First mark and click the document
type with the left mouse button, then select the desired document type from the Document Change toolbar.
Note: If a document type is renamed, all index field values of the document will be lost.
Pages can also be deleted, joined or split to another document type. Pages can also be dragged and dropped to another
document type.
Image window
The Image window shows the currently processed page of a document type. The image can be zoomed or adjusted to
the window using toolbar buttons and will be displayed in gray scale or binary mode.
For a good survey, the currently processed index field will be highlighted by a different color, provided that the index
field is not empty. In the case of alternatives, these alternatives will also be highlighted by a different color.
If the index field shows a table, the whole table field will be highlighted, where the currently processed element of the
table field will be highlighted in a different color.
Source window
The Source window shows the region of interest (snippet) of the current page in an enlarged presentation, adapted to
the size of the Source window.
The displayed snippet will be the image of the index field or index field element, which is highlighted in the Image
window.
Note: If the index field is a table, an element of the table must be selected in the Edit window before the
image of the table element will be shown.
(Table) Edit window
The information shown in this window and the available edit operations depend on the selected edit mode.
Edit Mode
Index Field
Description
The window shows the character recognition results of
index fields, at times associated with the image displayed
in the Fields Window. The default property of this
window is "overwrite". Typing any key will overwrite
the whole displayed value. To switch from overwrite to
insert mode, press the left or right arrow key in case of
simple index fields. In case of table fields press F2 to
switch to insert mode.
You can press the Return or Enter key to confirm
changes made in the Edit window. In the case of simple
index fields, changes will also be visible in the index
value field of the Fields window.
If this window loses the focus, it is no longer possible
to change values. In this case, you have to set the focus
to this window by clicking on the Edit Window with a
left mouse button click or by selecting an index field in
the Fields window. If the Edit window has the focus,
this will be recognizable by a blinking cursor (insert
mode). In overwrite mode the focus is recognizable by a
922
Edit Mode
Description
bold bordered table field element or the blue background
color of the index field value respectively.
Document Type
In this mode all document types for the current project

are listed in the window and an additional document
type can be selected according to the current document.
If changes have been made, they must be confirmed by
pressing the Return or Enter key. The document type will
also be visible in the Project window.
Note: If the document type is changed, all
index field values of the respective document
will be lost.
If this window is no longer active, values cannot be
changed. In this case, activate the window by clicking
on the Edit window with the left mouse button or by
selecting an index field in the Fields window.
Fields window
This window shows all index fields that are specified for the current document type and their current result values.
This view is HTML based and will be changeable by project specific templates. For additional hints refer to the
Programming Manual.
(Table) Information window
This window is provided for hints or messages for the operator, generated by the according script of the actual
processed project.
Custom window
If the Custom window is enabled, it appears at the bottom of the main application window by default when you start
the application. You can undock the Custom window and place it anywhere within your work space according to
your needs. To undock the window, either drag and drop or right-click the right pane of the window to open a shortcut
menu. On this menu, cancel the selection of Allow Docking. The window appears as a separate window which you
can move or resize. To dock it back, right-click the left pane of the Custom window and click Allow Docking on the
shortcut menu. Drag and drop the window to the desired location on the screen.
The Custom window consists of two adjacent panes:
Left pane
Right pane
To close the Custom window, click the close button in the upper-left corner of the window.
Note: The list of batches will not be displayed in the Custom window if the user is not granted administrator
permissions on the machine.
Left pane of the Custom window
The left pane of the Custom window displays:
The list of batches to be validated

Short-cut menu providing a set of commands to be used during the validation process
Batch List
The list of batches is displayed in the left pane of the Custom window in a table with the following columns:
Batch ID - Displays the number of a batch.
923
Batch Name - Displays task's name that was entered in the SiteMap tab of the OpenForms 360 route component
during its configuration. If no task name was entered, you will see a file name (see chapter "Batch Name" of
online help for OpenForms 360 components).
Status - Displays the current status of the batch, such as To Validate, Opened .
Change Time - Displays the latest date and time when the batch was changed.
SiteMap - Displays the name of the SiteMap project used to process selected batch.
User - Displays the name of the "validator" assigned to the current validation project.
You can sort the batches according to your needs by applying custom filters available in OpenForms 360 batch list
filtering options. From the left pane you can load a document, that is, task to the Image window of OpenForms 360
Validation and give the document an appropriate status.
To get the latest view of the batch list, right-click the left window pane and click Refresh.
Batch list filtering options
You can customize the task list according to your needs by applying custom filters to it. The filter sorts the list by a
user-specified criteria. Filtering options are accessible from the Tools menu of the main application. Go to the Tools
menu and click OpenForms 360 Options. In the dialog box select the desired filter from the list of the following
available custom filters:
Filter
Description
Status <> 'Validated'
Hides the tasks that have the status "Validated"
Status <> 'Validated' AND Status <> 'Rejected'
Hides the tasks that display the status "Validated" and

"Rejected".
StatusChangedTime >= '12/01/2006' AND

StatusChangedTime <= '12/31/2006'
Displays the tasks that were changed during a particular

period of time. Define the time frame by typing in the
appropriate dates between ">" and "<".
SiteMapFile like '%MyDSPProject10.sitemap'
Hides the tasks that belong to a project that you define

by typing the name of the project after the % sign.
GeneralName like '%.tif'
Displays only TIFF images.
ADObject like '%user1'
Displays tasks being worked on by a particular user.

Type in the name of the user after the % sign.
None
Displays all task in the list.
To see only those tasks that are only available to you, select the Show only tasks not being worked on by another
user check box.
To get the latest view of the list of tasks, click the Refresh button on the context menu.
Shortcut menu
If you right-click the left window pane, a shortcut menu with the following commands will appear:
Command Name
Description
Validate and Load Next
Select this command if you want to close the currently

loaded document, save the possible changes, and open
the next batch in the list.
Reject & Load next
Select this command if you think that the document you

have loaded for validation is a wrong one and you would
like to close it and open the next document in the list.
924
Command Name
Description
Load to Validation
Loads the previously selected batch to the Image

window.
Save
Changes will be saved to the XML file generated by

the OpenForms 360 engine. The document will remain
open. However, you will not be able to proceed with
validation. To continue your validation process you will
have to select a different command for this batch.
Validate and Save
Changes will be saved to the OpenForms 360 enginegenerated XML file while the image itself will be
stored in the Processed folder if you specified one
during the configuration of the OpenForms 360 capture
component. The document will be closed. The batch
in the list will display the status Validated. The
document will be retrieved by the OpenForms 360
capture component and passed on to the next workflow
component for further processing.
Validate without Saving
Changes will not be saved to the OpenForms 360 enginegenerated XML. The document will be closed; the
batch in the list will display the status Validated.
The document will be retrieved by the OpenForms 360
capture component and passed on to the next workflow
component for further processing.
Reject
The document will be closed, and the batch in the list

will display the status Rejected. The document
will not be retrieved by the OpenForms 360 capture
component.
Hold and Save
The changes will be saved, and the batch in the list will
display the status On Hold. The document will not be
retrieved by the OpenForms 360 capture component.
Hold without Saving
The changes will not be saved, and the batch in the list
will display the status On Hold. The document will not
be retrieved by the OpenForms 360 capture component.
Set Status
Opens the Select Status dialog box, where you can

select the appropriate status.
Refresh
Select this option to get the latest view of the batch list.
Select status
The status is assigned to a batch by the OpenForms 360server to reflect the document's current processing state.
The status serves as an identifier by which OpenForms 360capture component recognizes a document that is to be
processed or left untouched. In the administrator mode of operation, the administrator can change the status of a task.
However, while changing some of the statuses can be very useful, it is strongly recommended to change other statuses
only after through consideration as changing those statuses can result in a document not being processed at all.
To change a status of a task, select it in the list, right-click, and then click Set Status on the shortcut menu. In the
Select Status dialog box, select the appropriate status from the list of statuses available in the Select Status list. The
table below provides information about each status.
925
Status Name
Description
Captured
Image has been retrieved by OpenForms 360

capture component from the OpenForms 360 Server
successfully. Not recommended for manual setup.
Failed To Capture
Error occurred during capturing the image.
Lost
Image is present in the database but cannot be accessed

in the file system. Not recommended for manual setup.
On Hold
Image is present in the database but cannot be accessed

in the file system. Not recommended for manual setup.
Posted
Image has been posted by OpenForms 360 route

component to OpenForms 360 database. Ready to be
processed by OpenForms 360 engine. Assigning this
status will cause the engine to process this batch again.
Rejected
Image has been rejected by Validation Station and

will not be retrieved by the OpenForms 360 capture
component.
Separated
User should not select this status. It is automatically

applied by OpenForms 360 Server only when the check
box Enable Separation of Multipage Batches in the
OpenForms 360 Server Configurator application is
selected.
For example, a processed batch contains 10 documents
where 3 documents require user validation. The
OpenForms 360 Server splits the batch into two
batches: one with 7 documents and the other with 3
documents.On validation, two separate batches will be
displayed.
To Validate
Image has been processed by OpenForms 360 Sitemap

Professional and is ready to be validated in OpenForms
360 Validation.
Validated
Image has been validated in OpenForms 360 Validation

and is ready to be captured by OpenForms 360 capture
component.
In the Select Status dialog box you can reassign users:
Set Current UserSelect this check box, to replace the existing user by the user currently logged-in to the
system.
Clear UserSelect this check box to remove the user currently assigned to the selected task.
Right pane of the Custom window

The right pane of the Custom window has an informative function and provides two pieces of information pertaining
to the currently selected batch:
Full Project PathThe location of the project used to process the currently opened batch.
Confidence LevelsThe user-defined value of the confidence level defined during the configuration of the
OpenForms 360 route component (see "Use Validation" in the OpenForms 360 online help). If you specified
a confidence level for individual fields of a document, these values are displayed as a tree structure in the
Confidence Levels section of the right window pane. Clicking a confidence level value locates the respective
document field in the Project Explorer view window of the main application. (For more information about
926
the view windows of OpenForms 360 Validation, refer to "View Windows" in the OpenForms 360 Validation
Manual).
Using OpenForms 360 Plug-ins

The purpose of OpenForms 360 plug-ins
OpenForms 360 Server plug-in is a .NET 2.0 class library assembly compiled in a DLL. Plug-ins are called from
validation scripts and are intended for implementing validation business logic on the OpenForms 360 server side as
opposed to VB6 scripting, which implements business logic on the validation station side.
How to creating a plug-in using Visual Studio 2005
1. Run Visual Studio 2006, create new project and select Class Library from the template list.
2. Create a method inside the class that implements required business logic.
This class should contain a default constructor without parameters. In the following example, only string
parameters are supported. An output parameter should have the ref keyword in front of it.
Class1.cs
using System;
usingSystem.Collections.Generic;
usingSystem.Text;
usingSystem.Windows.Forms;
usingSystem.Diagnostics;
namespaceServerSidePluginTest
{
public class Class1
{
public string Method1(string
{
return "return value: " +
}
public string Method2(string
pOutStr)
{
pOutStr = "out parameter:
return "return value: " +
}
}
}
pStr)
pStr;
pStr1, string pStr2, ref string
" + pStr2.ToString();
pStr1 + "\n\r" + pOutStr;
3. Compile the project.

4. Copy output DLL (.dll) to the plug-in folder that was configured in the OpenForms 360 Server Configurator.
How to call the OpenForms 360 plug-in from OpenForms 360 Validation
A plug-in is called from VB6 Script of OpenForms 360 Validation Project. The script should be created in advance
before the actual Validator can use it during validation process. To create the script, perform the following steps in this
procedure.
1. Run OpenForms 360 Validation in administrative mode.
2. Connect to the OpenForms 360 server (File > Connect).
3. Open a task by right-clicking it and then clicking Load to Validation on the short-cut menu.
OpenForms 360 Validation Project (.vpj) will be generated as the task is loaded, based on the OpenForms 360
Professional project (.sitemap) and will be loaded to Image window.
4. Click Tools > Visual Basic Editor.
This opens the Microsoft Visual Basic editor.
5. Click Tools > References and select OpenForms Validation from the available references list.
6. Click OK.
927
7. Enter the following text in Application_OnProjectLoaded subroutine:

Private Sub Application_OnProjectLoaded(ByVal App As Application)
Dim OFAddin As OpenForms_Validation.AutoStoreGWAddin
Dim aims As AddInManagerService
Dim aim As AddInMoniker
aims = Me.Services("AddInManager")
aim = aims.At("OpenForms.Validation.AutoStoreGWAddin")
OFAddin = aim.Object
If Not (OFAddin Is Nothing) Then
Dim result As String
Dim pars(2) As String
pars(0) = "Input parameter 0"
pars(1) = "Input parameter 1"
'pars(2) is output parameter
result = OFAddin.InvokeMethod("ServerSidePluginTest.dll",
"ServerSidePluginTest.Class1", "Method2", pars)
MsgBox(CStr(result) & pars(2))
End If
End Sub
InvokeMethod method
The InvokeMethod method has the following header:
public string InvokeMethod ( string MyAssemblyFile , string MyClass , string MyMethod ,
string [] Params )
Parameters
Parameter
Description
MyAssemblyFile
File name of the assembly stored in the Plug-in folder.
MyClass
Full class name (including namespace) of the method

that is being called.
MyMethod
Name of the method that is being called.
Params
Array of parameters to be passed to the method.
Return value
Returns the value returned by MyMethod returns.
Comments
Following restrictions and limitations are known:
Only string parameters and return values are supported.

Each call of InvokeMethod creates a new instance of MyClass.
MyClass should have a default public constructor (without parameters).
Output parameter should be specified as ref in MyMethod header of the plug-in.
The member of the Params array that is associated with the output parameter will contain the appropriate output
value.
Using the Mouse (SnapIt)

Introduction
Overview
Tool tips
928
Overview
SnapIt, is a tool designed to speed up document post-processing. SnapIt turns the mouse into a convenient device for
efficient manual data entry. With the support of intelligent software that can distinguish OCR results, the mouse is
redeeming itself as a data entry tool for error handling of recognition results.
The patented SnapIt technology allows users and data entry professionals to capture data from free-form documents
such as invoices and purchase orders. Many operating functions are intertwined in the SnapIt technology. They are
all built around the fact that the error handling software not only displays an image of the document, but can also
distinguish the results of the recognition process.
SnapIt reverses the traditional data entry paradigm. When capturing free-form documents such as invoices, what
counts is not how fast you can type in the characters but how fast you can locate the information on the document.
This is the point where SnapIt kicks in.
The important difference to traditional validation of handwritten forms to validation of machine printed business
documents is that the challenging task on business documents is to locate the relevant data rather than capture it
correctly. Locating the data can be done very intuitively by pointing to it with the mouse.
SnapIt comprises the following features:
Feature
Description
Zone and Capture
This function allows to import selected characters or

words into the corresponding data field by drawing a box
around them with the mouse.
Pick a Word
This function allows to import selected characters or

words into the corresponding data field by clicking at
them with the mouse.
Multi-Selection
This function allows to capture several words by clicking

at each word with the mouse.
Data Type Locator
This function highlights all recognized fields of a

selected field type on the document, for example, all
date or amount fields. This allows the user to control the
extracted value or to find and capture the correct value
quickly.
Table Auto-Completion
This function allows to read a complete table

automatically after the first row has been captured
manually.
Zoom-in Pointer
The zoom-in pointer allows to enlarge the region

surrounding the mouse cursor. Thus it is possible to
show the complete document or a great part of it in the
image window in order to have a good overview and to
enlarge any details, that are too small to read, quickly
using the zoom-in pointer. This can save much time
normally used for zooming or scrolling of the image.
Zooming and Scrolling
Using the mouse wheel together with function keys

allows fast zooming and scrolling.
SnapIt tool tips

If SnapIt is active, the mouse cursor shows a tooltip, when the mouse is positioned in the image window. The tooltip
shows the name of the current field as title. Normally, when the mouse is not positioned over text, the current value of
the field, as it is displayed in the Edit window, is shown on dark blue background. The dark blue background signifies
that the tooltip shows the current value of the selected field:
929
Always when one of the SnapIt features is used to select characters or words, the tooltip shows the currently selected
text, that may be captured, on gray background. Gray background color always signifies that the tooltip does not show
the current field value but selected data that could be used to replace the current field value. In the following example
Pick a Word is used. The mouse cursor is positioned on a text string, in the following image, a number. The selected
word is highlighted in orange and the value read by character recognition is shown in the tooltip on gray background:
A mouse click would now replace the fields value. A double click would enter the value and switch to the next field.
SnapIt provides two different modes that can be selected using the option Multi-Selection on demand. In standard
mode, when the option is marked, Multi-Selection is disabled and can be used only by pressing the Shift key.
Standard mode is the default after OpenForms 360 Validation has been installed for the first time.
In Multi-Selection mode the function is always enabled.
Several functions and shortcut keys work differently in these modes. Therefore they are described in separate
sections.
The following sections first describe general functions that are independent of the mode you work with.
General functions
Editing with the Keyboard

Data Type Locator
Table Auto-Completion
Zoom-in Pointer
930
Editing with the keyboard

At any time the value shown in the tooltip can be edited. If you enter a character or use the F2 function key, the
tooltip will be replaced by an edit window. If you open the edit window by entering a character, the character will
replace the previously selected string. In the following example a digit has been entered in order to capture a new
value using the keyboard:
If the F2 key is used, the edit window opens and the previously selected value can be edited:
Another method to enter edit mode is using the Alt key while you capture data with the mouse. While the left mouse
button is kept pressed to capture text that has to be edited, press the Alt key and then release the left mouse button.
The edit window opens with the captured text.
The command Edit Value in the context menu of the image window opens the edit window with the current field
value.
Data type locator
This function highlights all occurrences of a special data format on the document, such as all amounts or date values.
This often allows to locate the correct value on the document quickly. In the following example the currently selected
field for the invoice date is empty and all date values on the document are marked:
931
Note: The Data Type Locator can be used only if the application provides the necessary data for the
respective field.
Table auto-completion
This function allows to capture a whole table with a few mouse clicks. To be able to use table auto-completion,
capture all relevant columns of the first table row.
Add a table row using the command Insert Row Above of the context menu of the Edit or Image window. Then go
to the first table row, i.e. the first row containing data, not the header line of the table. Capture the table cells of all
required columns. The captured cells of the first row specify the columns that will be completed.
Then use the Table Auto-Completion command in the context menu of the image window. The following example
shows Validation in table mode and an invoice table that has been prepared for automatic completion:
The remaining table rows are then filled automatically:
932
While capturing the cells of the first row, please take into account:
At least two cells must be captured.

You should only use cells that occur in all or most table rows.
A table cell may consist of several lines of text.
If the result is erroneous, for instance when a column has been forgotten, the command Clear Table Keeping First
Line allows to take back the changes.
While capturing complex tables, especially tables where not all rows have the same structure, you can capture several
table rows before calling table auto-completion or you can capture a row with differing structure, that was not found
in a first auto-completion run and start table auto-completion a second time.
The following example again shows OpenForms 360 Validation in Table mode with a table where the cells of a table
row stretch over several text lines. The first table row has already been captured so that Validation is ready for table
auto-completion:
933
Table auto-completion yields the following result:
As you can see, all rows that have the same structure as the first row were found. But the table contains additional
rows that have a different structure and where some cells are missing. To add these rows, add a new row after the first
row and capture the second table row. Afterwards call table auto-completion a second time:
934
This yields the following result:
Table auto-completion now found all rows of the second format and inserted them at the respective position. The table
is now complete.
Note: By default, only certain rows are displayed in the table grid and uncertain rows will not be deleted
when the command Clear Table Keeping First Line is used (when this command has been used, the
command Table Auto Completion will be disabled).
To be sure to delete all rows, first use the command View All Rows in the context menu of the table grid and then use
the Clear Table Keeping First Line command.
935
Another way to proceed is to use the command Clear > Table. This will delete all rows (certain and uncertain) of
the table. As next step add a table row (Insert Row Above/Below) and continue with the functionality of table autocompletion.
Zoom-in Pointer
The zoom-in pointer shows the neighborhood of the mouse cursor enlarged in a separate Zoom-in Pointer window.
This makes it easier to recognize small details without having to enlarge the complete document.
The zoom-in pointer has two different modes that can be switched using the context menu of the Image window.
If the zoom-in pointer is set to the mode Hide, it appears only while the right Ctrl key is pressed. The window
replaces the tooltip. It is always shown at the mouse position and moves together with the mouse:
While you keep the right Ctrl key pressed and the zoom-in pointer is shown, you are still able to capture data with
the mouse using Pick a Word or Zone and Capture. The respective highlighting will now appear in the Zoom-in
Pointer window. Only the tooltip is not visible:
If the mode is switched to Show, the Zoom-in Pointer window is shown as a normal window at a fixed position.
Thus you are able to work in the Image window with the normal document view and at the same time see the
enlarged surroundings of the mouse position in a separate window. Position and size of the window can be changed.
To change the window size, draw one of its corners with the mouse. To change the position, go to the title bar of the
window with the mouse and move the window to the new position. It can be placed anywhere on the screen:
936
In this mode the mouse position is indicated by cross hairs. The cross hairs can be removed by switching off the
option Zoom-in Pointer: Show cross hairs in mode Show.
If you work in mode Hide and are not satisfied with the size of the Zoom-in Pointer window, switch to mode Show
temporarily using the context menu of the Image window. In mode Show you can then adapt the window size by
drawing a window corner with the mouse. In mode Hide, the window will now also appear in the modified size.
Note: If you close the Zoom-in Pointer window by clicking on the respective button, then the mode is
switched to Hide. To reopen it, you will have to change the mode back to Show.
The mouse can also be used for fast zooming and scrolling in the Image window:
For zooming, use the mouse wheel while you press the left Ctrl key.
For vertical scrolling use the mouse wheel without pressing keys. If the current document consists of several
pages, vertical scrolling will also switch to the previous or next page.
For horizontal scrolling use the mouse wheel while you press the Shift key.
Capturing data in Standard Mode

Single Click Entry works in Standard Mode if the option Multi-Selection on demand is marked. In this mode a
mouse click will capture data that will replace the previous field value. To be able to capture several text strings one
after the other, Multi-Selection must be enabled temporarily by pressing the Shift key.
Pick a Word (Standard Mode)

Zone and Capture (Standard Mode)
Multi-Selection (Standard Mode)
Deleting the selection in the tooltip
Pick a Word (Standard Mode)

When the mouse is positioned over text, the selected area or word is highlighted in orange and its value is shown in
the tooltip:
937
A single mouse click will enter the shown value into the current field. A double click will enter the value and switch
to the next field.
To enter several neighboring words, press the left mouse button and drag the mouse over the desired words. The
words will be marked and shown in the tooltip:
As soon as all words are marked, release the mouse button and the selected words will be entered into the field:
In order to switch to the next field just double-click into an empty area of the document or press Return.
If the captured text needs to be edited, just hold down the Alt key before releasing the mouse button in order to enter
edit mode. When you have already released the mouse button, you can still enter edit mode by pressing F2.
To capture a word and switch to the next field, just point to a word and press Return.
Zone and Capture (Standard Mode)
Several words or a whole block of text can be easily captured by drawing a rectangle around the text using the mouse
while the left mouse button is kept pressed:
938
As soon as the mouse button is released, the captured text is entered into the current field. In order to switch to the
next field double-click into an empty area of the document or press Return.
If the captured text needs to be edited, hold down the Alt key while releasing the mouse button to enter edit mode.
Sometimes it is difficult to use Zone and Capture because Pick a Word always becomes enabled when the mouse
cursor is positioned over text. In these cases hold down the left Ctrl key. The mouse cursor changes to cross hairs, and
Pick a Word is disabled until the Ctrl key is released. This allows you to draw a rectangle without problems:
In order to replace the field value, Multi-Selection can temporarily be disabled. Hold down the Shift key while you
draw a rectangle with the mouse, and then release both Shift and mouse button.
Multi-Selection (Standard Mode)
With Multi-Selection, several words for a single field can be captured more comfortably by clicking on each word
with the mouse.
To use Multi-Selection in standard mode, hold down the Shift key while the required text strings are captured.
While you hold down the Shift key, all strings that are captured using Pick-a-Word or Zone and Capture are
highlighted in the image window and added to the selection in the tooltip:
939
To remove an item from the selection that has been added erroneously, just click on it again while holding down the
Shift key.
When you release the Shift key, the selection will be added to the field value:
Note: Before releasing the Shift key, the mouse button must be released. Otherwise the data will not be
entered into the field value.
To switch to the next field just double click an empty area of the document.
Deleting the selection in the tooltip
While the pressing the mouse button or the Shift key, you can delete the selection in the tooltip by pressing Esc. The
tooltip will then again show the field value, so that the field value is not changed when you release the mouse button
or the Shift key.
Capturing data in Multi-Selection mode
Single Click Entry works in Multi-Selection Mode if the option Multi-Selection on demand is not marked. In
this mode captured data will be added to or removed from the field value. In order to replace the field value, MultiSelection must be switched of be pressing the Shift key.
Pick a Word (Multi-Selection Mode)

Zone and Capture (Multi-Selection Mode)
Deleting the selection in the tooltip (Multi-Selection Mode)
940
Pick a Word (Multi-Selection Mode)

To add a string to the field value, just point to it with the mouse. The word becomes highlighted and the
corresponding character recognition result is added to the tooltip:
A single mouse click will now add the word to the field value:
To switch to the next field, capture the last word with a double click or, after having captured the last word with a
single click, just double click on an empty area of the document.
In a similar way you can add several words in a single step. Just position the mouse over the first word. When it
becomes highlighted, you can then draw the mouse over the selected words. The words become highlighted and
appear in the tooltip:
When you release the mouse button, the words will also appear in the field value.
In order to replace the field value, Multi-Selection can temporarily be disabled. Just hold down the Shift key, select
one or more words with the mouse, and then release both the Shift key and the mouse button.
Zone and Capture (Multi-Selection Mode)
Several words or a whole block of text can be added easily by drawing a rectangle around the text using the mouse
while the left mouse button is kept pressed:
941
As soon as the mouse button is released, the captured text is added to the current field. In order to switch to the next
field just double-click into an empty area of the document.
If the captured text needs to be edited, just press the Alt key before releasing the mouse button in order to enter edit
mode.
Sometimes it is difficult to use Zone and Capture because Pick a Word always becomes enabled when the mouse
cursor is positioned over text. In these cases just hold down the left Ctrl key. The mouse cursor changes to cross hairs,
and Pick a Word is disabled until the key is released. You can then draw a rectangle without problems:
In order to replace the field value, Multi-Selection can temporarily be disabled. Just hold down the Shift key, draw a
rectangle with the mouse and release both Shift and mouse button.
Deleting the selection in the tooltip (Multi-Selection Mode)
To delete an erroneously captured item in Multi-Selection Mode is quite easy. Just click on a captured word on the
document and it will be removed from tooltip and field value.
While the mouse button or the Shift key is kept pressed, the selection in the tooltip can be deleted by pressing the Esc
key. The tooltip will again show the field value, so that the field value is not changed when you release the mouse
button.
Typical use of SnapIt functions
When you start capturing data with the mouse you will need some time to get used to the functions of SnapIt. This
section gives some tips that should make it easier to become familiar with the Standard mode of SnapIt.
When working with SnapIt you should concentrate on the image window most of the time.
When you have found a value that is a word or is marked by the Data Type Locator function, move the mouse over
it and when the value is shown in the tooltip, double click with the mouse to capture the value and switch to the next
field.
942
In order to capture several words move the mouse to the first word and mark the requested words by drawing the
mouse over them while the left mouse button is pressed. When the mouse button is released, the marked words are
entered into the field. A double click into an empty area switches to the next field.
In order to capture only a part of a word, just draw a box around the requested characters. When the mouse button
is released, the marked characters will be entered into the field. To switch to the next field just double click into an
empty area of the document. To prevent the Pick a Word function from marking the whole word while drawing the
box, the function can be temporarily disabled by pressing the Ctrl key.
If you point on a word to use Pick a Word, but the value shown in the tooltip is not correct, press F2 to enter edit
mode. Correct the word and press Enter. Then double click into an empty area to switch to the next field.
If you have marked words during Zone and Capture but the words in the tooltip contain errors, release the mouse
button and press F2 to enter edit mode.
In order to capture a table, just capture the cells of the first table row in the same way as normal fields. When the last
cell is captured and the table row is complete, a context menu appears. Clicking on Table Auto-Completion will
capture the rest of the table automatically, clicking on Accept Table switches to the next field.
SnapIt options
The Options command on the Tools menu and in the context menu of the image view contains several options and
parameters controlling SnapIt functions.
If the option Single Click Entry Enabled is not marked, most SnapIt functions are not available. Only zooming and
scrolling with the mouse wheel still work.
If the option Zone And Capture: Reduce box is marked the box drawn around text (Zone and Capture function)
is implicitly clipped so that it just contains the captured text but no white margin. If the option is not marked the box
drawn by the user is not changed.
The option Multi-selection on demand allows to switch Multi-Selection on and off and to change the function of
the Shift key. If the option is not marked Multi-Selection is enabled and can be switched off temporarily by pressing
Shift. If the option is marked Multi-Selection is disabled and can be switched on temporarily by pressing Shift.
The Zoom Factor option specifies the zoom factor of the Zoom-in Pointer.
The option Zoom Factor Additive controls the behavior of the Zoom-in Pointer window, if zooming is used on the
Image window. If the option is marked the zoom factor of the zoom-in pointer adapts to that of the Image window.
Thus the representation in the Zoom-in Pointer window will also enlarge, if the image window is enlarged. If the
option is not marked, the zoom factor of the zoom-in pointer has a fixed value.
The option Zoom-in Pointer: Show crosshairs in mode Show specifies whether cross hairs are shown in the zoomin pointer in mode Show.
The option Tooltip font allows to change font and size of the tooltip text. A click on the button opens a dialog box
that allows to change the respective parameters. The example text in the option line is always displayed with the
current font settings.
If the option Show table name in tooltip is marked, the tooltip title shows table name, row number and column
in the format TableName[RowNumber] -> Column. If the option is not marked, the tooltip title has the format
Column[RowNumber].
Lists of keyboard shortcut keys

Controlling Project window
Keyboard shortcut
Description
Ctrl+F
First document
Ctrl+Shift+F
Last document
Ctrl+P
Next document
943
Keyboard shortcut
Description
Crtl+Shift+P
Previous document
Ctrl+T
First source
Ctrl+Shift+T
Last source
Ctrl+B
Next source
Crtl+Shift+B
Previous source
Ctrl+G
Next field, adjusted to selected filters
Crtl+Shift+G
Previous field, adjusted to selected filters
Crtl+Del
Delete documents
F3
Sets the focus to the current document
Right-arrow
Expands the current document node
Left-arrow
Reduces the current document node
Controlling the Image window

Keyboard shortcut
Description
Keyboard Shortcut
Description
Ctrl+Plus
Zoom in
Ctrl+Minus
Zoom out
Ctrl+3 (num. key)
Scroll image down fast
Ctrl+2 (num. key)
Scroll image down slow
Ctrl+9 (num. key)
Scroll image up fast
Ctrl+8 (num. key)
Scroll image up slow
Ctrl+4 (num. key)
Scroll image horizontal left
Ctrl+6 (num. key)
Scroll image horizontal right
Ctrl+1 (num. key)
Scroll to lower right corner
Ctrl+7 (num. key)
Scroll to upper left corner
Ctrl+Alt+1(num key)
Scroll to bottom left corner
Ctrl+Alt+3(num key
Scroll to bottom right corner
Ctrl+Alt+7(num key)
Scroll to top left corner
Ctrl+Alt+9(num key)
Scroll to top right corner
Ctrl+Alt+W
Fit image to window
Ctrl+Alt+H
Fit image to height
Ctrl+Alt+B
Fit image to width
Ctrl+Alt+C
Center image
Ctrl+Alt+L
Turn image 90 left
Ctrl+Alt+R
Turn image 90 right
944
Keyboard shortcut
Ctrl+Alt+G
Description
Toggle image presentation from gray to binary and
binary to gray.
Controlling index fields

Keyboard shortcut
Description
Tab
Next field. If the next field is a table field, the focus will
be on the first valid table cell taking account of specified
filters.
Enter
Next field taking account of specified filters. If the next

field is a table field, the focus will be on the first valid
table cell taking account of specified filters.
Ctrl+G
Next field taking account of specified filters. Within a

table this shortcut switches to the next field and not to
the next table cell.
Shift+Tab
Previous field. If the previous field is a table field, the

focus will be on the first valid table cell taking account
of specified filters.
Shift+Enter
Previous field taking account of specified filters. If the

previous field is a table field, the focus will be on the
first valid table cell taking account of specified filters.
Shift+Ctrl+G
Previous field taking account of specified filters. Within

a table this shortcut switches to the previous field and not
to the previous table cell.
Pos1
Set cursor to the beginning of the index field
End
Set cursor to the end of the index field
Right-arrow
Set cursor to the end of the index field or to the next

right character in an index field respectively.
Left-arrow
Set cursor to the beginning of the index field or to the

next left character in an index field respectively.
Up-arrow
Set cursor to the same position of the previous line in an

index field (multi-line index fields only).
Down-arrow
Set cursor to the same position of the next line in an

index field (multi-line index fields only).
Controlling table fields

Keyboard shortcut
Description
Enter
Next table cell in vertical order taking account of

specified filters. At the end of the table: next field.
Shift+Enter
Previous table cell in vertical order taking account of

specified filters. At the beginning of the table: previous
field.
Tab
Next table cell in horizontal order taking account of

specified filters. At the end of the table: next field.
945
Keyboard shortcut
Description
Shift+Tab
Previous table cell in horizontal order taking account of

specified filters. At the beginning of the table: previous
field.
Ctrl+G
Leave table and go to next field.
Shift+Ctrl+G
Leave table and go to previous field.
Ctrl+Backspace
Mark whole cell of table field.
Pos1
Go to first table cell in row.
End
Go to last table cell in row.
Ctrl+Pos1
Go to first table cell of table.
Ctrl+End
Go to last table cell of table.
Right-arrow
Go to next right table cell taking account of specified

filters.
Left-arrow
Next left table cell taking account of specified filters.
Down-arrow
Next table cell in column taking account of specified

filters.
Up-arrow
Previous table cell in column taking account of specified

filters.
Ctrl+Tab
Leave table and go to next field.
Ctrl+Shift+Tab
Leave table and go to previous field.
Ctrl+M
Insert table row above.
Ctrl+N
Insert table row below.
Ctrl+D
Delete table row.
Editing
Keyboard shortcut
Description
Ctrl+C
Copy selection to clipboard
Ctrl+X, Shift+Del
Cut selection and move it to clipboard
Ctrl+V, Shift+Insert
Insert contents of clipboard
Ctrl+Z; Esc
Undo last action
Ctrl+Enter
New Line (not in case of table fields)
Del
Delete selection
Ctrl+A
Replace value by next alternative
Crtl+Shift+A
Replace value by previous alternative
Miscellaneous
Keyboard shortcut
Ctrl+O
Description
Open batch
946
Keyboard shortcut
Description
Ctrl+L
Close batch
F2
Set focus to the edit window
F3
Set focus to the project window
F4
Toggle layout Table Mode/Normal and the reverse
Alt+F11
Change to VBA (administration mode only)
Data entry with SnapIt
Capturing Data
Editing
Navigation
Controlling Image View
Capturing data
Keyboard shortcut
Description
Click left mouse button
Capture word (highlighted in orange) selected by the

mouse cursor (Word Picker).
Hold down left mouse button pressed
Capture selected zone (highlighted in orange) while

mouse cursor is in empty region (Zone and Capture)
Ctrl + Hold down left mouse
Capture selected zone (highlighted in orange) (Zone and

Capture)
Enter
Capture selected text and switch to next field
Hold down Shift key
Multi-selection (if option Multi-selection on demand is

marked)
Draw small box in empty area
Clear field
Esc
Delete selection in tooltip
F2
Activate edit mode
Write text
Activate edit mode overwriting current value
Editing
Keyboard shortcut
Description
... + Alt
Edit captured data in tooltip
Enter
Capture edited data
Esc
Cancel edit mode
Navigation
Keyboard shortcut
Double-click left mouse button
Description
Go to next field or table cell
947
Controlling image view

Keyboard shortcut
Description
Mouse wheel
Move image vertically
Shift + mouse wheel
Move image horizontally
Ctrl + mouse wheel
Zooming
Right Ctrl key
Show Zoom-in Pointer
OpenText Livelink/Content Server

Welcome to OpenText Livelink/Content Server
Use the OpenText Livelink/Content Server route and eConnector components to send documents and data into
the OpenText Content Server ECM system, formerly known as OpenText Livelink ECM (henceforth referred to
as Livelink/CS). The integration between Workflow Server and Livelink/CS enables Livelink/CS users to capture
documents from a variety of Capture components into this document management system.
The component supports sending documents into Livelink ECM 9.2, Livelink ECM 9.7.1, and Content Server 10
servers.
Log on to Livelink/CS and identify the folder, category and fields within the component where you want the
document to be stored. Set up your workflow process to capture content from the specified Capture component and
then store the content in the specified OpenText Livelink/CS folder.
The integration between Workflow Server and OpenText Livelink/Content Server takes advantage of Livelink/CS
features, such as multiple category support, workflow initiation, security options, multi-value document and folder
naming support.
Getting started
Feature highlights
This component supports the following features:
Connect to the Livelink/CS server using different connection types.

Use of impersonation.
Versioning support.
Document lock for enhanced security.
Integration with Livelink/CS security options and features.
Assigning attributes to the documents.
Multiple category and folder structure support.
Initiate workflows with documents as attachments.
Using OpenText Livelink/Content Server

This component is mainly used to store any type of content from various sources. This component allows you to meet
your regulatory and archival requirements for records retention with ease. See a sample list of use cases below.
Knowledge ManagementCapture, process, organize, share and store valuable corporate information into the
Livelink/CS document management system.
Direct device connectivityAllow users to archive important documents by pressing just a few buttons on a
scanning device. Use the OpenText Livelink/Content Server component to directly connect various devices such
as digital copiers, desktop scanners, production high-speed scanners, desktop files and other types of files to back
end Livelink/CS.
Batch Import ServerUse this component along with Multi-Poll to create batch import directories, where files
read in from various directories can be imported directly into back-end Livelink/CS.
948
Uniform Capture ProcessUniform Capture Process toolsCreate capture business rules that dictate how your
corporate content is captured into back-end document management system using our process designer tools.
Connect email files to Livelink/CS DMSUse POP3 email or SMTP Capture components to connect email
content and archive all emails within an inbox or all emails sent to an SMTP gateway into Livelink/CS for
archival, management, or sharing.
Configuring OpenText Livelink/Content Server

The component's configuration window contains the following tabs:
Tab
Description
General tab
Use this tab to enter the general attributes that define

connectivity to the Livelink/CS application.
Document tab
Use this tab to set document attributes.
System tab
Use this tab to set up additional system attributes

configured on the Livelink/CS server.
Categories tab
Use this tab to create and remove associations between

the processed document and the categories defined on
the Livelink/CS server.
Workflows tab
Use this tab configure initiating one or several

workflows by the component for documents.
General tab
Use this tab to enter the general attributes that define connectivity to the Livelink/CS application.
Option
Description
Activate

perform any actions during files processing. This option
is only available in the OpenText Livelink/Content
Server eConnector component.
Server
Enter the IP address or the host name of the OpenText

Livelink/CS server.
Database
Enter the name of the Livelink/CS database connection

to be used to connect to the database. If a null string
is specified, the system uses the default database
connection assigned to the dftConnection variable in the
[general] section of the opentext.ini file.
User name
Enter a valid Livelink/CS user name. The processed

documents are associated with this user name.
Password
Port
Enter the port number that you connect to. The port
number value must match the port number that is
configured on the OpenText Livelink/CS server. For a
standard, non-tunneled connection to Livelink/CS, the
port number is the value assigned to the Port variable
in the [general] section of the opentext.ini file. The
port number is usually 2099.
949
Option
Description
Impersonate
If you select this option, you have to supply the user

name to impersonate. Make sure to use an administrator
user name and password for impersonation to work.
Advanced
Click this button to configure advanced connection

settings in the Connection Type dialog box.
Connection Type dialog box

Use this dialog box to configure a connection type.
Direct Connection
By default, this component uses a direct connection, which does not ensure the confidentiality of data passed over the
Internet or any unsecured network. The messages are passed as unencrypted plain text. If someone intercepts the plain
text message, they may be able to view its content.
Non-secure Tunneling
Non-secure tunneling is when LAPI exchanges data with a Livelink/CS server by transmitting unencrypted (plaintext)
Hypertext Transfer Protocol (HTTP) messages through the Web server integrated with a Livelink/CS server.
The server sends data in a HTTP request to the Web server integrated with the Livelink/CS server.
The Livelink/CS CGI process acts as a proxy that forwards the request to the Livelink/CS server (similar to how it
responds to a request made over a socket connection).
The Livelink/CS server processes the server request, generates a response, and returns it to the Livelink/CS CGI.
The Livelink/CS CGI process forwards the Livelink/CS server's response to the Web server, which returns the
response to the server.
Field
Value
HTTP Username
User name.
HTTP Password
Password of the HTTP Username account.
Livelink CGI File
URL to the Livelink/CS CGI integration process.
When this option is selected, the information on the General tab should be changed accordingly:
Option
Description
Server
The name of the machine on which the Web server is

running.
Port
The non-secure port to the Web server. The standard

value for the non-secure port is 80.
Non-secure proxy server tunneling

Non-secure proxy server tunneling is when LAPI exchanges data with a Livelink server by transmitting unencrypted
(plaintext) Hypertext Transfer Protocol (HTTP) messages through a Web Proxy Server, which passes messages to the
Web server integrated with a Livelink/CS server.
The server sends data in a HTTP request to the Web proxy server, much like a Web browser requests data from a
Web server through the Web proxy server.
The Web proxy server forwards the request to the Web server integrated with the Livelink/CS server.
responds to a request made over a socket connection).
The Livelink/CS server processes server's request, generates a response, and returns it to the Livelink/CS CGI.
950
The Livelink/CS CGI process forwards the Livelink/CS server's response to the Web server, which returns the
response to server application through the Web proxy server.
Field
Value
HTTP Username
User name known to the Web server.
HTTP Password
Livelink CGI File
The full URL to the Livelink/CS CGI integration process

in the form: http://host:port/livelink/livelink.exe, where
host is the Livelink/CS host name and port is the Web
server port number.
Option
Description
Server
The name of the machine on which the Web proxy server

is running.
Port
The port to the Web proxy server.
Secure Tunneling
This option requires Livelink Secure Connect. You must separately purchase and install Livelink Secure Connect
before you can implement secure communications. Livelink Secure Connect includes RSA BSAFE cryptographic and
security protocol software from RSA Security, Inc. The data is virtually impossible to decipher if intercepted but is
easily converted to plaintext by the application that is intended to receive the data.
The server sends data in a Secure Hypertext Transfer Protocol (HTTPS) request to the Web server integrated
with the Livelink/CS server. Browsers use the HTTPS protocol to encrypt user page requests and decrypt pages
returned by a Web server.
The Web server negotiates the SSL connection with the server through a SSL handshake and decrypts the
application's request.
responds to a typical Livelink/CS request).
The Livelink/CS server processes server's request, generates a response, and returns it to the Livelink/CS CGI.
The Livelink/CS CGI process forwards the Livelink/CS server's response to the Web server, which encrypts the
response and returns it to the server.
Field
Value
HTTP Username
User name known to the Web server.
HTTP Password
Livelink CGI File
The full URL to the Livelink/CS CGI integration process

in the form: https://host/livelink/livelink.exe, where host
is the Livelink/CS host name.
CA Root Certificates
A secure LAPI client application requires the root

certificate of the Certificate Authority (CA) from the
secure Web server integrated with a Livelink/CS Server
to verify the authenticity of the certificate passed. In
most cases, third-party CAs provide instructions on
how to obtain their root certificates on their Web sites
(for example, www.verisign.com or www.entrust.com).
Optionally, you can export some CA root certificates
from Microsoft Internet Explorer 5.0 and later.
951
Option
Description
Server
The name of the machine on which the Web server is

running.
Port
The secure port to the Web server. The standard value for
the secure port is 443.
Document tab
Use this tab to set document attributes.
Option
Description
Description
Enter a description of the document.
Folder
Enter the OpenText Livelink/CS destination folder. You

can enter the folder manually or click
. This button
opens the Select Destination dialog box that allows you
to select a folder from the list of available folders on the
server.
You can dynamically create folders from here.
Note:
The Livelink/CS server supports the slash mark
(/) in folder names. Use the colon (:) before
the slash mark in order to make the component
interpret this symbol as a part of name rather
than the delimiter between folders. For example,
1. If C is a subfolder of B and B is a subfolder
of A, then enter A/B/C.
2. If C is a subfolder of A/B, then enter A:/B/
C.
3. If B/C is a subfolder of A, then enter A/B:/
C.
Lock File
Select this check box to limit the availability of the

document. When this check box is selected, only the user
who is logged in can gain access to the document in the
future. If this check box is not selected, the document is
available to all users.
Pass-through
The Pass-through option is available in the OpenText

Livelink/Content Server eConnector component. When
this option is selected, the document is passed through to
the next component in the workflow process.
Options in the following group allow you to resolve the situation when a document with the same name already
exists on the server.
Replace
Select this option if you want the newly processed

document to replace the existing document with the same
name.
New Version
Select this option if you want to store the newly

processed document without overwriting the existing
document with the same name.
952
Option
Description
Rename
Select this option if you want to rename the processed

document. Enter the new name of the file. You can use
RRTs in this field to create a unique name at run time.
System tab
Use this tab to set up additional system attributes configured on the Livelink/CS server.
Option
Description
Add
Click this button to add an attribute.
Modify

modify the selected attribute in the Modify an attribute
dialog box.
Remove

remove the selected item from the list.
The system attributes are applied to every document on the Livelink/CS server.
Note: If the values of some required nodes are not set and you want to save the configuration, then the
component displays the following warning message:
Would you like to save, although all required system nodes are not set?
If you click OK, the configuration is saved.
Add/Modify an Attribute dialog box
This dialog box allows you to add/modify a system attribute of the document.
Option
Node
Description
Select the name of the attribute from the drop-down list
or type it manually. This text box can contain RRT from
the previous components.
Value
Enter the value of the attribute or if the button

is
available you can choose the value from a dialog box
opened by this button.
Type
This text box displays the node attribute type.
Required
This text box displays "yes" if the attribute is required,

and "no" if it is not required.
Note: You should not use the vertical bar (|) character in the attribute value, as this symbol is interpreted as
the multi-value (union) operator by the component.
How to create new attributes on OpenText Livelink/CS Server
Follow the steps below to create new attributes on the Livelink/CS server.
1. Click the Administer Additional Node Attributes link in the System Administration section on the Livelink/
CS Administration page.
2. On the Administer Additional Node Attributes page, click the Add a New Attribute link.
3. On the Add New Attribute page, type a unique name for the attribute in the Name field.
4. Select one of the following attribute types from the Type drop-down list:
Text : Field
Text : Popup
Text : Multiline
953
Flag : Checkbox
Date : Field
Date : Popup
Number : Field
Number : Popup
Note:
If there are several attributes with the same display name on the server, you can set a value only for one of
those attributes. Assigning values to other attributes with the same display name is not allowed.
It is mandatory to assign the correct values from the predefined set to the attributes of the Date : Popup
and Number : Popup types for the correct attributes assignment. This is a peculiarity of the OpenText
Livelink/CS system.
When you use system attribute of Flag : Checkbox type, its value is considered as True ('Check box is
turned On') if the value has the form abcd:
aPlus (+), minus (-) or nothing ()

bAny number of 0 (for example, 00000 or null string)
cAny digit from 1 to 9
dAny string of any symbols
For example, values "+0000000745dsfglkdjdbvflk34534@!$!@$gdfgd567", "01" or "-654hello!" are

considered as True. Other values are considered as False.
Categories tab
Use this tab to create and remove associations between the processed document and the categories defined on the
Livelink/CS server.
Every category associated with the document is displayed as a separate tab.
Option
Select
Description
Click this button to select a category that you want to
associate your document with and populate the field
values if appropriate. The button opens the Select
Category dialog box, which allows you to select one of
the available categories.
When you associate a document with a category, a new
tab appears. This tab allows you to add, modify and
remove the attributes for the selected category using
Add, Modify and Remove buttons.
You can associate your document with multiple
categories.
Remove
Click this button to remove the association between a

document and a category.
Add/Modify an Attribute dialog box

This dialog box allows you to add/modify an attribute or a set of attributes associated with the selected category.
Option
Description
Node
Select name of the attribute or the set of attributes from

the drop-down list or type it manually. This field can
contain RRT from the previous components.
Value
Enter the value of the attribute. If you select a set of

node attributes, you cannot set a value to it. In this case,
954
Option
Description
clicking
opens the Set Node dialog box, which
displays the attributes from the selected set.
Type
This box displays the type of the attribute or the set of

attributes.
Required
This box displays "yes" if the attribute or the set of

attributes is required, and "no" if it is not required.
Note: You should not use the symbol vertical bar (|) in the attribute value, as this symbol is interpreted by the
component as the multi-value (union) operator.
Workflows tab
Use this tab configure initiating one or several workflows by the component for documents.
When the component initiates a new workflow for a document, it attaches the document to the work package of the
workflow.
Each workflow that the component initiates is represented as a separate tab on top of the window.
Option
Description
Workflow title
For each workflow, you can enter its title in this field.
Select
Click this button to add a new workflow. The button

opens the Select Workflow Map dialog box containing
the tree with all workflow maps specified on the
Livelink/CS server. Select the desired Workflow
Mapworkflow map and press OK. A new tab with
the name of the workflow map will appear. The tab
represents a new workflow that will be initiated for
documents by instantiating the selected workflow map.
For each workflow map, the component allows initiating
only one workflow per document.
On the new tab, specify the title of the workflow in the
Workflow title field.
Remove
Click this button to remove the currently selected

workflow.
Component RRTs
Component RRT ID
The RRT ID for this component is OTX.
Name
Description
FileName
Counter

955
Name
Description
FileExt
Original file extension.
~OTX::FileName~~OTX::Counter~ is replaced with the value "Document5" if the original file name was
"Document" and there were up to 4 (Document1 to Document4) files already in the destination folder path.
The component supports sending documents into Livelink ECM 9.2, Livelink ECM 9.7.1, and Content Server 10
servers.
You cannot create categories through this component. A category has to be created via the OpenText Livelink/CS
application configuration first.
You cannot create fields through this component. Fields have to be created via the Livelink/CS application
configuration first.
You cannot create workflow maps through this component. Workflow maps should be configured on the Livelink/
CS server first.
If there are several attributes with the same display name on the server, you can set a value for only one of those
attributes. Assigning values to other attributes with the same display name is not allowed.
You should not use the symbol "|" in the attribute value as this symbol is interpreted as the multi-value separator
by the component.
The component does not allow instantiating the same workflow map more than once for one document.
Problem Description
Solution
No categories are available when you are configuring

Categories tab.
Maybe you have not created any categories on the

Livelink/CS server, or your user name and password
are incorrect. Please, make sure that the categories are
configured and check the user name and password.
The configured attributes are not assigned to the

document.
Probably there is an attribute of Date : Popup or

Number : Popup type on the server that has no value
assigned (in particular, such attribute may be added
on the server after the configuration has been started).
Assign one of the predefined values to this attribute.
This is a peculiarity of the OpenText Livelink/CS
system: you have to assign correct values to the
attributes of Date : Popup or Number : Popup types.
Only in this case the document attributes will be
assigned correctly.
If there is an attribute of Date : Popup type on the server

and the value that you assign to it does not belong to the
predefined values set, then the routed document on the
server will have only the preceding attributes with the

system. You have to assign one of the predefined values
to the attribute of Date : Popup type. Only in this case
the document attributes will be assigned correctly.
956
Problem Description
Solution
configured values and Date : Popup attribute with the

<None> value.
If there is an attribute of Number : Popup type on the
server and you assign it the value that does not belong to
the predefined values set, then the sent document on the
server will have this attribute with value <None>.

system. You have to assign one of the predefined values
to the attribute of Number : Popup type.
When you use the Non-secure Tunneling or Non-secure Install Java SE Runtime Environment version 1.3.1 or
proxy server tunneling connection types, the files are
later for the correct work of those connection types.
not sent to the server.
When the Secure Tunneling connection type is used,
the component gives the following error message at
configuration stage or at run time:
Encryption not available with this version. Could not
load LLSSL library.
Secure Tunneling requires Livelink Secure Connect.

Please make sure that you have purchased and installed
Livelink Secure Connect on the Workflow Server
machine.
Outlook MSG Loader

Welcome to Outlook MSG Loader
This component unpacks an Outlook MSG formatted file and extracts all related attributes into RRT values.
Use this component in a workflow process that captures from an Outlook application such as AutoCapture MS Office
Outlook client. Using AutoCapture MS Office Outlook client a user selects one or more email messages within MS
Outlook and selects a workflow for processing the selected messages. The workflow process receives one or more
MSG files. The Outlook MSG Loader loads each MSG file separately and extracts the file attributes.
Getting started
Feature highlights
This component offers the following capabilities:
This component is capable of processing a single workflow job with multiple MSG file attachments (e.g., user
selecting multiple files from Outlook client and using AutoCapture to send multiple messages into a single
workflow. Each MSG file is loaded and processed separately.
Extract all the file attachments within an MSG file into separate files and create separate files for workflow
processing.
Extract the To, From, Subject, CC and the Body fields of the message into RRT variables.
Using the Outlook Message Loader component

Here are some possible use cases of this component:
Automated email archival
Extraction of email file attachments
Setup a workflow process using AutoCapture

component. Define an AutoCapture form for users
to submit email records for archival purposes. Each
Outlook user can then submit email messages into
archival process by simply clicking on the email message
within their MS Outlook Client AutoCapture button. The
process on the server should contain the Outlook MSG
Loader as the first Process Component to load the MSG
file content into memory for workflow processing.
Your firm needs to extract every email attachment and
archive the email and corresponding attachments into
957
a records management application in accordance to

compliance rules that has been setup for your firm.
This process can be done through use of a process
that "crawls" through an Outlook inbox and exports
MSG files for every email within the email box.
The server process can then use the Poll Directory
Capture component and Outlook MSG Loader Process
component to load all the MSG files into the business
workflow designed to handle the compliance rules of
your firm.
Extraction of large volume of email
messages into searchable format
Your organization receives a large volume of TIFF or

PDF images on email and users are requiring you to
have a way to convert these attachments into searchable
format and storing them in a shared folder. This can
easily be done through creation of AutoCapture form
that uses Outlook MSG Loader to load each MSG file
and submits all attachments into OCR for searchable
processing.
Content Based email Workflow
Capture of email messages and apply workflow

processes based on either the messages or message
file content (i.e., To, From, CC, Subject, Body, Date).
Use the RRTs representing the email fields to route the
messages into multiple locations or workflows.
Configuring Outlook MSG Loader

Outlook MSG Loader dialog box
Configure the Outlook MSG Loader component settings in this dialog box.
Option
Description
Activate
Select this check box to enable Outlook MSG loader

component. You can enable or disable this component
for each form used in AutoCapture.
Create new job for each MSG
Select this check box to create a new job for each MSG
file.
Load attachments
Select this option to be process the attachment as part of

the job. Clear this check box to ignore any attachments.
Load body as file
Select this check box to load the email body for

workflow processing depending on email type. The valid
file types are:
Remove MSG after loading
HTML (.html)
Text (.txt)
Select this check box to remove the MSG file after it has
been loaded for workflow processing. If this check box
is not selected, the MSG file will be processed by the
workflow.
958
Outlook MSG Loader component RRTs

Component RRT ID
The RRT ID for this component is MSG.
Name
Description
From
"From" address of the email
To
List of "To" addresses of the email
CC
List of "Cc" addresses of the email
Date
Date of the email
Subject
Subject of the email
Body
Body of the email

There are no FRTNs defined for this component.
Depending on the Internet Browser, some metadata may fail replacing RRTs (From, To, Cc, Date, Subject, Body)
in File Renaming schemas as there may be some hidden characters such as < > " or \.
Microsoft Outlook 2002 or later must be installed for Outlook MSG Loader to work.
PaperPort AutoCapture Client

Welcome to PaperPort AutoCapture Client
PaperPort is a paper management software application from ScanSoft that helps you organize, access, share, and
manage document and image files on your personal computer. Install the PaperPort link for AutoCapture on the user
PC and the PaperPort is displayed as a client for AutoCapture server. The PaperPort client software is configured on
the user machine that communicates with AutoCapture server. Once this configuration is completed, documents and
files that reside in the PaperPort application can be captured into a workflow process.
PaperPort AutoCapture Client extends the capture capabilities of the server to the files that are stored in PaperPort.
AutoCapture includes server software that runs on the server and client software that runs on the user machine. The
PaperPort AutoCapture client communicates with the AutoCapture server to retrieve the menu, form information for
presentation on the user desktop.
When the server and client software are configured, a user can select a documents by dragging the document from
PaperPort desktop and dropping the document onto the AutoCapture program icon on the Send To bar at the bottom
of the PaperPort desktop.
959
This document describes the PaperPort AutoCapture Client configuration. Please refer to the AutoCapture Server help
file for information on how to configure the server.
AutoCapture Client Configuration
Use the AutoCapture Client Configuration dialog box to configure settings for the AutoCapture Client.
Option
Description
Server
Enter the IP address or the host name of the AutoCapture

server.
Port
Enter the port number over which the PaperPort

AutoCapture client communicates with the
AutoCapture server.
Note that this port number should match the port number
configured on the AutoCapture server.
Automatically Convert
This option allows you to convert the document to one of

the supported formats prior to sending it to the workflow
process.
Include icon
Clear this check box to remove a program icon from the

PaperPort Send To bar.
PDF Converter
Welcome to PDF Converter
PDF converter is a filter component that enables batch conversion of files of any format into PDF.
The PDF Converter component installs Print Driver just like any standard printer. Using the PDF Converter
component on the server allows the conversion to be performed centrally without a need to install PDF converter
print driver on each desktop or device. The native or file associated application running on the server that opens the
input file must support the print action. You can then use PDF converter component to receive files from a source
component such as POP3email, Digital Sender, MFP or Multi-Poll and print it into a PDF file format. Any file type,
Raster or Vector files can be converted as long as the corresponding application is installed centrally.
Getting started
Feature highlights
The component generates PDF files with a user defined Compatibility mode. The PDF files generated by this
component can be printed to a physical printer by applications that are capable of viewing standard PDF files.
The component supports activation by a custom condition specified as an expression that is interpreted as a
Boolean value.
Concatenation of multiple files into a single PDF file.
Support for PDF Linearization.
Three image compression algorithms are available: Default, 256 Color, and JPEG compression. Use default
algorithm if the number of colors does not exceed 256.
Font embedding option allows you to define which fonts to embed.
You can decrease document size for archival or transmission purposes by using colors conversion to the gray scale
or downsampling high resolution images.
Support for several paper sizes, resolution, and orientation.
The component allows multi-language support for converting characters that are not in the Western-European and
US character sets; for example, Eastern-European and Far-Eastern characters.
960
You can instruct the component to generate XMP metadata, that is, the PDF document properties like Author,
Creator and so on, in XMP (Extensible Metadata Platform) form.
Automatic conversion to hyperlinks option allows you to print the external references contained in the text of
the generated document in the form of hyperlinks.
Support for document security options such as encryption level, passwords, and permissions.
PDF bookmarks generation settings.
You can simulate PostScript language to improve compatibility with some applications, like Office XP.
Support for watermarks on the pages of the generated document.
Using PDF Converter

The following provides examples of common usage scenarios:
An enterprise where CAD documents need to be viewed by all users. Using this component within the server
removes the necessity of having the CAD application installed on each and every desktop just to view the CAD
files. Instead, with the CAD application installed centrally, the conversion of the CAD file occurs on the server.
Each user may then view the converted PDF file via a PDF Reader application.
Whenever there is a need to send documents to an external organization and the external entity may not be running
the application associated with the documents. Conversion of documents to PDF will remove environment specific
requirements as PDF Readers may be obtained freely.
Receive Fax from fax-server, convert to PDF files, and store for archival purposes.
Read files from a directory in batch-mode and convert into PDF files.
A company requiring all project data to be converted and maintained into an archived database, can design a
process with an email capture component and PDF Converter. The process will read emails with attachments from
an email account and convert them into PDF and store into a directory. In this situation, employees are able to
archive documents, simply by sending email with attachment to the designated email account.
The MFP devices can be configured with an archive button, so that by pressing this button, images are scanned
in, and sent to PDF Converter component for conversion. The PDF formatted files are archived into a designated
directory.
Configuring PDF Converter

General tab
Use the options in this tab to activate PDF Converter and set the general attributes of the component.
Option
Description
Activate
Activate the component. You can use a condition in this

field.
Remove original documents after PDF conversion
Selecting this check box will remove the original

documents from the process after conversion takes place.
When this check box is selected:
Concatenate the generated PDF documents
If the process is successful, the original document

will be removed.
If the process fails to convert to PDF, the original
documents will follow the "on failure" file options
that have been defined.
A job may consist of several files. Select this option to

concatenate the converted files into one PDF file. For
example if 5 JPEG files are scanned in from an MFP
device, this option will generate a single PDF file for all
5 images. This option will only concatenate the PDF files
that are generated through the PDF converter, input PDF
files will be skipped.
961
Option
Description
Fail job if PDF conversion is unsuccessful
Select this check-box to reject a job when the component

input file. If this check-box is not selected the component
will skip the failed file and continue the job.
All failed jobs are marked as rejected and are processed
according to On failure job process settings.
Paper size
Enter the default paper size for new documents. All

standard paper sizes supported by Windows are also
supported by the PDF Converter. You can use available
RRTs in this field.
The default value for the paper size depends on the

Windows settings and corresponds to the localespecific standard paper size.
If the standard paper size is selected, the Width and
the Length fields are disabled and display physical
paper dimensions in millimeters.
If you select Custom paper size option, the Width
and the Length fields become enabled.
Note: Some applications, for example, MS
Word, sometimes ignore the specified page
size settings and set another page format. It is
recommended to verify that the generated PDF
files have the correct format.
Width
Enter the width of the paper that you want to use for your
documents, in millimeters. This field is enabled only
when Custom is selected in the Paper size box or this
box contains an RRT. The minimum allowed value is
0.1mm.
Note: The maximum allowed value is 5000.0
mm due to the printer driver restriction. If
you enter a value greater than 5000.0 mm, the
generated PDF file will lose the content.
You can use RRTs in this field.
If a standard paper size is selected, this field is disabled
and displays physical paper width in millimeters.
Length
Enter the length of the paper that you want to use for
your documents, in millimeters. This field is enabled
only when Custom is selected in the Paper size box or if
this box contains an RRT. The minimum allowed value is
0.1mm.
Note: The maximum allowed value is 5000.0
mm, due to the printer driver restriction. If
you enter a value greater than 5000.0 mm, the
generated PDF file will lose its content.
You can use one or several available RRTs in this field.
962
Option
Description
If a standard paper size is selected, this field is disabled
and displays physical paper length in millimeters.
Resolution
Enter the resolution that the virtual printer will use for
printing, in DPI. You can enter the value manually or
select one from the drop-down list. The resolution value
is important mainly for raster images. Text appearance
can also be improved by increasing this value.
You can use available RRTs in this field.
Note: This field is important when you select
the Downsample high resolution images
option on Advanced tab. In this case the images
with resolution higher than specified in this field
will be downsampled to the specified resolution.
Orientation
You can set the orientation of the output to Portrait or

Landscape.
Note: When creating a PDF document from
TIFF or JPG images, some print application
(for example, MS Print Pictures, MS Paint,
IrfanView) ignore orientation and paper size
settings specified in the component and use their
own default settings. The solution is to allow the
service to interact with the desktop.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.
963
Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
964
unary_operation ::+
!
string_constant

965
Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
1Boolean
2, 3Any
966
Symbol
Description
Result type
Operands type
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Structure tab
Use this tab to control internal structure of the generated documents.
These controls do not affect the contents and layout of the document pages.
Option
Description
Set all PDF/A compatibility options
Select this check box to generate a PDF/A compatible

document.
Selecting this option enables the following options:
Font embedding
Embed standard fonts
Embed licensed fonts
Generate XMP metadata
Selecting this option disables the following options:
Multi-language support
No PDF/A compatibility
Automatic conversion to hyperlinks
Security settings
Note: Manual setting of the combination of
the options described above is equivalent to
selecting the Set all PDF/A compatibility
options check box.
The compliance with the PDF/A specification
cannot be guaranteed.
Compatibility mode
This group of options allows you to set the particular

PDF/A compatibility mode for the generated document.
Acrobat 8 CompatibleChoose this option to

produce PDF/A compatible document.
Acrobat 7 compatibleChoose this option to
produce document compatible with Acrobat 7.
No PDF/A compatibilityChoose this option to
disable the PDF/A compatible output. This option
is disabled when the Set all PDF/A compatibility
options check box is selected.
967
Option
Description
Note: Compliance with the PDF/A
specification cannot be guaranteed when you
choose the Acrobat 7 compatible option.
Multi-language support
For Acrobat 7 compatible, PDF/A

validation cannot be obtained for documents
created by versions of Acrobat earlier than
7.0.7.
The PDF/A validation in the Adobe
Acrobat 7 is based on the draft standard,
which is not compliant with the current
PDF/A specification. The Acrobat 7
compatible option should only be chosen
for compatibility with the validation plug-in
of the Acrobat 7.
When this option is selected, the PDF Converter will

allow converting characters that are not in the WesternEuropean and US character sets; for example, EasternEuropean and Far-Eastern characters. The conversion
in this case is less efficient, and files tend to be larger
in size. Font embedding is recommended in this case to
have some PDF viewers correctly display all the fonts.
This option is turned off and disabled when the Set all
PDF/A compatibility options check box is selected.
Note: When you use this option, you should
select the Font Embedding check box for
correct text representation in the generated PDF
document.
Font embedding
If you select this check box, the print driver will include
all True Type fonts used by the document in the
output PDF file. This results in producing larger files but
ensures consistent look of the document on any platform.
When you select this check box, the Embedding
Options button becomes enabled.
This option is selected and disabled when the Set all
Embedding options
This button is enabled only if the Font Embedding

check box is selected. Click this button to open the Font
Embedding Options dialog box that enables you to
define the fonts to be embedded more accurately.
Generate XMP metadata
When you select this check box, the PDF document

properties such as Author, Creator are generated in XMP
form.
This option is selected and disabled when the Set all
Automatic conversion to hyperlinks
When you select this check box, the external references

contained in the text of the generated document
will be converted to hyperlinks; for example, http://
www.mysite.com/.
968
Option
Description
By default, the list of the prefixes that the PDF
converter should consider as hyperlinks is
"www.;http://;file://;mailto:;https://;ftp://". You can
specify a custom semicolon-separated list of the
prefixes;for example, "ftp://;http://;www.".
Note: If the hyperlink destination is a
bookmark inside the same document, the
integrity of the hyperlink will be lost after the
conversion.
This option is turned off and disabled when the Set all
Web optimization (linearization)
To view a PDF file located on a web server or another

PC on the network, the user needs to download the
whole file to the local PC before being able to open this
file. When you select this check box, the PDF reader can
download and view the document page by page without
the need for downloading the full document. This results
in the PDF document appearing on the users screen in a
nearly simultaneous manner.
Note: The correct work of this option cannot be
guaranteed.
Security settings
Click this button to open the Security Settings dialog

box that allows you to encrypt generated documents and
protect them from illegal use or modification.
This button is disabled when Set all PDF/A
compatibility options check box is selected.
Bookmarks
Click this button to open the Bookmarks Options dialog

box that allows you to control automatic PDF bookmarks
generation.
Font Embedding Options dialog box

Use this dialog box to define the particular fonts to be used in the output PDF file.
Select from the following options:
Option
Description
Partial font embedding
This option is selected by default and instructs the PDF

Converter to embed only portions of the font file that are
actually used in the source-document.
Embed standard fonts
This option can be selected to embed all fonts, including

the standard Windows fonts, such as Arial and Times
New Roman fonts, into the generated document. Note
that this options must be selected in order to ensure PDF/
A compatibility. Disabling this options will also disable
Set all PDF/A compatibility options option on the
Structure tab.
969
Option
Description
Embed licensed fonts
This option can be selected to embed all fonts, including

the fonts that require a license from their manufacturer to
be embedded.
Security Settings dialog box

Use this dialog box to define the security settings for the generated document.
Option
Description
Encryption level
Select security level:
40 bit encryption
128 bit encryption
No encryption
Owner password
Enter the password that will be associated with the

encrypted document. It is the password for the owner of
the document and allows him/her to do any operation on
the document.
Obtain from RRT
Select this check box to specify owner password via

RRT. If this check box is selected, the Owner password
field is changed to the Owner password RRT field
where you can specify the RRT that will be replaced by
the password at run time.
Restricted owner access (user access disabled)
Select this check box to restrict owner access to the

document. When you select this check box, the User
permissions group is displayed as Owner permissions
and allows you to specify the owner permissions. No
user password or user permissions can be specified
in this case since the user access is disabled when the
owner access is restricted. By default, this option is
unchecked and the owner permissions to the document
are unlimited.
User must enter password
If you select this check box, the user will be prompted

for a password when trying to open the document. This
option is enabled only if the Restricted owner access
check box is not selected, because no user access is
available if the owner access is restricted.
User password
This field is enabled only if the User must enter

password option is on. Enter the user password. The
user must enter this password to open the document. If
the user password is empty, it is equivalent to turning
off the User must enter password option. If the user
password is the same as the owner password, it is
equivalent to selecting the Restricted owner access
option.
Obtain from RRT
Select this check box to specify user password via RRT.

If this check box is selected, the User password field
is changed to the User password RRT where you can
specify the RRT that will be replaced by the password at
run time.
970
Option
Description
User permissions/Owner permissions
The following permissions can be configured for the user

\owner access:
Modify document
Print document
Add notes and modify form fields
Copy text and graphics
Bookmarks Options dialog box

Use this dialog box to configure automatic PDF bookmarks generation settings.
The PDF converter looks into the generated file to determine fonts used in the titles of the chapters and generates a
bookmark for each chapter.
Option
Description
Generate bookmarks
Select this check box to activate bookmarks generation.

If this check box is not selected, no bookmarks tree will
be present in the generated documents and other controls
on this dialog will be disabled.
Start from page number
Bookmarks will be created from the page you specify

on. Enter 1 to create bookmarks on all pages of the
document.
Fonts used for bookmarks
This group defines the parameters of the procedure for

determining bookmarks.
Detect title fonts automatically
When this option is selected, the converter will

automatically detect fonts used in the chapter titles of the
converted documents. The fonts are used to determine
the text for bookmarks.
Bookmarks tree depth
Enter the number of bookmark levels.
Use these fonts
Select this option to specify semicolon-separated list

of fonts that will be used for determining bookmarks.
Each list entry should specify font name, size in points,
weight, italic and underline styles, separated with
commas. For example, "Arial,10,400,0,0". When you
select this option, the Bookmark tree depth field is
disabled and the number of bookmark tree levels is equal
to the number of the list entries. The first entry in the
list specifies top level of bookmarks, the second entry
specifies second level, etc. Use the
button to select
fonts from the list of available fonts. This button opens
the Specify Title Fonts List dialog box.
Note:
If the Use these fonts option is selected, but
the font list is empty, the bookmarks will not be
generated.
It you select this option and specify the fonts
list, take into account that the font sizes in the
generated documents are rounded off to the
specified resolution. To avoid rounding, it is
971
Option
Description
recommended to set a multiple of 72 in the
Resolution field in the General tab.
Specify Title Fonts List dialog box

This dialog box allows you to indicate the fonts that should be used for the chapter titles.
Option
Description
Fonts list
This field displays the table of the font entries that

will be used for titles. Each entry contains: level of
bookmarks, font name, font size, font weight, italic style
(1- italic, 0-normal), underlined style (1-underlined, 0normal).
Add
Click this button to add a new font entry "Arial, size 12,
weight 400, not italic, not underlined" to the Fonts list.
Remove
Select one or several entries in the Fonts list and click

this button to remove the selected entries from the list.
Insert
Select an entry in the Fonts list and click this button to

add a font entry "Arial, size 12, weight 400, not italic,
not underlined" before the selected font.
Selected font properties
This group displays the properties of the selected font

entry and allows you to modify these properties. This
group of fields is disabled if the Fonts list contains no
entries.
Font name
Select font from the list of the installed fonts.
Font size
Select font size in points from the list of standard true

type font sizes or enter a custom size.
Font weight
Select font weight from the list of all standard font

weights: Thin (100), Extra light (200), Light (300),
Regular (400), Medium (500), Semibold (600), Bold
(700), Extra bold (800), Heavy (900).
Italic
Select this check box to use the italic style.
Underline
Select this check box to use the underline style.
Note: All the properties changes are applied immediately and reflected in the Fonts list.
Advanced tab
Use this tab to configure compression, color conversion, watermark and other advanced settings of PDF conversion.
Option
Description
Convert colors to gray scale
Select this check box to generate gray-scaled document.

This will reduce the size of the document.
Algorithm
Select one of the three available image compression

algorithms for the generated document:
Default compression - the default image compression

algorithm makes use of color palettes to reduce the
overall size of all images. This algorithm works well
as long as the number of colors does not exceed 256.
972
Option
Description
256-color compression - the 256-color compression

algorithm computes the mostly used 256 colors
in an image and replaces all other color pixels by
their closest match. This compression algorithm
works usually very well with most applications but is
relatively slow on large images with a large number
of colors.
JPEG compression - the JPEG compression
algorithm produces excellent results with real life
true color images with a small distortion of the source
image. It is not recommended for graphics other than
real pictures. When JPEG compression is selected,
the JPEG compression level selection box becomes
enabled. This box is used to select the compression
level.
You can use one or several available RRTs in this field.

JPEG compression level
This field is enabled when you select JPEG compression

in the Algorithm field. JPEG compression levels vary
from 1 to 9. Level 1 produces poor quality images with
a very large compression ratio. Level 9 produces very
good quality images with medium compression ratio.
Downsample high resolution images
If you select this check box, the images with resolution

higher than the value specified in the Resolution field
in the General tab will be downsampled to the specified
here resolution.
Convert RGB colors to CMYK color space
If you select this check box, the RGB colors of the

generated document will be converted to CMYK
color space. For example, RGB {255,255,255} will be
converted to CMYK {0,0,0,0} for White color.
Physical margins (in millimeters)
Most printers have a minimum physical margin below

which they cannot generate any output. Use this group of
fields to specify horizontal and vertical margin values to
prevent users from drawing outside the printable area.
Horizontal
Enter the value for horizontal margins. This field allows

you to enter the values with 0.1mm precision. You can
use one or several available RRTs in this field.
Vertical
Enter the value for vertical margins. This field allows

you to enter the values with 0.1mm precision. You can
use one or several available RRTs in this field.
Simulate PostScript
Select this check box to simulate PostScript language.

This option improves compatibility with some
applications. For example, the option may be useful for
printing Wordarts and semi-transparent backgrounds
using Office XP. Some other applications may conflict
with this option.
Note: Using this option is not recommended
unless the application needs simulating
PostScript. After using this option make sure
973
Option
Description
that the generated documents have acceptable
quality.
Document properties
Click this button to open the Document Properties

dialog box to specify PDF metadata; for example,
Creator, Author, Subject.
Watermarks
This button opens Watermarks Options dialog box.
Document Properties dialog box

Use this dialog box to specify standard PDF metadata to be set in the generated documents.
If the Generate XMP metadata check box is selected on the Structure tab, these values will be generated in the
XMP section of the document. The following fields can be specified:
Title
Subject
Author
Creator
Keywords
You can use one or several available RRTs in each of these fields.
Note: The characters that are not in the Western-European and US character sets; for example, EasternEuropean and Far-Eastern characters should not be used in these fields.
Watermark Options dialog box
Use this dialog to specify the settings for printing watermarks on the pages of the generated document.
Option
Description
Print watermarks
Select this check box to enable watermarks printout. If

this check box is not selected, all the other settings in this
dialog are disabled.
Watermark text
Enter the text which will be printed on the pages of the

generated document as a watermark. You can use one or
several available RRTs in this field.
Note: When you use characters that are not in
the Western-European and US character sets,
for example, Eastern-European and Far-Eastern
characters, in the Watermark text field, you
have to select the Multi-language support
option in the Structure tab for correct text
representation.
Watermark color
Enter watermark text color in the "red, green, blue" form.

Each component of this form is an integer value 0-255.
For example, 255,255,255 for White, 255,0,255 for
Magenta.
Alternatively, color can be specified as single decimal or
hexadecimal number. For example, 16777215 or 0xffffff
for White, 16711935 or 0xff00ff for Magenta. You can
use the
button next to this field to select the
color from the color selection dialog box.
974
Option
Description
Text font
Enter the name of the font for the watermark. You

can use one or several available RRTs in this field. By
default, the Arial font is used for watermarks.
Font size
Enter the size of the font for the watermark. The size
value can be entered with 0.1 precision. You can use one
or several available RRTs in this field.
Horizontal
Enter the horizontal coordinate of the watermark on the

page, in inches. This field can contain RRT or a number
with 0.01 precision. The minimal value is 0.0 inches.
Vertical
Enter the horizontal coordinate of the watermark on the

page, in inches. This field can contain RRT or a number
with 0.01 precision. The minimal value is 0.0 inches.
Orientation
Enter the angle of rotation of the watermark. Zero (0)

means no rotation, that is, horizontal text. This field can
contain RRT or a number with 0.1 degree precision. The
minimum value is 0.0 degrees.
Print on
Specify the pages on which the watermark will be

printed:
Pages list
All pages
Odd pages only
Even pages only
Pages from following list.
This field becomes enabled, if you select "Pages from

following list" in the Print on field. Enter commaseparated list of page numbers or ranges, for example, 1,
2, 10-15.
If you want to set particular pages for watermarks
printout, type here the numbers of particular pages
separated by a comma. For example, 2, 6, 8.
If you want to set a page range for watermarks printout,
type the number of a first page in the range, then insert
"-" or "..", and close the range with the number of the last
page in the range. For example, 31-49 or 31..49.
You can set several page ranges for watermarks printout
using the above syntax. In this case, each page range
should be separated from others by comma. For example,
31-49, 50-64, 67..70.
Separate pages and page ranges can be combined in one
string the same way, with comma as a separator. For
example, 1,2,5-7,10,20..25.
You can set an open range in order to print watermarks
on pages from a particular page and till the end of the
file. To do so, set the opening page number followed by
".." or "-". For example, 7- or 7.. .
You can also set an open range in order to print
watermarks starting from the first page of the job and till
975
Option
Description
the particular page. To do so, set ".." or "-" followed by
the particular page number. For example,-7 or ..7.
Print watermarks over the page contents
If you select this check box, the watermarks will be

printed over page contents. By default this check box
is not selected and watermarks are printed at the page
background, behind the page contents.
Applications tab
Use this tab to determine the settings for advanced control of the printing applications.
Conversion timeouts
This group allows you to specify how fast the printing application should respond to the print request and what
the component will do if the application does not respond during the timeout. The timeouts should be specified in
seconds.
Option
Description
First page timeout
Enter a reasonable timeout value between the moment of

sending a document to printing application and the actual
time when the first document page starts to be printed. If
an error occurs in the native application during starting,
document loading or preparing for printing, the process
will hang until the timeout expires. The default value is
set to 60 seconds. You can use one or several available
RRTs in this field.
Next page timeout
Enter a reasonable timeout value between the end of

printing of the previous page and the end of printing of
the next page. If an error occurs in the native application
during preparing and printing any single page of the
document, the process will hang until the timeout
expires. This timeout is also used to wait until printing
of the last page is completed and the document is closed.
The default value is set to 20 seconds . You can use one
or several available RRTs in this field.
Complete timeout
Enter a reasonable timeout value for the complete PDF

conversion process. If an error occurs in the native
application during PDF conversion, the process will hang
until the timeout expires. The timeout value depends
on the complexity (such as size, and type) of your files.
The default value is set to -1. You can use one or several
available RRTs in this field.
Note: In timeout fields, if the specified value
is -1, that means infinite timeout, that is,
application should wait infinitely for the event.
Value 0 means that the application will not wait
at all.
Close topmost window after timeout
If this check box is selected, the component will close

the topmost window on the screen after any of the
timeouts has expired and terminate the process that
opened the window.
976
Option
Description
Note: When you use this option, the component
will terminate the process of the topmost
(foreground) window displayed on the desktop,
even if this window does not belong to the
printing application. This option is used for the
compatibility with the previous version of the
component and it is not recommended to use
this option in the new version of the component.
Close application window after timeout

all the windows that belong to the printing application
process after any of the timeouts has expired.
Terminate application process
If this check box is selected, the component should

terminate the printing application process after any of the
timeouts has expired.
If both the Terminate application process and the Close application window after timeout options are selected,
then the component will attempt to close the application windows first and then to terminate the process.
Note: Sometimes the component does not have information about the printing application. For example,
it can happen when an instance of the printing application is already running. In this case the component
cannot handle the Close application window after timeout and the Terminate application process options
correctly. To avoid this problem do not launch any applications under the component service account, at least
those of them which are used by the PDF Converter.
Application dialogs
This group allows you to specify how the component should handle the printing applications which interact with the
user when printing documents. According to these settings, the component will close the dialogs which are issued by
the printing application or the other dialogs that can block printing.
Option
Description
Press OK button automatically
If this check box is selected, the component will send

the Enter key to the dialog-like windows that have a
default button different from a Cancel button. Most of
the standard message boxes are regular dialogs with
the default OK button, therefore when this options is
selected, the OK button on such dialogs will be pressed
automatically.
Note: Some message boxes are not regular
dialog windows; for example, Convert
File dialog box of the Microsoft Word. The
component will fail to determine the default
button and will not close this dialog box.
For those dialog boxes use the title-based
search using the Send 'Enter' to dialogs with
following titles option.
Send 'Enter' to dialogs with following titles
This field displays the list of the titles of dialog boxes

that the component should close with the Enter key.
Add
Click this button to add a new dialog box to the list in the
opened Add Dialog Title window.
977
Option
Description
Edit
Click this button to edit the selected dialog box in the

opened Edit Dialog Title window.
Remove
Select one or several dialog boxes in the list and click

this button to remove them from the list.
Close topmost dialogs
If this check box is selected, the component will send the

Enter key to the desktop and close the topmost dialog
box. Any window with the dialog frame is considered as
a dialog box. This check box is not selected by default.
Close applications dialogs only

the dialogs that are opened by the printing application
process. This check box is selected by default.
Note: Sometimes the component does not
have information about the printing application.
For example, it can be when an instance of the
printing application is already running. In this
case the component cannot handle the Close
application dialogs option correctly. To avoid
this problem, do not launch any applications
under the workflow service account, at least
those of them which are used by the PDF
Converter.
Close visible dialogs only

only the dialogs that are visible for the desktop where the
component service is running.
Note: It is recommended to clear the Close
visible dialogs only check box when working
on Windows Vista or Windows 2008 server.
Add/Edit Dialog Title dialog box

Use this dialog box to add/edit a title of the dialog boxes in the list.
Option
Description
Dialog title
Enter the title of the dialog box in the Send 'Enter' to

dialogs with following titles list in the Application tab.
Component RRT
Component RRT ID
The RRT ID for this component is PCF.
RRTN
Description
FileName
FileExt
978
RRTN
Description
PagesCount
Number of pages in the converted document. This RRT

is available only for the subsequent components in a
process.
Example of usage of the RRTN:

~PCF::FileName~~PCF::FileExt~ is replaced with the "Mydocument.doc" if the original file was
Mydocument.doc.
Sufficient disk space must be provided to store the converted files.

If you select Custom Paper size option and process TIFF documents with a different Custom Paper Size width
and length, the output PDF documents will not take the custom setting. This is due to a security issue with
Windows 2000 service pack 4. In order to get Paper Size customized, the user has to start the service with a local
administrator account.
Native or file associated application that is used for printing should be installed. As part of the server installation,
the print driver should be installed on the server.
It is not recommended to use the files associated with the application which brings up a GUI that requires user
input, when running PDF Converter. GUI which requires user input can lock the service until the specified time
out period has expired and can cause the PDF conversion to fail.
A recommended practice is to run the PDF converter in test mode in foreground for a while. This can be done
from the command prompt by running the server from the installed directory using the command "batch -e cc:\MyProcess.cfg", where "c:\MyProcess.cfg" is the location of the process definition file. Running the server
will display any GUI or error messages that the native or file associated application might display during PDF
conversion.
The native or file associated application must support the Print action. The Print action allows the native
application to print the contents of the file and exit, displaying as little as necessary to complete the task.
The maximum paper width and paper length value that allows correct work of the PDF converter is 5000.0 mm
according to the printer driver restriction.
The correct work of the Web optimization (linearization) option cannot be guaranteed.
PDF/A validation of generated PDF documents may fail due to incomplete compliance with the formal document
structure requirements.
When you use the Acrobat 7 compatible option, the PDF/A validation cannot be obtained with the Adobe
Acrobat versions earlier than 7.0.7.
The PDF/A validation in the Adobe Acrobat 7 is based on the draft standard and is not compliant with the current
PDF/A specification. The Acrobat 7 compatible option presents only for the compatibility with the validation
plug-in of the Acrobat 7.
Some applications, for example, MS Word, sometimes ignore the specified page size settings and set page size
accordingly to internal application or document settings. Therefore it is recommended to verify that the generated
PDF files have the correct page size.
When you use characters that are not in the Western-European and US character sets, for example, EasternEuropean and Far-Eastern characters, in the document text or in the Watermark text field, you have to select the
Multilanguage support option for correct text representation.
When you use the Multilanguage support option, you should select the Font Embedding check box for correct
text representation in the generated PDF document.
979
The characters that are not in the Western-European and US character sets, for example, Eastern-European and
Far-Eastern characters should not be used in the fields of the Document Properties dialog box.
When you use the PDF Converter to convert files of some types, the protection software, for example, antivirus
program, may block AutoStore batch.exe process that tries to interfere in the printing application. This behavior
is caused by the PDF Converter that tries to control the printing process. Set the protection software to allow such
behavior, since it does not represent any danger.
When you select the Web optimization (linearization) option, files of some formats, for example, MS
Word 2003, MS Excel 2003, TIFF, may fail to be converted to PDF using some applications. Therefore, it is
recommended not to use this option.
When you use MS Word 2007 for printing the documents that contain bulleted lists, the documents may be
converted into PDF incorrectly. However, the documents with numbered lists are converted correctly.
If the input document contains bulleted list, it may fail to be validated as PDF/A compatible with Adobe Acrobat
8. However, if the input document contains numbered list instead of bullets, the generated document is validated
as PDF/A compatible.
It is recommended to clear the Close visible dialogs only check box, when working on Windows Vista or
Windows 2008 server.
It is not recommended to start the service under the LocalSystem account when you work with Microsoft Office
documents (for example, Word, Excel). Please start service under the account which was used for configuring
Microsoft Office.
How to check print pction

Follow the steps to check the print action for a file type.
1.
2.
3.
4.
Open Windows Explorer.

Click on Tools > Folder Options.
Click on the File Types tab.
Select a file type and click the Advanced button.
5. Make sure Print is listed as one of the supported Actions.
980
Problem Description
Solution
The following error message appears in the Status

Monitor:
This may happen when the printing application tries to

interact with the user and the user doesn't respond or
"First page timeout (60) expired. Failed to convert file to printing takes so much time that the timeout expires.
PDF"
1. Configure the printing application properly. Set
options that respond to the printing application.
2. If printing of some documents requires more time
than what is specified in the timeout options, try to
increase the conversion timeouts.
Service hangs or appears to stop running after the first
job, and images stack in the work folder. The Status
Monitor shows the following message:
The service cannot detect the correct program

responsible for handling the print operation for the
specified file in the work folder.
"Error: native application could not be found. Failed to

convert file to PDF"
To fix this problem you need to make sure you have at

least one program managing the file-printing operation
for that file type. You can simply check this by right
clicking on one of the file types and check if the default
action for "PRINT exists. Change the settings under
your Windows Explorer > Tools > Folder options> File
types.
Status Monitor shows one of the following warning

messages:
"PDF Converter: Bookmarks depth (value) is invalid
and have been set to 1",
These messages mean that you have entered a nonnumeric value in the Start from page number field
or in the Bookmarks tree depth field. In this case the
component automatically changes the entered value to 1.
"PDF Converter: Bookmarks start page (value) is

invalid and have been set to 1",
wherevalue is some non-numeric value.
Bookmarks are not generated for the specified fonts.
Please make sure that generated PDF contains fonts

of exactly same sizes. Since font sizes in the output
document are aligned to the specified resolution it is
recommended to set resolution to a multiple of 72 (144,
288, etc). Also, please make sure that the page size of the
981
Problem Description
Solution
output document is the same as you've specified. Some
applications (like MS Word) may scale document's fonts
in some combinations of document's layout and paper
size. In this case you should set page size to be equal
to the document's page size and do not print additional
document elements (like comments and changes). Also,
for correct generation of bookmarks, it is recommended
to turn OFF the Font embedding option.
PDF/A validation of the generated PDF document fails

and the Preflight profile contains the following error
message:
To avoid this problem, use empty fields of the

Document Properties and do not use bookmarks.
"%Property% mismatch between DocumentInfo and

XMP metadata"
, where %Property% is one of the Document Property
field names, for example, Author.
PDF/A validation of the generated PDF document fails
and the Preflight profile contains the following error
message:
To avoid this problem, do not select the Multilanguage

support option.
"Type 2CID font: CIDToGIDMap invalid or missing".

The generated PDF document is not validated as PDF/A
compatible.
1. If you use the Adobe Acrobat 7 Preflight for

validation, select the Acrobat 7 compatible option.
2. If you use some other tool for validation, for
example, Adobe Acrobat 8 Preflight, select the
Acrobat 8 compatible option.
HTML and HTM files always fail during conversion.
The Default configuration for the PRINT operation

on any Microsoft system with Internet Explorer is the
following:
"C:\Program Files\Microsoft Office
\Office10\msohtmed.exe" /p %1
located at Folder Options> File Types > HTM from
Windows Explorer. You need to have an application
managing such operations like MS Word for example.
Another workaround is to use the VBscript to modify
the HTM file to be Word-friendly and print through MS
Word. Refer to knowledge base for script information.
Local RRTs cannot be drag-and-droped into some

controls of the component's GUI.
Try entering the desired RRTs manually.
The orientation and paper size settings are ignored when

printing TIFF or JPG images.
When creating a PDF document from TIFF or JPG

images, some print application (for example, MS Print
Pictures, MS Paint, IrfanView) ignore orientation and
paper size settings specified in the component and use
their own default settings. The solution is to allow the
service to interact with the desktop and set these settings
manually in a print pop-up window.
982
POP3 Email
Welcome to the POP3 Email component
POP3 Email is a Capture (source) component used to retrieve Email messages from a mail server that supports POP3
protocol. This component retrieves and processes the Email messages including any attachments from the designated
mailbox one at a time. The content of each email message including any attachments will be retrieved and processed
as a single job. Upon completion of the processing by this component, the email message will be removed from the
designated mailbox.
POP3 stands for Post Office Protocol, Version 3. POP3 is a mail protocol that's used only to retrieve mail (from a
POP3 enabled mail server), not to send mail. This component uses the POP3 protocol over TCP to query a POP3
enabled mail server for new mail messages.
In order to use this component, a "POP3 account name" and its associated password for a specific mail server must be
supplied. POP3 account name is a unique name of an electronic mailbox. This information must be unique so only the
intended owner of a mailbox can gain access to it.
Getting started
Feature highlights
Capture email messages including attachments from a designated mailbox on a mail server that supports the POP3
protocol.
Optionally save email messages as HTML or text files.
Using the POP3 Email component

The following provides examples of common usage scenarios:
Scan documents using a local scanner and email the scanned documents in to a designated POP3 Email mailbox
for processing.
Forward incoming faxes in to a designated mailbox for processing.
A company requires all project data to be converted to PDF and maintained into an archived database, can setup
a process with POP3 Email as the source component, PDF Converter as a filter component, followed by the
Folder Store as destination component. In this scenario, POP3 Email inbox reads the email and converts the email
and attachments to PDF format and stores it in to a directory. In this situation, employees are able to archive
documents, simply by sending email with attachment into the designated POP3 Email account and the process
automatically reads the POP3 Email and converts the attachment to PDF for storage into the archival system.
Configuring the POP3 Email component

General tab
Configure options to required to communicate with the email server.
Option
Description
Server
Enter the name or IP address of the mail server where the

email message will be retrieved. This mail server should
support the POP3 protocol.
User Name

to the mail server. POP3 account user name is a unique
name of an electronic mailbox. This information must be
unique so only the intended owner of a mailbox can gain
access to it. The POP3 account name is very often the
first part of an email address. For example, if an email
983
Option
Description
address is suzyq@xyz.com, the POP3 account name is
probably "suzyq".
Password
connect to the mail server.
Port Number
The port number that will be used by the POP3 email

component to establish a TCP connection to the mail
server.
The default port for a an unencrypted POP3 connection
is 110. The default port for an encrypted connection
using SSL is 995.
Select this check box if the server requires an encrypted

Secure Sockets Layer (SSL) connection.
Save message body as a file
Select this check box to save the email as a text or html

file.
Selecting this option does not have any effect on the
existing email file attachments. A new file be created
that contains only the email header and body content.
Keep raw message content.
Select this check box to keep the unprocessed message

content.
Click the browse button (...) to specify the folder where
you want to locate unprocessed message content.
Component Setting tab

Use this tab to activate and configure processing and routing components in the workflow.
Click on this tab to view a list of all of the processing and routing components that are in the workflow. To activate or
configure a component, click to select its entry, and then click the Configure button to open the component settings
dialog box. For additional information about a component's settings, click the Help button in the component settings
dialog box.
POP3 Email component RRTs
Component RRT ID
The RRT ID for this component is POP.
The following table describes the reserved RTN names for this component. These Runtime Replacement Tags (RRTs)
may be used in any of the components following the POP3 Email component.
Name
Description
From
The From field value for a POP3 email message.
From
From
To
The To field value for a POP3 email message.
CC
The CC field value for a POP3 email message.
984
Name
Description
Subject
The Subject field value for a POP3 email message.
Date
The Date field value for a POP3 email message.
Body
The Body field value for a POP3 email message.
For example if there is a SharePoint Process component defined in the process where POP3 Email is the Capture
component, you can define the SharePoint Process (filter) "Subject" field as ~POP::Subject~.
Problem Description
Status monitor indicates the component is unable to
connect to the POP3 Email server.
Solution
Verify that the POP3 protocol is enabled on the mail

server.
Verify that POP3 support is not disabled for the user's
mailbox.
Verify that the client can ping the server using the
mail server's Internet protocol (IP) address and the
mail server's computer name
Try using an email client such as Microsoft Outlook
Express to connect to users mailbox.
Use a telnet tool to verify connection to the POP3
mail server. For more information, see How to Verify
the Connection to a POP3 Mail Server.
How to verify the connection to a POP3 mail server

You can use a Telnet tool, such as HyperTerminal, to verify the connection to a POP3 mail server.
1. Open a Telnet tool such as HyperTerminal.
2. For the host name, type the name of the Mail Server computer, and for the port, type 110.
If a "term type" is requested, do not type anything.
For example, type telnet server 110, and then press Enter. A message similar to the following should be
displayed:
+ OK Microsoft Exchange 2000 POP3 server version 6.0.6249.0 ready.
3. Enable local echoing and sending end-of-lines for the current Telnet session.
4. Type user domain\username\mailbox and then press Enter.
The domain is the name of the domain in which the user account is located, user name is the user name for the
mail account, and mailbox is the mailbox for the account.
Note: The mailbox portion of the above command is only necessary if it is different from the user name.
After you press Enter, the following should be displayed.
+OK
985
5. Type pass password , where password is the password for the email account, and then press Enter.
After you press Enter, the following message should be displayed:
+OK User successfully logged on
6. To determine if the mailbox has new messages, type stat and then press Enter.
After you press Enter, the following message should be displayed:
+OK xyyyy
where x is the number of new messages and yyyy is the total size of the messages in bytes. This is known as a drop
listing.
7. To end the Telnet session, type quit, and then press Enter.
A message similar to the following should be displayed:
+ OK Microsoft Exchange 2000 POP3 server version 6.0.6249.0 signing off.
Messages are not accessible from another email client once they are downloaded to the local hard disk.
Professional Image Management

Welcome to the Professional Image Management component
Professional Image Management component is a filter component that is primarily used to enhance the quality and
appearance of B/W images.
This component enhances the quality of the scanned or faxed document, by performing operations that remove
imperfections. You can also use the options in this component to split the image in to several documents based on a
pre-defined set of criteria.
Professional Image Management uses Lead Tools Technology for image processing options.
Getting started
Feature highlights
Despeckle option removes specks from black and white images, such as FAX transmissions or scanned
documents.
Deskew option automatically straighten scanned images.
Smooth Text option smooths out the bumps and fills in the nicks of a black and white image.
Dot Removal option is used to find and remove dots and specks of various sizes. It is similar to the despeckle
option but allows more control as to which dots to remove. Certain images might have larger dots that would not
be removed by the despeckle option.
Remove hole punches option removes hole punch marks from a black and white image, that is most likely is the
result of a scanned document. This will remove hole punches that may be located at either top, bottom, left or
right side of the image.
Line Removal option is used to remove horizontal and/or vertical lines in a black and white image.
Border Removal option is used to remove black borders from black and white images, which are often the result
of scanned documents where the paper document is smaller than the resulting scanned image.
Remove Empty Pages option is used to remove pages that do not have any text or images. Note that empty does
not mean a white page; a completely black page (or any other color) will be considered empty as well.
Split the original file into multiple files.
986
Using the Image Management component

Use this component to enhance the quality of a scanned or faxed image.
Configuring the Professional Image Management component
Image Processing tab
Use the options in this tab to process the image.
Option
Description
Activating
Check this option to activate the image management

configuration.
Deskew
Click the ellipsis button to make skewed scanned or

faxed images straight.
Fast Deskew: Select this check box to rotate the image
clockwise or counter clockwise.
Threshold AngleIf the original image is skewed

by an amount that is between minimum and
maximum then the image is rotated. However if the
original image skew angle does not fall between the
minimum and maximum range, the image is not
rotated at all.
Document TypeDifferent rotation algorithm is
applied depending on whether the image is text only
or text and picture.
Fill Areas Exposed after RotationSelect this
check box to fill the exposed areas of the rotated
image with black after the deskew operation.
Precision Deskew: Clear the Fast Deskew check box for

more advanced deskew options.
Threshold AngleIf the original image is skewed

by an amount that is between minimum and
maximum then the image is rotated. However if the
original image skew angle does not fall between the
minimum and maximum range, the image is not
rotated at all.
Deskew AngleRotate the image if the original
image is skewed up to this maximum angle. The
maximum rotation is limited to 45 degrees in either
direction.
PrecisionThis parameter lets you control the
granularity precision by which the deskew operation
is performed. To improve the quality of deskew
operation, set this parameter to a smaller value. The
precision cannot be more than the Deskew Angle.
Interpolation When RotatingInterpolation is an
imaging method to increase or decrease the number
of pixels in a digital image. How smoothly images
appear without introducing jaggies depends on the
sophistication of the interpolation algorithm. You can
chose bilinear, bicubic, or no interpolation algorithm
when rotating the image.
987
Option
Description
Document TypeDifferent rotation algorithm is

applied depending on whether the image is text only
or text and picture.
Fill Areas Exposed after RotationSelect this
check box to fill the exposed areas of rotated image
with black after the deskew operation.
Despeckle
Check this option to remove undesired dots and speckles

from black and white images, such as FAX transmissions
or scanned documents.
Smooth text
Check this option to smooth and fill in patchy black and

white images.
Trim Edges
Check this option to trim blank space from the edges of

scanned documents. Select the ellipses button to set the
threshold for the Trim edges Options.
Remove dots
Check this option to remove dots and speckles of various

sizes. This is similar to the Despeckle option, although
it allows more control as to which dots to remove.
Certain images might have larger dots that would not be
removed by the despeckle option.
Note that there is possibility of removing certain portions
of an image if the Maximum dot height and width are set
too high.
Remove hole punches
Use this option to remove hole punch marks from a

black and white image. The hole punches can be located
at either top, bottom, left or right of the image. You
can tune the maximum hole punch width and height as
required.
The default hole punch location is set to left side of the
image.
Remove lines
Use this option to remove unwanted horizontal and/or

vertical lines in a black and white image by specifying
the line attributes. The max line width can be configured
to be between 0 and 0.1 inche.
Remove borders
Use this option to remove black borders from black

and white images. This occurs often when the scanned
documents is smaller than the resulting scanned image.
Set the parameters for the border removal:
White Noise specifies the amount of white noise

tolerated when determining the border.
Variance specifies the mount of variance tolerated in
the border. The value should be higher the more the
border varies in thickness.
988
Option
Description
Remove empty pages
Border Area specifies the percentage of the page

from each edge that is designated as the search area
for borders to remove.
Check this option to remove pages that do not have any

text or images.
Empty does not necessarily mean a completely white
page, a completely black page (or any other color). This
option can be used in multi-page TIFF files and does not
apply to any other supported formats of this component.
Remove first pages
Select this option to remove the first page from the

image. Note that this option takes precedence over other
options.
Auto binarization
Converts the image into a binary format. The supported

file types for the image are PDF and TIFF.
PDF Load Options
Use the same horizontal and verticalSelect this

check box to use only one value for both horizontal
and vertical resolutions.
Horizontal resolution (DPI) and Vertical resolution
(DPI)These combo boxes allow you to set up
horizontal and vertical resolution of opened files in
DPI. You can enter the value manually or select one
of the predefined values: 72, 96, 150, 200, 300, or
600. The default value is 200 DPI for both vertical
and horizontal resolutions.
Color depth (BPP)Set up color depth of PDF
documents manually or select one of the predefined
values: 1, 4, 8, or 24. For example, 24 BPP (bits
per pixel) denotes true color images, 1 BPP denotes
black-and-white images. The default value is 24 BPP.
Text anti-aliasing (bits)Enter the level of text
anti-aliasing manually or select one of the predefined
values: 1 (means no anti-aliasing), 2, or 4 (gives
maximum anti-aliasing). The default value is 4 bit.
Graphic anti-aliasing (bits)Enter the level of
graphics anti-aliasing manually or select one of the
predefined values: 1 (means no anti-aliasing), 2, or 4
(gives maximum anti-aliasing). The default value is 1
bit.
Split tab
This tab provides several options for splitting an image. Specify the desired type of splitting from the list below:
None
No split is applied to the image.
Split into specified pages
The user can specify the number of pages the document

is split into. For example, If the user is scanning batches
of 3 pages invoices, the process could receive one big
file containing several invoices. The user can choose to
989
split every 3 pages, having as a result a single file for

each invoice.
Split on pages
The user can provide specific page numbers where

the document should be split, you can instruct the
component to split the document on a particular page
or on several pages in a comma separated list. If one
of the page numbers that the document should split
on, does not exist, the component will just ignore it. If
for example the configured process will be receiving
scanned documents that are always formatted in a
specific way, and the first 2 pages contain information
that the user wants to store in a separated document,
then by choosing this option and setting the associated
parameter to "2", the result will be 2 files, one containing
the first 2 pages and other containing the remaining
pages.
Split on empty page
The split option is used for splitting multi-page tiff files,

it does not apply to any of the other supported formats by
the different options of this component.
Professional Image Management component RRTs

Component RRT
The RRT ID for this component is PIM
Name
Description
RemovedPageList
Comma-separated list of removed pages.
PageCount
Number of pages in the document.
SplitNumber
Index to the document created as a result of split.
The following example provides a sample usage for your reference:

The RRT string ~PIM::RemovedPageList~ is replaced with comma-separated list of the removed pages.
These RRTNs are normally used in scripts. For example, based on the value that ~PIM::SplitNumber~ returns,
the scripts applies a watermark to your document.
This document does not have any SSRTNs.
Problem Description
Solution
When using the Line Removal option, some lines are not This is caused when there are lines in the image that
removed.
are wider than the maximum width specified in the
990
Problem Description
Solution
configuration. Increase the maximum specified width
from the component configuration GUI.

The following options can only be used in black and white images (1 bit formats):
Smooth text, line removal, hole punches removal, dot removal and border removal.
The supported formats for the Image Component are:
JPEG Formats
JPEG File Interchange Format

Tagged Image File with JPEG compression
JPEG 2000 Format. This file format contains image
data and extra information about the contents and
organization of the file.
GIF Formats
CompuServe GIF
TIFF Formats
Tagged Image File Format, with no compression and

with RGB color space and 8-bit grayscale.
Tagged Image File, with no compression and with
CMYK color space.
YCbCr color space.
Tagged Image File with PackBits Compression and
RGB color space.
CMYK color space.
color YCbCr space.
Tagged Image File with CMP Compression.
Tagged Image File with JBIG Compression.
Tagged Image File with a vector image saved as a
DXF
Tagged Image File with JPEG 2000 Compression.
This file format contains only a stream of image data.
Tagged Image File with Wavelet CMP Compression.
BMP Formats
Windows BMP, with no compression.

Windows BMP, with RLE compression.
OS/2 BMP version 1.x.
Wireless Bitmap file. Type 0.
WMF and EMF Formats
Windows Meta File

Windows Enhanced MetaFil
Exif Formats
Exif file containing a TIFF image, with no

compression and with RGB color space.
compression and with YCbCr color space.
Exif file containing a JPEG compressed image
991
1-Bit FAX Formats
TIFF, compressed using CCITT.

TIFF, compressed using CCITT, group 3, 1
dimension.
dimensions.
TIFF, compressed using CCITT, group 4.
Raw FAX, compressed using CCITT group 3, 1
dimension.
dimensions.
Raw FAX, compressed using CCITT group 4.
IOCA, compressed using CCITT group 3, 1
dimension.
dimensions.
IOCA, compressed using CCITT group 4.
IOCA, compressed using IBM MMR, with the
MO:DCA wrapper.
IOCA, uncompressed, with the MO:DCA wrapper.
MacPaint.
Portable Bitmap - ASCII File.
Portable Bitmap - Binary File.
XBitmap File.
Microsoft Paint.
Other 1-Bit Formats
Quick Capture Desktop

Welcome to the QuickCapture Component
QuickCapture component extends the capture capabilities to TWAIN-enabled MFPs and scanners. Use this
component to capture paper documents from any TWAIN-enabled PC scanner and MFP into digital document
workflows.
QuickCapture comprises of a server software that runs on the workflow server and a client software that runs on a
PC. A QuickCapture client communicates with the QuickCapture server to get the menu and form information for
presentation on the client PC that is running QuickCapture Pro or QuickCapture Desktop. When the server and client
software are configured, a QuickCapture Desktop or QuickCapture Pro user can select the desired workflow, enter
document meta-data, preview the scanned documents, rotate, rescan, delete and finally send the document to the
workflow server for additional processing and archival.
This document describes the QuickCapture server (component) configuration. Please refer to the QuickCapture
Desktop or QuickCapture Pro help files for information on how to set up client software.
QuickCapture component provides the following features:
Secure communication (via SSL) between the scanning device and the Workflow server.
Personalized workflows for the logged-in user. Supported authentications include Windows NT, Active Directory,
NetWare, and custom authentication.
Optional Lock ing of scan setting. If not "Lock"ed, user can modify the scan setting from the QuickCapture
Desktop or QuickCapture Pro interface.
Scripting for advanced functionality to perform database look-ups, meta-data validation and more.
Scanning mixed mode documents (B/W, grey scale or color).
992
Multi-layer menu definition.

Centralized meta-data form definition for centralized control over the indexing forms.
Support for webforms as a secondary method for collection of meta-data for a scan job
Custom VBScripts extend the functionality of forms, updating form field values/settings at runtime, and
performing any form field validation based on available runtime data.
Getting started
Use this component to capture scanned documents into workflows by using QuickCapture Desktop applications.
QuickCapture Desktop is designed to run on a PC desktop.
When configured, this component provides a menu hierarchy for users to easily navigate to the desired workflow.
Furthermore, the indexing forms allow users to index documents at the point of capture before releasing the
documents to the workflow for processing and routing to desired destinations. This component can perform real-time
data look-up and validation to automatically populate indexing fields.
Configuring Quick Capture
Menu tab
Use this tab to add, edit, or remove groups, menus, and forms.
Option
Description
Add
Group
Menu
Form
Edit
Click this button to edt a selected group, menu or form.
Remove
Click this button to remove a selected group, menu or

form.
Group
Field Name
Name
Description
Type a name for the group you are creating. This
describes the name of the group. This name does not
appear on the QuickCapture Desktop panel and it is used
strictly as logical group name.
Note: This component initially has a default
group, which is named Common Group.
Root Menu Title

device display.
Select this check box to apply authentication settings

to the group dialog. This option is useful when you
want to group devices such that some of them support
authentication and some do not.
Software Update
This option applies to client devices. There are 2

methods available to update the client software on
devices:
993
Field Name
Description
Members
USB Update
UNC Update
Click Add to enter either a valid scanning device IP

address or a host name. Click Ping Address to check the
validity of the IP address or host name. Click Remove to
delete a scanning device.
Menu
Add a menu to create a hierarchy. The menu entry will simply guide the desktop users to select the desired workflow.
Field Name
Description
Name
Icon File
Browse to the folder location that contains GIF, PNG, or

JPEG file for this menu entry. The menu icon is 48x48
pixels and a color depth of 256 bits per pixel.
Form
Add a form when your workflow requires capture of index data. To add a form, fill out the following 3 tabs:
General tab
Scanner Settings tab
Components tab
General tab
Field Name
Description
Form Name
The name of the form to be displayed by client software,

such as QuickCapture Desktop.
Icon File
Browse to the folder location that contains GIF, PNG,

or JPEG file for this form entry. The Form icon is 48x48
256 color.
Form Type
Form Style
Local FormSelect this option if you want to

create your own form template using form fields and
style sheets.
Web FormSelect this option to either create or
point to an existing web app/form and provide the
URL. The web app/form will be displayed in the
web form-enabled QuickCapture clients. Once the
Submit button is clicked by the user all the standard
HTML control name/value pairs along with any
hidden fields (the name of the hidden field must end
with _RRT) will be captured as the RRT enabled
meta data for the document(s) captured.
Click the browse button (...) to customize the look and

feel of the form you are designing. See Style Builder for
specific attribute information.
994
Field Name
Script File
Description
The Script File feature extends the functionality of
otherwise static Forms by allowing custom VBScripts
to be executed on the server at runtime to update form
field values/settings, and to perform any necessary form
field validation based on available runtime data. Enter
the VBScript name for validating the index data on the
devices.
Run Script on Form LoadSelect this check box

to execute the script file on the server prior to loading
the form on the script-enabled client.
Run Script on Form ValidateSelect this
check box to execute the script file on the server to
determine if the form data submission is allowed.
For more information, see VBScripting.

Form Fields
Add fields by clicking the New field button appearing as

the first column header and labeled N. Once you have
added the first row, you can tab through to get additional
fields added.

be any alphanumeric characters. Using special
characters (~, &, <, >,%, ", /, \, :, ?, | ) is not
recommended.
Boolean
Button
Date/Time
Label
Number
String
String list
String Multiline
Required checkbox (R)Select this check box if
the field is required to be filled.
Validation checkbox (V)Select this check box if
you want the field to be validated.
HintDescription field for administrator reference.
PropertiesSet the field attributes by clicking the
properties button (...) in the right-most column on
each entry.
Scanner Settings
Option
Description
Allow user to change default Original Type
If enabled, user will see an icon representing this scanner

setting on the QuickCapture Desktop user interface
which allows the user to change the settings. If this
995
Option
Description
option is disabled, the setting is "locked", i.e., the user
cannot change scan settings defined for the form.
Original Type
Resolution
Determines the quality of the scanned image. The image

resolution is defined by the number of dots-per-inch that
are used to create the image. The higher the resolution
the sharper the image. 300 dpi is optimal for creating text
PDF files.
Color
Document Type
B/W ATP
B/W iThreshold
Gray
Color

Contrast (min 1 max 100)
One sided
Two Sided
TextSelect this when your documents are text

only.
Text and GraphicsSelect this when the image is
printed image.
PhotographSelect this setting when the
documents is image of printing paper
Enhances the edges contained in an image by adjusting

the difference between black-and-white, and thereby
making an image sharper or softer.
In a low contrast setting, the difference between black
and white is small, so the image is softer. In a high
contrast setting, the difference between black and white
is large, so the image is clearer. Thus, the higher the
contrast level, the more enhancement of the image edges.
Threshold (min 0 max 255)
Converts a gray scale image to a black-and-white image.

A low threshold value produces a lighter image, and can
be used to subdue backgrounds and subtle, unneeded
information. A high threshold value produces a darker
image, and can be used to help pick up faint images.
Output Format
JPEG Quality
TIFF
PDF
JPG
Good
Better
Best
Superior
996
Option
Description
Brightness
Determines how light or dark a color will be. The higher

the brightness value, the closer a color will be to white,
the lower the value, the closer it is to black.
Page Size
Displays paper size options based on what is allowed by

the individual scanner. If the paper size is not chosen,
the scanner will default to 8.5 x 11.0.
Show TWAIN user interface

Components tab
attributes. The configure button () appears in the last column within each row.
Select a component by clicking the left-most column next to each component and then configure the component for
this form by clicking the configure button (...) in the right-most column on the row.
Field types
Boolean field
A Boolean field allows users to set a True or False condition.
Option
Description
Default Value
This is the default value that will be selected for this

field.
True Value
You can use a different value from "True to identify a

true case, such as "Yes" or "On". If you do not specify
anything here, the default "True" will be used.
False Value
You can use a different value from "False to identify a

false case, such as "No" or "Off". If you do not specify
anything here, the default "False" will be used.
Has Label
Select this check box to display a label to the field when

displayed in Quick Capture.
Style
Click the browse button (...) to configure the style for the
Data or Label. Refer to the Style Builder for details.
Button field
A button field creates a button in a form.
In the Name column, enter text to be displayed as the button label. Use a descriptive action name such as "Submit",
etc. The maximum number of characters supported for this field is 10. Click the browse button (...) to configure the
style for the button Data.
Refer to the Style Builder for more information.
Date & Time field
A Date/Time field allows users to enter dates and times in a form.
Option
Format
Description
Specify the desired format for this field. A valid format
is composed of the following pattern letters:
Text: If the number of pattern letters is 4 or more,

the full form is used; otherwise a short or abbreviated
form is used if available.
997
Option
Description
Number: The number of pattern letters is the

minimum number of digits, and shorter numbers are
zero-padded to this amount
Year: If the number of pattern letters is 2, the year is
truncated to 2 digits; otherwise it is interpreted as a
number.
Month: If the number of pattern letters is 3 or more,
the month is interpreted as text; otherwise, it is
interpreted as a number.
General Time Zone:Time zones are interpreted as
text if they have names. For time zones representing
a GMT offset value, the following syntax is used:
Select the mode for the Date field. There are 3 available
modes:
Date: With this mode only the day, month and year
of the date can be specified.
Time: With this mode only the hour, minutes and
seconds of the date can be specified.
Date and Time: All parts of the date can be
specified.
Default value
Specifies a default value for this field.
Has Label

displayed in Quick Capture Desktop.
Style
Data, Label, or Button. Refer to the Style Builder for
details.
Label field
Use the label field to display a label in a form.
Option
Description
Text
Specifies the text of a label.
Style
Data. Refer to the Style Builder for details.
Number field
A number field allows users to enter numeric values in a form.
Option
Description
Default value
Specifies the default value for the field.
Maximum value
Specifies the maximum allowed value for a field.
Minimum value
Specifies the mimimum allowed value for a field.
Maximum number of decimals
Specifies the maximum number of decimal places for a

field value.
Has Label
Select this check box to display the label for the field.
998
Option
Style
Description
Click the browse button to configure the style for the
details.
String field
A string field allows users to enter a single line of text in a form.
Click the browse button (...) in the P (Field Form Properties) column to open the String Properties dialog box.
Option
Description
Default value
Specifies a default value for a field.
Maximum characters
Specifies the maximum number of characters that a user

can enter in a field.
Has Label

displayed in Quick Capture.
Style

details.
String List field

The String list creates a drop-down menu on the MFP control panel that is visible to users. Users cannot change the
values in the list.
Clicking the P (Field Form Properties) button when String list is selected in the Type field opens the String List
Properties dialog box. The String List Properties dialog box contains the following elements:
Option
Description
List item number. You can click the N column label to

add a value to the list.
Label
Use this field to provide a label for a string list item. This
label will be displayed on the device panel instead of the
actual string list value that is passed to the server. If left
blank and a label is not provided, the string list value is
displayed to the user and is also passed to the server.
Value
Use this field to type in the values a user sees in the

drop-down menu.
Click the checkbox in the D column to designate the item

Value as the default value for the field.
Add
Click this button to add a new item to the list.
Remove
Click this button to remove the selected value from the

list.
Multi-selection
Allow the user to select multiple items.
Separator character
Type the character used to separate multiple selections in

the field value.
Run lookup script

Has Label
999
Option
Style
Description
details.
String Multiline field

The String Multiline field allows users to enter multiple lines of text in a form.
Option
Description
Default value
The default value for the field.
Display width in characters
The line width displayed in the form. A horizontal scroll

button is added when the number of lines of data exceeds
this value.
Display number of lines
The number of lines of data displayed in the form. A

vertical scroll button is added when the number of lines
of data exceeds this value.
Has label
Style

details.
Style Builder dialog box

Use the Style Builder dialog box to define an HTML style, background, color, and more for field labels or data. There
are five sections to the Style Builder:
Font
Background
Text
Position
Edges
Font
The Font page of the Style Builder dialog box makes it possible for you to define CSS font attributes.
FamilyProvides a list of font choices for text displayed in this style. If you are designing documents for the
Internet, choose fonts that most users will have. A diverse Internet audience will probably not all have a wide
assortment of fonts installed. If you select Family, you can click the adjacent browse button (...) to open the Font
Picker dialog box and select fonts.
System FontSelect this option to have the style to apply a system font choice that the user has defined on the
computer viewing the page. For example, if you select Window Caption, a viewer's web browser will display text
on your page that is formatted in this style using the font assigned to Window Caption on the viewing computer.
This Window Caption font might be Times on one computer, and Verdana on another.
Font Attributes
ColorSets the color of text displayed in the style. Click the browse button (...) or the dropdown arrows to
specify a color.
ItalicsSets the FONT-STYLE attribute for text displayed in this style. Select either <Not Set> (no option
chosen), Normal, or Italic.
Small CapsSets the FONT-VARIANT attribute for text displayed in this style. Select either <Not Set> (no
option chosen), Normal, or Small Caps.
SizeThis sets the size of the style's font using one of three attributes: Specific, Absolute, Relative.
1000
SpecificSets a specific size for the font. The adjacent drop-down list displays unit options, which include
px, pt(default), pc, mm, cm, in, em, ex, and %.
AbsoluteSets an absolute size for the font, which you choose from a list of options. Select <Not Set> (no
value specified), XX-Small, X-Small, Small, Medium, Large, X-Large, or XX-Large.
RelativeSets a relative size for the font, which you choose from a list of options.
EffectsSets predefined effects for the style. These check boxes are available: None (no effects), Underline,
Strikethrough, and Overline.
BoldSets the FONT-WEIGHT attribute based on either Absolute or Relative values.
AbsoluteSets the absolute bold attribute for the style to the bold attribute that is associated with the font.
Select either <Not Set> (no option chosen), Normal (not bold), or Bold.
RelativeSets the relative bold attribute for the style to a bold attribute that is either more or less bold than
the default bold value for the font. Select <Not Set> (no option chosen), Lighter, or Bolder. Because Lighter
and Bolder attributes are relative to individual fonts, the degree of boldness varies according to the font to
which it is being applied.
CapitalizationSets the TEXT-TRANSFORM attribute for the style. Select <Not Set> (no option chosen),
None, Initial Cap, lowercase, or UPPERCASE.
Background
The Background page of the Style Builder dialog box makes it possible for you to set attributes for a CSS style that
will define a background color or image when the style is applied. Options available on the Background page of the
Style Builder dialog box include:
ColorSets the BACKGROUND-COLOR attribute for the style. Select an option from the drop-down list or
click the browse button (...) to open the Color Picker dialog box and select additional colors.
TransparentThis check box is used to set the BACKGROUND-COLOR attribute to the value transparent. If
you select transparent, you cannot select a background color.
Background imageSets the image the style will display in the background. Type a path and filename in the
field or click the browse button (...) to open the URL Picker and go to the location of the image.
ScrollingSets the BACKGROUND-ATTACHMENT attribute for the background image applied by the style.
Select a value from the drop-down list. An image can either remain fixed as the page scrolls or scroll along with
the text and images above the background. Select <Not Set> (no option chosen), Scrolling background, or Fixed
background.
PositionSets the position attributes for the background image applied by the style. The position value relates
to the tiling attributes. If you set a position for the background and do not choose tiling attributes, the background
image is fixed at the specified position. If you set a position for the background and choose tiling attributes, the
position serves as the starting point for the tiling attribute. You must select both horizontal and vertical position
values. If you specify only one value, the CSS Editor displays an invalid property name in the CSS Editor. When
you select both horizontal and vertical position values, the property is displayed correctly as background-position.
An example of a valid background-position declaration is BACKGROUND-POSITION:left center.
HorizontalSets the horizontal position for the background image applied by the style. Select <Not Set>
(no option chosen), Left, Center, Right, or Custom. If you select Custom, the fields to the right of Custom are
available. The default value is 50%. Enter a value in the number field and choose an increment (px, pt, pc, mm,
cm, in, em, ex, or %) from the unit field's drop-down list.
VerticalSets the vertical position for the background image applied by the style. Select an option from the
drop-down list. Select <Not Set> (no option chosen), Left, Center, Right, or Custom. If you select Custom,
the fields to the right of Custom are available. The default value is 50%. Enter a value in the number field and
choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %) from the drop-down list in the unit field.
Do not use background imageWhen selected, removes the background image from the current page. The
Image attributes are unavailable in the dialog box. If an image had been specified from the page, the backgroundimage property is removed from the style after you click OK.
TilingSets the tiling attributes for the background image assigned by the style. Images can tile several different
ways, as shown in the following table:
1001
Tiling Attribute
Description
Tile in horizontal direction
Image tiles from left to right across the page, but not
from top to bottom.
Tile in vertical direction
Images tile from top to bottom once.
Tile in both directions
Images tile both horizontally and vertically.
Do not tile
Disables tiling; image appears in locations specified by

the position value and does not repeat.
Not set
No option chosen; no code added to the style.
The Text page of the Style Builder dialog box makes it possible for you to define CSS text positioning attributes.
Options available on the Text page of the Style Builder dialog box include the following.
AlignmentFor the following alignment options, if you select <Not Set>, no code is added to the Style.
HorizontalSets the TEXT-ALIGN attribute value for text formatted in the style. Select <Not Set> (no
option chosen), Left, Center, Right, or Justified. Letter and Line values that you set below are adjusted to
accommodate the Justified attribute.
VerticalSets the VERTICAL-ALIGN attribute value for text formatted in the style. Select <Not Set>, (no
option chosen), Subscript text, or Superscript text.
JustificationSets the TEXT-JUSTIFY attribute value for text formatted in the style. Select <Not Set> (no
option chosen), Auto, Space words, Newspaper style, Distribute spacing, or Distribute all lines. Justification
attributes are available only if you select Justified for the horizontal value.
Spacing BetweenSets spacing between letters and vertical spacing between lines of text formatted in the style.
LettersSets the value for vertical spacing between lines of text formatted in the style. Select <Not Set> (no
option chosen), Normal, or Custom. If you select Custom, the fields to the right of Custom are available. Enter
a value from 1 to 512 in the number field and choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %). The
default unit option is pt.
LinesSets the value for vertical spacing between lines of text formatted in the style. Select <Not Set> (no
option chosen), Normal, or Custom. If you select Custom, the fields to the right of Custom are available. Enter
a value from 1 to 512 in the number field and choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %). The
default unit option is pt.
Text Flow
IndentationSets the TEXT-INDENT attribute value for text formatted in the style. Enter a value (1512)
in the number field and choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %). The default unit option is
pt.
Text DirectionSets the DIRECTION attribute value for text formatted in the style. Select <Not Set> (no
option chosen), Left to right, or Right to left.
Note: When the attribute is <Not Set>, no code is added to the style.
Position
The Position page of the Style Builder dialog box makes it possible for you to define CSS positioning attributes.
Position ModeSets the mode that determines which subsequent positioning fields become available. Select
one of the following options from the drop-down list:
<Not Set> When the attribute is <Not Set>, no code is added to the style.
Position in normal flow Does not change position of element; height and width can be specified. The
preview area adjacent to the Position Mode selector updates to reflect the mode selections.
Offset from normal flow Makes it possible for you to specify top and left positions for an element relative
to its position in the normal flow, height and width can be specified. An elements normal flow is its position
before the style is applied.
1002
Absolute positionMakes it possible for you to specify absolute top position, absolute left position, Z-index,
height, and width for an element. You typically absolutely position elements that you want to anchor to a
specific position. For example, you might absolutely position a logo so that is does not move as you add and
edit other elements.
If you select a position mode, the following options are available:
TopSets the top position of an element, either as an absolute value or as a value relative to its position in
the normal flow. Enter a value and choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %). The default unit
option is px.
LeftSets the left position of an element, either as an absolute value or as a value relative to its position in
the normal flow. Enter a value and choose a unit option (px, pt, pc, mm, cm, in, em, ex, or %). The default unit
option is px.
HeightSets the height of an element. Enter a value and choose a unit option (px, pt, pc, mm, cm, in, em, ex,
or %). The default unit option is px.
WidthSets the width of an element. Enter a value and choose a unit option (px, pt, pc, mm, cm, in, em, ex,
or %). The default unit option is px.
Z-IndexSets the Z-order for an element. The Z-order controls the display of overlapped elements; elements
with higher Z-order values are displayed in front of those with lower Z-order values. To move the element
higher in the Z-order, enter a positive number, for example. Z-INDEX:99
To move the element lower in the Z-order, enter a smaller or negative number.
Note: Z-Index and position are related. If you have entered position values that cause elements to overlap,
you can control which element appears on top of the other by assigning appropriate Z-Index values.
Assign a higher Z-Index value to the element that you want to appear on top of the other element.
Edges
The Edges page of the Style Builder dialog box makes it possible for you to define CSS style attributes that determine
the border and margins for area surrounding an HTML element.
MarginsSets attributes that control the distance between the rectangular area that surrounds an element and
other elements. Enter values in one or more of the fields (Top, Bottom, Left, or Right) and select a unit option: px
(default), pt, pc, mm, cm, in, em, ex, or %. Margin values can be either positive or negative.
PaddingSets attributes that control the amount of space between an element and its margin or between an
element and its border if the object has a border. Enter values in one or more of the fields (Top, Bottom, Left, or
Right) and select a unit option: px (default), pt, pc, mm, cm, in, em, ex, or %. Padding values must be positive.
Borders The following attributes control the border of the rectangular area that surrounds an element. Select the
edge to be changed: Select All, Top, Bottom, Left, or Right. Code is not added to the style until you select a border
style.
StyleSelect <Not Set>, None, Solid Line, Double Line, Groove, Ridge, Inset, or Outset.
WidthSelect <Not Set> (no option chosen), Thin, Medium, Thick, or Custom. If you select Custom,
adjacent fields are available in which you enter a number and select a unit option: px (default), pt, pc, mm, cm,
in, em, ex, or %.
ColorSets the color for the selected border in the style. Select a color from the drop-down list or click the
browse button (...) to open the Color Picker dialog box and select additional colors.
Preferences tab
Use this tab to specify where the program files for the job that is processing will be stored by the server.
Option
Home Directory
Description
1003
Option
Port Number
Description
Enter the port number used by the QuickCapture
server to communicate with clients. The same port
number must be specified in the client configuration
to communicate with the server. If the client is having
problems communicating with the server, check the
port settings on the client to make sure it matches the
port number specified on the server. If client and server
settings match, make sure there are no firewall blocking
the specified port. This field is initially set to 8088.
Note: To modify device settings, open
an Internet browser and access the device
configuration settings screen for the device.

between the server and the QuickCapture Client to take
place over an SSL secure channel.
Keep
The Keep setting allows the workflow to keep the

processed and/or rejected files in the specified directory
upon completion of successful routing. If you enable
this option, all files are stored into the Processed Files
directory at the time when the service successfully
completed writing them into the destination location.
Realize that if this option is enabled, a copy of every
file that has been routed successfully is saved in the
Processed Files directory. Make sure that proper disk
The Rejected Files directory is used for storing any files
that failed to be stored into the final destination location.
The failure could be due to any number of reasons
and it must be researched through searching the server
application log file entries. Typically, it is beneficial to
have a secondary process that takes this directory as an
input and routes messages out to system administrator
and warns them of failure. Note that the service must
have sufficient rights to access this directory.
Authentication tab
Set up the authentication attributes in this tab. The authentication server is running on the QuickCapture component of
workflow server.
Option
Authentication Type
Description
The supported Authentication Types are:
NONEThe device does not require the user to

feature.
Windows
Active Directory
NetWare
Script
1004
Option
Description
Windows
Choose this option to use Windows NTLM

authentication.
Domain NameEnter the Windows domain name.

Note: When windows authentication is
selected, the email address is retrieved
automatically as part of the authentication, so an
address is needed.
Active Directory
Choose this option to use Windows Active Directory for

user name and password settings.
Netware
Domain NameEnter the Active Directory domain

name.
Choose this option to use NetWare authentication. This

will prompt the user for the NDS context and tree.
NDS TreeEnter the Netware Directory Services

tree name.
NDS ContextEnter the NDS context name.
Authentication Server with the authentication
type being NDS, then the credentials provided
will be used by workflow server. If the
Authentication Type of the device is other than
NDS, then in addition to workflow server login
screen, the devices authentication screen is also
displayed.
Script File
Enter the path to the VB.Net script that contains the code
that will authenticate the user. You can click the browse
button (...) to locate the file.
Authentication requires LDAP lookup
Select this check box when authentication requires

looking up the email address and other attributes for the
authenticated user.
LDAP tab
Enter the LDAP attributes in this tab.
Option
Description
LDAP ServerEnter the LDAP server against

which you want to authenticate the user.
Root DirectoryEnter the directory from which
to begin the LDAP query. If this field is left blank,
the search starts at the LDAP default directory. Click
Find Root to locate the default root of the LDAP
server.

1005
Option
Description
It is important to note that if the root is left blank when
you press the Test button, the results may differ from
when you actually run the server with QuickCapture
component (equipped with Authentication). A blank
root uses the default value, which is retrieved from
the account that you are logged into the machine as.
However, when you run the server, you are logged in
as LocalSystem (or whichever user name you specify
on the Service tab), possibly yielding different results.
For this reason, it is highly recommended that you either
supply the root or log-in to the service with a user name/
password different than LocalSystem.
Credentials

AnonymousSelect this check box to log on to

LDAP server as anonymous user without providing
user name and password.
Username/passwordEnter the username/
password to access the LDAP server.

Active DirectoryWith Windows Active Directory

authentication method, the username is matched
against the field "samAccountName", the Get Email
From is matched against the field "mail", and the
Get Display Name From is matched against the
field "displayName".
eDirectoryWith NetWare authentication method
use the eDirectory search to match the Username
against the field "uID", Get Email From against the
field "mail", and the Get Display Name against the
field "cn".
multiple types of authentication. To customize the
search, use this option to create matches against
values that you can define for the following
parameters:
1006
Option
Description

Get Email From
Click Reset to reset field values to empty.

Test
To test the settings, click the Test button and enter a

user name as it will be entered on the QuickCapture
Desktop application. This verifies that an email address
and display name can be found for the user on the LDAP
server.
QuickCapture omponent RRTs

Component RRT ID
The RRT ID for this component is QCC.
Name
Description
Device Host Name
If available, the host name of the scanning device
Device IP Address
IP address of the scanning device
File Format
Received file format value: TIFF
File Page Count
Number of pages received
File Size
Received file size
Bits Per Pixel
Received file bits per pixel (1 for B/W, 8 for Grayscale,

24 for Color)
File Count
Number of files received by the server
Sender Display Name
The authenticated user's display name if Authentication

Sender Domain Name
The authenticated user's domain name if Authentication

Sender Email Address
The authenticated user's email address if Authentication

Sender Username
The authenticated user's user name if Authentication has

been turned on for the scanning device

This component supports FRTNs and replacement of field names created during the setup of the QuickCapture
component with the values entered in these fields at the device. The following example provides some sample usage
for your reference:
The RRT string ~QCC::%Client ID%~ is replaced by Johnson Co if the user types in Johnson Co for the field
named Client ID.
1007

Name
Description
DT: Weekday Name (A)
Received file date: abbreviated weekday name
DT: Weekday Name (F)
Received file date: full weekday name
DT: Month Name (A)
Received file date: abbreviated month name
DT: Month Name (F)
Received file date: full month name
DT: Day of Month
Received file date: day of month as decimal number

(0131)
DT: Hour (24)
Received file date: hour in 24-hour format
DT: Hour (12)
Received file date: hour in 12-hour format
DT: Day of Year
Received file date: day of year as decimal number (001

366)
DT: Month
Received file date: month as decimal number (0112)
DT: Minute
Received file date: minute as decimal number (0059)
DT: Locales A.M./P.M.
Received file date: current locales A.M./P.M. indicator

for 12-hour clock
DT: Second
Received file date: second as decimal number (0059)
DT: Week of Year (S)

Sunday as first day of the week (0053)
DT: Weekday
Received file date: weekday as decimal number (06;

Sunday is 0)
DT: Week of Year (M)

Monday as first day of the week (0053)
DT: Year
Received file date: year without century, as decimal

number (0099)
DT: Year (C)
Received file date: year with century, as decimal number

/
\
:
?
"
<
>
|
Use of the following characters is not allowed within the Menu, Form or Group:
&
<
1008
>
Troubleshooting
VBScripting
The VBScript feature provides the ability to extend the functionally of otherwise static Forms by allowing custom
VBScripts to be executed on the server at runtime to update form field values/settings and perform any necessary
Events
Form_OnLoad(Form)
Field_OnValidate(Form, FieldName, FieldValue)
Form_OnValidate(Form)
Field_OnLookUp(Form, FieldName, FieldValue)
Button_OnClick(Form, ButtonName)
Form_OnLoad event
This event occurs before a form is displayed on the device panel.
Form_OnLoad ( Form )
Argument
Description
Form
Remarks
Example
Add Items To "TO" Field on form
form.Fields.Field("TO").AddListItem "User1","User1@gMail.com"
end sub
Field_OnValidate event
This event occurs when a when user attempts to set a new value for a field on the form.
Field_OnValidate ( Form , FieldName , FieldValue )
Argument
Description
Form
The form object.
FieldName
The name of the field that requires

validation.
FieldValue
The value of the field that requires

validation.
1009
Remarks
You can use this event to perform tasks such as validating user input for a form field. If the return value is empty
Example
Function Field_OnValidate(Form, FieldName, FieldValue)
Write custom validation to check that the user is attempting to enter a
value for the Amount field that is less then 100.
End If
End If
End Function
Form_OnValidate event
This event occurs when the users send a document.
Form_OnValidate ( Form )
Argument
Description
The form object.
Form
Remarks
You can use this event upon user pressing the "send" button to perform tasks such as validating user input for a form
field. If the return value is empty string then validation is assumed to have been successful.
Example
Function Form_OnValidate(Form)
Write custom validation to check that the user is attempting to enter a
value for the Amount field that is less then 100.
Set Amountfield = Form.Fields.Field(Amount)
If (CInt(Amountfield.value) > 100) Then
Form_OnValidate = Amount cannot be greater than 100.
End If
End Function
Field_OnLookUp event
This event occurs when a field is marked as a look-up field and the user interacts with the device to request additional
values for that field value.
Field_OnLookUp ( Form , FieldName , FieldValue )
Argument
Description
Form
The form object.
FieldName

lookup.
FieldValue

lookup.
1010
Remarks
You can use this event to perform tasks such as looking up field values based on the user input on a form. If the
return value is empty string then the look-up has been successful.
Example
Function Field_OnLookUp(Form, FieldName, FieldValue)
Form.TraceMsg "Field_OnLookUp"
Dim rootDSE, domainObject
Set rootDSE = GetObject("LDAP://RootDSE")
DomainContainer = rootDSE.Get("defaultNamingContext")
Set conn = CreateObject("ADODB.Connection")
conn.Provider = "ADSDSOObject"
conn.Open "ADs Provider"
nickname = Value & "*"
ldapStr = "<LDAP://" & DomainContainer & ">;(& (mailnickname=" &
nickname & ")(|(&(objectCategory=person)(objectClass=user)(!(homeMDB=*))
(!(msExchHomeServerName=*)))(&(objectCategory=person)(objectClass=user)(|
(homeMDB=*)(msExchHomeServerName=*)))));adspath;subtree"
Set rs = conn.Execute(ldapStr)
While Not rs.EOF
Set oUser = GetObject(rs.Fields(0).Value)
For Each email In oUser.proxyAddresses
If InStr(email, "SMTP:") = 1 Or InStr(email, "smtp:") = 1 Then
Form.Fields.Field(Name).AddListItem Right(email, Len(email) 5),Right(email, Len(email) - 5)
End If
Next
rs.MoveNext
Wend
End Function
This event occurs when a when user clicks a button field on the form.
Button_OnClick ( Form , ButtonName )
Argument
Description
Form
The form object.
ButtonName
The name of the button field that was

clicked.
Remarks
You can use this event to perform tasks such validating user input for a form field or populating other form field
values on the form.
Example
Sub Button_OnClick(Form, ButtonName)
Write custom code to lookup the users home directory.
Form.Fields.Field(Path).Value = LookupHomeDirectory(Form.UserName)
End Sub
1011
Form object
Properties
Property
Description
UserName
Returns the authenticated users

account name. This property is only
available if authenticated has been
EMailAddress
Returns the authenticated users

email address. This property is only
available if authenticated has been
Name
This is the name of the form.
GUID
Unique ID of the form.
ScanSettings
This is an object.
Fields
This is an Object and containers

object form fields.
Methods
Method
Description
TraceMsg ( Msg ) ;
Displays debug messages in the status monitor when

debugging is turned on.
StatusMsg ( Msg ) ;
Displays status messages.
WarningMsg ( Msg ) ;
Displays warning messages.
ErrorMsg ( Msg ) ;
Displays error messages.
Fields object
Properties
Count
Number of fields in a container.
Field (name)
This returns field object by name.
Item (index)
This return the field object by index
Remark
Field and item properties will return one of the following objects:
Form Field String
Form Field String List
Fboorm Field Boolean
Form Field Date
Form Field Number
1012
Form Field String

Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
Form Field String List

Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
Separator
AddListItem Method
Table 56: Arguments
Name
Type
Label
String
Value
String
Form Field Boolean

Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
True
String
False
String
1013
Form Field Date

Name
Type
Value
String
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
Format
String
FormFieldNumber
Name
Type
Value
number
Name
Required
Boolean
Validate
Boolean
HelpMsg
String
MaxValue
number
MinValue
number
DecimalPlaces
number
Format
String
Scanner settings
Scanner Settings properties
The Scanner Settings have the following properties:
Name
Type
Properties
Value
Example
Resolution
enum
N/A
75=75PDI
Form.ScanSettings.Resolution=400
100=100DPI 150 =
150 DPI 200 = 200
DPI 240 = 240 DPI
300 = 300 DPI 400
= 400 DPI 600 = 600
DPI
Format
enum
N/A
SCANForm.ScanSettings.Format=2
FORMAT_PDF=0
SCAN_FORMAT_TIF=1
SCANFORMAT_JPEG=2
1014
Name
Type
Properties
Value
Example
Color
enum
N/A
COLOR_BLACK_WITE_ATP=0
Form.ScanSettings.Color=0
COLOR_BLACK_WHITE_ITHRESHOLD=1
COLOR_COLOR=2
COLOR_GRAY=3
MadCap:keyword
term="ImageType" /
>ImageType
enum
N/A
SCAN_TEXT_TYPE=0Form.scanSettings.ImageType=1
SCAN_PHOTO_TYPE=1
SCAN_TYPE_TEXT_AND_PHOTO=2
Duplex
boolean
N/A
true/false
JpegQuality
enum
N/A
DRAFT=0 GOOD=1 Form.ScanSettingsJpegQuality=1

BEST=2 BETTER=3
SUPERIOR=4
Contrast
number (short)
N/A
1-100
Form.ScanSettings.Contrast=60
Threshold
number (short)
N/A
1-255
Form.ScanSettings.Threshold=75
Lock
Object
Form.ScanSettings.Duplex=True
Form.scansettings.lock.color=trueFor
Brightness
-100 to 100 default 0
PageSize
PS_AUTO
=0,PS_A4LETTER=1,PS_B5LETTER
= 2,PS_USLETTER
= 3,PS_USLEGAL =
4,PS_A5 = 5,PS_B4
= 6,PS_B6 =
7,PS_USLEDGER =
9,PS_USEXECUTIVE
= 10,PS_A3
= 11,PS_B3 =
12,PS_A6 =
13,PS_C4 =
14,PS_C5 =
15,PS_C6 =
16,PS_4A0 =
17,PS_2A0 =
18,PS_A0 =
19,PS_A1 =
10,PS_A2 =
21,PS_A7 =
22,PS_A8 =
23,PS_A9 =
24,PS_A10 =
25,PS_ISOB0 =
26,PS_ISOB1 =
27,v PS_ISOB2
= 28,PS_ISOB5
= 29,PS_ISOB7
= 30,PS_ISOB8
= 31,PS_ISOB9
= 32,PS_ISOB10
= 33,PS_JISB0
= 34,PS_JISB1
= 35,PS_JISB2
= 36,PS_JISB3
1015
Name
Type
Properties
Value
Example
= 37,PS_JISB4
= 38,PS_JISB6
= 39,PS_JISB7
= 40,PS_JISB8
= 41,PS_JISB9
= 42,PS_JISB10
= 43,PS_C0
= 44,PS_C1
= 45,PS_C2
= 46,PS_C3
= 47,PS_C7
= 48,PS_C8
= 49,PS_C9 =
50,PS_C10 =
51,PS_USSTATEMENT
=
52,PS_BUSINESSCARD
= 53Default
PS_USLETTER
Lock Object Properties
Name
Type
Color
Boolean
Contrast
Boolean
Duplex
Boolean
JpegQuality
Boolean
Format
Boolean
ImageType
Boolean
Threshold
Boolean
Resolution
Boolean
Brightness
Boolean
PageSize
Boolean
Ricoh Desktop ESF

Welcome to the Ricoh Desktop SF
The Ricoh Desktop SF capture component allows direct integration of Ricoh MFPs with the workflow server. This
Multi-Layer menu definition for ease of use and quick indexing.

Support for various meta-data field types such as Text, Numeric, Date/Time, List and Label field types.
Support for various Scan Setting parameters; option to allow the user change the scan setting at the MFP panel.
1016
Getting started
Supported devices
The following device is supported: SP4410SF.
Installing and configuring the Ricoh Client software
How to Install Ricoh Client software
1. Access the setup web page for the device by opening your web browse and typing http://device_ip_address in the
address box.
2. Select the Settings on the left of the scree.
3. In Other Settings, select Embedded Solutions.
4. Select the System tab and Select Info.
5. Select Install and Select Browse.
6. Navigate to the directory: C:/distributables_directory/Ricoh ESF/eSF 2.0
7. Select the file autostoreclient.fls.
8. Click Start Install.
How to Determine local hostname or IP address of the Workflow server
1. Open a new configuration file within AutoStore Process Designer and drag and drop the Ricoh Desktop SF
component.
2. Right-click Ricoh Desktop SF and select Properties.
3. Select the Preferences tab.
4. Copy the Server URL.
5. Open a command window.
To get host the name, and at the prompt type hostname.
To get IP address, and at the command prompt type ipconfig.
6. Replace the text localhost with either the name of the host or the IP address of the host.
How to configure the Ricoh Desktop SF component to use the Workflow server
1. Access the setup web page for the device by typing the following URL in your browser: http://device_ip_address.
2. Select the Settings on the left of the screen.
3. In Other Settings, select Embedded Solutions.
4. Select the Solutions tab and select AutoStore Client.
5. Select Configure.
6. In AutoStore Server URL, insert the URL address for the workflow server (see Determine the Workflow Server
Address.).
7. Click Test.
If the test fails, the Workflow server may not be running. Return to the Autostore Process Designer and ensure
that the Workflow server is running.
How to assign solution ID to AutoStore client
1. Access the setup web page for the device by typing the following URL in your browser: http://device_ip_address.
2. Click the Settings on the left of the screen.
1017
4. Click the Solutions tab and select AutoStore Client.

5. Click Configure.
6. Select a value for Function ID in the list.
By default this value is "Solution 5". Do not change the default setting unless there is a different application for
the Ricoh MFP that uses the same function ID.
7. Restart the device if you changed the Function ID from "Solution 5" to another value.
How to configure AutoStore Authentication on Ricoh Desktop SF
Perform the steps in this procedure to configure Autostore Authentication.
After you install and configure the Ricoh Client Software on the MFP the AutoStore authentication Module is
automatically registered in the Ricoh Desktop SF system.
1. Access the devices setup web page by typing the following URL in your browser: http://device_ip_address.
2. Select Settings on the left of the screen.
3. In Other Settings, select Security.
4. Select Edit Security Setup.
5. Select Security Templates.
6. Press Add a Security Template.
7. Enter AutoStore in the Security Template Name box, select AutoStoreAuthModule as Authentication Setup,
press Save Template.
This creates the security template with the name "AutoStore".
8. Select Return to Edit Security Setups.
9. Press Access Controls.
10. Select an "AutoStore" value for Solution 5 drop down list.
If you assigned different Function ID when you were configuring Autostore client <link to Assign Solution Id to
AutoStore client> then select appropriate drop down List.
How to Test Ricoh Desktop SF
1. Access the panel of the Ricoh MFP.
2. Select the AutoStore icon.
3. Ensure the component is accessible from the Ricoh MFP panel.
Configuring the Ricoh Desktop SF component
General tab
This tab defines menu structure that will be shown on the Ricoh device. The devices can be grouped based on their
IP address. Each group of devices can have its own menu structure. By default there is a single group called Default
Device Group. If you do not configure additional groups, all devices pointed to the workflow server will display the
menu structure under Default Device Group.
Use this tab to Add, Edit, or Remove the following:
Group
Menu
Form
Shared Form
You can create additional groups and assign devices to the newly created groups. This way even though all devices
are connecting to the same workflow server, they can be used for different functions. Simply drag and drop to change
the order of menus and forms that appear on the MFP control panel.
In addition, users may create custom menus and shared forms. By default there is a Default Menu which can be
removed. Users may also create a shared form. A shared form is a form which can be used within different menus.
A user needs to only create one shared form in the same manner as a regular form would be created. This shared
form can then be referenced in other menus.
1018
Option
Description
Add
Click this button to create one of the following:
Group
Menu
Form
Shared Form
Edit

menu, form or shared form.
Remove
Click this button to remove the currently selected group,

menu, form or shared form.
Group
On the General tab, the configure the following entries for a new group:
Option
Description
Name

as a logical group name. This component has a default
group called "Default Device Group". You may add
Menus and Forms to this group.
Associated MFPs

that belong to this group. Press Ping to validate the
If cleared, group level authentication is used. If selected,

component level authentication is used.
For settings on the Authentication tab, see Authentication.

Menu
Add a menu to create a hierarchy. The menu entry guides MFP users to select a workflow.
Field Name
Description
Display Text
Enter the name that will be displayed on the MFP panel.
Normal
Enter the location of the image that will be displayed

on the MFP panel (this image will be the icon that is
displayed prior to the user pressing that icon on the MFP
panel). If no image is selected, the default image on the
MFP panel will be used.
Pressed
Enter the location of the image that will be displayed on

the device once the user has pressed the icon (this image
will be displayed for a corresponding icon once the user
has selected that icon; i.e. the image used will change
from the one specified in the Normal field to the one
specified in the Pressed field). If no image is selected,
1019
Form
When setting up a form the following four tabs must be configured:
General Tab
Fields Tab
Components Tab
Appearance Tab
General Tab
Field Name
Description
Display Name

form.
Single Touch Scan
Check this option if you do not want the user to enter

option, the scan operation will start immediately after the
user presses the "form" button on the device.
Access Control
Access to the form can be control with the following

options:
Scan Settings
PublicAllows unrestricted public access to the

form.
Restricted AccessRestrict access to users or
groups listed. Users can also search for users and
groups by selecting Active Directory Integrated and
accessing the entire active directory.
This table lists all of the available scan settings. In the

Value column you can set default scan settings, which
will be used if the user does not change the setting at
the device panel. See the Ricoh Desktop SF User Guide
for detailed description of each scan parameter. By
selecting Locked (next to Basic Options), all Basic
Options are locked and cannot be changed by the user
at the MFP device panel. By checking Default (next
to each Parameter), default options as supplied by the
MFP device itself are used. Note: Selecting both Default
and Locked does not produce any different result. By
checking the Default checkbox, the user will override
the Locked checkbox. The user may define different
scan settings for different parameters. The user should
note that the Default checkbox must NOT be checked in
order to set values for Basic Options.
Page SizeProvides the list of available page size.

SidesPlacement of the target document on the
MFP device.
document can be either Portrait or Landscape.
File FormatFile format of the scanned document.
Multi-Page TiffA Tiff file format can be either a
single page format or a multiple page format.
1020
Field Name
Description

available color mode. The target document will
be rendered in grayscale or color. If no value is
specified, color will be used. If the device is only
able to scan in monochrome then all scans, regardless
of specification, will be monochrome.
Mono Bit DepthSpecifies bit depth and used only
when Color Mode is set to Black and White. If
Color Mode is set to Color, then any selection will
be ignored and bit-depth will be set to 24-bit.
CompositionThis option is not available in this
version.
Content Contents of the target document.
CompressionThis option is not available in this
version.
The user may define different scan settings for Advance

Options as well. The user should note that the Default
checkbox must NOT be checked in order to set values
for Advance Options. The user should also note that all
MFPs do not support these Advance Options. The user
should check the user manual for their specific MFP for
more information.
Custom JobAllows a user to concatenate sets of

original scan jobs into one single job. Jobs may from
different sources and different settings.
DarknessThe darkness level of the scan with (1)
being the lightest and (9) the darkest.
Edge Erase (Top, Left, Right, Bottom)Specifies
the amount of image data to erase at either the top,
left, right or bottom of the original image window.
This option allows the user to eliminate unwanted
marks along the edge of the target document.
Scan Preview (hard drive)When enabled, the
user will see a thumbnail of the image scanned. With
flatbed devices, a thumbnail will be displayed for
each page scanned. For ADF devices, a thumbnail
will be displayed for only the first page.
Background RemovalSpecify the background
removal level of a scan. Higher values change lighter
shades to white. A value of zero (0) is neutral.
Color DropoutTurns the selected color to white
in order to aid with forms processing functions. Also
turns dark marks and notations to black. This setting
only affects grayscale jobs.
Color Dropout ThresholdSpecify the threshold
for shades to become either black or white. By
increasing the threshold, darker shades become black
while lighter shades become white. By decreasing
the threshold, darker shades become white while
lighter shades become black.
ContrastSpecify the contrast level of the scan.
Higher values results in more contrast.
1021
Field Name
Description
Dynamic Form
JPEG QualityThe amount of image quality

and detail to be retained by the JPEG compression
algorithm.
SourceSpecify the scanning source.
Negative ImageSpecify whether the image
produced by the scan is to be inverted.
Shadow DetailSpecifies the black-point level of
the scan.
Scan Edge to EdgeSpecify whether target
document will be scanned from edge to edge or only
within the specified margins.
SharpnessSpecify the sharpness of the image.
Increasing the value may be useful for blurry text.
Decreasing the value may be useful for moir
patterns.
Action Button TextSpecify the text to be
displayed on the Action button. If no text is
specified, the default text for the action is used.
One Page CopySpecify whether scanner scans an
entire job at one time or one page.
Pdf PasswordThis option is not available in this
version.
Pdf Algorithm Specify the encryption algorithm
to use with secure PDF. File Format must be set to
SECURE PDF. The encryption algorithm is selected
automatically.
Restart Job This option is not available in this
version.
Scan Recovery This option is not available in this
version.
Scanner Jam Recovery Specify whether the full
or partial job must be resubmitted when the job is
cancelled for any reason. If Page-level is selected
and the entire job must be restarted, then the job must
be resubmitted. The Page-level setting saves all
properly scanned pages but all pages after the first
jammed must be resubmitted.
Enable Dynamic FormStandard behavior of a form

can be modified by responding to events. This checkbox
allows the workflow sever to load form snap-ins. Here
are some examples of what enabling dynamic forms can
do:
Add and remove fields

a list field from a database)
Snap-in pathPath to the compiled snap-in (.net

assembly) that contains the code to respond to form and
field events. If you have an existing snap-in you want
to use, you can browse for it using the ellipsis button
1022
Field Name
Description
next to the Snap-in path box. Source Path. Path to the
source code of the snap-in. This path is used by code
editor to compile the snap-in only during design time.
Create/Edit Snap-in: You can also click the Create/Edit
Snap-in button to open a code editor window with basic
snap-in code. For details of the code editor window
and the object model used to respond to form and field
events, please refer to the Ricoh Desktop SF Snap-in
documentation by clicking Help in the code editor
window. Raise event when Form is LoadedSelect
this checkbox to cause the form to initiate an event every
time the user enters the form. Raise event when Form is
SubmittedSelect this checkbox to make the form to
initiate an event every time the user presses Scan button
in this form.
Fields Tab
NameThe field name should be unique among the other fields within this form.
DisplayThe text which is displayed above the field at the device panel.
TypeA field type represents the format by which data is collected at the device panel. Regardless of field type,
the result will be in text format. The following field types are supported:
Textallows a user to enter un-formatted text.

Integerallows a user to enter integers (whole numbers only).
Numericallows a user to enter numbers (with or without decimal point).
Listallows to present users with a list of choices from which users select the desired item. Use this field
type if you want a text field with auto complete capabilities. If a list of choices is too long, the list can be made
searchable.
TreePresents a list of choices in tree form.
N (Notify Server)If checked, this field triggers an event when the value of the field changes. You can respond
to this event in the snap-in that was configured for the dynamic form section in the General tab. For details on
how to respond to form and field events, refer to the Ricoh Desktop SF Snap-in documentation.
P (Properties)Allows a user to edit additional properties of the field type.
Components Tab
Configure the component for this form by clicking the Properties button (right-most column on each row). The
configure.
Appearance Tab
Option
Description
Description

form.
Scan Button Label
Enter the text that will appear on the scan button on the
display panel for the device.
1023
Option
Description
Button Images - Normal
Enter the location of the image that will be displayed

on the MFP panel (this image will be the icon that is
displayed prior to the user pressing that icon on the MFP
panel). If no image is selected, the default image on the
MFP panel will be used.
Button Images - Pressed
Enter the location of the image that will be displayed on

the device once the user has pressed the icon (this image
will be displayed for a corresponding icon once the user
has selected that icon; i.e. the image used will change
from the one specified in the Normal field to the one
specified in the Pressed field). If no image is selected,
Shared Form
A shared form is exactly the same as a regular form with the exception that any specific shared form can be
referenced multiple times. This option allows the user to create one shared form and reference the same form in
another group or menu.
Field Name
Description
Add
Click this button to create and customize a shared form.

For information on creating and customizing a form, see
the Form help page.
Remove
Click this button to delete a shared form.
Edit
Click this button to edit and customize a shared form.
Ref
Click Ref to display information on the number of

references a shared form may have. Keep in mind, that a
shared form may not have any references. A shared form
can be created but does not have to be placed within
a group or menu. The different groups or menus that
reference a shared form can be managed by clicking Ref.
Field types
Date Time field
Option
Description
Default value
Default value can be represented in two different ways:
Time interval from nowWhen this option is

selected, the default value of the field will be the time
a user opens a form plus the interval. For example if
you want the default time to be yesterday, enter "-1"
into the time interval checkbox.
Fixed timeWhen this option is selected, a user
opens up a form which contains this field and its
value will be exactly as specified in Fixed Time textbox.
This option defines the format of the date or time, in

which the date/time value will appear on the device
panel.
1024
Custom DateTime format strings

Format specifier
Description

dd

EEE

panel.
EEEE

control panel.

MM

MMM

example Jan, Feb).
MMMM

January, February).
yy
yyyy

twelve-hour time.
hh

HH

mm

added.
All other alphabetic characters are invalid. Symbols and numeric characters, however, are untouched.
1025
Examples

yyyy-MM-dd HH:mm2009-01-03 15:35
hh:mm a3:35 P.M.
Integer field
Option
Description
Default Value
Required

Password
Obscures data whenever it is displayed or entered on the

device panel. The default value is false.
Maximum Value
The maximum allowed integer value.
Minimum Value
The minimum allowed integer value.
Error Message
The error message which will be displayed on the device

panel when the user enters an incorrect value.
List field
Option
Description
Value
that will be sent to the server (and used for the field
RRT).
Label
The text associated with the list item which will be

displayed to a user.
Selected
Specifies which list items will be preselected when a

user activates the form. If Allow Multiple Select is
selected, you can preselect multiple list items.
If checked a user will be able to select multiple options

simultaneously. The value of the field will form from
the values of the selected options separated by Item
Separator.
Display Search Option
If checked, a user will be able to search through

available options.
Apply Search Pattern to Current List
Check the checkbox to allow the user to search through

the elements that have been added to the list field type.
Note that the Display Search Option must be checked
to use this option. If Apply Search Pattern to Current
List is not selected and the user attempts to search
through the elements of the list field type, the search
must be implementing through custom scripting.
Delete All
Delete all values from the list.
Import
Specify a comma separated value (CSV) file which can

be imported into the list.
Export
List values can be exported into a CSV file.
1026
Numeric field
Option
Description
Default
The default text that will appear on the MFP panel.
Max Length
The maximum number of characters allowed for the text.
Min Length
The minimum number of characters allowed for the text.
Required

Password

Regular Expression

a numeric value. The entered value by the user will be
validated against this expression.
Error Message

Keyboard Type
Specify the keyboard type that will be displayed on the

device panel.
Text field
Option
Description
Default Value
Required

Password

Max Length
The maximum length of the text string allowed.
Min Length
The minimum length of the text string allowed.
Regular Expression

text. The entered value by the user will be validated
against this expression.
Error Message

Tree field
Right-click on the tree to add, edit and remove nodes.
Option
Description
Value of the Node
Specify the value of the node.
Defaulted Selected Node
Specify the node which will be selected by default on the

device when a user activates a form.
1027
Option
Path Separator
Description
Used between the node labels that forms a full node path.
Preferences tab
processed.
Option
Server
Description
Specify the web server that the scanned document
image(s) and associated metadata should be transferred
via HTTP or SSL. This allows a web application/service
to directly receive the data rather than watching for a file
to appear at a predetermined location.
Keep
Server URLThe http URL from which the data

will be retrieved by the workflow.
Server SSL URLThe https (SSL) URL from
which the data will be retrieved by the workflow.
SSL CertificateThe certificate by which data can
be retrieved by the workflow server, when using https
(SSL).
Home FolderThe root directory where the server
creates all temporary directories and files necessary
have proper permission to write to this directory.
Processed FilesSelect Processed Files to keep
a copy of all files that are processed without errors.
Warning: If this option is enabled, a
copy of every file that has been routed
successfully is saved in the Processed
Files directory. Make sure that proper disk
storage is allocated when using this option.
Rejected FilesSelected Rejected Files to keep a
copy of all files that failed to be processed. Enter the
Note: The service account for the service must
have write permissions on the Processed Files
and Rejected Files directories.
RRT Format tab

Option
Description
1028
Option
Description
The Time Stamp list on the right shows some examples
of date time formats. You can drag & drop to fill out
format strings or press < button.
Full description of format strings can be found in Custom
DateTime Format Strings.
File Size Format
Use this option to specify the unit in which File Size

RRT will be represented.
Authentication tab
In this tab you can set up the authentication parameters.
Option
Authentication Type
Description
Select the authentication method you want to use. The
following options are:
StandardTwo options are available:

authentication is within the same domain, the
Server or LDAP path can be left blank.
Fast BindIf disabled, the Active Directory

Server returns all the user attributes to the
workflow server.
Server BindIf disabled, the Active
Directory Server tries to connect to DNS
server to resolve the IP address of the
workflow server.
Use SSLIf disabled, the connection
between LDAP and Workflow server is not
encrypted. To use SSL option you must have
a server certificate for the ADAM service . If
verifying against another domain, enter the
server name and port number (i.e. LDAP://
server name,5001). Click Test to verify
that the username created on the server
Simple bindEnter the Server or LDAP path
(i.e. LDAP://server name,5000)
Fast BindIf disabled, the Active Directory

Server returns all the user attributes to the
workflow server.
Server BindIf disabled, the Active
Directory Server tries to connect to DNS
server to resolve the IP address of the
workflow server.
Use SSLIf disabled, the connection
between LDAP and Workflow server is not
encrypted. To use SSL option you must have
a server certificate for the ADAM service . If
verifying against another domain, enter the
server name and port number (i.e. LDAP://
server name,5001).
1029
Option
Description
Refer to Binding to an LDAP Server in the
MSDN Library to learn about setting the LDAP
Bind options.
Netware
This will prompt the user for their NDS context and tree.

tree name.
displayed.
Custom

are validated.
Snap-in path
Path to the compiled snap-in (.net assembly) that

contains the custom authentication code. If you have an
existing snap-in you want to use, you can browse for it
using the ellipsis button next to the Snap-in path box.
Create/Edit Snap-in
You can also click the Create/Edit Snap-in button to

open a code editor window with basic snap-in code. For
details of the code editor window and the object model,
please refer to the Fujitsu Capture Component Snapin documentation by clicking Help in the code editor
window.
A sample custom script is available with this component.
Source Path
Path to the source code of the snap-in. This path is used

by code editor to compile the snap-in only during design
time.
Select this checkbox to look up the email address and

other attributes for the authenticated user.
Note: When windows authentication is
selected, the email address is retrieved
automatically as part of the authentication and
as a result an LDAP search is not required if
only the email address is needed.
To Configure the LDAP server, enter the following
information:
Search RootEnter the search root folder you want

to begin searching against. If this field is left blank,
the search starts at the LDAP default directory.
AuthenticationSelect the required authentication
type and provide the user credentials.
1030
Option
Description
Directory SearchSearch the entries in the address

book directory services database.
Test Look-upTo test the search settings, enter a
sample user name in the Username box and click
Test.
Obtaining an SSL certificate

Obtaining a certificate
Microsoft. To install a Certificate authority check the "Certificate services" checkbox. (IIS should be installed before
or at the same time as you install the certificate services). Once the installation is complete, request a certificate using
your browser (address: http://localhost/certsrv):
1.
2.
3.
4.
5.
6.
7.
8.
9.
Click "Request a certificate"

Click "Advanced certificate request"
Click "Create and submit a request to this CA"
In the "Name"-textbox write the full dns name of the server
Make sure "Type of certificate" is "Server authentication certificate"
Select PCKS10 as the format
Optionally fill in the other information
In the "Friendly name"-textbox write the full dns name of the server
Click the submit button.
1. Open "Control Panel \ Administrative Tools \ Certification Authority"
2. Browse to the "Pending requests"-folder
3. Locate the certificate request, right-click and select "All tasks \ issue".
The certificate has now been created and resides in the "Issued certificates"-folder. Next we need to download and
install the certificate:
1.
2.
3.
4.
Open http://localhost/certsrv
Click "View the status of a pending certificate request"
Click the certificate request
Click the certificate to install it

1.
2.
3.
4.
5.
6.
7.
Select "Run..." from your start menu and type mmc. This will open the management console.
Click "File \ Add/Remove snap-in"
Click "Add..." and select "Certificates"
Select "Service account"
Select "Local computer"
Select your ADAM instance service
Add a new "Certificate" snap-in, but this time select "My user account" instead of "Service account"
1031
8. Click "Close" and "Ok"

9. Open the "Personal"-folder under the "Certificates - Current user"-tree
10. Select the certificate and copy it into the same location under "Certificates - adam instance name"
to C:\Documents and Settings\All Users\Application Data\Microsoft\Crypto\RSA\MachineKeys (if these
permissions are not set correctly you will get an error in the event log: Schannel ID: 36870 - "A fatal error
occurred when attempting to access the SSL server credential private key. The error code returned from the
cryptographic module is 0x6.")
12. Restart your ADAM instance
1.
2.
3.
4.
Run the "ADAM Tools Command Prompt" from your ADAM program group
Type "ldp" and hit enter
Click "Connection \ Connect..."
Type the DNS name of your server in the server textbox (localhost will not do here as the dns name is checked
against the certificate)
ADAM)
6. Check the SSL checkbox and hit "OK"
If you still get the "8009030e No credentials are available in the security package" after the import, or you get an error
when importing the keys into the LOCAL_MACHINE\Personal store, check that you/administrators have full access
to "C:\Documents and Settings\All Users\Application Data\Microsoft\Crypto\RSA\MachineKeys". Try importing the
certificates directly into both LOCAL_MACHINE\Personal and ADAM\Personal instead of copying them for the
Current_user store.
Ricoh Desktop SF component RRTs
Component RRT ID
The RRT ID for this component is RSF.
Name
Description
Number of Files
Number of Documents received in a batch.
File Size
Size of the received file.
Form ID
The GUID of the form selected at the network scanner.
Batch ID
The GUID of the received batch.
Sender Username
The name of the user authenticated on the device.
Sender E-mail
The email address of the user authenticated on the

device.
Device IP

received
1032
Name
Description
Device Host Name
Host Name of the device from which a batch has been

received
Device Domain Name

been received
Device MAC Address
The network MAC address (UAA) of the device
Device Model Number
The model name of the printer.
The serial name of the device.

This component does not support SSRTNs.
Problem
The AutoStore Status Monitor displays the same URL
value when the Ricoh Desktop SF component and the
Lexmark MFP component are used even when different
endpoints are configured for each task.
Solution
No action needs to be taken. The URL will always
display a value according to the Lexmark MFP
component. However, this is not an error and there is no
issue.

Ricoh ESA
Welcome to the Ricoh ESA component
The Ricoh ESA component allows for direct integration of the AutoStore server and Ricoh MFP devices. This
Device level authentication including Windows, Active Directory, and NetWare and custom script authentication.
Multi-Layer menu definition that allows ease of use and quick indexing.
Support for String, String list, Boolean, Date, Number, Database Lookup and Folder Browse field types to provide
document indexing flexibility.
Device groupings allow devices to be divided into functional or organizational groups.
Extensible forms through VBscript. You can create more interactive forms and validate before a document is
scanned.
Access control support to menus and forms.
Support for Duplex and Color Scanning.
Ability to create forms Send to Email, SharePoint 2007, SharePoint 2010, and Smarticket.
Ability to browse the SharePoint site at the device panel.
Ricoh ESA integration utilizes the latest in ESA technology and is designed to provide enterprise level functionality.
1033
Getting started
Supported devices
Please refer to http://www.nsiautostore.com for a complete up-to-date list of supported devices.
Use this component to capture documents from the Ricoh ESA device and to process the digitized documents
for storage in a repository or for distribution. This component allows Ricoh ESA devices to access a rich set of
workflows and attain high levels of document capture efficiency.
The Ricoh ESA component allows Ricoh devices with ESA capability to integrate directly with AutoStore server.
Additionally use the scripting capability provided by this component to create dynamic forms and fields that are
connected with your applications. Validation of form fields can also be done directly against back-end application
databases to provide a quality control indexing station on the Ricoh ESA devices.
This component provides a rich set of form fields to allow the user to capture String, String List, Date, Number,
Boolean, Label field values. Creation of forms using these devices is now very simple and easy to manage since all
devices are centrally controlled from the AutoStore server.
This implementation provides an enterprise solution that can provide:
Device grouping and scan setting control from a single location without the need to log on to every device
Centralized indexing form management
Support for Server Farms and load balancing for larger deployment of devices
Install the Ricoh ESA component

How to install JavaTM platform
1.
2.
3.
4.
Make sure that the Main Power of the Ricoh Device is turned OFF.
Insert SD card into available slot. Power ON the Ricoh Device.
Press the User Tools/Counter/Inquiry hard button on the Ricoh Device control panel.
Press the Extended Feature Settings button in the bottom left of the screen to display the Extended Feature
Settings menu.
5. Press the Extended Feature Settings button to display the Extended Feature Settings screen.
6. Press the Install tab to display the SD Card and Web Server installation sources.
7. Press the SD Card button to display the JavaTM Platform.
8. Select the JavaTM Platform to start the installation.
9. Select the appropriate SD Card slot as the destination installation and press the Next button.
10. To start the installation press the OK button on the Extended feature information screen. A screen Installing the
extended feature will appear showing that the installation process is being performed.
11. Once installation has completed press Exit to end the installation.
12. To start up the JavaTM platform, press the "Startup Setting tab.
13. Press the JavaTM Platform button.
14. Startup settings will be valid after turning the power of the machine on again.
How to install AutoStoreXlet
Note: If your environment uses the Ricoh Unified Client, refer to the Device Registration Service web Help
for information on installing the AutoStore Xlet.
If your environment does not use the Ricoh Unified Client, complete the following procedure:
1.
2.
3.
4.
Double-click the Ricoh ESA component in a workflow to open the component settings.
In the Ricoh ESA settings dialog box, click the Preferences tab.
Click Device manager.
In the Ricoh ESA Device Manager, click Add to add a Ricoh device. Click Import to add multiple Ricoh devices.
1034
5. Select the Ricoh devices and click Install.

Note
You can also use Windows Explorer to open the Ricoh ESA Device Manager application. The file is located in the
NSI installation folder:
<installation directory>\Distributables\Ricoh ESA\RicohDeviceManager.exe
For example:
C:\Program Files\NSi\AutoStore Workflow 6\Distributables\Ricoh ESA\Ricoh ESA\RicohDeviceManager.exe
Installation through Web Image Monitor

1. Open a web browser and browse to:
2.
3.
4.
5.
6.
http://<device IP address>
Click Login in the Web Image Monitor page.
Enter admin for the user name and leave the password blank.
Select Device Management > Configuration.
Under Extended Feature Settings, click Install.
Select Local File and browse to:
<installation directory>\Distributables\Ricoh ESA\Web Image Monitor
\33956098.zip
Note: If the device supports the Java 2.x platform, browse to <installation directory>\Distributables
\Ricoh ESA\Web Image Monitor\33956098. 2.x Platform.zip.
7. Click Display Extended Feature List.
Note: AutoStore files will upload to the device.
8. Under Installation Target Setting, for Install to, select the SD Card for the Java Platform.
9. Under Type J Setting, enable Auto Start.
Note: By enabling Auto Start, AutoStore is started automatically when the device starts.
10. In the list of applications, select AutoStore.
11. Under Extended Feature List, click Install.
12. On the summary page, click OK. Once installation is complete, the Extended Feature List is empty.
13. Click Back.
14. Click Startup Settings under Extended Feature Settings. If the AutoStore application shows a status of Stop,
select AutoStore and click Start Up/Stop.
Note: The first time AutoStore is installed, it is not started automatically. Start AutoStore manually as
described in Step 14.
15. The device must be linked to the AutoStore Server. Use the Xlet Configuration Tool located in:
<installation directory>\Distributables\Ricoh ESA\
Using the Ricoh ESA component
Press the ON button allocated to the Java platform (Other Function is the default) on the Ricoh Device Control
Panel.
Select AutoStore to display the configured menu items.
Configuring the Ricoh ESA component
Note: If your environment uses the Ricoh Unified Client, refer to the Device Registration Service web Help
for configuration information.
If your environment does not use the Ricoh Unified Client, use one of the following methods to configure the
AutoStore Xlet or force a menu update once the AutoStore server has been configured and started:
1035
Method 1
Use this method to pre-set the configuration settings in the DALP file found in the 33956098 directory prior to
installing the AutoStore Xlet.
Open the DALP file in a standard text editor.

Modify the IP address in the line <argument>-s 127.0.0.1</argument> with the appropriate IP address of the
AutoStore server
Modify the Port in the line <argument>-p 8084</argument> with the appropriate port assigned to the Ricoh
component in the AutoStore configuration file.
Method 2
Use this method to update the AutoStore settings from the device panel once the AutoStore Xlet has been installed
and started.
Click on the Settings button on the top left corner.

Enter 78673 (corresponding to the letters STORE on the keypad) for the system code and click OK.
Modify the server IP address and port number as needed and click OK.
Method 3
Use this method to force a menu update once the AutoStore server has been configured and started.
1.
2.
3.
4.
Double-click the Ricoh ESA component in a workflow to open the component settings.
In the Ricoh ESA settings dialog box, click the Preferences tab.
Click the Device manager button.
In the Ricoh ESA Device Manager, select Ricoh devices and click Update.
Note: You can also use Windows Explorer to open the Ricoh ESA Device Manager application. The file is
located in the NSI installation folder:
<installation directory>\Distributables\Ricoh ESA\RicohDeviceManager.exe

For example:
C:\Program Files\NSi\AutoStore Workflow 6\Distributables\Ricoh ESA\Ricoh ESA\RicohDeviceManager.exe
Uninstalling the Ricoh ESA component
Note: If your environment uses the Ricoh Unified Client, refer to Ricoh ESA Actions in the Device
Registration Service web Help for more information.
If your environment does not use the Ricoh Unified Client and you want to update the AutoStoreXlet, uninstall the
current AutoStoreXlet and install the new version as follows:
From the Ricoh Device Manager:
1. Double-click the Ricoh ESA component in a workflow to open the component settings.
2. In the Ricoh ESA settings dialog box, click the Preferences tab.
3. Click Device Manager.
4. In the Ricoh ESA Device Manager, select the Ricoh device and click Uninstall.
How to use Windows Explorer to open the Ricoh ESA Device Manager
You can also use Windows Explorer to open the Ricoh ESA Device Manager application. The file is located in the
NSI installation folder:
installation directory\Distributables\Ricoh ESA\RicohDeviceManager.exe
For example:
C:\Program Files\NSi\AutoStore Workflow 6\Distributables\Ricoh ESA\Ricoh ESA
\RicohDeviceManager.exe
installation directory\Distributables\Ricoh ESA\RicohDeviceManager.exe
1036
For example:
C:\Program Files\NSi\AutoStore Workflow 6\Distributables\Ricoh ESA\Ricoh ESA
\RicohDeviceManager.exe
1. Start in the Ricoh device control panel.
2. Press the User Tools/Counter/Inquiry hard button on the Ricoh Device control panel.
3. Press Extended Feature Settings to show the Extended Feature Settings Menu.
4. Press Extended Feature Settings to show the Extended Feature Settings screen.
5. Select the Startup Settings tab to show the active applications.
6. Select the AutoStore application.
7. Press the Execute button to stop AutoStore.
8. Select the Uninstall tab to show the installed applications.
9. Scroll down to the AutoStore option and select it to show the Extended feature settings screen.
10. Press OK.
11. Press OK to complete the uninstallation.
Configuring the Ricoh ESA component
Menu tab
Use this tab to add, edit, or remove the groups, menus, and forms.
Option
Description
Add Group
Add Menu
Click this button to add a menu.
Add Form
To add a form, click this button and then click the type of
form that you want to add.
Basic Form
Email Form
SharePoint Form
Smarticket Form
Edit

Remove

Group options
Field Name
Description
Name

does not appear on the desktop and it is used strictly as
logical group name. This component is equipped with
a default group called Common Group. You may add
Menu and Form to the Common Group.
Root Menu Title

device display.
1037
Field Name
Description
Enable this option to apply authentication settings to the

Group.
Update menus on startup
If your environment does not use the Ricoh Unified

Client, enable the option to update menus on devices on
startup. Enter Administrator User Name and Password
and intervals when updates are made.
Note: If your environment uses the Ricoh

Unified Client, the option does not appear on
the dialog box.
Device List
Click Add to enter either a valid Ricoh ESA IP address/

Host Name. (Click Ping Address to check the validity
of the IP address/Host Name.) Click Edit to edit a IP
Address/Host Name. Click Remove to delete an MFP
device. Click Import to load a CSV file containing
Device IP addresses/Host Names. Click Export to export
a CSV file containing Device IP addresses/Host Names.
Menu options
Add a menu to create a hierarchy. The menu entry will simply guide the desktop users to select the desired workflow.
Field Name
Description
Name
Icon file
Browse to the folder location that contains the icon to be

displayed on the MFP device panel for this menu entry.
The images supported are Windows BMP images with 2
or 256 colors. The maximum image size should be 260
pixels wide by 85 pixels tall. The recommended image
size is 48x48. For 256 color images, the transparency
color is RGB (255,0,255)
Restrict access
Select this check box to restrict access to the form to

certain users or groups.
Note: when the authentication type is Windows you can
use the browse button (...) to select Windows groups or
users.
type:
Windows: Determined by the Windows groups that

authenticated user is a member of.
Netware: Groups are not supported.
The User Membership custom script can be created to

provide the groups that authenticated user is a member
of.
Forms
Basic form
Add a basic form when your workflow requires capture of index data. To add a basic form, fill out the following three
tabs:
General tab
Scan Settings tab
1038
Components tab
General tab
Option
Description
Form name
The name of the form to be displayed on the Ricoh MFP.
Icon file

Restrict access
If this check box is selected, access to the form can

be restricted to certain users or groups. When the
authentication type is Windows you can use the browse
button (...) to select Windows groups or users. Group
membership is determined by the authentication type:

the authenticated user is a member of.
Netware: Groups are not support.

provide the groups of which an authenticated user is a
member.
VBScript file
Enter the VB Script file name for loading/validating the

index data on the devices.
Run on form load
If this check box is selected, the provided script file will

be executed on the server prior to loading the form on
the MFP device.
Run on scan
If this check box is selected, the provided script file will

be executed on the server prior to starting the scan job on
the device.
Forms fields
Add fields by clicking on the New field button appearing

NameField name is a string type and can be any

alphanumeric characters. Use of special characters
(~,&, <, >, %, , /, \, :, ?, |) are not recommended.
Boolean
Button
Date/Time
Label
Number
String
String list
Database lookup
1039
Option
Description
Folder browse
RequiredCheck this box if the field is

CommentDescription field for administrator
reference. This field is not currently used anywhere
on the device.
PropertiesSet the field attributes by selecting the
Properties button on the rightmost column on each
entry.
Scan Settings tab

Option
File type
Description
Specifies the scan file type.
JPEGJPEG image
MTIFFMulti-page TIFF image file
PDFPDF document
TIFFSingle page TIFF image file
File name
Enter the file name for the scanned document.
Resolution
Select the desired scanning resolution.
Scan Type

Scan source
B & W: Text / Line ArtSelect this option to scan

BW text documents which may contain simple line
art.
B & W: Text / PhotoSelect this option to scan BW
documents that contain a mix of graphics, photos and
text.
Black & White: TextSelect this option to scan
BW documents that you are looking to be OCR'ed
into text.
Black & White: PhotoSelect this option to scan
BW documents that contains graphics and photos
GrayscaleSelect this option to scan documents in
Grayscale.
Full Color: Glossy PhotoSelect this option to scan
Color documents that contain graphics and photos.
Full Color: Text / PhotoSelect this option to scan
color documents that contain a mix of graphics,
photos and text
Auto Color Select (7.x and above)Select this
option to scan based on the colors in the document.
Specifies the source for the scan.
Auto DetectSelect this option to automatically

detect whether the document is on the glass or in the
document feeder.
1040
Option
Description
Feed type
Choose the feed orientation used for scanning:
Scan sides
Left (Readable Direction)Specifies that

documents are scanned the same direction that they
are read.
Right (Unreadable Direction)Specifies that
documents are scanned orthogonally to the direction
that they are read.
If supported by the device hardware, this option

determines if the back side of a document placed in the
document feeder should also be scanned.
Scan size
SADFSelect this option when the scan job will

contain multiple batches to be placed in document
feeder. Scanning is automatically resumed once the
next batch is placed in the document feeder.
BatchSelect this option when the scan job will
contain multiple batches to be either placed on the
glass or on the document feeder.
1 SidedScans only one side of the original

2 SidedTop to TopWhen scanning the second
side, image will be created by supposing that the
second side is in the same direction as the first
2 SidedTop to BottomWhen scanning the
second side, image will be created by supposing that
the second side is in the opposite direction as the
first.
Auto Detect: Same Size, Auto Detect: Mixed Sizes,

A3, B4 JIS, A4 LEF, A4 SEF, B5 JIS LEF, B5 JIS SEF,
A5 LEF, A5 SEF, 11x17, 8.5x14, 8.5x13, 8.5x11 LEF,
8.5x11 SEF, 5.5x8.5 LEF, 5.5x8.5 SEF.
Note: LEF refers to Long Edge Feed and SEF
refers to Short Edge Feed. These terms describe
the manner in which the documents are fed into
the MFP.
Note: The Auto Detect option is not supported
for MP C300/400SR devices. The appropriate
paper scan size must be selected. It is
recommended that the Allow user to change
default option for Scan size be turned off for
MP C300/400SR devices.
Scan density
Move the slider to the right to increase scan density or to

the left to decrease scan density. Characteristics due to
the type of paper such as nonwhiteness like newspaper
or transparent originals can be reduced by adjusting the
scanning density. The default setting is the middle of 9
adjustment levels.
Allow user to change
Select this check box next to an option to allow the user

to change the specified setting on the device panel at
scan time.
1041
Components tab
List of all process components and the route component, along with their description, type, and the configuration
button to set their configuration attributes. The configuration button appears as a browse button (...) in the last column
of each row.
Select a component by clicking the left-most column next to each component and configure the component for this
form by clicking on the Configure button (right-most column on each row).
Email form
Add an email form when your workflow requires a document to be sent to an email destination. To successfully
configure the Send to Email form, you must completely enter required information on the three tabs:
General tab
Scan Setting tab
Fields tab
Components tab
General tab
Field Name
Description
Form name
The name of the email form to be displayed on the Ricoh

MFP.
Icon file

Restrict access
Select this option to restrict access to the form to certain

users or groups. Note: When Windows authentication
is used, you can click the browse button (...) to select
Windows groups or users. Group membership is
determined by the authentication type:
Windows: Determined by an authenticated user's

membership in Windows groups.

of.
To field
In the Display as box, type the label for the To field. The
default is To.
Show From field
Select to display the From field of the email. In Display

as box, type the label for the From field. The default is
From.
Show CC field
Select to display the CC field of the email. In the

Display as box, type the label for the CC field. The
default is Cc.
1042
Field Name
Description
Show BCC field
Select to display the BCC field of the email. In the

Display as box, type the label for the BCC field. The
default is Bcc.
Subject field
In the Display as box, type the label for the Subject

field. The default is Subject.
Show Message field
Select to display the Message field of the email. In the

Display as box, type the label for the Message field. The
default is Message.
Email address entries
Select Allow user to add email address entries to allow

users to add email addresses. Click the Search options
button to configure how users search for addresses.
Global address list
Allows the user to search the global address list for

fields. In the Display as box, type the label for this
search option. Note that the global address list that will
be searched is defined by the following criteria:
If Windows authentication is used, then the search

will be performed on the global address list
associated to the device for the user logon.
If there is no logged on user, then the search will be
performed on the global address list that is associated
with the service account for the service.
Regardless of which global address list is used, the

Exchange contacts (Requires Windows
authentication)
Select this check box to allow users to search their

In the Display as box, type the label that users see for
this search option.
In the Server box, type the IP address or host
name of the Exchange Server. Contact your system
administrator if you are uncertain of the correct
address.
Note: If a secure socket layer (SSL) connection
should be used to connect to the Exchange
Server, select the Use SSL check box.
LDAP

CC and BCC fields.
In the Display as box, type the label that users see for
this search option.
In the LDAP Server box, type the IP address or host
In the Root directory box, type the distinguished
name for the node where the search should start. For
example: DC=Sales,DC=MyCompany,DC=com. If
1043
Field Name
Description
this field is left empty then the starting point of the

search will be the root of the directory tree. Click
Find root to browse for the node.
Select the Anonymous check box to establish an
anonymous connection to the LDAP server.
Alternatively, enter logon credentials to log in to
the LDAP server with the specified Username and
Password.
will be used.
In the Name attribute box, enter the name of the
LDAP attribute that represents the name of the user.
In the Email attribute box, enter the name of the
LDAP attribute that represent the email address of
the user.
Scan Settings tab

Field Name
Scan Setting
Description
File type In this list, click the file type for the
scanned document:
JPEGJPEG image
PDFPDF document
File name: Enter the file name for the scanned
document.
Resolution: Select the desired scanning resolution.
Scan type: Allows you to select from a list of
document type to get the optimum scanner setting for
proper documents:
B & W: Text / Line ArtSelect this option

to scan BW text documents which may contain
simple line art.
Black & White: PhotoSelect this option to
scan BW documents that contain photos.
Black & White: TextSelect this option to
scan BW documents that you are looking to be
OCR'ed into text.
scan BW documents that contains graphics and
photos
GrayscaleSelect this option to scan
documents in Grayscale.
Full Color: Glossy PhotoSelect this option to
scan Color documents that contain graphics and
photos.
1044
Field Name
Description
Full Color: Text / PhotoSelect this option
to scan color documents that contain a mix of
graphics, photos and text
Auto Color Select (7.x and above)Select
this option to scan based on the colors in the
document.
Scan Source:

detect whether the document is on the glass or in
the document feeder.
SADFSelect this option when the scan job
will contain multiple batches to be placed in
document feeder. Scanning is automatically
resumed once the next batch is placed in the
document feeder.
Feed type: This option specifies placement of the
original document.
Left (Readable Direction)Select this mode

when the original orientation is the same as the
copy paper orientation.
Right (Unreadable Direction)Select this
mode when you want to copy A3, B4 JIS or 11
17 size originals. The machine rotates the copy
image by 90 percent.
Scan Sides: If supported by the device hardware,
this option determines if the back side of a document
placed in the document feeder should also be
scanned.

2 Sided - Top to TopWhen scanning the
second side, image will be created by supposing
that the second side is in the same direction as the
first
2 Sided - Top to BottomWhen scanning the
that the second side is in the opposite direction as
the first.
Scan SizeAuto Detect: Same Size, Auto Detect:
Mixed Sizes, A3, B4 JIS, A4 LEF, A4 SEF, B5 JIS
LEF, B5 JIS SEF, A5 LEF, A5 SEF, 11x17, 8.5x14,
8.5x13, 8.5x11 LEF, 8.5x11 SEF, 5.5x8.5 LEF,
5.5x8.5 SEF
Note: LEF refers to Long Edge Feed and

SEF refers to Short Edge Feed. These terms
describe the manner in which the documents
are feed into the MFP.
Note: The Auto Detect option is not a
supported scan size for MP C300/400SR
1045
Field Name
Description
devices. The appropriate paper scan size

must be selected. We recommend that the
Allow user to change default option for
Scan Size be turned off for MP C300/400SR
devices.
Scan density: Select the level of shadow and
brightness details recorded by the scanner from lower
to higher density.
Allow user to change: Select this check box for any
option to allow the user to change a setting on the
device panel at scan time.
Fields tab
Field Name
Description
VBScript file

Run on form load
Select this check box to execute the script file on the

server prior to loading the form on the MFP device.
Run on scan

server prior to starting the scan job on the device.
Forms Fields
Add fields by clicking the N (New Field) button at the

top of the first column in the field table. After you add
the first row, you can press the Tab key to tab through
columns and add additional fields.

(~,&, <, >, %, , /, \, :, ?, |) is not recommended.
Boolean
Button
Date/Time
Label
Number
String
String list
Database lookup
Folder browse
RequiredCheck this box if the field is

on the device.
properties (...) button on the rightmost column on
each entry.
1046
Components tab
button to set their configuration attributes. The configuration button appears as a browse button (...) at the last column
of each row.
SharePoint form
A SharePoint form enables users to browse and scan directly into a Microsoft SharePoint document library.
Important: To use these features, SharePoint 2007 and SharePoint 2010 AutoStore components must be
installed. The SharePoint 2007 route component is installed by default with AutoStore (if the administrator
does not clear the option during installation). The SharePoint 2010 component is available as an add-in
component. Both of these route components must be configured prior to creating a SharePoint form.
When you add a SharePoint form, configure settings on the three tabs of the SharePoint Form dialog box:
General tab
Scan Setting tab
Components tab
General tab
Field Name
Description
Form name
The name of the email form to be displayed on the Ricoh

MFP.
Icon file
Click the browse button (...) to specify the icon to be

Restrict access
Select this check box to restrict access to the form

to certain users or groups. When the authentication
type is Windows you can use the browse button (...) to
select Windows groups or users. Group membership is
determined by the authentication type:

Netware: Groups are not support.

of.
Server Version
Select one of the following:
SharePoint 2007
1047
Field Name
Description
Server address
Type the path to the SharePoint 2007 or SharePoint

2010 server where you will be storing the documents.
This field can contain "http://" or "https://" followed
by the server name or IP address. For example, both
http://sp2007 or https://192.199.292.255 will work.
The field can also contain only the server address,
e.g. sp2007. In this instance, the component will
automatically insert "http://" before the server address.
User name/password
In User name, type the user name which will be used

to log in to the server. If you are using a domain user
account to connect to SharePoint 2007 or SharePoint
2010, type the user name with the domain name. For
example, enter DOMAIN\SpUser. Local server users
only need to enter the user name, for example, SpUser.
In Password, type the user password that will be used to
log on to the server.
If Use the authenticated user credentials is selected

and authentication has been enabled, then user
credentials entered at the MFP device panel will also
be used to log on to the SharePoint Server. The feature
requires Windows authentication.
Site
In Site, enter the name of the SharePoint site where you

want to store the documents. This can be done either
manually or by selecting a value from the drop-down
list. You can specify a sub-site of the site by entering
its name after the parent site name followed by "/", for
example, SubSite1/SubSite1_1. Select the Allow user to
change check box to permit users to change the site on
the device.
Document library
In Document library, enter the name of the default

document library to where you want to send the
documents. This can be done either manually or by
selecting a value from the drop-down list. Select the
Allow user to change check box to permit users to
change the document library on the device. This check
box cannot be cleared if Allow user to change is
selected for the Site.
Content type
In Content type, enter the name of the default content

type to associate to the document. This can be done
either manually or by selecting a value from the dropdown list. Note that the user will only be able to select a
content type at the device panel if there is more than one
content type assigned to the selected document library;
otherwise the content type is assigned automatically.
Select the Allow user to change check box to permit
users to change the content type on the device. This
check box cannot be cleared if Allow user to change is
selected for the Site.
Default folder
In the Default folder box, enter the name of the default

folder where the routed files will be stored, this can
be done either manually or by browsing to the desired
1048
Field Name
Description
folder. Click the browse button (...) to open the Select
Folder dialog box. Select the Allow user to change
check box to permit users to change the folder on the
device. This check box cannot be cleared if Allow user
to change is selected for the Site.
Scan Settings tab

Field Name
Scan Setting
Description
File type: Choose the file type for the scanned

document.
JPEGJPEG image
PDFPDF document
File name: Type the file name for the scanned
document.
Scan type: Allows you to select from a list of
proper documents:
B & W: Text / Line ArtSelect this option to

scan BW text documents which may contain
simple line art.
B & W: Text / PhotoSelect this option to scan
BW documents that contain a mix of graphics,
photos and text.
into text.
photos
GrayscaleSelect this option to scan documents
in Grayscale.
photos.
document.
Scan source

1049
Field Name
Description
feeder. Scanning is automatically resumed once

the next batch is placed in the document feeder.
original document.
mode when you want to copy A3, B4 JIS or 11
17 size originals. The machine rotates the copy
image by 90 percent.
scanned.

first
the first.
8.5x13, 8.5x11 LEF, 8.5x11 SEF, 5.5x8.5 LEF,
5.5x8.5 SEF

must be selected. It is recommended that the
devices.
to higher density.
1050
Components tab
button to set their configuration attributes. The configuration button appears at the last column within each row with
"... appearing on it.
Smarticket form
Add a Smarticket form when your workflow requires Smarticket processing.
To add a Smarticket form, configure options on the following four tabs:
General tab
Scan Settings tab
Fields tab
Components tab
General tab
Field Name
Description
Form name
The name of the Smarticket form to be displayed on the

Ricoh MFP.
Icon file
Click the browse button (...) to specify the icon to be

Restrict access
If this option is checked, access to the form can be

restricted to certain users or groups.
Note: When the authentication type is
Windows you can click the browse button (...) to
type:

The User Membership custom script can be created

to provide groups in which an authenticated user has
membership.
Server address
Specifies the server name or IP address and port of the

Web Service address.
The format is http :// server_name : port or http
:// ip_address : port .
If Secure Sockets Layer (SSL)is enabled, the required
format is https :// server_name : port or https
:// ip_address : port .
1051
Field Name
Description
For example, either "https:://sp2007" or
"https://192.199.292.255" will work if the IP address for
the server is 192.199.292.255 and SSL is enabled. If you
only specify a the server address, such as "sp2007", the
component will automatically insert "http://" before the
address.
Click the Test button to confirm that the Server address
and User name entries are valid.
User name
In User name, enter the user name which will be used

to log in to the server. If you are using a domain user
account to connect to the server, enter the user name
with the domain name. For example, enter "DOMAIN
\SpUser". For a local user, you only need to enter the
user name, such as SpUser.
Use Windows authenticated user credentials
Select this check box to allow Windows user account

credentials entered at the MFP device panel to be used to
log on to the Smarticket server. If Use the authenticated
user credentials is selected and Windows authentication
has been enabled, then user credentials entered at the
MFP device panel will also be used to log onto the
Smarticket server.
Display ticket ID with ticket name
Select this check box to display the ticket ID along with

the ticket name for Smartickets listed on the form. Clear
this check box to display only the Smarticket name.
Scan Settings tab

Field Name
Scan Settings
Description
File Types
JPEGJPEG image
PDFPDF document
File Name: Enter the file name for the scanned
document.
Scan Type: Allows you to select from a list of
proper documents:
B & W: Text / Line ArtSelect this option to

scan BW text documents which may contain
simple line art.
B & W: Text / PhotoSelect this option to scan
BW documents that contain a mix of graphics,
photos and text.
into text.
1052
Field Name
Description

photos
GrayscaleSelect this option to scan documents
in Grayscale.
photos.
document.
Scan Source

feeder. Scanning is automatically resumed once
the next batch is placed in the document feeder.
original document.
mode when you want to copy A3, B4 JIS, or
11x17 size originals. The machine rotates the
copy image by 90 percent.
scanned.

first
the first.
1053
Field Name
Description
8.5x13, 8.5x11 LEF, 8.5x11 SEF, 5.5x8.5 LEF,
5.5x8.5 SEF

must be selected. It is recommended that the
devices.
to higher density.
Fields tab
Field Name
Description
VBScript file

Run on form load

server prior to loading the form on the MFP device.
Run on scan

server prior to starting the scan job on the device.
Forms Fields
Add fields by clicking the N (New Field) button at the

top of the first column in the field table. After you add
the first row, you can press the Tab key to tab through
columns and add additional fields.

(~,&, <, >, %, , /, \, :, ?, |) are not recommended.
Boolean
Button
Date/Time
Label
Number
String
String list
Database lookup
Folder browse
1054
Field Name
Description
RequiredSelect this check box if the field is

on the device.
properties (...) button on the rightmost column on
each entry.
Components tab
button to set their configuration attributes. The configuration button appears at the last column within each row with
... appearing on it.
Field types
Boolean field
Option
Description
Default value
The default value can be set to True or False.
True value
Set the value for a true condition.
False value
Set the value for the false condition.
Visible
Clear this check box to hide the field so that it does not
display on the device panel.
Enabled
Clear this check box to display the field in read-only

mode on the device panel.
Button field
A button field creates a button on the device panel.
Option
Description
Alignment
Align the button to the left, center or right.
Visible
Enabled

The Button field type can also be used for custom scripting. See Events for more information.
Database Lookup field
Option
Data source
Description
Select the desired data source. Note that only a system
data source can be selected as a data source. If no data
source was previously created, a new data source can
1055
Option
Description
be created by click the browse button (). If you create
a new data source, the Keep alive command will
continually ping the Data Source.
Login ID
Enter the Login ID for the Data Source. Entering a

value for this field is optional. If no entry is made, then
the user account running the AutoStore service will be
used.
Password
Enter the Password for the Login ID. If no entry is

made for Login ID, then the user account running the
AutoStore service will be used. Therefore, no password
will need to be entered.
Table
If Table is selected, then the name of the table can be

selected from the drop down menu.
Value column
For Value Column, the user must select the name of the
column from which values will be loaded into the lookup
list.
Display column
For Display Column, the user may select the name of

the column which will provide the names which will be
displayed in the lookup list. Note that the Value Column
is mandatory while Display Column is optional. If
nothing is entered for Display Column, those values
listed from the Value Column will be displayed.
Query
If Query is selected, then the user must enter a SQL

query. The SQL query will produce the results which
will populate the database lookup list. For more
information on SQL scripting syntax see General SQL
syntax.
Test
Click this button to test connection to a specified table on

the data source.
Allow multiple selection
If Allow multiple selection is selected, the user can

make multiple selections based on the results populated
within the database lookup list.
Visible
Enabled

General SQL syntax

A simple SQL query:
from <Table>
1056

select <ValueField>
from <Table>
from Customers
from Customers
SQL wildcard syntax is used with the like operator. The wildcard _ is used to specify a wildcard for one character.
The wildcard % is used to specify a wildcard for one or more character.
Workflow form.
RRT pattern takes the following format: ~RCH::%FieldName%~.
It is important to note that the % symbol used with RRT patterns does not function like the % symbol used for
entered by the user from the Workflow form.
Example:
from Customers
where Customer Name like ~RCH::%Customer%~
In this example, the AutoStore form has the RRT pattern patternFld. Once a user enters a value for
patternFld, then ~RCH::%patternFld%~ will get replaced with the value of patternFld.
If the user entered Johnson at the MFP for patternFld, the resulting query would be:
from Customers
1057
Note that RRT patterns within SQL select statements can be used with other SQL syntax such as wildcards. The
following would be a valid SQL statement:
from Customers
where Customer Name like %~RCH::%patternFld%~%
DateTime field
A date/time field allows users to enter times and dates.
Default Value: The default date value. The default date format can be relative to todays date in +-format (for
example, today defaults to todays date, today+1 is tomorrow, today-1 is yesterday.)
Format: Specify the desired format for this field. A valid format is composed of the following pattern letters.
Note: ll lower case and upper case characters not mentioned in the table below are reserved.
Letter
Date or Time
Presentation
Example
Era designator
Text
AD
Year
Year
1996; 96
Month in year
Month
July; Jul; 07
Week in year
Number
27
Week in month
Number
Day in year
Number
189
Day in month
Number
10
Day of week in month
Number
Day in week
Text
Tuesday: Tue
AM/PM marker
Text
PM
Hour in day (023)
Number
Hour in day (124)
Number
24
Hour in am/pm (011)
Number
Hour in am/pm (112)
Number
12
Minute in hour
Number
30
Second in minute
Number
55
Millisecond
Number
978
Time zone
General time zone
Pacific Standard Time;

PST; GMT-08:00
Time zone
RFC 822 time zone
-0800
Letters that are not quoted, from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the
components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents
a single quote. All other characters are not interpreted; they're simply copied into display date. Please refer to the
examples below.
1058
Pattern letters are usually repeated, as their number determines the exact final display, depending on the type of
presentation we have:
If the number of pattern letters is 4 or more, the full form
is used; otherwise a short or abbreviated form is used if
available.
Text
Number
The number of pattern letters is the minimum number

of digits, and shorter numbers are zero-padded to this
amount.
If the number of pattern letters is 2, the year is truncated
to 2 digits; otherwise it is interpreted as a number.
Year
Month
If the number of pattern letters is 3 or more, the month

is interpreted as text; otherwise, it is interpreted as a
number.
General time zone
Time zones are interpreted as text if they have names.

For time zones representing a GMT offset value, the
following syntax is used:
GMTOffsetTimeZone:
GMT Sign Hours : Minutes
Sign: one of + or Hours: Digit or Digit Digit
Minutes: Digit Digit
Digit: one of 0 1 2 3 4 5 6 7 8 9
Hours must be between 0 and 23, and Minutes must
be between 00 and 59. Digits
RFC 822 time zone: For formatting, the RFC 822 4digit time zone format is used:
RFC822TimeZone: Sign TwoDigitHours Minutes
TwoDigitHours: Digit Digit
TwoDigitHours must be between 00 and 23.
Examples
The following examples show how date and time patterns are interpreted if the device is set to English. The given date
and time are 2001-07-04 12:08:56 local time in the U.S. PCT zone.
Date & Time Pattern
Result
yyyy.MM.dd G 'at' HH:mm:ss z
2001.07.04 AD at 12:08:56 PDT
EEE, MMM d, ''yy
Wed, Jul 4, '01
h:mm a
12:08 PM
hh 'o''clock' a, zzzz
12 o'clock PM, Pacific Daylight Time
K:mm a, z
0:08 PM, PDT
"yyyyy.MMMMM.dd GGG hh:mm aaa"
02001.July.04 AD 12:08 PM
"EEE, d MMM yyyy HH:mm:ss Z"
Wed, 4 Jul 2001 12:08:56 -0700
"yyMMddHHmmssZ"
010704120856-0700
Visible: Clear this check box to hide the field so that it does not display on the device panel.
1059
Enabled: Clear this check box to display the field in read-only mode on the device panel.
Custom date and time format strings
Custom date and time format strings format dates in Date/Time fields.
Format: Specify the desired format for this field. A valid format is composed of the following pattern letters.
Note: All lower case and upper case characters not mentioned in the table below are reserved.
Description
%a
%A
Full weekday name
%b
%B
Full month name
%C
Century number
%d
The day of the month (0031)
%e
The day of the month (031)
%H
Hour (0023)
%I
Hour (0112)
%j
Day of the year (000366)
%k
Hour (023)
%l
hour (112)
%m
month (0112)
%M
minute (0059)
%n
a newline character
%p
PM or AM
%P
pm or am
%S
second (0059)
%s

00:00:00 UTC)
%t
a tab character
%U, %W, %V
the week number
%u
the day of the week (17, 1 = SUN)
%y
year without the century (0099)
%Y
year including the century (for example 1979)
%%
Folder Browse field

A folder browse field allows users to select documents in a selected folder.
Option
Root
Description
Specifies the root folder for the field.
1060
Option
Description
To select a specific folder on the device, the user must
select from the starting folder path and then continue
to select the folders until the target folder is reached.
For example, if the target folder path is C:\install
\folder1\folder2 and the field is configured with
the folder path of C:\install, then the folder path
displayed on device will start at C:\install. The user
may continue further down the folder path by selecting
on device folder1 and pressing OK, and then selecting
folder2 and selecting OK.
Visible
Select this check box to display the field in the device

panel. Clear this check box to hide the field so that it
does not display on the device panel.
Enabled
Select this check box to allow the user to edit the field
value. Clear this check box to display the field in readonly mode on the device panel.
Label field
Option
Description
Text
Enter the text that will be displayed
Font size
Select the font size for the label
Visible
Enabled

Number field
An numer field allows users to enter numbers
Option
Description
Default Value
Enter the default value for the number
Min Value
Enter the minimum value for the number
Max Value
Enter the maximum value for the number
Visible
Enabled

String field
A string field allows users to a string of text.
Field Name
Description
Default value
Type the default value for the string.
Maximum characters
Type the maximum number of characters allowed for the

string.
1061
Field Name
Description
Visible
Enabled

Obscured Entry
Select this check box to obscure the user entry replacing

characters entered by the user with asterisks (*).
String List field

A string list field allows users to select from items in a list.
Option
Description
Add
Add values to the string list.You can also click the N

button at the top of the first column, or press the Tab key
to tab through the last row in the list.
Remove
Remove a selected value from the string list.
Import
Select to import values from a file. The file must be a

CSV file.
Export
Select to export values to a file.The file must be a

CSV file with each row containing a label and value
(label,value).

entries.
Visible
Enabled

Preferences tab
In this tab, set the location where the server stores the program files for the job that is processing.
Option
Description
Home directory

related traffic. The server must have permission to write
to this directory.
Server address

Client, enter the IP address or server name of the
AutoStore server.

the Preferences tab.
Port number
Enter the port number used by the Ricoh component

to communicate with the MFP. The device must be
configured to use the same port number that is assigned
to the Ricoh component.
Tip: If the device is having problems
communicating with the server check the port
settings on the server to make sure it matches
1062
Option
Description
the device port number. Also make sure there
that there is no firewall blocking the specified
port.
Secure communication (SSL)
Select this check box to allow information exchange

between the server and the MFP device over an SSL
enabled secure channel.
Scan job transfer failure
In the Script file box, enter the path to the VBScript file
that contains the code to permit custom authentication.
For more information, see ScanJobTransferFailure
(ScanJobInfo) Event.
Keep
These options allow the workflow to retain processed or

rejected files.
Processed filesSelect this check box to store

processed files after the service successfully writes
them to the destination location. In the adjacent box,
specify the folder in which to store the files.
Warning: If this is option is enabled, a
successfully is saved in the Processed files
directory. Make sure that sufficient disk
space is allocated for the specified directory.
Rejected filesSelect this check box to store
rejected files that fail to reach the destination
location. In the adjacent box, specify the folder in
which to store the files.
There are many reasons for these failures. You can
research them by examining the server application
log file entries. It is recommended to have a
secondary process take this folder as an input and
notifies a system administrator of a failure.
Device manager

Client, use the Ricoh ESA Device Manger to view and
manage MFD client devices as follows:
AddClick to enter the IP address of the MFP. A

comment can be added for this specific MFP also.
RemoveClick to remove the MFP from the device
list.
EditClick to edit the IP address of comment for
the MFP.
ImportClick to import MFPs using a CSV file.
The entries are separated by a comma. The entries are
IP Address, Comment, Version, JavaTM Platform,
Status. IP Address is required while other entries are
optional.
ExportClick to export MFPs listed in the device
manager into a CSV file.
Update MenusClick to update AutoStore
Settings.
1063
Option
Description
RefreshClick to display the Java platform version

for the MFP. If AutoStore Xlet is installed, the
version of AutoStore Xlet will be displayed also.
InstallClick to install the AutoStore Xlet for the
selected Ricoh device.
UninstallClick to uninstall the AutoStore Xlet for
the selected Ricoh device.
StartClick to start AutoStore Xlet.
StopClick to stop AutoStore Xlet.
RebootClick to reboot the MFP.
Use SSLClick to enable remote options on
CAC enabled devices. You must select this prior to
attempting use a remote option.
Change PasswordClick to change remote
installation password on the MFP. Note that the
default password for new Ricoh devices is "ricoh".
Note also that for MFPs with Java 7.x or higher, the
remote installation password can be changed through
the web image monitor:
1. Log on to the web image monitor
2. Click Configuration.
3. Click Administrator Tools (can be found under
Extended Feature Settings).
4. Scroll to the bottom and click to change the
remote installation password
Enable external USB keyboard support
Select this check box to allow the user to use an external

keyboard at the device.
Note: USB keyboard detection is currently not
compatible with the CAC Java Platform.
Auto reset timer
Specifies the number of seconds of inactivity that will

cause a reset to the main screen. If authentication is
enabled the logged on user is automatically logged out.
External application
When integrating with an external third party java

application (for example, Equitrac), you can select this
check box to switch to the third party application from
within the AutoStore Xlet. This option is available on
devices that have Java Platform 4.x and above. If this
option is enabled, a button with the provided name will
be displayed on the AutoStore Xlet application to allow
the user to switch to the external application.
Product IDThe Ricoh assigned product ID (for

example, 34081794 is the Ricoh assigned product ID
for Equitrac) for the third party application can be
found in the extended feature info on the device or
web image monitor.
NameThe name of the external application that
will be displayed on the button within the AutoStore
Xlet.
1064
Option
Description
IconThe icon for the external application button.

The user should browse to the folder location that
contains the icon to be displayed on the MFP device
panel for this menu entry. The images supported are
Windows BMP images with 2 or 256 colors. The
recommended image size is 20x20. For 256 color
images, the transparency color is RGB (255,0,255).
Authentication tab
Setup the authentication attributes in this tab. The authentication server is running on the Ricoh ESA component of
workflow server.
Option
Description
Authentication Type
NoneServer authentication is not enabled.

WindowsProvides integration with Windows
NTLM authentication.
Active DirectoryProvides integration with
Windows Active Directory for user name and
password settings.
NetwareProvides integration with Novell
ScriptProvides the ability to create a custom script
authentication.
For information about configuring options for each of

these authentication types, see Authentication Types.
Domain name
This option specifies the domain name for Windows or

Active Directory authentication types.
NDS tree
This option specifies the NDS tree for the Netware

authentication type.
NDS context
This option specifies the NDS context for the Netware

Script file
This option specifies the script file for the Script

Authentication requires LDAP lookup
Select this check box to query the LDAP server after

successful authentication to retrieve the display name
and email address for the user. If the LDAP query fails
for the user, the authentication will fail.
Restricted Access User Membership
Provides the ability to create a custom script to return the

group memberships for the logged in user. User access is
determined by comparing groups returned by the script
with groups specified by the Restrict access option in
the form or menu definition. You can click the browse
button (...) to edit a new or existing script. For more
information, see GetUserMemberships event on page
1074.
1065
Authentication types
Authentication Type
None
Description
Server authentication is not enabled.
Unified Client, refer to the Device Registration
Service web Help for more information on
authentication.
If the device uses third-party authentication, you can
retrieve credentials for the logged in user by enabling
support as follows:
Card Authentication
Package (CAP):
1. Verify that a CAP

authentication solution
is installed on the
device.
2. Modify
<argument>s 127.0.0.1</
argument> in the
Xlet DALP file before
loading the Xlet to
<argument>s Autostore
Server
Address</
argument>
3. Add <argument>-a
cap</argument>
to the application
element in the DALP
file before loading the
Xlet.
Common Access
Card (CAC):
1. Verify that a Ricoh

CAC authentication
solution is installed on
the device.
2. Modify
<argument>s 127.0.0.1</
argument> in the
DALP file before
loading the Xlet to
<argument>s Autostore
Server
Address</
argument>
3. Create an empty file
named enable_aaa
(no file extension
or contents) and
place it in the /
1066
Authentication Type
Description
certificates/
conf directory of the
SD card.
4. Add <argument>-a
aaa</argument>
to the application
element in the DALP
file before loading the
Xlet.
Active Directory

name.
Netware

tree name.
Script
Script FileEnter the path to the VBScript file

that contains the code that handles the authentication
event.
See Authenticate Event.
LDAP tab
Enter the LDAP attributes on this tab.
Option
Description
LDAP Server
Specifies the LDAP server to use to authenticate users.
Root Directory
Enter the root search directory you want to begin

searching against. If this field is left blank, the search
starts at the LDAP default directory. Click Find Root to
locate the default root of the LDAP server.
The Ricoh ESA has been integrated with ADSI (Active
Directory Service Interface). With ADSI, Microsoft is
able to offer a COM-component for access to various
directory services. ADSI is a component of Windows
2000.
The structure of a directory service is hierarchic and
it can be seen as a directory tree: there is a root where
you can start from to other entries. The root can contain
containers (knots) and leaves. Containers themselves
can contain other entries while leaves mark the end
of a branch in a directory tree. Every entry in this
directory describes an object and has specific attributes.
Conceptually the root is the topmost entry in a LDAP
hierarchy. This can be illustrated with the Windows
file system: the hard disk C: is the root, the directories/
folders are the containers and the files are the leaves.
1067
Option
Description
Note: When the root is left blank, and you
press the Test button, the results may differ
from when you actually run the server with
Ricoh ESA component (equipped with
Authentication). A blank root uses the default
value, which is retrieved from the account that
you are logged into the machine as. However,
when you run the server, you are logged in as
LocalSystem (or whichever user name you
specify on the Service tab), possibly yielding
different results. For this reason, it is highly
recommended that you either supply the root or
login to the service with a user name/password
different than LocalSystem.
Credentials

AnonymousSelect this check box if you want to

log in to LDAP server as anonymous user without
providing user name and password.
Username/passwordEnter the username/
password to access the LDAP server.

Active DirectoryWith Windows Active

Directory authentication method, the user name
is matched against "samAccountName" field, the
Get Email From is matched against "mail" field,
and the Get Display Name From is matched against
"displayName" field.
eDirectoryWith Netware authentication method
against "uID" field, Get Email From matched against
"mail" field, and Get Display Name matched against
"cn" field.
1068
Option
Description

multiple types of Authentication. To customize the
values that you can define for the following:

Get Email From
Click Reset to blank out the above field values.

Test
To test the settings, click the Test button and enter a user
name as it will be entered on the MFP. This verifies that
an email address and display name can be found for the
user on the LDAP server.
VB scripting
The VB Script feature provides the ability to extend the functionally of otherwise static Forms by allowing custom
VB Scripts to be executed on the server at runtime to update form field values/settings and perform any necessary
Events
The following events are supported for Ricoh ESA scripting.
Event
Description
Authenticate event on page 1069
You can use this event to authenticate the user name and
password entered in the device logon dialog.
Button_OnClick event on page 1070
This event occurs when a button field on a form is

pressed.
FieldName event on page 1070

new value for a field on the form.
Field_OnChanged event on page 1071
This event occurs when a field value on the form has

changed.
Field_OnScan event on page 1071
This event occurs when a form is open and the device

start button is pressed and before device begins the scan
operation.
Form_OnLoad event on page 1072
This event occurs before a form is displayed on the

device panel.
CardLogin event on page 1072
This event occurs after a user successfully logs in.
CardLogout event on page 1073
This event occurs after a user logs out.
GetUserMemberships event on page 1074
This event occurs when a successful authentication has

occurred.
ScanJobTransferFailure event on page 1075
This event occurs when a scanned job fails to transfer to

the server.
Authenticate event
You can use this event to authenticate the user name and password entered in the device logon dialog.
Authenticate ( username , password , deviceaddress )
1069
Argument
Description
username
The user name entered in the login

dialog on the device panel.
password
The password entered in the login

dialog on the device panel.
deviceaddress
The IP address of the device that

triggered the authentication request.
Remarks
A false return value indicates a failed authentication request.
Example
Function Authenticate(UserName, Password, DeviceAddress)
If (UserName = "JohnD" And Password ="pass") Then
Authenticate = true
Else
Authenticate = false
End If
End Function
This event occurs when a button field on a form is pressed.
Button_OnClick ( form , buttonname )
Argument
Description
form
The form object.
buttonname
The name of the button field.
Remarks
You can use this event to perform tasks such as populating other form field values.
Example
Sub Button_OnClick(Form, ButtonName)
'Write custom code to lookup the user's home directory.
If (ButtonName = "MyButton") Then
Form.SetFieldValue "Path", LookupHomeDirectory(Form.UserName)
End If
End Sub
FieldName event
Form_OnLoad ( fieldname , fieldvalue )
1070
Argument
Description
fieldname

validation.
fieldvalue

validation.
Remarks
Example
Function Field_OnValidate(FieldName, FieldValue)
Field_OnValidate = ""
value
'for the Amount field that is less then 100.
End If
End If
End Function
Field_OnChanged event
This event occurs when a field value on the form has changed.
Field_OnChanged ( form , fieldname , fieldvalue )
Argument
Description
form
The form object.
fieldname
fieldvalue
Remarks
Example
Sub Field_OnChanged(Form, FieldName, FieldValue)
'Write custom code to lookup the users home directory.
If (FieldName = "UserName") Then
Form.SetFieldValue "Path", LookupHomeDirectory(FieldValue)
End If
End Sub
Field_OnScan event
This event occurs when a form is open and the device start button is pressed and before device begins the scan
operation.
Field_OnScan ( form )
1071
Argument
Description
The form object from which the scan
was initiated.
form
Remarks
You can use this event to perform tasks such as populating or validating the form fields. If the return value is an
empty string then validation is assumed to have been successful.
Example
Function Form_OnScan(Form)
If (Form.UserName = "") Then
Form_OnScan = "Unable to lookup the user's home directory"
Else
Write custom code to lookup the authenticated users home directory.
End If
End Function
Form_OnLoad event
Form_OnLoad ( form )
Argument
Description
form
Remarks
Example
Write custom code to lookup the authenticated users home directory.
End Sub
CardLogin event
This event occurs after a user successfully logs in.
This event is used by the script specified on the Authentication tab by the Restricted Access User Membership
option.
CardLogin (User, DeviceAddress)
Argument
Description
The authenticate user object.
User
DeviceAddress
The string value that is IP address of

the MFP device.
1072
Remarks
You can use this event to return the user and MFP device IP address after login.
Example
Function CardLogin(User, DeviceAddress)
CardLogin = "Debug Msg: " + User.Username + " (" + User.DoDEDI + ")
logged in to " + DeviceAddress
End Function
Properties
Username
Returns the authenticated user name.
Note:
When CAC authentication has been enabled, the following can be returned:
DoDEDI - the authenticated user's DOD EDI ID.

UserID - The user ID of the authenticated user.
DeviceAddress
Returns the IP address of the MFP device.
CardLogout event
This event occurs after a user logs out.
option.
CardLogout (User, DeviceAddress)
Argument
Description
User
DeviceAddress
The string value that is IP address of

the MFP device.
Remarks
You can use this event to return the user and MFP device IP address after logout.
Example
Function CardLogout(User, DeviceAddress)
CardLogout = "Debug Msg: " + User.Username + " (" + User.DoDEDI + ")
logged out of " + DeviceAddress
End Function
Properties
Username
1073
Note:

DeviceAddress
Returns the IP address of the MFP device.
GetUserMemberships event
This event occurs when a successful authentication has occurred.
option.
GetUserMemberships ( User )
Argument
User
Description
Remarks
You can use this event to authenticate the return the ACL group memberships for the logged in user. The return value
should be a semicolon separated list of users.
Examples
Function GetUserMemberships(User)
If (User.UserName = "JohnD") Then
GetUserMemberships = "Group1;Group2"
End If
End Function
To block access to either a menu or form, include code such as the following:
If (User.UserID = "99999") Then
GetUserMemberships = "authorized"
Else
GetUserMemberships = "notauthorized"
End If
End Function
Use the following script in order to view attributes from the CAC card. Run the script and view the attributes in the
Windows event log.
cnt = User.PropertyCount
Set shell = CreateObject("WScript.Shell")
For i = 0 To cnt - 1
shell.LogEvent 4, User.PropertyName(i)
shell.LogEvent 4, User.PropertyValue(i)
If (User.PropertyName(i) = "UPN") Then
If ( User.PropertyValue(i) = "2001393041@mil") Then
1074
GetUserMemberships = "approved"
Else
GetUserMemberships = "notapproved"
End If
End If
Next
End Function
By setting a value such as notauthorized, the user will be restricted from access to a menu or form where the entry
for Restrict Access is notauthorized. The Restrict Access entry is made on the General tab when configuring any
form or on the menu configuration page.
User Properties
UserName
EmailAddress
Returns the authenticated email address if it is available for a user.
UserID
Returns the authenticated user ID if it is available for a user.
Note:
AuthType - The authentication type for the authenicated user.

DisplayName - The display name of the authenticated user.
Email - The email address of the authenticated user.
FirstName - The first name of the authenicated user.
LastName - The last name of the authenicated user.
MiddleName - The middle name of the authenicated user.
Status - The status for the authenicated user.
UPN - The UPN for the authenicated user.
ScanJobTransferFailure event
This event occurs when a scanned job fails to transfer to the server.
This Scan Job Transfer Failure option in the Ricoh ESA preferences provides the ability to create a custom
notification when a scanned job does not transfer from the device to the server. Scanned job transfers can fail if
the device loses network connectivity or if the scanned job is too large and the network bandwidth is limited. Once
network connectivity is restored, if the scanned job still fails to be transmitted, the scan data associated with the failed
job is transferred to the server for proper notification handling.
ScanJobTransferFailure ( ScanJobInfo )
Argument
ScanJobInfo
Description
The object containing the failed
scanned job data.
Remarks
This event can be used to notify the user or administrator when a scanned job fails to be transferred to the server for
processing.
1075
Example
Sub ScanJobTransferFailure (ScanJobInfo)
ScanJobInfo.StatusMsg "Date: " + CStr(ScanJobInfo.Date)
ScanJobInfo.StatusMsg "Time: " + CStr(ScanJobInfo.Time)
ScanJobInfo.StatusMsg "Time24Hour: " + CStr(ScanJobInfo.Time24Hour)
ScanJobInfo.StatusMsg "Username: " + ScanJobInfo.UserName
ScanJobInfo.StatusMsg "Email address: " + ScanJobInfo.EmailAddress
ScanJobInfo.StatusMsg "DeviceAddress: " + ScanJobInfo.DeviceAddress
ScanJobInfo.StatusMsg "Page Count: " + CStr(ScanJobInfo.PageCount)
Set Form = ScanJobInfo.Form
ScanJobInfo.StatusMsg "Form Name: " + Form.Name
ScanJobInfo.StatusMsg "Form ID: " + Form.ID
For i = 0 to Form.FieldCount-1
Set Field = Form.GetField(i)
ScanJobInfo.StatusMsg "Field:" + Field.Name + " = " + Field.Value
Next
End Sub
ScanJobInfo Properties
Date
The date of the scanned job.
Time
The time of the scanned job in am/pm format.
Time24Hour
The time of the scanned job in 24 hour format.
EmailAddress
If available, returns the authenticated users email address.
Username
If available, returns the authenticated users username.
DeviceAddress
The IP address of the device.
PageCount
The number of pages scanned.
Form
The form that was selected and scanned to.
Form Properties
Name
The name of the form associated with the failed scanned job.
ID
The GUID of the form associated with the failed scanned job.
Form Methods
GetField ( Index )
1076
Argument
Description
The zero based index of the form
field.
Index
Return value
Returns the form field.
Field Properties
Name
The name of a field.
Value
The value of a field.
Form object
Properties
DeviceAddressReturns the device IP address.
DoDEDIReturns the CAC authenticated user's DOD EDI ID. This property is only available if CAC
authentication has been enabled for the device.
UserIDReturns the authenticated user ID. This property is only available if CAC or CAP authentication has been
UserNameReturns the authenticated users account name. This property is only available if authentication has
been enabled for the device.
EMailAddressReturns the authenticated users email address. This property is only available if authentication has
been enabled for the device.
AuthTypeThe authentication type for the authenicated user if the device is CAC enabled.
DisplayNameThe display name of the authenticated user if authentication is enabled on the component preference
tab.
EmailThe email address of the authenticated user if authentication is enabled on the component preference tab.
FirstNameThe first name of the authenicated user if the device is CAC enabled.
LastNameThe last name of the authenicated user if the device is CAC enabled.
MiddleNameThe middle name of the authenicated user if the device is CAC enabled.
StatusThe status for the authenicated user if the device is CAC enabled.
UPNThe UPN for the authenicated user if the device is CAC enabled.
UserIDThe user ID of the authenticated user if the device is CAC or CAP enabled.
Methods
The following methods are supported for Ricoh ESA scripting.
Method
Description
GetFieldValue method on page 1078
This method returns the value of a form field.
SetFieldEnabled method on page 1078
This method determines whether a field is enabled.
SetFieldValue method on page 1078
This method sets the value of a form field.
SetFieldVisible method on page 1078
This method determins whether a field is visible or

hidden.
SetScanAttributes method on page 1079
This method sets the scan settings for a form.
1077
Method
Description
UpdateBooleanField method on page 1079
This method updates the definition of a Boolean field.
UpdateDateField method on page 1080
This method updates the definition of a date field.
UpdateFolderBrowseField method on page 1080
This method updates the definition of a Folder Browse

field.
UpdateLabelField method on page 1080
This method updates the definition of a Label field.
UpdateListField method on page 1080
This method updates the definition of a list field.
UpdateNumberField method on page 1081
This method updates the definition of a Number field.
UpdateStringField method on page 1081
This method updates the definition of a String field.
string GetFieldValue ( FieldName )
Argument
Description
FieldName
Return Value
A string expression representing the value of the field.

Note: The return value for the String list type is the label of the selected entry.
SetFieldEnabled method
This method determines whether a field is enabled.
SetFieldEnabled ( FieldName , Enabled )
Argument
Description
FieldName
Enabled
A Boolean value indicating whether

the field is enabled
SetFieldValue ( FieldName , FieldValue )
Argument
Description
FieldName
FieldValue
SetFieldVisible method
This method determins whether a field is visible or hidden.
SetFieldVisible ( FieldName , Visible )
Argument
FieldName
Description
1078
Argument
Description
the field is visible or hidden.
Visible
SetScanAttributes method
SetScanAttributes ( ScanType , ScanResolution , ScanSource , ScanSides )
Argument
ScanType
ScanResolution
ScanSource
ScanSides
Value
Setting
B & W: Text/Line Art
Black & White: Photo
B & W: Text/Photo
Black & White: Text
Gray Scale
Full Color: Text / Photo
Full Color: Glossy Photo
100
100 DPI
200
200 DPI
300
300 DPI
400
400 DPI
600
600 DPI
AutoDetect
SADF
Batch
1 Sided
2 Sided - Top to Top
2 Sided - Top to Bottom
UpdateBooleanField method
UpdateBooleanField ( FieldName , TrueValueName , FalseValueName , Required , Value )
Argument
Description
FieldName
The name of the field to update.
TrueValueName
A string value representing the true

value.
FalseValueName
A string value representing the false

value.
Required

the field requires a value or not.
Value
The default value of the field.
1079
The field must exist on the form definition.

UpdateDateField method
UpdateDateField ( FieldName , Format , Required , Value )
Argument
Description
FieldName
Format
The output format of the date field.

Refer to the documentation.
Required

Value
Remarks
UpdateFolderBrowseField method
This method updates the definition of a Folder Browse field.
UpdateFolderBrowseField ( FieldName , Root , Required )
Argument
Description
FieldName
Root
The root folder path.
Required

Remarks
UpdateLabelField method
This method updates the definition of a Label field.
UpdateLabelField ( FieldName , FontSize , Text )
Argument
Value
FieldName
FontSize
Description
Small size text in the label area.
Medium size text in the label area.
Large size text in the label area.

The text contained in the label area.
Text
Remarks
UpdateListField method
UpdateListField ( FieldName , Required , List , Value )
1080
Argument
Description
FieldName
Required

the field requires a value.
List
A semicolon separated list of list

choices. To support a choice where
the Label and Value are different,
use Label=Value syntax for each
semicolon separated entry.
Value
Remarks
UpdateNumberField method
This method updates the definition of a Number field.
UpdateNumberField ( FieldName , Min , Max , Required , Value )
Argument
Description
FieldName
Min
The minimum allowed value for the

field.
Max
The maximum allowed value for the

field.
Required

Value
Remarks
UpdateStringField method
UpdateStringField ( FieldName , MaxLength , Password , Required , Value )
Argument
Description
FieldName
MaxLength
The maximum number of characters

that can be typed in the field.
Password

the field value entry on device panel
should be obscured.
Required

Value
1081

Messages
StatusMsg
ErrorMsg
WarningMsg
TraceMsg
StatusMsg (Text)
Displays a status message in the status monitor
ErrorMsg (Text)
Displays an error message in the status monitor
WarningMsg (Text)
Displays a warning message in the status monitor
TraceMsg (Text)
Displays a debug message in the status monitor if the debug option has been turned on for the task
Ricoh ESA component RRTs
Component RRT ID
The RRT ID for this component is RCH.
Name
Description
AuthType
The authentication type for the authenicated user if the

device is CAC enabled.
DisplayName
The display name of the authenticated user if

authentication is enabled on the component preference
tab.
DoDEDI
The DOD EDI ID of the authenticated user if the device

is CAC enabled.
Domain
The domain of the authenticated user if authentication is

enabled on the component preference tab.
Email
The email address of the authenticated user if

authentication is enabled on the component preference
tab.
FileSize
Received file size.
FirstName
The first name of the authenicated user if the device is

CAC enabled.
Format
Valid file format is: Tiff.
1082
Name
Description
HostName
IPAddress
LastName
The last name of the authenicated user if the device is

CAC enabled.
MiddleName
The middle name of the authenicated user if the device is

CAC enabled.
PageCount
Number of pages received.
ScanDensity
The scanning density used for a scan.
ScanFileName
The file name for a scan.
ScanResolution
The resolution setting in dots per inch (DPI) used for

scanning.
ScanSides
1-sided or 2-sided original.
ScanSource
Specifies the source for a scan (Auto Detect, SADF, or

Batch).
ScanType
The scan type setting used for scanning.
Status
The status for the authenicated user if the device is CAC

enabled.
UPN
The UPN for the authenicated user if the device is CAC

enabled.
UserID
The user ID of the authenticated user if the device is

CAC or CAP enabled.
UserName
The user name of the authenticated user if authentication

is enabled on the component preference tab.

The RRT string ~RCH::%Client ID%~ is replaced by Company if the user types in Company for the field
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%c
Received file date time appropriate to locale
%d
1083
Name
Description
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%x
Received file date representation appropriate to the

locale
%X
Received file time representation appropriate to the

locale
%y
%Y
%z
Time zone name or abbreviation or empty if unknown
/
\
:
?
"
<
>
|
Use of the following characters is illegal within the Menu, Form, Group:
&
<
>
1084
RightFax Capture
Welcome to RightFax Capture
Use RightFax Capture component to capture new faxes that appear on a RightFax server and put them into the
workflow.
RightFax is a blocking component, which means that it requires configuring of other components that follow
RightFax Capture in the processing chain. The component also allows you to configure separate workflows for
received and sent faxes.
The component passes various information about the captured faxes to the subsequent components via RRTs.
The component works with RightFax Server versions 9.0, 9.3, 9.4, 10.0, 10.5, and 10.6. The RightFax client software
should be installed on the machine with Workflow Server for correct functioning of the component.
Getting started
Feature highlights
Capturing faxes from a RightFax server.

Different workflows for sent and received faxes.
Synchronization of multiple instances of the component working with the same server.
Pass various information about the captured faxes to the subsequent components via RRTs.
How to use RightFax Capture

This example procedure steps through capturing received faxes for all users, recognizing the faxes, and saving them
to a local folder.
1. Create a workflow with the RightFax Capture component, the OCR component and the Send to Folder route
component.
2. In the General tab of the RightFax Capture component configuration, set work directory for the faxes captured
from the server, processed and rejected files directories for the faxes captured from the server.
3. Select Capture received faxes option, For all users option and IsViewed flag in Received Faxes tab.
4. Configure other components.
5. Run the process.
The received faxes are captured, recognized and saved in the specified folder.
Configuring RightFax Capture
The RightFax Capture Configuration component configuration window consists of three tabs:
Tab
Description
General Tab
Use this tab to configure main parameters for connection

to RightFax server and for the captured faxes.
Received Faxes Tab
Use this tab to configure settings for received faxes.
Sent Faxes Tab
Use this tab to configure settings for the sent faxes.
General tab
Use this tab to configure main parameters for connection to RightFax server and for the captured faxes.
Option
Connection
Description
This group of settings contains main parameters for
connection to RightFax server.
1085
Option
Description
Server name
Enter the address of the RightFax server. It is mandatory

to fill out this text box.
User Name
Enter the user name to connect to the RightFax server.
User Password
Enter the password to connect to the RightFax server.
NT Authentication
Select this check box to use Windows Authentication for

connection to the RightFax server. In this case the User
Name and the User Password text boxes are disabled
and the current system account is used. If this check box
is not selected, it is mandatory to enter User Name and
User Password.
Note: For Windows authentication to work
correctly, you need to configure the Service
Manger. In the Log On tab of the Service
Manager, select This account, browse for your
domain name for Windows authentication and
enter the correct password.
Capture
This group of settings contains settings for captured files.
Work directory
Enter the path to the working directory where files will

be copied before processing. You can click
the path.
to select
Keep files
Select the options in this group to keep processed or

rejected files.
Processed
Enter the path to the directory where processed files will

be kept. You can click
Rejected
Enter the path to the directory where rejected files will

be kept. You can click
Synchronization
to select the path.

to select the path.
This group of settings allows you to specify the

parameters for synchronization of several instances of
the component that try to capture faxes from the same
box. Without synchronization, components could capture
faxes which were just captured by another instance of the
component.
The synchronization is performed by regulating access
to a table on an Microsoft SQL Server. Every act of
capturing a fax is preceded by locking the table and
followed, after the component processes the fax, by
unlocking it. If the table is already locked, which
means that another component is capturing faxes, the
component waits until it is unlocked.
It is recommended to use this option when you are using
multiple workflows with the component.
Note: The order of locking the specified SQL
Server table by different component instances
is arbitrary rather than First In, First Out. If
two instances of the component are waiting for
1086
Option
Description
a lock over the table, then either of these two
instances can be the first to obtain the lock.
With that said, it is recommended to specify
different synchronization tables for different fax
boxes on the RightFax server. This ensures that
each fax box is checked by the component on a
regular basis.
SQL Server
Enter the identifier for the SQL Server instance that

will be used for synchronization. This is typically in the
format hostname/instanceID for a named instance
of SQL Server.
Database
Enter database name.
Table
Enter name of the table.

Note: The specified table should not be a
system table of the RightFax server. It should
be a separate table created in the SQL Server
database to be used only for synchronization
purposes.
NT Authentication
Select this check box to use Windows Authentication to

connect to the instance of SQL Server. In this case the
User Id and Password text boxes are disabled and the
current system account is used. If this check box is not
selected, you must enter a User Id and Password for a
SQL Server account.
User Id
Enter user ID to connect to the specified instance of SQL

Server.
Note: For correct work of the synchronization,
the specified user ID should have the SELECT
permission on the specified table.
Password
Enter the password to connect to the instance of SQL

Server.
Received Faxes tab

Use this tab to configure settings for received faxes.
Option
Description
Capture received faxes
If this check box is selected, the component will capture

faxes received on the server.
For all users

received faxes for all users. Otherwise, the component
will capture only the faxes for the user that is specified
on the General tab.
Note: This option should be used only in the
case, when the user account specified in the
component configuration has got sufficient
rights to capture faxes from all users. If the
1087
Option
Description
account does not have enough rights, an error
will be generated.
Mark flags
This group of check boxes allows you to select fax flags.

After capturing a fax, the component marks it with the
selected flags. The tags serve as markers to indicate that
the fax has been captured. Faxes with any of the selected
flags are considered as already processed and are not
captured by the component.
Three types of flags are available:
IsViewed
IsPrinted
IsGenericFlag1On
Configuration
This tab displays the subsequent components in the

workflow. The components are displayed only if the
Capture received faxes check box is selected. You can
configure the workflow for received faxes.
Configure
Select a component in the list and click this button to

configure the selected component.
Sent Faxes tab

Use this tab to configure settings for the sent faxes.
Option
Description
Capture sent faxes

faxes sent from the server.
For all users

sent faxes for all users. Otherwise, the component will
capture only the faxes for the user that is specified on the
General tab.
Note: This option should be used only in the
case, when the user account specified in the
component configuration has got sufficient
rights to capture faxes from all users. If the
account does not have enough rights, an error
will be generated.
Mark flags
This group of check boxes allows you to select fax flags

that will be used as markers to indicate captured faxes.
Faxes with any of the selected flags are considered as
already processed. Three types of flags are available:
Configuration
IsViewed
IsPrinted
IsGenericFlag1On
This box displays subsequent components in the

workflow. The components are displayed only if the
Capture sent faxes check box is selected. You can
configure the workflow for sent faxes.
1088
Option
Description
Configure
Select a component in the list and click this button to

configure the selected component.
Component RRTs
Component RRT ID
The RRT ID for this component is RFC.
For each captured fax, the component generates the following RRTNs:
RRTN
Description
Sender Name
The name of the sender of the fax.
Sender Fax Number
The fax number of the sender of the fax.
Receiver Name
The name of the receiver of the fax.
AutoForwardCount
The number of times that the fax has been forwarded

using the AutoForward feature. This number is tracked
for each fax in order to prevent infinite forwarding
loops. By default the maximum number of allowed
AutoForward events is 5.
BFTFilename
The file name of the binary file transfer information

file if it exists. Binary file transfers have been replaced
by the fax image attachment, but this property remains
available for backwards compatibility.
BFTFileSize
The size of the binary file transfer information file if it

exists. Binary file transfers have been replaced by the fax
image attachment, but this property remains available for
backwards compatibility.
BillingCode1
The Billing Code 1 field.
CoverSheetSizeInBytes
The size of the fax cover sheet in bytes.
FaxDisposition
An integer that indicates the disposition of the fax.

This property has been replaced by information in the
FaxStatus property, but remains available for backwards
compatibility.
FaxErrorCode
The Fax error code.
FaxFilename
The name of the image file associated with the incoming

fax. The image file is stored in the image folder on the
fax server.
FaxID
ID assigned to the fax by the fax hardware when the fax

is scheduled to be sent.
FaxPagesInFront
The number of fax pages in the queue preceding the

current fax.
FaxRecordDateTime%Year
The year the fax was created.
FaxRecordDateTime%Month
The month the fax was created.
1089
RRTN
Description
FaxRecordDateTime%Day
The day the fax was created.
FaxRecordDateTime%Hour
The hour the fax was created.
FaxRecordDateTime%Minute
The minute the fax was created.
FaxRecordDateTime%Second
The second the fax was created.
FaxStatus
The status of the fax.
FaxTerminationStatus
An integer indicating the termination status of the fax.
FCSFilename
The name of the fax cover sheet image in the server's

image folder.
FromFaxNumber
Sender's personal fax number.
FromGeneralFaxNumber
Sender's general fax number.
FromGeneralVoiceNumber
Sender's general voice telephone number.
FromName
Sender's name.
FromVoiceNumber
Sender's personal voice telephone number.
GenerateCompletionEvent
Specifies whether or not to generate a completion event

once the fax has been sent.
Handle
The handle is used internally by the RightFax system

to identify each unique object. If you specify a value
without specifying a property name, the system will
assign that value as the object Handle.
HasBFT
Indicates whether or not the fax will use binary file

transfer. The property returns True if the fax has BFT;
it returns False if it does not. Binary file transfers have
been replaced by the fax image attachment, but this
property remains available for backwards compatibility.
HasCoversheet
Indicates whether or not the fax has a cover sheet. It is

only valid for outgoing faxes.
HasHotlink
Indicates whether or not the fax has a hotlink.
HasPDF
Indicates whether or not the fax has a rich PDF

document associated with it.
HideFromWeb
Hides the fax from the certified delivery Web interface

when the recipient deletes it. (The original fax cannot
be deleted from the fax database by the recipient, so it is
hidden instead.)
ImageSizeInBytes
The size of the fax body in bytes.
InputFilename
The name of the file that appears in the outgoing folder.
IsApproved
Indicates whether or not the fax has been approved.
IsBillingCodesVerified
Indicates whether or not the BillingCode attachment has

been checked against the list of valid billing codes.
IsBroadcastFax
Specifies whether or not the fax is a broadcast fax.
1090
RRTN
Description
IsCallbackRequested
Indicates whether or not the sender requests a call from

the recipient.
IsCertifyDelivered
Indicates whether or not the fax was sent via certified

delivery.
IsCoversheetConversionNeeded
Specifies whether or not the cover sheet for the fax needs
to be converted to a TIFF format image file.
IsCoversheetFine
Specifies whether or not the cover sheet is in Fine mode.

True indicates that the cover sheet is in Fine mode
(200x200 dots per inch resolution); False indicates that it
is in normal mode (100x100 dots per inch resolution).
IsDeleted
Specifies whether or not the fax has been deleted.
IsDeletedAfterAnySend
Specifies whether or not the fax will be deleted from

the server after the Send event, no matter it has been
successfully sent or not.
IsDeletedAfterSuccessfulSend
Specifies whether or not the fax will be deleted from the

server after a successful Send event.
IsFaxAutoForwarded
Specifies whether or not the fax was automatically

forwarded.
IsFaxBodyAutomaticallyPrinted
Specifies whether or not the fax was automatically

printed.
IsFCSCompleted
Specifies whether or not the fax cover sheet has been

completed.
IsFineMode
Specifies whether or not the body of the fax is in Fine

mode. True indicates that the fax is in Fine mode
(200x200 dots per inch resolution); False indicates that it
is in normal mode (100x100 dots per inch resolution).
IsForwarded
Specifies whether or not the fax was manually

forwarded.
IsGatewayGenerated
Specifies whether or not the fax was generated by the

RightFax e-mail gateway.
IsGenericFlag1On
Specifies whether or not the user customizable API flag

Generic1 is on.
IsHeld
Specifies whether or not the fax is being held for preview

before being sent by the user.
IsInDelaySend
Specifies whether or not the fax is being held until the

date and time specified by the DelayFaxSendDateTime
property.
IsInitialized
Specifies whether or not the fax was initialized.
IsINLJob
Specifies whether or not the fax is an INL job.
IsLCRTimeDelayed
Specifies whether or not the fax was delayed because of

a least-cost routing rule.
IsNeedingApproval
Specifies whether or not the fax is being held until it is

approved.
1091
RRTN
Description
IsPrinted
Specifies whether or not the fax was successfully

printed.
IsProductionFax
Specifies whether or not the fax was generated by the

RightFax Production module.
IsReceived
Specifies whether the fax is an incoming or outgoing

fax. True indicates that the fax was received (incoming).
False indicates that the fax was sent (outgoing).
IsViewed
Specifies whether or not the fax was viewed.
LastHistoryChangeDateTime%Year
The year and time that the most recent history element
was added to this fax.
LastHistoryChangeDateTime%Month
The month and time that the most recent history element
LastHistoryChangeDateTime%Day
The day and time that the most recent history element
LastHistoryChangeDateTime%Hour
The hour and time that the most recent history element
LastHistoryChangeDateTime%Minute
The minute and time that the most recent history element
LastHistoryChangeDateTime%Second
The second and time that the most recent history element
MaximumRetries
This property specifies the maximum number of times

the system should attempt to deliver the fax if the phone
number is not responding. If this is set to 1, the system
will stop after the first failed attempt.
NeedsPDFConversion
Indicates whether or not the fax needs to be scanned for

embedded codes before conversion.
NeedsPrescan
Indicates whether or not the fax requires PDF

conversion. When PDF conversion is complete, this
property is automatically set to False.
OriginalBFTFilename
The name of the binary file transfer file before it was

renamed by the fax server. Binary file transfers have
been replaced by the fax image attachment, but this
property remains available for backwards compatibility.
OriginalFCSFilename
The name of the original file that was converted to use

as the fax cover sheet. This is the name as it appears in
the server folder. The converted file name is accessible
through the FCSFilename property.
OwnerID
The UserID for the owner of the fax.
Priority
The priority of the fax.
RemoteID
The ID of Sender's fax machine. This applies only to

received faxes.
SecureCSID
The secure caller subscriber identification of Sender's fax

machine, if any. This applies only to received faxes.
1092
RRTN
Description
SendTime
The total length of transmission time it took to send

or receive the fax. This is available for all received
faxes. It is only available for sent faxes after successful
completion.
StatusDescription
The current status of the fax in text format.
ToCityState
Specifies the city and state of the recipient.
ToCompany
Specifies the recipient's company name.
ToEmailAddress
Specifies an e-mail address for the document destination.
ToFaxNumber
Specifies the telephone number of the recipient's fax

machine.
ToName
Specifies the recipient's name.
TotalLinkCount
The total number of links associated with this fax. Links

are generated when a RightFax user sends or forwards a
fax to another RightFax user. Rather than duplicate the
image file of the fax for each user, the system creates a
link to a single instance of the image.
TotalPages
The total number of pages in the fax. The fax must be

converted for this to be valid.
ToVoiceNumber
Specifies the telephone number of the recipient.
TypeOfPrintJob
Specifies the type of data in the print job.
UniqueID
Specifies the unique ID for this specific print job.
UserComments
A comment text added to the fax by the fax sender.
UseSmartResume
Indicates whether or not the fax will use the Smart

Resume feature of the RightFax system.
The component works with RightFax Server versions 9.0, 9.3, 9.4, 10.0, 10.5, and 10.6.
The Right Fax client software should be installed on the machine with Workflow Server for correct work of the
component.
The component can capture one received and one sent fax at a time. That is, at most the component captures two
faxes simultaneously. The captured faxes are processed independently.
When the component searches for new faxes, it has to go over all faxes in the user's folder until a new fax is
found. This is because the RightFax API is able to get only the full collection of faxes, which includes always all
faxes for a user. If the number of faxes in the user's folder grows, the time of searching for new faxes grows as
well. This can significantly decrease performance. To avoid this, it is recommended to delete faxes from the server
from time to time.
Problem
When several instances of the component are capturing
faxes from the RightFax server, some faxes are not
captured.
Solution
This may happen when someone is sending fax while
a RightFax Capture component processes faxes from
the server. In this case, the new fax might be marked as
captured and, therefore, will not be processed.
1093
Problem
Solution
The Synchronization option in the General tab is used,

however does not work.
The user may have no right to execute SQL queries of

the SELECT type from the specified table. Contact the
SQL Server administrator.
Process does not respond for a long time and eventually

ends with an error.
This happens if the SQL Server instance or connection

credentials are not valid. The component waits for a
fixed timeout for the response from the server. Check
that there the information for connecting to the SQL
Server database is correct.
The component fails to capture files and the following

The probable cause of this problem is that you might

select the For all users check box in either Received
Faxes tab or Sent Faxes tab or both, but the user
account, specified on General tab does not have
sufficient rights to perform this operation.
COM error: (80070005)
To fix the problem, make sure that the specified user

account has sufficient rights for capturing the faxes from
all users, or clear For all users check box on all the tabs.
RightFax Route
Welcome to the RightFax Route component
RightFax Route component allows sending documents to users by fax. When the documents being processed in the
workflow reach the component, it sends the documents to the RightFax server to create a fax out of them and then
sends the fax to a specified recipient. The component also allows you to add a coversheet to the fax.
The component works with RightFax Server versions 9.0, 9.3, 9.4, 10.0, 10.5, and 10.6. The RightFax client software
should be installed on the machine with Workflow Server for correct work of the component.
Getting started
Feature highlights
Sending faxes through the RightFax server.

Coversheet support.
How to the Use RightFax Route component

The example of the component usage is as follows: sending faxes to the recipient that is defined by user.
1. Create a workflow with the AutoCapture component and the RightFax Route component.
2. In the AutoCapture component configuration, add a form that allows you to set name and fax number of the user
who will be the fax recipient.
3. In the RightFax Route configuration, define server name, user name and password.
4. In the Recipient name text box use the ~ACC::Name~ RRT. In the Fax number text box use the
~ACC::FaxNumber~ RRT.
5. Run the process.
When user captures files from the desktop, fills out the form, the documents are sent by fax to the defined recipient.
Configuring the RightFax Route component
The component configuration window contains two tabs:
1094
Tab
Description
Server tab
Use this tab to set the parameters for connection to the

RightFax server and specify the fax recipient.
Cover Sheet tab
Use this tab to add cover sheets to the sent faxes.
Server tab
Use this tab to set the parameters for connection to the RightFax server and specify the fax recipient.
Option
Description
Server name
Enter the name of the RightFax server. You can use

RRTs in this box. This option is required.
User name
Enter the user name to connect to the RightFax server.

You can use RRTs in this box.
User password
Enter the user password to connect to the RightFax

server.
NT Authentication
Select this check box to use Windows authentication.

Selecting this check box disables the User Name and the
User Password options. If you clear this check box, you
must specify the User Name and User Password
Note: For Windows authentication to work
correctly, you must correctly configure the
Service Manger. In the Log On tab of the
Service Manager settings, select This account,
browse for your domain name for Windows
authentication and enter the password.
Impersonation
Enter the ID of the user under which the faxes will be

sent. The specified user will be set as the owner of the
fax. This is useful when you want to login under one
user and send faxes using different user accounts. You
can use RRTs in this box.
Note: The user ID is case-sensitive.
Recipient name
Enter the name of the fax recipient. You can use RRTs in
this box. This option is required
Fax number
Enter the fax number of the fax recipient. You can use
RRTs in this box. This option is required.
Cover Sheet tab

Use this tab to add cover sheets to the sent faxes.
The component can use one of the cover sheet templates provided by the RightFax server. A cover sheet template can
be either a Microsoft Word document or a PCL file. When the fax is sent, the sender and recipient information as well
as cover sheet notes are merged with the cover sheet template and converted to the image file that is added to the sent
fax as a cover sheet.
Option
Use cover sheet
Description
Select this check box if you want to add cover sheets to
the sent faxes. If this check box is not selected, the faxes
will be sent without cover sheets.
1095
Option
Description
Default options
If you select this check box, the component will use

the default options for cover sheet settings that are
predefined on the RightFax server. In this case, the Use
cover sheet, Cover sheet file and Sparse rows options
are disabled. This option is checked by default.
Cover sheet file
Specify the file that will be used as a template for the

cover sheet. You can enter the file name manually or
select from the drop down list of cover sheet templates
available on the RightFax server. You can use RRT in
this test box.
Note: If you do not have permission to change
the cover sheet, this text box will be disabled
and the default value will be used.
Click this button to update the list of available cover
sheet templates from the server. The component displays
an error message if this operation fails.
Cover sheet notes
Enter the text that will be used in the Notes section of the
cover sheet. You can use RRTs in this box.
Sparse rows
If this check box is selected, then the text in the Note

section of the cover sheet will be written with oneline interval between lines. This option is intended for
compatibility with the previous version of the component
where the lines were always written with this interval.
By default, this check box is cleared.
Note: The RightFax API allows displaying no
more than 21 lines in the Note section of the
cover sheet.
RightFax Route component RRTs

The component works with the RightFax Server versions 9.0, 9.3, 9.4, 10.0, 10.5, and 10.6.
The Right Fax client software should be installed on the machine with Workflow Server for correct work of the
component.
The built-in conversion engine on the RightFax Server supports only the file formats listed in the below table.
Therefore only the files of those formats should be used for correct work of the component:
Document Type
Supported Versions
ANSI text (7 & 8 bit)
All versions
ASCII Text (7 & 8 bit)
All versions
Binary group 3 fax
All versions
BMP (including RLE, ICO, CUR, and OS/2 DIB &

OS/2 Warp)
Windows versions
CDR (if TIFF image is embedded)
Corel Draw versions 2.0 through 9.0
1096
Document Type
Supported Versions
DCX (multi-page PCX)
Microsoft Fax
DRW (Micrografx Designer)
Version 3.1
DRW (Micrografx Draw)
Versions through 4.0
EPS
If TIFF image is embedded
Freelance for Windows
Versions 1.0, 2.0, 96, 97, and Millennium
GIF
Compuserve
HTML
JPEG (includes EXIF)
All versions
Lotus 1-2-3 (DOS & Windows)
Lotus 1-2-3 (OS/2)
Lotus 1-2-3 Charts (DOS & Windows)
Lotus 1-2-3 Charts (OS/2)
Lotus 1-2-3 for SmartSuite
SmartSuite 97, Millennium, and Millennium 9.6
Lotus AMI/AMI Professional
Lotus Symphony
Versions 1.0, 1.1, and 2.0
Microsoft Binder
Version 7.0, Binder 97
Microsoft Excel Charts
Versions 2.x through 7.0
Microsoft Excel for Macintosh
Versions 3.0 through 4.0, 98, and 2001
Microsoft Excel for Windows
Versions 2.2 through 2002
Microsoft Multiplan
Version 4.0
Microsoft PowerPoint for Macintosh
Version 4.0, 98, and 2001
Microsoft PowerPoint for Windows
Versions through 2002
Microsoft Rich Text Format (RTF)
All versions
Microsoft Windows Works
Microsoft Word for DOS
Microsoft Word for Macintosh
Versions 4.0 through 2001
Microsoft Word for Windows
Versions through 2002
Microsoft WordPad
All versions
Microsoft Works for DOS
Microsoft Works for Macintosh
Microsoft Works for Windows
Microsoft Write
Novell WordPerfect for DOS
Novell WordPerfect for Macintosh
Versions 1.02 through 3.0
1097
Document Type
Supported Versions
Novell WordPerfect for Windows
PCX bitmap
PC Paintbrush
PICT1 & PICT2 (Raster)
Macintosh standard
QuattroPro for DOS
QuattroPro for Windows
Versions through 10
TIFF
Versions through 6
TIFF CCITT Group 3 & 4
Fax systems
Unicode Text
All versions
UUEncode
No specific version
WordPerfect Graphics (WPG and WPG2)
ZIP
PKWARE versions through 2.04g
The RightFax API allows displaying no more than 21 line in the Note section of the cover sheet.
Problem
Solution
When you send faxes using NT authentication, the

following error message appears in the Status Monitor:
For correct work of NT authentication, you should

correctly configure the Service Manger. In the Log On
tab of the Service Manager, select This account, browse
"RightFax Route: Login failed: 0x800426AF(The user or
for your domain name for NT authentication and enter
object does not exist.)"
the correct password.
When you use multiple workflows with the component,
some faxes are not sent to the server and the Status
Monitor gives one of the following messages:
RightFax Route: Login failed:

0x800700E7 (All pipe instances are
busy.)
RightFax Route: Failed to send fax.
Error code 0x800700E7 (All pipe
instances are busy.)
For the correct work of multiple workflows with the

component, it is necessary to set up correct number of
database threads on the RightFax Server. In particular,
the Maximum Threads value should be not less than
number of simultaneously working RightFax route
components and the Maximum File I/O Threads value
should be big enough. Contact you RightFax server
administrator.
Send to Database
Welcome to Send to Database component
Use this component in a process to directly write images, files, or data into ODBC database tables such as Microsoft
Access, or Visual Fox Pro.
Application of this component includes direct table update on any application SQL table with images and data
elements, or creation of document archival system.
The ODBC Data Source must be properly set up prior to configuring this component.
Getting started
Feature highlights
This component allows you to:
1098
Select from various data source to store data and binary documents into.
Provide credentials for access security.
Specify the table name for routing images and field information.
Specify the binary field name, the column in the table which you want to save the image.
Add, modify, and remove field values in a database table.
Using Send to Database component

The most common use of this component is for archival purposes. Files, data, and documents can be stored in binary
format into ODBC compliant database tables for long term archival and record keeping. As an example, one of the
more common processes that can take advantage of this component is having the Multi-functional Device (MFD) as
a Capture (source) component. From the MFD, configure this component and assign Runtime Replacement Tags to
store the images, files, and new field names, into the Data Source that you select.
This component can be used with any file/document type.
Configuring the Send to Database component
General tab
Activate the component and configure database information on this tab.
Option
Activate
Description
Select this check box to enable Workflow Tracker
process component.
This component provides three state "activation check
box. The three states of the field are:
Active (check box ON)The component is active

for all workflow jobs.
Inactive (check box OFF)The component is
inactive for all workflow jobs.
Conditionally Active (Activate button doubleclicked and check box is Grayed ON)The
component becomes active only if the conditional
statement is True.
The Activate check box is beneficial when your

process involves creation of device function keys. This
component can be turned ON or OFF per device function
key by using the Activate check box.
Data Source
Provide the data source name that you want to use (such
as Microsoft Access). This is a required field.
Select the ellipses to enter the name of the data source.
You can also enter a Keep alive command. By entering
a command, the connection to the data source is kept
alive by automatically running the entered command at
intervals.
User Name
Enter the user name to log in to the data source.
Password
Enter the password to log into the data source.
Table Name
Select the table name that will be connected to in the

database. This is a required field.
1099
Option
Description
Image Field Name
Select the field in the table in which to save images. This

field has to be a large binary field (BLOB). The process
will fail at run time if you specify any other field type.
This field must be configured.
If you need to create new fields in the database, switch to
the Field Values tab and click Add.
Field Values tab

Manage field value entries in this tab.
Option
Description
Add
Click this button to add a new field value entry to the

database table. The new field value can contain Runtime
Replacement Tags.
Modify
Click on this button to modify the field value entries for

the database table.
Remove
Click on this button to remove field value entries from

the database table.
Send to Database component RRTs

Component RRT ID
The RRT ID for this component is SDB.
The following table describes the reserved RTN values.
Name
Description
FileName
FileExt
The original file extension value.
FileSize
The size of the file in bytes.

Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
1100
Name
Description
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
An example using a SSRTN:

The RRT expression ~SDB::%m~-~SDB::%d~-~SDB::%Y~ will be replaced by 07-23-2005.
Problem Description
Solution
Error displayed when selecting the Table browse button.
You either do not have a valid user name and password,

or you have an invalid Data Source. Make sure the Data
Source you selected is actually connected, and
configured properly.
If you need to create a database table, you should do so from within the database and create the tables from there.
You cannot create tables dynamically from this component.
Data Source, Table Name, and the Image Field Name fields are mandatory and have to be configured.
The Image Field name must be a BLOB field.
All images within a BLOB field are stored as binary values. To extract and view the images you must develop
your own image extraction tool.
1101
Send to Database (Bulk)

Send to Database Batch component
Send to Database Batch component
Use this component in a process to Batch write files, or data into ODBC database tables such as Microsoft Access,
or Visual Fox Pro.
Application of this component includes direct table update on any application SQL table with data elements, or
creation of document archival system.
The ODBC data source must be properly set up prior to configuring this component.
General tab
Field Name
Description
Data Source
Provide the type of source you want to use (such as

Microsoft Access).
User Name
Provide the user name to which you will log into the data
source (if needed).
Password
Provide the password to which you will use to log into

the data source (if needed).
Table Name
Select the table to which you want to connect. If an error

pops up, you either do not have the a valid data source,
user name, or password.
Field mapping
Field Name
Description
Field Delimiter
Enter the field delimiter used in the CSV file.
Direct Mapping
If this check box is selected, the database field names are

mapped automatically from the column names from the
first row in the CSV file. If this check box is cleared, you
would manually type in the batch fields. The first row of
the CSV file must be reserved for column names.
DB Fields
Displays the database fields from the selected table in the

database.
Type
Displays the database field type.
Check for Duplicate Record
Check to see if a record for a file already exists in a

database.
Batch Field
Automatically mapped or manually enter the CSV

header field names from the first row.
1102
Send to Folder
Welcome to Send to Folder component
Send to Folder is a Route component that copies files to any local or network directory. Using directories is one of
the fastest methods for implementing a document storage system as storing files into flat folders requires no database,
no application, and lower cost of ownership. With Send to Folder component, you can create business rules for
multiple folder locations, security access, and file naming of scanned imaged and processed file.
This component is also capable of checking security access level of the user prior to storing documents into folders.
Using the check security feature, users scanning document into folder destination can only store into the destination
directory if proper access level has been granted to the user by the administrator. Using this feature an organization
can implement a secured storage location that accepts files only based on security settings.
The Send to Folder Route and eConnector components are identical except the Send to Folder Route component
solely stores the files and doesn't pass the files on, as it is the last component in the process. The Send to Folder
eConnector passes the files onto the next component in the process. The Send to Folder eConnector also allows you
to enable or disable pass-through of documents. This option makes the document available/not available for other
components in the process.
This component requires Active Directory Services with minimum of NT 4.0.
Getting started
Feature highlights
Create dynamic folder names and locations.

Rename files, based on document index information, field values, or field value references.
Check user level security against the destination folder location. Only accept users with write permission to store
files into destination location.
Specify file property information about the nature of documents stored in the folder along with keywords and
comments.
All types of files including images can be processed through this component.
Send to Folder is fully integrated with other components such as Barcode, Form Recognition, OCR, PDF, and so
forth. For example, a barcode value can be used as part of destination folder name to create dynamic destination
folder based on barcode values on the document.
Using the Send to Folder component
A list of most common usage scenarios are provided below:
A user logs into a device, scans a document and the document is placed in user's directory on a shared network
drive.
Use this component to store information into several folders where other processes will read the information for
processing.
Configuration
Configurations dialog box
Use the options here to define the structure of how documents are stored.
Option
Locations table
Description
The table in this dialog box specifies folder paths for
sending documents.
1103
Option
Description
N (number)The ordinal number for a path in the

list. You can rearrange items in the list by clicking a
number and dragging it up or down in the list.
Folder PathShows the destination folder for an
item in the list.
Rename SchemaShows the rename schema for
an item in the list.
P (properties)Click the browse button in this
column to edit properties for an item in the list.
Add
Click this button to add a folder path to your workflow

process.
Remove
Click this button to remove a selected folder path from

the list.
General tab
Enter the folder path attributes on this tab.
Option
Folder Path
Description
Enter the destination folder path that you want files to
be copied to. The server must have write access to this
folder. The input device can dynamically set the folder
path.
Make sure to use the UNC path instead of a mapped
drive because a mapped drive is local to your machine.
Overwrite Existing File
Select this check box to overwrite an existing file with

the same name as a captured file. If the overwrite and
rename options are not selected, and a file with the same
name already exists in the destination folder, then an
error message is generated.
Rename File
Select this check box if you want the output file to be

renamed.
If this check box is selected and a rename schema is not
provided, then at run time the schema name defaults to
~STF::FileName~_~STF::Counter~~STF::FileExt~.
For example, if the input file name is File.tif, then
the file will be renamed File_1.tif.
Schema
Enter a schema for renaming files. You can use Runtime

Replacement Tags (see RRT) to dynamically set the
value of the schema at run time.
Check User Security
Select this check box to have the system check the user's
or sender's security level to verify the write access. This
refers to a look up in the user's Active Directory Services
to see if the user has security rights to copy the files to
the designated folder.
1104
Option
Description
User Name
Enter the user name for the directory. Click the browse
button (...) to open the Windows Select User dialog box
to specify a user name.
Security tab
Enter security attributes for the destination folder on this tab.
Option
Description
Owner
Select the user who will be the owner of the file or

folder. The owner of a file or a folder has the right to
allow or deny access to that resource.
Permission Entries
Entries in this table defines permissions for users or

groups. Click the Add button to add an entry to the table.
TypeSpecifies either Allow or Deny to grant or

deny access to files and folders.
NameSpecifies users or groups who should
be allowed or denied access to files and folders.
Separate multiple objects with a semicolon.
PermissionSpecifies permission for an entry in
the list. See Table 60: Permissions for folders and
files on page 1106
Add
Click this button to add an entry to the Permissions

Entries table.
Edit
Click this button to edit a selected entry in the

Permission Entries table.
Remove
Click this button to remove a selected entry from the

Permission Entries table.
Inheritable permissions from parent
Select this check box to have folders and files

inherit permissions set in the parent object. Inherited
permissions ease the task of managing permissions and
ensure the consistency of permissions among all objects
within a given container.
Inherited permissions are permissions that are
propagated from a parent object to its descendants. For
example, when you create a folder called MyFolder,
all subfolders and files created within MyFolder would
automatically inherit the permissions from that folder.
MyFolder has explicit permissions, while all subfolders
and files within it have inherited permissions.
Note: Explicitly defined permissions take
precedence over inherited permissions.
The following table describes the effect of permissions for folders or files.
1105
Table 60: Permissions for folders and files

Permission
Folders
Files
Full control
Permits reading, writing, changing,

and deleting of files and subfolders.
Permits reading, writing changing

and deleting a file.
Read
Permits viewing and listing of files

and subfolders.
Permits viewing or accessing

contents of a file.
Read & execute
Permits viewing and listing of files

Permits execution of a file as well as
and subfolders as well as executing
viewing and accessing its contents.
of files; inherited by files and folders.
Write
Permits adding of files and

subfolders.
Permits writing to a file.
Summary tab
Enter the document attributes on this tab. You can use RRTs to define these entries at run time.
Tip: You can view these fields in Windows Explorer by right-clicking a file, and clicking on Properties.
Option
Description
Subject
Specifies subjects for documents.
Title
Specifies a title for documents.
Author
Specifies the author for documents.
Category
Specifies a category for documents.
Keywords
Enter keywords for documents. The keywords assist with

searching for a file. Multiple entries may be separated by
either a comma or space character.
Comments
Enter comments that can provide information about the

file.
Send to Folder component RRTs

Component RRT
The RRT ID for the Send to Folder component is STF.
Name
Description
FileName
Counter

FileExt
1106
Name
Description
Path
The folder path entry. For example, if you have

configured 3 folder paths, then this RRTN can take the
following values: Path1, Path2, Path3. Path1 refers to the
first path entry configured, Path2 refers to the 2nd path
entry configured, etc. This applies to the Send to Folder
The RRT schema ~STF::FileName~~STF::Counter~ is replaced with the value Document5 if the original
file name was Document and there were already 4 files with the same name (Document1 to Document4) in the
destination folder path.
The Reserved RTN values FileName, Counter, FileExt can only be used with the Rename field of this component.
In other words, you may not use ~STF::FileName~, ~STF::Counter~, or ~STF::FileExt~ in any
component other than the Send to Folder eConnector, and they must only be used with the Rename field of this
component.
Use the C format specifiers to create and display the counter with the required number of leading
spaces or leading zeros. For example, if the file name is Test.doc, and the rename schema is
~STF::FileName~~STF::Counter:03~~STF::FileExt~, then the resulting file names are
Test001.doc, Test002.doc, and so forth. If the file name is Test.doc and the rename schema is
~STF::FileName~~STF::Counter:3~~STF::FileExt~, then the resulting file names are Test
1.doc, Test 2.doc, and so forth (note the 2 spaces after "Test").
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
Current locales A.M./P.M. indicator for the 12-hour

clock
%S
1107
SSRTN
Description
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

The RRT schema ~STF::%Y~-~STF::%m~ will be replaced by 2004-10
Problem Description
Solution
Error dialog box pops up when creating a folder path.
Make sure invalid characters are not used in the folder

path definition. The invalid characters are: \ / : * ? " < > |
The Path RRTN is not replaced with a path folder.
This situation occurs when you specify a Path, such as

Path8, where only 6 folder path entries are configured
with the Send to Folder component. Check to make sure
the Path number is valid.

With Folder Path, set on the General tab, make sure to use the UNC path instead of a mapped drive because a
mapped drive is local to your machine.
Send to FTP
Welcome to Send to FTP component
The Send to FTP component provides you with the mechanism for storing files that are fed from a capture component
to the FTP site for storage. Additional control over the FTP site transmission is provided through support for secured
FTP sites as well as bandwidth flow-control.
This component is available either as an eConnector (process) component or as a route component.
Getting started
Feature highlights
The Send to FTP provides the following features:
Multiple FTP sites.

Secured connection to FTP sites.
Active flow control.
How to use the Send to FTP component

The following are examples of how this component may be used:
An enterprise where PDF documents from several sources have to be placed on several FTP servers. These
documents may then be processed for printing, or sending out as email, depending on the business need.
1108
Connectivity of remote offices to central office can easily be implemented using FTP component. Scanners from
remote sites can easily be connected to multiple sites using a secured FTP protocol.
Control the bandwidth usage when connecting remote scanning offices through use of the Bandwidth control
feature of FTP component. Bandwidth control lowers the impact of implementing distributed scanning on
transmission infrastructure.
Configuring the Send to FTP component

Send to FTP dialog box
Set the attributes of FTP sites in this dialog box.
Option
Description
Activate

Conditional Activation). This combo box is only present
in the eConnector component.
Pass Through documents
Select this check box if you want documents to

be available to the rest of the components in your
process. This check box is only present in eConnector
component.
Add
Click this button to add FTP sites to your process. This

opens the FTP Site Settings dialog box.
Edit
Select an item in the list of sites, and click this button to

edit the settings of the selected FTP site.
Remove
Select the FTP site you want to delete and click this
button.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.
1109
Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
1110
unary_operation ::+
!
string_constant

1111
Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
1Boolean
2, 3Any
1112
Symbol
Description
Result type
Operands type
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
FTP Site Settings dialog box

Use this dialog box to set the connection parameters.
Option
Description
Server
The server address can either be an IP address or a name

of the FTP site where you want to store documents.
Click the Advanced button to set the security level for
the server in the open Advanced Settings dialog.
Port
Standard FTP port that identifies the TCP/IP port to use

on the server. The default number is 21.
Passive mode
Select this check box if you want a Passive mode for

this FTP session. The Passive command requests that
the server "listen" on a data port (which is not its default
data port) and waits for a connection rather than initiate
one upon receipt of a transfer command.
User Name
Specify the user name that has access into the FTP site.
The user account must have read/write/create/delete
access to directories and files. If you do not specify the
user name, the access rights are set to anonymous by
default.

via RRTs.
Password
Specify the password that is associated with the user

name. This value will be only used in case of the Obtain
password via RRT check box is not selected. Select the
Encrypt check box to mask the password so that others
cannot read it as you type.
Password RRT

replaced with the actual password at run time. This value
will be only used in case of the Obtain password via
RRT check box is selected.
Folder Path
Specify the folder where the documents will be stored on

the FTP server. If the directory does not exist, the entire
recursive directory path will be created. However, if you
do not specify a path or folder name, the data are stored
1113
Option
Description
on the root directory of the FTP server. Click the browse
button (...) to browse to the directories on the server.
Overwrite Existing
Select this check box to overwrite existing files of the

same name. If you do not select this check box and there
is an existing file with the same name, then the captured
document will not be stored at the site.
Rename file
Check this box if you want the output file to be renamed.
Schema
Enter a schema name for the output file name. You can
use RRTs to dynamically set the value of the name at run
time.
Advanced Settings dialog box

Use the options in this dialog box to configure the level of security.
Option
Description
Upload speed
This option allows you to set control over data transfer

speed in KB per second. 0 means no speed limitation.
Note: The upload speed for quite small files
cannot be limited.
SSL/TLS
Use SSL
Select this option to enable secure connection. Select an

Implicit or Explicit security mode.
Encrypt control channel
When using explicit mode, you can additionally enable

encryption for the FTPS control channel.
Ignore server certificate errors
This option disables server certificate validation.
Folder path
Browse through the directories on the server to select the destination folder.
Send to FTP component RRTs
Component RRT ID
The RRT ID for the Send to FTP component is FTP.
RRTN
Description
~FTP::OriginalFileName~
~FTP::Counter~

~FTP::FileExtension~
The original file extension value
~FTP::Path,[ServerNumber],[FileNumber]~
The folder path associated with an FTP server, where

ServerNumber is a number of the FTP server and
1114
RRTN
Description
FileNumber is a number of the file on the FTP server.
For example, if you have configured 3 FTP servers/
folder paths and there are two files on each of them,
then this RRTN can take the following values: Path,1,1;
Path,2,1; Path,3,1 etc.
~FTP::URL,[ServerNumber],[FileNumber]~
The URL of the FileNumber file uploaded to the

ServerNumber FTP server.
~FTP::URL,1,1~
The url of the 1st file uploaded to the 1st FTP server.
~FTP::FileCount~
The count of documents in one package.
The following examples provide some sample usage for your reference:
The RRT scheme ~FTP::OriginalFileName~~FTP::Counter~ is replaced with the value Document5 if
the original file name was Document and there were up to 4 (Document1 to Document4) files already within the
destination folder path.
Note: The Reserved RTN values OriginalFileName, Counter, FileExtension can only be used
with the Rename field of this component. In other words, you may not use ~FTP::OriginalFileName~,
~FTP::Counter~, ~FTP::FileExtension~ in any other component but Send to FTP, and it must be
used only with the Rename file field of this component.
The RRT scheme ~FTP::URL,1,1~- replaced with the value "ftp:\localhost:8\out\file.txt" if the file name is file.txt
and it was the first uploaded file to the first server in the row.
Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
1115
Name
Description
%w
%W

day of week (0053)
%y
%Y
Example of the SSRTN:

The RRT scheme ~FTP::%Y~-~FTP::%m~ will be replaced by "2007-10".
Problem Description
Files cannot be copied into the destination directory.
Solution
Make sure that the destination ftp folder has Write

access.
Check user name/password to make sure it is valid.
Check the access rights for the user.
Check to make sure there are no firewalls.
If overwrite existing is not checked off, make sure
that a file with the same name does not already exist.
Send to HTTP Help

Welcome to the Send to HTTP component
The component is used to send data via a web form. The component submits documents and field values to a
specified web service(URL). The data is transmitted in a HTTP POST request in the form of multipart/form-data. You
can load a page that contains a web form in a built-in web browser and fill in the fields of the form directly on the
page, the component will detect the fields from the page and add them to the request.
The capabilities of the component is not restricted to submitting web forms, it can send data to any web service that is
able to recognize such requests. In this case you have to specify all fields manually.
The component support NTML and basic authentication with SSL encryption.
Getting started
Feature highlights
The component has the following features:
Sending documents and data to a web service via a web form. You can also send data to any web service that is
capable to process such request, without actually using an existing web form.
A built-in browser that allows automatic detection of input fields of a form.
NTLM and basic authentication.
Support for SSL encryption.
Validation of the HTML response using a regular expression or by checking for a substring.
1116
How to use Send to HTTP

The following use case provides a sample of the component application: Scan documents from an MFP device, save
directly into a web-site containing a web-form.
1. Design a workflow process with two components: an MFP component that corresponds to the selected type of an
MFP device, and the Send to HTTP component.
2. Download the desired web-site in the Web Browser window of the Send to HTTP configuration. See Web
Browser.
3. In the Send to HTTP dialog box, configure field values and make sure that the address is correct. See Send to
HTTP Dialog Box.
4. Configure both components and start the process.
Now when the MFP user enters a pre-configured function key on the control panel of the MFP device, the scanned
document is routed directly into the web service and the form fields are filled out with the configured field values.
Configuring Send to HTTP
Send to HTTP dialog box
Configure the Send to HTTP component settings in this dialog box.
Option
Description
Activate
Select this check box to activate the component.

Otherwise, it will not take part in processing. This check
box is present only in the eConnector component's
configuration.
Pass through
This check box is present only in the eConnector

component's configuration. Select this check box if
you want the file(s) to be available to the rest of the
Address
Enter the address to which the request will be sent. This

field must contain the actual address of the web service
that can process the HTTP request that you are going to
send.
You can specify a web-page URL containing a form that
you want to submit. In this case, you can view the page
in a built-in Web Browser and specify the field values
directly on the page. Note that the form's address, to
which it is submitted, can be different from the address
of the page. The address to submit the form is specified
in the action attribute of the form tag in the source code
of the page. You can specify the field values on the page
in the built-in browser and then correct the address. If the
action tag is not specified, the form is submitted to the
address of the page.
View
This button opens a built-in Web Browser dialog box,

which allows browsing a web page containing web
forms.
Fields
This group of options displays the list of the web-site

form fields with the values to be sent.
The fields will be sent to the server in the form of keyvalue pairs as a part of the request.
When you preview a web page in the built-in web
browser, the component automatically finds all fields
1117
Option
Description
of all forms in the page and adds them to the list. If you
don't need any fields, you have to remove them manually
from the list.
If you preview several web pages one after another, the
component adds fields from a page to the list without
removing the fields of the previous pages. If you don't
need them, you have to remove them manually from the
list.
If you specify the address by means of RRTs and want
to have, say, 2 different addresses depending on some
conditions, you have to make sure the list of fields
contains the fields for both addresses. In this case all the
fields will be sent to a current address.
Add
This button opens Field Properties dialog box, in which

you can add a new field.
Edit
Click this button to edit the properties of a selected field.
Remove
Select one or several fields and click this button to

remove them.
File field(s)
Enter the names of the fields that the server expects to

contain files. In case of a web form, it is the names of
input fields that correspond to file select controls(the
fields of file type in the form). The names of the fields
must be separated by a comma, without spaces. If the
component receives several documents simultaneously,
each field, starting with the first in the list, will be
assigned a document. If there are more fields than
documents, the remaining fields will not be sent. If
there are fewer fields than documents, the remaining
documents will not be sent anywhere but considered as
successfully processed.
Authentication
This group contains authentication parameters.
NTLM
Select this check box to use NTLM authentication. If you

select this check box, you must enter system user name
and password for connecting to the site. In this case the
password is sent to the site in an encrypted form.
Basic
Select this check box to use Basic authentication. If you

select this check box, you must enter system user name
and password to connect to the site.
Note: If you select both NTLM and Basic
authentication, the component first tries to use
NTLM authentication, then basic authentication
and then anonymous access.
If anonymous access is disabled on the website, the following error message appears at run
time: "Web-server authentication failed. One
of possible reasons: incorrect user name and/or
password".
1118
Option
Description
User name
Enter user name to connect to the site. This text box is

enabled only if either the NTLM check box or the Basic
check box is selected. It is mandatory to fill out this text
box.
Password
Enter user password to connect to the site. This text box

is enabled only if either the NTLM check box or the
Basic check box is selected.
Note: If the NTLM authentication is ON
on the web-site and the computer where the
component is running is in the service domain,
the domain user name and password will be
used for authentication. The specified User
name and Password will be ignored in this
case, they make sense only if the computer is
not in the service domain.
SSL encrypting
Select this check box to use SSL encryption. You may

use this feature only if the web-site supports secure
communication with SSL encrypting. If the web-site
requires secure communication, it is mandatory to select
this option.
HTML response check
This group allows you to check the HTML response in

order to determine success or failure of the operation.
Check HTML response
If you select this check box, the HTML response text

will be compared with a regular expression or a substring
to determine success or failure of the data sending.
Search for
Enter a text that will be compared with the HTML

response text.
Match regular expression
If you select this check box, the text entered in

the Search for field will be interpreted as a regular
expression. For example, [0-9] will be interpreted
as a number in the interval from 0 to 9. See Regular
Expression Syntax for details.
Match substring
Select this option to check if the response contains a

specified substring.
Successful match denotes routing failure
if you select this check box, the text entered in the

Search for text box is compared with the HTML
response text, and a successful match will mean a
failure of data sending. If this check box is not selected,
the component will interpret a successful match as a
successful data sending.
Match case
Select this check box to perform case-sensitive

comparison.
Web Browser dialog box

This dialog box displays the web page configured for the Send to HTTP component.
To open this dialog box, click the View button next to the HTTP Address in the Send to HTTP dialog box. You can
enter the values of the fields on this page to specifies values for fields that are used by the Send to HTTP component.
1119
Option
Description
Address
Enter the URL of the web-site containing a web form.

Click the Go button to display the form.
OK
Click this button to populate field names and values in

the Fields list that appears in the Send to HTTP settings
dialog box. If the field is already in the list, its value will
be updated.
Field Properties dialog box

Use this dialog box to add a new field or edit a selected field from the fields list.
Option
Description
Field name
Enter the field name. This option is required.
Field value
Enter the field value.
Regular expression syntax

Regular expression
Description
a where a is any symbol excluding symbols (|)[].*+^$\?
\a
a where a is any symbol including (|)[].*+^$\?

To represent any symbol "as is", prefix it with a
backslash symbol. You can use it to represent special
characters, including characters inside of CharSet. To
represent a single backslash character ( \ ), prefix it with
itself ( \\ ).
For example: \* means character "*" and \a means
character "a".
Any single symbol.

For example: expression 11.5 corresponds to such
combinations of characters as "1135", "11f5", "11_5" and
so on.
RegExp
Any regular expression RegExp.

For instance, 112 represents sequence "112", which can
be found inside a string (not the whole string!).
RegExp1|RegExp2
Any one of expressions RegExp1 or RegExp2

For example, expression 1|3 validates any of symbols "1"
or "3".
Note: Concatenation has priority over
alternation. This means that combination 12.5|
78 corresponds "(12(any number)5) or (78)".
So, the representations of this example can be:
"1235", "12f5", "78".
RegExp+
Regular expression RegExp repeated one or more times.

Use this expression to find sequences of desired
characters.
1120
Regular expression
Description
For example, (1|3)+ will find expressions (1|3), (1|3)(1|3)
and so on.
RegExp*
Regular expression RegExp repeated zero or more times.
RegExp?
Regular expression RegExp repeated zero or one time.
RegExp1RegExp2
Sequence of two expressions: RegExp1 then RegExp2.

For example, (1|3)(11.5) corresponds to such
combinations as "11175", "311t5" and so on.
Beginning of string.
Use this symbol to find strings which begin with
predefined regular expression. The desired expression
must follow ^ sign.
For example:
Expression ^1 corresponds to all strings which begin

with "1";
^(1|3) - all strings which begin with "1" or "3".
End of string.
Use this symbol to find strings which end with
predefined regular expression. The desired expression
must precede $ sign. Expression ^RegExp$ corresponds
to the whole string only.
For example:
[CharSet]
Expression 5$ corresponds to all strings which end

with "5";
(1|3)$ - all strings which end with "1 or "3;
^(a|c)..123.$ represents whole strings which begin
with "a" or "c" then have any two characters,
then sequence "123" and end with any character:
"age123y", "cat1234" and so on.
Any single symbol belonging to a character set CharSet.

The CharSet is specified as a character string and
includes all symbols of the string. The order of
characters doesn't matter. A "-" sign inside of the
CharSet has a special meaning and is used to represent a
characters interval.
For example, expression [12a-e34] means the same as
[12abcde34], it stands for any character "1", "2", "3",
"4", "a", "b", "c", "d" or "e".
[^CharSet]
Any symbol not belonging to manifold CharSet.

For example, [^12a-e34] means any character excluding
"1", "2", "3", "4", "a", "b", "c", "d" and "e".
Note: Other symbols inside brackets are
considered as characters but not special
1121
Regular expression
Description
symbols. For instance, [$] is not a symbol of
end of string but it is a character "$.
Symbol ^ must stand right after "[", otherwise it means
just a character "^.

Send to HTTP component RRTs
Component RRT ID
The RRT ID for this component is HTP.
This component does not have any RRTNs.
Name
Description
%d
%j
%I
%H
%P
Current locales AM/PM indicator for 12-hour clock
%M
%m
%b
Abbreviated english month name (JanDec)
%B
Full english month name (JanuaryDecember)
%S
%U

day of week (0053)
%W

day of week (0053)
%w
%a
Abbreviated english weekday name (SunSat)
%A
Full english weekday name (SundaySaturday)
%y
Year without century as decimal number (0099)
%Y
Year with century as decimal number
1122
Here is the sample use case of the SSRTN:

~HTP::%Y~-~HTP::%m~ will be replaced by 2010-11.
Web service uses the default HTTP and HTTPS ports.

The component requires Internet Explorer 5.01 or a later.
The component submits data only in multipart/form-data format. The component does not support data
interchange if the server expects another data format; for example, application/x-www-form-urlencoded.
Problem description
Solution
Status monitor shows the following error message:

Make sure you can access the web service using
"Error Status Code: 403, Status Text: Forbidden" and the specified credentials.
component rejects the input file.
Status monitor shows the following error message: "The
connection with the server has been reset or terminated,
or an incompatible SSL protocol was encountered" and
the component rejects the input file.
This message may appear in the following situations:

"Web-server authentication failed. One of possible
reasons: incorrect user name and/or password" and the
This message may appear in the following situation:

The web service doesn't support basic not NTLM
authentication and anonymous access is disabled.
Contact the web-site administrator.

"Server does not support the specified authentication
type(s)" and the component rejects the input file.
Make sure the server supports the type of authentication

you selected.

HTML response includes the substring indicating the
invalid response data" and the component rejects the
input file.
This message means that the HTML response was

validated and the result of the verification was
interpreted as a routing failure.

server name or address could not be resolved" and the
This message means that the specified server name is

incorrect. Make sure that you have specified correct
URL of the web-site in the Address field.

server name or address cannot be resolved or the server
returned an invalid or unrecognized response" and the
This message means that the specified server name is

incorrect or the server response cannot be recognized.
Make sure that you have specified correct URL of the
web-site in the Address field.
The Component reports successful result even when a

job failed to be accepted by a web service.
The address to which a form is submitted may be

different from the address of the page that contains the
form. The address is specified in the action attribute of
the form tag. The files will be sent to a wrong address,
but the service still may respond positively. Make sure
you have the correct address in the configuration.
1. The file size exceeds the web-site restrictions. Try to

decrease the file size.
2. The specified resource cannot be found on the webserver. Check that you have entered correct URL of
the web-site in the Address field.
1123
Send to Mail Recipient

Welcome to the Send to Mail Recipient component
Send to Mail Recipient is a process and route component providing standard SMTP and Microsoft Exchange
messaging capabilities. Use this component in your process, to send the processed file as email attachment to
designated recipients.
This powerful component allows you to distribute files, metadata, and additional information via email. Use MFP
component as your source component to scan documents and then convert the scanned documents into PDF files and
email them as an attachment to designated recipients.
Getting started
Feature highlights
Specify the desired SMTP gateway for delivering the email message.
Specify the desired Microsoft Exchange for delivering the email message.
Attach processed files to an email and send to designated recipients.
Return the processed files as email attachment to the sender (requires sender email).
How to use the Send to Mail Recipient component

Consider a process where you want to capture documents, process them and send the processed documents as an
email attachment.
Note: Keep in mind that you can use RRTs of other components in any fields to create custom and dynamic
values.
There are no file type restrictions and any file type can be processed by this component.
1. Setup the process, by configuring the proper capture, process and add the Send to Mail Recipient component.
2. Setup the Send to Mail Recipient properties.
3. Set the Server Name to the SMTP gateway used for sending email. Or use the IP address of your SMTP mail
server.
webmail.company_name.com
4. Set the From field to who is sending this email. You can use the RRTs of other components to dynamically set the
values for From field.
As an example, when your capture component is a POP3 email and you like to have the processed file be sent
back to the sender then set the From and the To field to ~POP::From~. This person would receive processed
documents back by simply sending document to a POP3 email account.
5. Set the Subject and Body; these are optional fields.
The subject would be the same as any subject of an email that you would want to send. For example,
Corresponding documents would be such a subject. The body of the email would be anything additional that
you would want to add to the email.
6. Configure other components and run the process.
Configuring the Send to Mail Recipient component
Configure the email attributes here.
The configuration window of the component has two tabs:
Tab
General Tab
Description
Use this tab to configure general component parameters
and servers that will be used in process.
1124
Tab
Description
Use this tab to configure the message parameters.
Message Tab
General tab
Use this tab to configure general component parameters and servers that will be used in process.
Option
Description
Activate
Check this box to enable this component processing.

This option applies only to the eConnector component.
Pass through
Check this box if you want the documents to be available

to the rest of the components in your process. This
option applies only in the eConnector component.
Server List
This list contains email servers with server types and

user names. You may Add, Edit or Remove email
servers. Also you may move the selected server up or
down in the list.
Click Add to select the desired server type. There are three server types available:
SMTP server
Exchange CDO-MAPI
Exchange web services
Select the desired server type and click it to open the configuration window.
SMTP Server Configuration dialog box
Use this dialog box to configure SMTP Server settings.
Option
Description
Server
Provide the server IP address or the host name of the

SMTP server to which you will send your email through.
This is a required field.
Test
Click this button to verify connectivity to the SMTP

server IP address you entered.
Port
Enter the port number on which the SMTP service is

listening. The default port number is 25.
Select this check box if a server that you want to connect

requires a secure connection. When this check box is
selected, the default port number is 465.
Check this option to perform authentication with SMTP

server.
User Name
The username used in conjunction with the password

field when authenticating with the SMTP server. You
may specify the user name via RRTs.
Password
The password used in conjunction with the username

field when authenticating with the SMTP server. You
may specify the password via RRTs.
Encrypted
Check this box to encrypt the password. If you specify

the password via RRT, this box must be unchecked.
1125
Option
Description
Log on using NTLM Authentication
If unchecked then basic (clear text) authentication is used

otherwise it will use integrated windows authentication.
Microsoft Exchange CDO-MAPI Server Configuration dialog box

Use this dialog box to configure Microsoft Exchange settings.
Option
Description
Server
Provide the server IP address or the host name of the

Microsoft Exchange server to which you will send your
email through. This is a required field.
Test
Click this button to verify connectivity to the server IP

address you entered.
Mailbox
Enter the exchange mailbox that the email will be sent

out from. The mailbox name is normally the same as the
NT user name.
Note: If the Mailbox field is using RRTs
to define dynamic Mailboxes, then it is
recommended to use the username/password of
an exchange administrator that has read/write
access to all the exchange server mailboxes.
User Name
Enter the username used in conjunction with the

password field when authenticating with the exchange
server. The user should have access to the configured
mailbox.
Password
Enter the password used in conjunction with the

username field when authenticating with the exchange
server. You may define a password using RRTs.
Encrypted
Check this box to encrypt the password.

Note: Users should use password encryption
only with static passwords. If you are using
RRTs to define dynamic passwords, then the
literal RRT string is encrypted.
Domain
Enter the domain that the user name belongs to.
Save copies of messages in Sent Item folder
If this option is checked, then a copy of email message

sent out will be kept in the sent items folder of the
configured mailbox.
Microsoft Exchange Web Server Configuration dialog box

Use this dialog box to configure Microsoft Exchange web server settings.
Option
Description
Web Service URL group
This group allows setting web service parameters.
Auto discovery based on email address
Select this option to get the Exchange service URL

automatically using the email address. When you select
this option, you should enter the email address into the
Service text field. (Select Test Autodiscovery)
1126
Option
Description
URL
Select this option to enter the Exchange service URL by

hand. When you select this option, you should enter the
URL of Exchange web service into the Service text field.
(Select Test connection)
Service
Use this text box to enter data according to what option

you select to get the Exchange service URL. If you select
Auto discovery based on email address option, then
you should enter the email address into this text field.
If you select URL option, you should enter the URL of
Exchange service into this text field.
Timeout
Define the timeout for attempts to connect to the server

in seconds. The default timeout is 100 seconds.
User Name
Enter the username used in conjunction with the

password field when authenticating with the exchange
server. The user should have access to the configured
mailbox.
Encrypt password
Check this box to encrypt the password.
Password
Enter the password used in conjunction with the

username field when authenticating with the exchange
server. You may define a password via RRTs.
Note: If you define a password via RRTs, you
should not select the Encrypt password check
box; otherwise, the password won't be read
correctly and the documents will be rejected.
Domain
Enter the domain that the user name belongs to.
Impersonation attribute
select the type of impersonation. There are three

available types: Principal name, e-mail and SID. If you
don't want to use impersonation, select None from the
drop-down list; at this case, the Impersonate as text
field will be disabled.
Impersonate as
enter the value for impersonation. Depending on what

type of impersonation is selected, you can enter either
the sender name, or e-mail or account SID.
Note: Before using impersonation with this
server, please, read the Configuring Exchange
Impersonation on the Microsoft Exchange
section of the MSDN Library.
Save copies of messages in Sent Item folder
If this option is checked, then a copy of email message

sent out will be kept in the sent items folder of the
configured mailbox.
Ignore certificate errors
Check this box to ignore certificate errors, when the

component attempts to send messages.
Test connection
Click this button to test the connection to the server.
Test Autodiscovery
Click this button to test if the service URL is found

automatically or not.
1127
Message tab
Use this tab to configure the message parameters.
Option
Description
From
Specify the Internet email address of the sender. You

must populate this field.
To
Specify the Internet email address of the recipient of the

email. You must populate this field.
Cc
Specify the Internet email address of the Cc recipient of

the email. This is an optional field.
Bcc
Specify the Internet email address of the Bcc recipient of

the email. This is an optional field.
Subject
Specify the subject of the email. This is an optional field.
Body
Provide a body and additional information for this email.

This is an optional field.
Rename file
Check this box if you want to rename documents that

you are sending through the component.
Schema
Specify the rename schema for the documents.
Component RRTs
Component RRT ID
The RRT ID for this component is STM.
This component replaces the following RRTNs:
RRTN
Description
~STM::FileName~
~STM::FileExtension~
The original extension of the file.

This component does not replace any FRTNs.
Name
Description
%a
%A
%b
%B
%d
%H
1128
Name
Description
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

~STM::%Y~-~STM::%m~ will be replaced by 2012-08.
Problem Description
Solution
This component is not sending email.
Make sure your sever name and the recipients email is

correct. If you have multiple recipients, make sure they
are separated by a semicolon.
The emails are rejected by the SMTP gateway server.
Make sure the SMTP relay parameter is turned on.
The email addresses entered in the To field are not

validated. Non-compliant addresses could be used.
Use the Notification Process component in your process.

Using the Notification component allows you to require
a user name and password so that you can prevent noncompliant addresses from being used.
When the component tries to send letters via Exchange

web service with impersonation the following error
appears:
This error appears when the currently logged on user has

no sufficient rights to impersonate the requested user.
"Unable to connect to the Exchange Web Service. Error

description: The server to which the applications is
connected cannot impersonate the requested user due to
insufficient permission."
When the component tries to send letters with large
attachments via SMTP server, the following error
message appears: "Not enough storage is available to
complete this operation".
To solve this problem, make sure that the current

user has the permission to impersonate the requested
account on the server. For a proper configuration
of impersonation, read Configuring Exchange
Impersonation.
This error may appear when the virtual memory
size is not large enough for a proper operation of the
component.
Make sure that the virtual memory size, set for the
machine where the workflow server is running, is large
enough so that the component successfully can send
letters with large attachments.
1129
For a proper operation of the component with Microsoft Exchange Server CDO 1.2.1 (Collaboration Data Objects
1.2.1) should be installed on the machine.
Note: There are the following restrictions in this case:
Microsoft Outlook 2010 does not support CDO.

When used on Windows 7, Windows 2008 R2 and Windows 8, CDO requires that Microsoft Outlook
should not be installed.
With SMTP Server, Server Name and From are mandatory fields. Make sure to enter valid values for each of these
fields.
With Microsoft Exchange Server the Server Name, Mailbox, User, Name, Password, Domain, From and To are
mandatory fields. Make sure to enter valid values for each of these fields.
Send to Mail Recipient component does not validate email addresses.
When renaming schema is used with CDO-MAPI, all accounts, used in configuration of the component, should
have the "Read" permission for Temp folder (when service is running as Local system folder Temp is C:
\Windows\Temp).
Send to PC
Welcome to the Send to PC component
Send to PC is a Route (destination) component that can be used to deliver documents to a designated inbox on user
PCs that are running the Send to PC client application.
The Send to PC component maintains a list of NT user names for client PCs that are currently connected to the Server.
When processing a job, the Send to PC component will be assigned a list of users that the documents with a job
should be delivered to. The assigned list will be compared with the maintained list to determine the location of the
document delivery.
The user can specify a Secret Key on the Send to PC client application. This will prevent document delivery if the
secret key for that user is not specified.
Getting started
Feature Highlights
Use this component to deliver documents to a designated inbox on a client PC.

Deliver documents to one or more client PCs.
Document delivery to designated client inboxes can be protected by defining a secret key in the Send to PC Client
application. When a secret key is specified on the client, documents will only be delivered if the secret key has
been provided.
This component works independent of the type of Capture component used in the process.
Using Send to PC component

The following provides example of common usage scenarios:
Send to My PC: The Multi-functional Devices that have authentication enabled, can be configured with a Send
to PC button, where by pressing this button, images are scanned in and then delivered to the authenticated users
designated inbox. This will also alleviate extra load/stress on the mail server.
Send to user workstation: Any user can now scan documents from an MFD and designate an user inbox for delivery.
This allows the recipient to be anywhere within the network.
Configuring the Send to PC component
Configure options for the Send to PC component in the Send to PC and Advanced dialog boxes.
Send to PC Dialog Box
1130
Advanced Dialog Box

Client Configuration
Send to PC dialog box

This dialog box specifies the destination users and folder.
Option
Send to
Description
Enter a comma separated list of Windows domain
users to which to deliver incoming documents. You can
specify domain name in format domain\username
. If you do not specify the domain name, the component
uses the default domain that is specified in the
Advanced dialog box.
For example, if there is a user called Earthling in the
domain EARTH, and the default domain is EARTH,
then the domain is not required and you can enter either
Earthling or EARTH\Earthling. However, if
you want to specify a user Martian in domain MARS,
then the domain name and user name must be entered as
MARS\Martian.
If a secret key is specified in the Send to PC Client
settings on a destination PC, the secret key must be
appended to the client name using the Separator
specified in the Advanced dialog box. For example, if
the secret key on the client for Earthling is "tree", and the
default separator "@" is specified for Separator, then
the user name would be entered as Earthling@tree.
Destination folder
Enter the name of the destination folder. The name of the

folder can either be its literal name or the name can be
specified by an alias on a destination computer. In order
to use an alias, the alias must be enclosed between angle
brackets (< and >).
For example, to use the alias "Test", it must be entered as
<Test>.
Aliases are created using the Send to PC Client
application. If an alias has not been created, the name
between the angle brackets is used as the literal name of
the destination folder. See the help documentation for
Send to PC Client for information about creating aliases.
Advanced
Click this button to open the Advanced dialog box to set

the connection attributes.
For details about options in the Advanced dialog box,
see Advanced Dialog Box.
Advanced dialog box

This dialog box specifies connection attributes for the component.
1131
Option
Description
Default Domain
The domain name that will be attached to user names

that do not specify the domain in the Send to list.
File Transfer Port
The server uses this port to deliver files to client PCs.

The default value is 3711. You may need to change this
if you are using the component in multiple processes
or if you are running both the server component and
the client application on the same machine. For more
information, see Restrictions and Limitations.
Separator
The character that separates a user name from the secret

key in the Send to list. The Separator value delimits
the beginning of the secret key in the user name string.
The default charactor for the separator is the at sign (@)
character.
The secret key is an option on the Send to PC Client. If
the Send to PC Client settings for a user specify a secret
key, then in the Send to box you must append the secret
key to the user name using the separator character in
order to send documents to the PC.
The comma (,) and the semicolon (;) cannot be used as
the separator.
Schema
Enter the schema name for the output file name. You can
set this value at run time.
Client Configuration dialog box

Apply these settings on the client to configure the Send to PC Client application.
Option
Description
Server
The Send to PC server that will be delivering documents.
Test
This button can be used to check the validity of the

specified Send to PC server.
User Name
The user currently logged on in the Windows

Domain\User name format.
Secret Key
An optional secret key that to protect the destination

folder. If a secret key has been defined, then documents
will be delivered to this inbox only if the appropriate key
is provided with the user name.
Automatically start when window starts up
As a convenience, Send to PC client will start every time

you turn on your computer. If you want to disable this
feature, clear the check box next to this option.
Automatically connect at startup
As a convenience, the Send to PC client will connect

automatically to the defined Send to PC server at startup.
If you want to disable this feature, clear the check box
next to this option.
1132
Option
Description
Directory for files received
The directory where incoming documents will be saved

to. The path can be directly typed into the field or a
Browse key, to the right end of the field, helps search the
hard disk.
Connect
Click on this button to connect to the specified Send to

PC server and register as client that is able to receive
documents.
Disconnect
Click on this button to disconnect from the Send to PC

server.
Send to PC component RRTs

This component does not generate Runtime Replacement Tags, however all the parameters can contain RRT strings.
For example, when POP3Email is the Capture (source) component, the Send to parameter can be set to ~POP::To~
to dynamically set the recipient based on the name in To value of an email.
Problem Description
Client cannot connect to the Send to PC component on
an AutoStore server.
Solution
Check if the client and server computers are running

Microsoft TCP/IP installed. If not, install the TCP/IP
protocol.
Check if the client computer can ping the
server computer (via IP address) using ping
server_ip_address. If there is no response, then your
computer is probably configured incorrectly or there
is a problem with the physical network connection of
your computer.
Check to make sure that the Registration and File
Transmit ports on the server and client match.
Make sure that the File Transmit Port port specified
in the Advanced dialog box is not blocked by a
firewall. You can check by using the Windows Telnet
Client on the client to connect using the specified
port. Refer to Windows Help and Support for
information about installing and using the Telnet
Client.
Make sure that the port does not conflict with another
application running on the server.
Document metadata is not delivered to a client PC.

Documents are not delivered to Windows user groups.
The client directory for received files cannot be dynamically set or changed at run time.
If a user is logged in to 2 different PCs at the same time, documents are delivered to the PC that the user logged
into last.
In order to use the Send to PC server component in multiple processes, the default registration and file transmit
ports must be changed (For example, set the first process to have 3711 for the registration and file transmit port,
and set the second process to have 3712 for the registration and file transmit port.)
1133
In order to run Send to PC server component and the client on the same machine, the registration and file transmit
ports cannot be the same (for example, set the file transmit port to 3711 on both the server component and in the
client application, and set the registration port to 3712 on both the server component and in the client).
If the user is logged in, the component will attempt to transmit the document 3 times before giving up and
rejecting the job.
Send to PC Client
Send to PC Client Configuration dialog box
Client configuration options are covered in the following topics.

Advanced dialog box

Configure Send to PC Client options in this dialog box.
Option
Description
Server
The Send to PC server that will be delivering documents.

Enter the IP address or network name for the server.
Test
Click button can be used to check the connection to the

specified Send to PC server. The Send to PC component
must be in a running task on the server.
Advanced
Click this button to configure connection options and

inbox subfolder aliases. For more information, see
Advanced Dialog Box.
User Name
The user currently logged onto the Windows

Domain\Username.
Secret Key
A secret key to protect your inbox. If a secret key has

been defined then documents will be delivered to this
inbox only if the appropriate key is provided in the Send
to PC settings on the server.
Automatically start when windows starts up
Select this check box to start the Send to PC Client

application when Windows starts. You can clear this
check box to disable this feature.
Select this check box to have the Send to PC Client

application automaticaly connect to the Send to PC
server at startup. You can clear the check box to disable
this feature.
Inbox folder
The complete path to the folder where incoming

documents will be saved. You can type the path or click
the Browse button to locate the folder.
Connect
Click on this button to connect to the specified Send to

PC server and register the client to receive documents.
1134
Option
Description
Disconnect
Click this button to disconnect from the Send to PC

server.
Advanced dialog box

Configure advanced Connect to PC Client options in this dialog box.
Option
Description
Connection Options
Specify the port number used to transmit documents

from the server. This setting should match the port
number configured for the Send to PC component.
Inbox Subfolder Aliases
Specifies subfolder aliases. These can be referred to

instead of subfolder names as destination locations in the
Send to PC configuration on the server.
Add
Click this button to add a subfolder alias to the Inbox

Subfolder Aliases list. In the Inbox subfolder alias
dialog box, specify values for the following options.
AliasSpecify the alias that will be used to

reference the folder.
ValueSpecify the subfolder name.
Remove
Click this button to remove the selected subfolder alias

from the Inbox Subfolder Aliases list.
Edit
Click this button to edit the Alias or Value for a selected

subfolder alias from the Inbox Subfolder Aliases list.
Import
Click this button to import alias definitions from a text

file. One alias definition should be entered on each line
with the alias and value separated by the vertical bar
character in this format:
alias1 | value1
alias2 | value3
alias3 | value3
...
Export
Click this button to export alias definitions to a text file.

The alias definitions are exported in the format described
for the Import option.
Problem Description
Client cannot connect to a running send to PC server
Solution
Does the client computer have Microsoft TCP/IP

installed? If not, install the TCP/IP protocol.
Check that client computer can ping the server
computer (via IP address).
1135
Problem Description
Solution
1. At a command prompt, enter ping
server_ip_address .
2. If there is no response, then either the computer is
configured incorrectly or there is a problem with
the physical network connection for the computer.
Send to Printer
Welcome to the Send to Printer component
Use the Send-to-Printer component to send scanned images directly to a printer. This component also allows you to
select the printer size, source, and zoom level. All print drivers for each printer must be installed and configured on
the server.
Use the Send-to-Printer component to define and designate a printer as the destination for images that are sent to the
server. This component enables the Multi-functional devices to define copying function keys that scan documents and
automatically send them to a defined printer location.
Send to printer provides batch printing of commonly used image files formats such as TIFF and JPEG. It also allows
the user to print PDF format after acquiring a special license.
With this component you can print documents to any printer that is configured in the machine where the system is
running. The system can also switch between printers based on the name or the extension of the document filename.
Send to Print can be used both as a Process component or Route component in a process workflow, depending on the
needs of the user.
This component uses Lead Technologies to manipulate different file formats without using any native application in
the service machine. The printing process is achieved by using the printer drivers installed in the service machine,
because of this you must setup previous to configuring the process any printers that you want the component to use.
Getting started
Feature highlights
Many business processes that deal with image documents incorporate printing as part of their workflow. The Send to
Printer component provides the means to satisfy many of the printing needs in a document management environment.
Whether obtaining a printed version of a document is the final goal of the process, or the system relies on printed
versions as an alternate source of information for users, the Send to Printer component can be used to accommodate
many scenarios where unattended printing will be necessary.
The Send to Printer configuration only allows you to specify parameters that are common to most print drivers, such
as paper size, printer name, pages per sheet, number of copies, and orientation. Other parameters that are specific to a
printer must be set in the local printer configuration.
Refer to the Restrictions and Limitations for a complete list of file formats supported by this component. Also only
non-interactive printer drivers are supported. Some printer drivers might not be supported when the system is running
as a service, as some printer drivers require interactive response from the user before printing.
Using the Send to Printer component
To use this component the user must first decide whether sending to a printer will be the final step of the workflow or
an intermediate one. This will define if Send-to-Printer component is used in the configuration as a Process or Route
component.
Use the Send-to-Printer component to accomplish these tasks:
Remote Copy
Scan files and route them to a remote printer.
1136
File type based printing
Scan files and send them to printers according to file

types
Color Copy
Scan in color and send the images to a color printer.
Print broadcast
Create process chains with Poll Directory Capture

component and Send to Printer Route component to
broadcast multiple copies of document to multiple
printers.
Special Printer Features
Printing confirmation page
The automatic stapling, and other specific features of

a printer, can be done by creating a copy of the printer
driver which has the stapling option on by default and
using this specific driver.
Use File Options within your workflow process to store
documents into a "Success" or "Failure" directory. If
you want confirmation page to be printer on success or
failure, use Poll Directory with Send to Printer to route
files from Success or Failure Directory to a printer.
Licensing the Send to Printer component

There are two types of licensing available for this component:
Image Files
The Send to Printer will support all the file formats

described in Restriction and Limitations, except for PDF
formats.
Image and PDF Files
The Send to Printer will support all the file formats

described in Restriction and Limitations, including PDF
formats (not available for HP DSS Workflow).
Configuring the Send to Printer component

Send to Printer Configuration dialog box
Use the Send-to-Printer component to route images to printers that are located anywhere on the network. This
component provides remote copying capabilities.
Each page (tab) in the Send-to-Printer component represents a printer that can receive image files. The General tab
defines the "catch-all" printer. Based on the file extension, you can further determine the routing. For example, you
can add a tab and define a separate printer for TIFF images, or define another printer for PDF files.
Option
Add
Description
Adds a printer tab for a defined file extension. All
files that include the file extension are routed to the
printer defined here rather than to the printers defined in
General tab.
Click the Add button to open the File Pattern dialog
box, which lets you type in a File Name Pattern. For
example, you can enter a file extension, such as *.pdf
or *.tif, which enables users to print out PDF or
TIF files with a particular set of properties that are
configured in the resulting tab.
Remove
Deletes the currently selected tab. You can delete any tab
except for the General tab.
1137
Option
Description
Activate
Activates the Send-to-Printer component to send images

to the printer.
Keep
This option is only available when Send to Printer

Process component (not Route component) is used.
Check this box to keep the original file and not delete it.
Printer Name
Select the printer name from the drop-down list of

printers configured on the server.
Paper
SizeEnter the paper size. The values that appear

in the drop-down list depend on the model of the
printer selected.
Sourceindicates the paper source based on
available paper sources on the printer driver. If you
click the Auto Select option, the printer uses the
paper tray that supports the paper size you have
selected. If you choose a paper source other than
Automatically Select, make sure that the correct form
(paper size) is assigned to the paper source.
For the exact definitions of the paper sizes and

sources available for your printer, consult the printer
documentation or contact the manufacturer.
Orientation
Choose how the document will be oriented on the page.

If you choose Portrait, the document will be oriented
vertically and if you choose Landscape, the document
will be oriented horizontally.
Copies
Number of copiesEnter the number of copies you

want to print.
To print a complete copy of the document before the

first page of the next copy is printed, select the Collate
check box. If you prefer to print all copies of the first
page and then print all copies of subsequent pages, clear
the checkbox.
Zoom
Specifies the number of pages that appears on each

printer page.
Sent to Printer component RRTs

This component does not generate Runtime Replacement Tags (RRTs). However, you can use RRTs to configure any
of the options for this component.
Problem
Server stops processing when trying to print document.
Solution
The print driver is trying to get interactive information.
Make sure your printer configuration does not request
any information from the user. For example if your
printer keeps a copy of the printing job, make sure the
1138
Problem
Solution
printer does not need to ask the name of the file, but
this is generated by the printer driver. If you are using
the system as a service any kind of interactive actions
will cause the service to stop until a response is given.
Note that for the case that you are using the interactive
version of the system it might be desirable that the
printer request additional information from the user.
An error occurs when trying to print a PDF file, even

though the system is licensed for PDF printing.
The PDF format you are trying to use is not supported.

If the application that generates the PDF document can
generate one of the PDF supported formats, use this
instead if your business process allows it.

This topic lists supported formats for the Send to Printer component. Only non-interactive printer drivers are
supported.
1-Bit FAX Formats

Other 1-Bit Formats
BMP Formats
Exif Formats
GIF Formats
JPEG Formats
PostScript Formats
TIFF Formats
WMF and EMF Formats
1-Bit FAX Formats
TIFF, compressed using CCITT

dimension
dimensions
TIFF, compressed using CCITT, group 4
dimension
dimensions
Raw FAX, compressed using CCITT group 4
dimension
dimensions
IOCA, compressed using CCITT group 4
IOCA, compressed using IBM MMR, with the
MO:DCA wrapper
IOCA, uncompressed, with the MO:DCA wrapper
MacPaint
Portable BitmapASCII File
Portable BitmapBinary File
XBitmap File
Microsoft Paint
Other 1-Bit Formats
1139
BMP Formats
Windows BMP, with no compression

Windows BMP, with RLE compression
OS/2 BMP version 1.x
Wireless Bitmap file. Type 0
Exif Formats

compression and with RGB color space
compression and with YCbCr color space
GIF Formats
CompuServe GIF
JPEG Formats

JPEG 2000 Format. This file format contains image
data and extra information about the contents and
PostScript Formats
PDF 1.3 (Image and PDF Files license required)

PostScript Language Level 3 files (Image and PDF
license required)
EPSEncapsulated PostScript (Image and PDF
Files license required)
TIFF Formats
Tagged Image File Format, with no compression and

with RGB color space and 8-bit grayscale
CMYK color space
YCbCr color space
RGB color space
CMYK color space
color YCbCr space
Tagged Image File with a vector image saved as a
DXF
Tagged Image File with JPEG 2000 Compression.
This file format contains only a stream of image data.
Tagged Image File with Wavelet CMP Compression
Windows Metafile
Windows Enhanced Metafile (EMF)
WMF and EMF Formats
1140
Send to SFTP Help

Welcome to the Send to SFTP component
The Send to SFTP route/eConnector component provides you with the mechanism for routing files to an SFTP server.
Additional control over the SFTP site transmission is provided through support for bandwidth flow-control.
The only difference between Send to SFTP route and Send to SFTP eConnector components is that Send to SFTP
eConnector component has two additional options:
Activate combo box activates the component depending on a condition.
Pass through check box makes documents available to the subsequent components, if selected.
These two options are absent in Send to SFTP route component configuration.
Getting started
Feature highlights
Send to SFTP component provides the following features:
Support for multiple SFTP sites

Dynamic file renaming and storage support
Flow control
Using the Send to SFTP component

An enterprise where PDF documents from several sources have to be placed on several SFTP servers. These
documents may then be processed for printing, or sending out as email, depending on the business needs.
Connectivity of remote offices to central office can be easily implemented using the SFTP component. Scanners
from remote sites can be easily connected to multiple sites using a secured FTP protocol.
feature of SFTP component. Bandwidth control lowers the impact of implementing distributed scanning on
Configuring Send to SFTP

Use the Send to SFTP dialog box to create, edit, or remove SFTP sites that are connected to by the Send to SFTP
component.
Option
Activate
Description
This combo box activates the component according to a
condition (see Conditional Activation).
This combo box is available only in the eConnector
configuration.
Pass through
Select this check box to make documents available to the

subsequent components in the workflow. This option is
available only in the eConnector configuration.
Default proxy
Click this button to enter or edit the default proxy server

settings. This button opens Default proxy server dialog
box.
Add
Click this button to add a new SFTP site into the list. It
opens Add Site Configuration dialog box.
Edit
its settings. It opens Edit Site Configuration dialog box.
1141
Option
Description
Remove
Click this button to remove selected sites from the list.


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
logic_expression ::Copyright 2014 Notable Solutions, Inc.
1142
logic_expression | logic_expression_and
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
1143


Constants
Examples:

Boolean).
value False.
1144
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
Proxy Settings dialog box

These options configure proxy server settings for an SFTP site.
This dialog box represents one of the following two configuration windows:
Default Proxy Settings dialog box allows you to configure the default proxy server settings.
Proxy Settings tab in the Advanced Settings dialog box allows you to configure the settings of the proxy server
that will be used to communicate with an SFTP site.
Option
Proxy type
Description
Select the proxy type that will be used in the
configuration. The following proxy types are available:
SOCKS4 proxy firewall
1145
Option
Description
Note: When you use this proxy type,

then only Login text box is enabled in
Authentication group, since this proxy server
type requires only logins.
Typical WEB proxy
SOCKS4a proxy firewall

NTLM authenticated WEB proxy
Windows Integrated Authentication proxy
Note: When you use this proxy server type
all options in the Authentication group are
disabled.
If you don't want to use a proxy server in your

configuration, select No proxy in the Proxy type combo
box. When you select No proxy, all the settings of this
dialog box become disabled.
Note: You can use the RRTs in this combo box;
in this case they should be replaced with the
following values:
Proxy type
RRT value
No proxy
ProxyNone
SOCKS4 proxy
firewall
ProxySocks4
SOCKS5 proxy
firewall
ProxySocks5
Typical WEB proxy
ProxyWEBStandard
SOCKS4a proxy
firewall
ProxySocks4a
NTLM authenticated
WEB proxy
ProxyWEBNtlmAuth
Windows Integrated
Authentication proxy
ProxyWEBIntegratedAuth
Proxy address
Enter the hostname or the IP address of the proxy server.
Port
Enter the port number which will be used by the proxy

server. The default port number is 8080.
If this check box is selected, user must specify the

login and password that will be used for authorization
on the proxy server. Otherwise, the component will
use "anonymous" login to connect to the proxy server.
By default, this check box is selected for all types
1146
Option
Description
of the proxy servers, except for Windows Integrated
Authentication proxy.
Login
Enter the username that will be used for connecting

through the proxy server.

via RRTs.
Password
Enter the password for the Login account used for

accessing the proxy server. This value will be only used
in case of Obtain password via RRT check box is not
selected.
Password RRT

Use default proxy
Check this box if you want to use default proxy server

settings. This check box is presented only in Proxy
Settings configuration tab.
Add/Edit Site Configuration dialog box

Use this dialog box to add or edit SFTP site configuration.
Option
Description
Site name
Enter the name of an SFTP site.
Server address
Enter the IP address or the server name of the SFTP site.

It is mandatory to fill this field.
Port
Enter the port number that will be used by the

component to establish connection to the SFTP server.
User name
Enter the user name of the client who will have access
rights to the SFTP site. After you specify the user name,
specify the password associated with this user. It is
mandatory to fill this text box.
Check this box if you want to obtain the password via

RRT at run time.
Password
Enter the password for the specified user name. It is

mandatory to fill this text box. This value will be only
used in case of Obtain password via RRT check box is
not selected.
Password RRT

Destination folder path
Enter the folder where the documents will be stored on

the SFTP server. If you specify a new folder in this field,
it will be created on the SFTP server. However, if you do
not specify a path or folder name, the data is stored in the
root directory of the SFTP server.
1147
Option
Description
Advanced
Click this button to test sending data to the SFTP server.

This button opens the Advanced Settings dialog box.
Test
Click this button to configure and run the test of the

connection to the specified SFTP site. This button opens
Run Test dialog box.
Overwrite destination file if file exists
Select this check box to overwrite the file if it already

exists. If you do not select this option, the file will not be
overwritten, and respective error message will appear in
the Status Monitor.
Rename file

renamed. The Schema field becomes enabled.
Schema
use Runtime Replacement Tags (RRT) to dynamically set
the value of the schema.
Note: The default schema is

~STF::FileName~_~STF::Counter~~STF::FileExt~
For example, if the input file name is File.tif, the
renamed file will be File_1.tif.
Use this dialog box to configure proxy server settings and flow control settings.
This dialog box consists of two tabs:
Tab
Description
Proxy Settings
Use settings on this tab configure the proxy server

settings.
Flow Control Settings tab
Use settings on this tab to set the parameters of transfer

rate.
Proxy Settings dialog box

These options configure proxy server settings for an SFTP site.
This dialog box represents one of the following two configuration windows:
Default Proxy Settings dialog box allows you to configure the default proxy server settings.
Proxy Settings tab in the Advanced Settings dialog box allows you to configure the settings of the proxy server
that will be used to communicate with an SFTP site.
Option
Proxy type
Description
Select the proxy type that will be used in the
configuration. The following proxy types are available:

Typical WEB proxy
SOCKS4a proxy firewall
1148
Option
Description

NTLM authenticated WEB proxy
Windows Integrated Authentication proxy
Note: When you use this proxy server type
all options in the Authentication group are
disabled.
If you don't want to use a proxy server in your

configuration, select No proxy in the Proxy type combo
box. When you select No proxy, all the settings of this
dialog box become disabled.
Note: You can use the RRTs in this combo box;
in this case they should be replaced with the
following values:
Proxy type
RRT value
No proxy
ProxyNone
SOCKS4 proxy
firewall
ProxySocks4
SOCKS5 proxy
firewall
ProxySocks5
Typical WEB proxy
ProxyWEBStandard
SOCKS4a proxy
firewall
ProxySocks4a
NTLM authenticated
WEB proxy
ProxyWEBNtlmAuth
Windows Integrated
Authentication proxy
ProxyWEBIntegratedAuth
Proxy address
Enter the hostname or the IP address of the proxy server.
Port
Enter the port number which will be used by the proxy

server. The default port number is 8080.
If this check box is selected, user must specify the

login and password that will be used for authorization
on the proxy server. Otherwise, the component will
use "anonymous" login to connect to the proxy server.
By default, this check box is selected for all types
of the proxy servers, except for Windows Integrated
Authentication proxy.
Login
Enter the username that will be used for connecting

through the proxy server.

via RRTs.
1149
Option
Description
Password
Enter the password for the Login account used for

accessing the proxy server. This value will be only used
in case of Obtain password via RRT check box is not
selected.
Password RRT

Use default proxy
Check this box if you want to use default proxy server

settings. This check box is presented only in Proxy
Settings configuration tab.
Flow Control Settings tab

Use this tab in the Advanced Settings dialog box to set the transfer rate parameters.
The component provides an easy method to control the speed with which the data is transmitted. This is especially
useful when you don't have the bandwidth to transfer larger files and need to reduce the impact on the network.
Option
Description
Activate flow control
Select this check box to activate the flow control options.
Transfer interval (Milliseconds)
Use this slider to set the desired transfer intervals in

Milliseconds. A transfer interval is a period of time
between sending chunks of data. The longer the interval
the slower the transmission rate.
Buffer size (Bytes)
Use this slider to set the size of each transmitted buffer.

The larger the buffer size the higher the transmission
rate and the larger impact on the bandwidth. The value
should be between 512 and 32768 bytes.
Run Test dialog box

This dialog box allows you to test the connection with an SFTP server.
Option
Description
Connection timeout
Specify the timeout for the connection with an SFTP

server.
Run test
Click this button to begin a test. The test will be

conducted against your SFTP server. The component will
send 100 KB of data using the SFTP protocol. At the end
of the test the results are reported in 100 KB/X Seconds
where X is the number of seconds required for sending
100 KB. The typical size of B/W documents is between
25 and 50 Kbytes. You can stop a test by clicking the
Stop button. Then the results are then reported in Y KB/Z
seconds, where Y is the number of kilobytes that the test
was able to process and Z is the number of seconds taken
to send the Y kilobytes.
Test result
This field displays the progress of the test.
1150
Note: To use the test feature, you must have SFTP access to the SFTP server from your machine. This
feature establishes connection to the SFTP server and transmits dummy data to the server to test the
transmission bandwidth.
Send to SFTP component RRTs
Component RRT ID
The RRT ID for the component is SFP.
Name
Description
FileName
Counter

FileExt
~SFP::FileName~~SFP::Counter~ is replaced with the value "Document5" if the original file name was
"Document" and there were up to 4 (Document1 to Document4) files already within the destination folder path.
Note: The Reserved RTN values FileName, Counter, FileExt can only be used for the Schema setting
in the Edit/Add Site Configuration dialog box of this component. In other words, you may not use
~SFP::FileName~, ~SFP::Counter~, ~SFP::FileExt~ in any other component but Send to SFTP
component, and it must only be used with the Schema setting of this component.
This component supports the field RTN values listed below:
Name
Description
%URL, [Site Name]%
The list of URLs of uploaded files for the [Site

name] SFTP server. This RRT is applicable only for
the eConnector component and can be used in the
%PATH, [Site Name]%
The destination path for the [Site name] SFTP server.

This RRT is applicable only for the eConnector
component and can be used in the subsequent
components.
%FILE, [Site Name]%
The list of the uploaded files to the [Site name] SFTP

server. This RRT is applicable only for the eConnector
component and can be used in the subsequent
components.
~SFP::%URL, [MyServer]%~ is replaced by sftp://MyServer/Folder1/MyDocument.txt

~SFP::%PATH, [MyServer]%~ is replaced by /Folder1
~SFP::%FILE, [MyServer]%~ is replaced by MyDocument.txt
1151
Note: For correct work of the ~SFP::%URL, [Site Name]%~, ~SFP::%PATH, [Site
Name]%~, ~SFP::%FILE, [Site Name]%~ RRTs the following restrictions should be accepted:
The site names should not contain the tilde (~), colon (:), per cent (%), comma (,), and slash (/) symbols.
All sites should have different names.

Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

~SFP::%Y~-~SFP::%m~ will be replaced by 2010-06.
Non-standard settings of SFTP service are not supported.

For correct work of the ~SFP::%URL, [Site Name]%~, ~SFP::%PATH, [Site Name]%~, ~SFP::
%FILE, [Site Name]%~ RRTs the following restrictions should be accepted:
The site names should not contain the tilde (~), colon (:), per cent (%), comma (,), and slash (/) symbols.
All sites should have different names.
1152
Problem Description
Files cannot be copied into the destination directory.
Solution
Make sure that the destination folder has Write

access.
Check username/password to make sure it is valid.
Make sure there are no firewalls.
If overwrite existing is not checked off, make sure
that a file with the same name does not exist yet.
SFTP Poll
Welcome to the SFTP Poll component
SFTP Poll is a Capture (source) component used to download files from SFTP sites. This component scans SFTP sites
listed in its configuration, looks for new files that match particular filter configurations, polls the files, and puts them
into knowledge objects. It provides also a scheduled activity from each site that allows the SFTP traffic to be targeted
during designated hours.
SFTP Poll is a blocking component, which means that it requires configuring of other components that follow SFTP
Poll in the processing chain.
Getting started
Feature highlights
Capturing files matching name filters from multiple SFTP sites.

Scheduled download.
Transfer interval and buffer size control.
Using the SFTP Poll component

Set up SFTP Poll attributes as required by your business process and add Process and Route components to your
Workflow Server process. The files are automatically passed to the following component and, at the end of the
process, they are kept either in "Processed" or in "Rejected" folders defined in SFTP Poll configuration.
Configuring the SFTP Poll component
Main window
Use main component window to create new sites, edit or remove the existing sites.
The component will scan the listed URLs and poll new files from them according to the settings of every site.
Option
Description
Add
Click this button to add a new site into the list. This
opens the Add SFTP Site dialog box.
Edit
its settings. This opens the Edit SFTP Site Properties
dialog box.
Remove
Select a site or several sites in the list and click this

button to remove them.
1153
Add/Edit SFTP Site dialog box

This dialog box allows you to configure settings of a particular SFTP site.
This dialog consists of the following tabs:
Tab
Description
General Tab
Use settings on this tab to set the Site name and

Description of the SFTP site
SFTP Tab
Use settings on this tab to set SFTP properties.
Files Tab
Use settings on this tab to set files options.
Schedule Tab
Use this tab to specify the periods of time during which

the component will download files from SFTP sites.
Components Tab
Use settings on this tab to configure other components

that take part in the workflow.
Advanced Tab
Use this tab to configure the flow control options.
General tab
Use settings on this tab to set the Site name and Description of the SFTP site
Option
Description
Site name
Enter the name of the SFTP site, that will be used in the
workflow.
Description
Enter the description for the selected SFTP site.
SFTP tab
Use settings on this tab to set SFTP properties.
Option
Site URL
Description
Enter the URL of the SFTP site in the following form:
[sftp://]host[:port][/path]. In particular, you can enter IP
address or NetBIOS name of the required machine.
Examples: sftp://mycompany.com:8070, 197.168.0.163,
MainSFTPserver:8080.
Prefix path with dot
This check box allows you to set up the configuration

depending on a particular site behavior.
1. When this option is turned ON, the [/path] section
of the Site URL is prefixed with the dot (., a
current directory symbol) in the remote path for file
downloading. For example:
Site URL
Remote path
"site/path"
"./path"
"site/"
"."
"site"
"."
2. When this option is turned OFF, then the [/path]

section of the Site URL is sent as it is. For example:
1154
Option
Description
Site URL
Remote path
"site/path"
"path"
"site/"
""
"site"
""
"site/./path"
"./path"
"site/."
"."
"site//path"
"/path"
By default, this option is turned ON. If the site requires

an absolute path to be included in the remote path and
you are going to capture files from a subdirectory; for
example, Mysite/Sub1, then it is recommended to turn
this option OFF and to use an additional slash in the Site
URL, for example, Mysite//Sub1.
Login

to the SFTP server.
Note: The component does not allow user
names containing spaces, although it is possible
to create such a user name on the SFTP site.
Password
connect to the SFTP server.
Test connection
Click this button to check connection with the defined

SFTP.
Files tab
Use settings on this tab to set files options.
Option
Description
File filter
Input filter for files. Only files matching the filter will be
downloaded by SFTP Poll. By default the filter is set to
*.* (this means that any files will be downloaded). "*" is
a wildcard meaning that any possible characters will be
accepted. You can enter several file filters, separated by ;
(semicolon) without spaces.
Working directory
Files will be downloaded to this folder before being sent

to the subsequent components. If the folder does not
exist, it will be created.
Keep processed files
If a file is successfully processed through the workflow,

that is, if it reaches the destination, it will be placed into
this directory.
Keep rejected files
If the option is on, files that failed to process through the

entire workflow will be copied to the folder defined here.
Schedule tab
1155
Use this tab to specify the periods of time during which the component will download files from SFTP sites.
Option
Description
Start
Define time at which download should start.
Finish
Define time at which download should stop. If the finish

time is earlier than the start time, the component will
start at the start time and continue checking files until the
finish time next day.
Interval
Set time interval at which the component will check the

SFTP site for new files to be downloaded.
Start days
Select days of week for which these schedule settings

will apply.
Note: If the schedule is disabled, then all files found at SFTP sites will be polled by the component. They
will not be passed to the next component in Workflow Server process until they all are polled.
Components tab
Use settings on this tab to configure other components that take part in the workflow.
To configure settings of a component, select a component in the list of components and press the browse button.
Note: SFTP Poll is a blocking component, which means that it requires configuring of other components that
follow SFTP Poll in the processing chain.
Advanced tab
Use this tab to configure the flow control options.
Option
Description
Enable data flow control
Maximum transfer interval (Milliseconds)
Use this slider to set the desired transfer intervals in

Milliseconds. A transfer interval is a period of time
between capturing chunks of data. The longer the
interval the slower the transmission rate.
Buffer size (Bytes)
Use this slider to set the size of each transmitted buffer.

The larger the buffer size the higher the transmission rate
and the larger impact on the bandwidth.The value should
be between 512 and 65536 bytes.
Note: If data flow control is disabled, then the control is not provided and the files are downloaded with
maximally possible rate.
SFTP Poll component RRTs
Component RRT ID
The RRT ID for this component is SFT.
The following table describes the reserved RTN values of this component.
Note: The RRTs are generated for each file separately.
1156
Name
Description
~SFT::SiteName~
The original SFTP site name, which is set in the sites

configuration in General tab.
~SFT::SiteDescription~
The SFTP site description, which is set in the sites

configuration in General tab.
~SFT::SiteIP~
The site URL, which is defined in the sites configuration

in SFTP tab.
~SFT::Path~
The path to the folder where the file is placed.
~SFT::FileName~
The name of the file (without file path and extension, for
example, File1 - NOT File1.txt or C:\Temp\File1.txt).
~SFT::FileExt~
The file extension (without a dot).
~SFT::DatePolled~
The date the file was downloaded.
~SFT::TimePolled~
The time the file was downloaded.
~SFT::SiteName~~SFT::SiteIP~ is replaced with the value "Music192.168.0.115" if the defined site name
was "Music" and the selected IP was 192.168.0.115.
The number of downloads that can be created depends on many factors, such as the number of running system
processes or services. (On the average, the maximum number of downloads is about 40.) In order to be able to run
more downloads it's necessary to apply additional settings.
The recommended way is to allow the Capture Server's Windows service to interact with desktop. To do this, go to
Service Manager, select the Log On tab. In the "Log on as" group, select the "Local System account" radio button,
and select the "Allow service to interact with desktop" check box, and press OK. If the service is running you will
need to restart it.
The other way to allow more downloads requires editing the registry using the Registry Editor. WARNING: Using
Registry Editor incorrectly can cause serious system-wide problems that may require you to reinstall the system
to correct them. When the "Allow service to interact with desktop" option is checked for the Server's service, it
runs in the interactive window station. If this option is off, the service runs in the non-interactive window station.
By default, the non-interactive window station has a desktop with 512 kilobytes heap, whereas the desktop of the
interactive window station has 3 megabytes heap. The number of downloads is limited by the heap size. If you
wish to run the service in the non-interactive window station (with "Allow service to interact with desktop" option
switched off), you may increase the heap size of the non-interactive window station's desktop. Please read the
Microsoft Knowledge Base for details which you can find in the article INFO: COM Servers Activation and NT
Windows Stations in the Window Stations and Windows NT Resources section.
The number of scheduled downloads that can run simultaneously depends on many factors, such as available
physical memory, processor performance, the average time required for processing of one polled file, and the
number of files coming from SFTP sites. (Please note that this section is applicable to the scheduled downloads
only.) For each download working in scheduled mode, the component collects messages that will be output to
Status Monitor and to log files. These messages are output and deleted from the memory each time the server
process runs (the frequency of running is set up in server process information dialog). The number of messages
stored in memory can grow if there are too many files to download, and the server does not have enough time
to process them. If this occurs, you need to adjust scheduling settings, and possibly the frequency of SFTP Poll
process as well. If you set up the server to make a smaller pause between runnings of the process, it will flush the
status messages more often, and SFTP Poll will consume less memory space. If you schedule SFTP polling with a
longer interval, or within a shorter period of time, the number of messages will decrease, which results in smaller
memory space used as well. In order to determine, whether it is necessary to adjust your polling process, you can
look at the log files created in the debug mode. There are a number of messages containing 'message generation'
1157
and 'message output to the server' times. If after a period of work, there are messages in the log file, which were
output long after their generation (the time difference is significantly more than the process frequency), this means
that the process needs to be adjusted.
The component does not allow user names containing spaces, although it is possible to create such a user name on
the SFTP site.
Problem Description
Solution
When you are downloading files from a subdirectory; for Probably, the SFTP site requires an absolute path to be
example, Mysite/Sub1, the files are not captured by the
included in the remote path for files downloading and
component.
the /Sub1 section of the Site URL is prefixed with a dot
(., a current directory symbol). Turn the Prefix path
with dot option OFF and use an additional slash in the
Site URL; for example, Mysite//Sub1.
The process hangs after processing several sites.
Probably the maximum downloads amount has been

exceeded. Make sure that additional settings for
extending the number of downloads as described in
Section 1 of Restrictions and Limitations are set.
SharePoint 2007
Welcome to the SharePoint 2007 component
SharePoint 2007 route/eConnector component is used to route documents and list items, for example, tasks or issues,
to Microsoft SharePoint. The component allows assigning necessary properties to the sent files and setting access
rights to the routed documents and list items.
The component was designed for using with Microsoft Office SharePoint Server 2007 and Windows SharePoint
Services 3.0, each one further referred to as SharePoint 2007 Server.
Note: The component has a server module which represents a web service running on SharePoint 2007
Server. To properly connect to a remote SharePoint 2007 Server from a client machine, the user has to install
this web service on the SharePoint 2007 Server machine.
Getting started
Feature highlights
The component provides you with the following features:
Sending documents to SharePoint 2007. Specify the destination (site, document library, folder, name) and the
parameters of the routed document (fields, content type, permissions).
Creating items in a list on SharePoint 2007 Server and specifying their properties: content type, fields,
permissions.
Check-in capability.
Renaming the routed document with the rename schema.
Using the SharePoint 2007 component

Use this component to store documents into a centralized, unified interface for enterprise users and highly flexible
deployment options.
How to route scanned documents into SharePoint 2007
1. Design a workflow process with MFP component corresponding to the selected type of MFP device and
SharePoint 2007 Route component.
1158
2. Configure SharePoint 2007 Route component to route the scanned documents into SharePoint folder with
assigning of the properties that uniquely identify the document.
3. Configure both components and start the server.
Now when the walk-up MFP user enters a pre-configured function key on the control panel of the MFP device, the
scanned document with the configured properties is routed directly into SharePoint 2007 Server.
How to send emails directly into SharePoint 2007
1. Design a workflow process with SMTP Capture component, SharePoint 2007 eConnector component and Send to
Folder Route component.
2. Select the Activate check box in SharePoint 2007 Process configuration.
3. Configure all 3 components and start the server.
Now all incoming emails sent to an SMTP gateway are:
Saved into a pre-configured folder on the SharePoint 2007 Server for archival management or sharing purposes.
Routed to the local or network folder according to Send to Folder configuration.
You also can configure SharePoint 2007 eConnector component to route list items with some email information to
take stock of emails on the server.
Configuring the SharePoint 2007 component
The component configuration window consists of three tabs:
Tab
Description
General tab
Use this tab to set general connection parameters to log

in to SharePoint 2007 Server.
Documents tab
Use this tab to specify the parameters of the routed

documents.
List Items tab
Use this tab to specify the attributes of the list items that
you want to add to lists on SharePoint 2007 Server.
General tab
Use this tab to set general connection parameters to log in to SharePoint 2007 Server.
Option
Description
Activate
This check box is present only in eConnector component

to store captured document into SharePoint 2007 Server
before further processing by the subsequent components.
If this box is not checked, the component won't perform
any actions during files processing.
Pass through
This check box is present only in eConnector component

configuration window. Select this check box if you
want the documents to be available to the subsequent
Connection
This group contains connection parameters.
Server address
Enter the address of the SharePoint 2007 Server on

which the documents or list items will be stored. This
field can contain "http://" or "https://" followed by server
name or IP address. For example, "http://sp2007" or
"https://192.168.0.178". Alternatively, it can contain
only server address, for example, "sp2007" - in this
1159
Option
Description
case the component will use "http://" prefix before it
automatically. It is mandatory to fill out this field.
User name
Enter the user name that will be used to log in to the

server. If you are using a domain user account to connect
to SharePoint 2007, enter the user name with the domain
name; for example, ORGDOMAIN\SpUser. The local
server users can enter only the user name; for example,
SpUser. It is mandatory to fill out this field.

via RRT. When this check box is selected, the Password
text box becomes disabled. In this case the component
will use the password obtained via RRT at run time to
connect to the SharePoint 2007 Server.
Password
Enter the user password which will be used to log in to

the server.
Password RRT
Enter another component RRT that contains the

password to the user specified in User name. This text
box is enabled only if the Obtain password via RRT
Note: You should never specify a fixed
password instead of an RRT in the Password
RRT text box, since the value of this field is not
encrypted. To specify a fixed password, please
use the Password text box.
At the configuration time the component always
uses the value of the Password text box as
the user password for connection to the object
store even if the Obtain password via RRT is
selected.
Impersonate
Select this check box to change the author of the sent

document. Enter the name of a new author in the
impersonate text box. If this check box is not selected,
the author will be the user specified in the User name
text box.
Note: The impersonation in this component is
partial. This means the following:
1. At the configuration stage, switching
Impersonate option does not affect the
component controls behavior except for the
controls available in Permission settings
dialog box and its child dialog boxes.
The functionality of these dialog boxes
(getting lists of permissions and groups, user
validation) works under the impersonator
account.
2. At run time the documents and list items are
sent under the impersonator account.
If you use the Impersonate option, you should
be sure that the user specified in the User name
1160
Option
Description
text box has the administrator permissions. This
is necessary in order to keep security by not
allowing any SharePoint 2007 user to route
documents under other users credentials.
Site

to store the documents or list items either manually or
select the site from the drop-down list. You can specify
a subsite of the site entering its name after the parent
site name followed by "/", for example, SubSite1/
SubSite1_1. If a site is not specified, the component
will store documents or list items in the base SharePoint
directory.
Advanced
Click this button to open the Advanced Connection

Settings dialog box that allows you to specify web
protocol timeout.
Advanced Connection Settings dialog box

This dialog box allows you to set the timeout for uploading documents and list items.
Option
Web protocol timeout
Description
Specify the timeout in seconds for uploading documents
or list items into the SharePoint 2007 Server. If a
problem occurs while uploading, or a very big file
is being uploaded, the component waits for this time
and when the timeout expires, the component aborts
uploading and rejects the document. It is recommended
to increase timeout value when sending big documents
or when sending documents into the document library
which already contains a large number of the documents.
Documents tab
Use this tab to specify the parameters of the routed documents.
Option
Description
Route documents
Select this check box if you want to route documents to

SharePoint Server. If this check box is not selected, the
component won't route any documents (for example, if
you need to route list items only).
Document library
Enter the name of the document library that you want

to work in either manually or select the library from the
drop-down list. If the specified library does not exist on
the server, the configuration can be saved, however an
error message will appear at run time. It is mandatory to
fill out this field.
Folder path
Enter the name of the folder where the routed files will
be stored either manually or browse to the desired folder
using the
button. This button opens the Select
Folder dialog box. You can create a folder dynamically
by entering a new name for the folder. You can also
create a subfolder of the existing folder by entering the
subfolder name after the folder name followed by a slash
1161
Option
Description
mark (/), for example, Folder1/New folder. You can use
one or several available RRTs to create folder names.
Note: You cannot use ~SPS::Counter~ to
dynamically set folder names.
Rename schema
Select this check box if you want to rename routed

documents. In order to do this enter the schema for the
output file name in the field next to this check box. You
can use one or several available RRTs to dynamically set
the value of the schema.
If this check box is not selected, the routed file will keep
its original name.
If this check box is selected and the
rename schema is not specified, then at
run time the default schema will be used:
~SPS::FileName~_~SPS::Counter~~SPS::FileExt~.
For example, if the input file name is File.tif, the
renamed file will be File_1.tif.
Check in comment
This field is enabled only if Check in option is selected.

Enter a comment to the document that you are checking
in. You can use one or several available RRTs in this
field.
create check in comment.
Check in
If you select this check box, the file will be checked in

on the server. This means that the file will be available
to other users for editing and check-out, if they have
appropriate permissions.
Overwrite
If you select this check box, a routed document replaces

the existing document with the same name in the
specified path as a new version. In other words, the
version of a routed document will be increased by 1.0 in
comparison with the version of the existing document
that have the same name. However, if a document with
the same name does not exist in the specified path, the
version of the new routed document will be set to 1.0.
If this option is not selected and the file already exists
in the specified library, the routed document will be
rejected.
Note:
If you send a document to a document

library where the Require check out option
in the Document Library Versioning settings
is set to "No" and the last version of the
file on server is checked in, the component
may create more than one new document
versions. Such behavior is related to the
Share Point 2007 server that creates a new
version when performing each operation:
1162
Option
Description
saving file, assigning fields, assigning

permissions, and so on.
Creation of a new version is possible only
if this functionality is set for the specified
document library. Otherwise, the routed
document will simply replace the existing
document of the same name.
Permissions
Click this button to set the permissions, that is, access

rights that users or groups will have. The Permissions
Settings dialog box will open.
Content type
Specify the content type of the document manually

or select the type from the drop down list. A content
type describes the set of properties of the document
and its behavior. The content types are defined on the
SharePoint 2007 Server at the site level and can be
applied to document libraries or lists configured to
manage them. You can use RRT in this combo box.
Note: You can set up the content type in two
ways:
1. Specify the content type in the Content type
combo box.
2. Leave the Content type combo box blank
and specify the value of the Content Type
field in the Fields list.
If you do not specify the content type and the
specified document library is configured to
use content types, the document will have the
default "Document" content type.
Fields
This group allows assigning properties or fields to the

routed document.
Note: Each document library has its own
specific set of fields. If this document library
requires a set of mandatory fields, these fields
will be assigned to the document anyway. If you
don't specify the values of mandatory fields,
they will be set to default values specific to the
document library.
The component verifies the correctness of the
specified fields at the configuration stage. If
you specify an incorrect field, the component
displays the
sign before the field name. If
you specify the document content type in the
Content type combo box, the component will
check if the fields configured in the Fields list
belong to the specified content type. When
the Content type combo box is blank, the
component checks if the configured properties
belong to the list of all possible fields of the
document library.
1163
Option
Description
If the component cannot verify the correctness
of a field name, for example, if the Content
type, Document library, Server address
or Site value contains an RRT, the
displayed before the field name.
sign is
Ignore missing fields
If this option is selected, the component will ignore

fields that are specified in the configuration and absent
on the SharePoint server. If this option is not selected
and you specify fields that are absent on the server,
routed documents will be rejected.
Add
Click this button to add a new field to the fields list. This
opens the Add Field dialog box.
Edit
Click this button to edit properties of the selected field

from the list. This opens the Edit Field dialog box will.
Remove

Select Folder dialog box

This dialog box displays the folders of the selected document library as a tree.
The tree displays only those folders, in which the user has permission to write. Select the folder where routed
documents will be stored and click OK.
Permissions Settings dialog box
Use this dialog box to indicate users or groups that can access routed document.
The dialog window displays the current list of permissions given to users or user groups.
Column
Description
Type
This column displays one of two alternatives: User or

Group.
User Name
This column displays the name of a corresponding user

or group.
Permissions
This column displays access right the corresponding user

or group has.
Option
Description
Inherit permissions from its parent folder or library
If this check box is selected, the document will inherit

permissions from its parent folder or library. In this
case, the buttons on the right side of this dialog box are
disabled. If this check box is not selected, the buttons are
enabled.
Add
Click this button to add a new permission to the

permissions list. The Add Permission dialog box will
open.
Edit
Click this button to edit the properties of the selected

permission. The Edit Permission dialog box will open.
1164
Option
Description
Delete
Select one or several permissions and click this button to

remove the selected permissions from the list.
Restore
Click this button to return to the previous list of

permissions.
Add/Edit Permission dialog box

In this dialog box you can add a new permission to the permissions list or edit the properties of the selected
permission.
Option
Description
Type
Select the type of entity to which you want to grant

permission: User or Group.
Name
Enter the name of the user or the group that will have the
permission.
Note: If you choose the "User" type, you can
enter the user name in one of the following
forms:
Login name, for example, mydomaincom

\johns or johns;
Display name, for example, John Smith;
E-mail, for example,
johns@mydomain.com.
and click the

button next to this field to
make the component attempt to validate the
specified user. The component searches the
user in the SharePoint2007 users list, and if
the user is not found, searches it in the domain
users list. If the validation is successful, the
user name is displayed in the Name field in the
form of display name. If the validation fails,
the following message appears in the lower
part of the dialog box: "User name could not be
resolved".
If you choose the "Group" type, you can enter
the group name manually or select using the
button next to this field. This button opens
the Select Name dialog box.
Permissions
Enter permission to the corresponding user or group

either manually or select from the drop-down list.
Notes
Enter a comment to the permission. If you choose the

"Group" type, this field contains the description of the
selected group.
Note: If you select the Impersonate option on the General tab, then the functionality of this dialog
(displaying drop-down list of permissions and user validation) works under the impersonator account.
Select Name dialog box
1165
In this dialog box you can select the group which will have the permission.
Option
Name
Description
Enter name manually or select from the drop-down list
of the SharePoint groups.
Note: If you select the Impersonate option
in the General tab, then the drop-down list
displays only the groups available for the
impersonator.
Add/Edit Field dialog box

In this dialog box you can add a new field to the fields list or edit the properties of the selected field.
Each document library has its own specific set of fields. You may add any field from this set. If this folder requires a
set of mandatory fields, these fields will be assigned to the document anyway. If the user does not specify the values
of mandatory fields, they will be set to the default values specific to the folder.
Option
Name
Description
Enter the field name either manually or select the name
from the drop-down list of the fields specific to the
document library. The names of the mandatory fields are
marked off with '*'.
Note: You can enter any custom field name,
but if the entered name is not specific to this
document library, the document will not be
routed and an error message will appear.
The components supports only the following
types of fields:
Value
Single line of text

Choice
Number
Currency
Date and Time
Yes/No
Person/Group
Hyperlink
Enter field value either manually or select it from the

drop-down list of the values specific to this field.
Note: If the specified field points to a user, you
can enter the value of this field in one of the
following forms:

\johns or johns;
johns@mydomain.com.
If the specified field points to a date, you can

enter the value of this field in one of the server
locale supported date formats; for example,
06-20-2007 or Jun, 20, 2007.
1166
Option
Description
If the specified field points to a hyperlink, you
following forms:
<http://somelink> or <https://somelink>
[http://somelink] or [https://somelink]
http://somelink or https://somelink
You can use one or several available RRTs to create field

values.
set the value of the schema.
List Items tab
Use this tab to specify the attributes of the list items that you want to add to lists on SharePoint 2007 Server.
An item is specified as a set of fields and their values.
Option
Description
Route list items
Select this check box if you want to create list items. If

this box is not checked, the component won't create any
list items (for example, if you need to route documents
only).
List
Enter the name of the list on the specified server where

list items will be created, or select the list from the
drop-down list. If the specified list does not exist on the
server, the configuration can be saved, however an error
message will appear at run time. It is mandatory to fill
out this text box.
Overwrite
If this check box is selected, the component will compare

the existing items in the specified list on the server with
the one that is being added, and if they coincide, the
old items will be replaced with the new one. Items are
compared based on the values of certain key fields. Click
the Search keys button to specify these fields. If this
check box is not selected, new items will be added to the
list without replacing old ones. In this case there may be
several items with identical field values.
Search keys
This button is enabled only when the Overwrite check

box is selected. Click this button to specify the fields that
will be used as a basis for item comparison. The Search
Keys dialog box will open.
Note: If you use the Overwrite option and
specify a particular list item field as key field,
this field should be added to the Fields list for
correct replacement. Because it will provide the
values with which to compare the fields.
Permissions

rights that users or groups will have. The Permissions
Settings dialog box will open.
1167
Option
Content type
Description
Specify the content type of the list item. You can enter
the content type manually or select the content type from
the drop down list. The content types are defined on the
SharePoint 2007 Server at the site level. You can use
RRT in this combo box.
ways:
combo box.
2. Leave the Content type combo box blank
and specify the value of the Content Type
field in the Fields list.
If you do not specify any content type and the
specified list is configured to use content types,
the list item will have the default Item content
type.
Fields

routed list items.
Note: Each list has its own specific set of
fields. If this list requires a set of mandatory
fields, these fields will be assigned to the list
item anyway. If you do not specify the values
of mandatory fields, they will be set to default
values specific to the list.
If you use the Overwrite option and want some
list item fields to be replaced by the new values,
you should add these fields to the Fields list
for correct replacement, even if these fields are
mandatory.
specified fields at the configuration stage. If
you specify an incorrect field, the component
displays the
you specify the list item content type in the
Content type combo box, the component will
check if the fields configured in the Fields list
belong to the specified content type. When
component checks if the configured properties
specified list.
If the component cannot verify the correctness
of a field name, for example, if the Content
type, List, Server address or Site value
contains an RRT, the
the field name.
sign is displayed before

1168
Option
Description
Add
Click this button to add a new field to the fields list. The
Add Field dialog box will open.
Edit

from the list. The Edit Field dialog box will open.
Remove

Search Keys dialog box

In this dialog box you can specify key fields that will be used to compare items.
Option
Description
List items search keys
This group contains a list of key fields and the buttons

for managing this list.
Add
Click the button to add a new key field to the list. This
opens the Add Search Key dialog box.
Delete
Select one or several key fields and click this button to

delete the selected key fields from the list.
Add Search Key dialog box

Use this dialog box to add a new key field to the list of key fields.
Option
Description
Key name
Enter the name of a key field either manually or select

the name from the drop-down list of fields. The names of
the mandatory fields are marked off with '*'.
Permissions Settings dialog box

In this dialog box you can indicate users or groups that can access created list item.
Column
Description
Type

Group.
User Name
This column displays the name of a corresponding user

or group.
Permissions
This column displays access right the corresponding user

or group has.
Option
Description
Inherit permissions from its parent folder or list
If this check box is selected, the list item will inherit

permissions from its parent list. In this case, the buttons
on the right side of this dialog box are disabled. If this
check box is not selected, the buttons are enabled.
1169
Option
Description
Add

open.
Edit

Delete

Restore

permissions.

permission.
Option
Description
Type

Name
Enter the name of the user or the group which will have
permission.
Note: If you choose the "User" type, you can
forms:

\johns or johns;
johns@mydomain.com.
and click the

button next to this field to
make the component attempt to validate the
specified user. The component searches the
user in the SharePoint2007 users list, and if
the user is not found, searches it in the domain
users list. If the validation is successful, the
the following message appears in the lower
resolved".
If you choose the "Group" type, you can enter
the group name manually or select using the
button next to this field. This button opens
the Select Name dialog box.
Permissions
Enter permission given to the corresponding user or

group either manually or select from the drop-down list.
Notes
Enter a comment to the permission. If you choose the

"Group" type, this field contains the description of the
selected group.
1170
Note: If you select the Impersonate option in the General tab, then the functionality of this dialog
(displaying drop-down list of permissions and user validation) works under the impersonator account.
Select Name dialog box
In this dialog box you can select the group which will have the permission.
Option
Name
Description
Enter name manually or select from the drop-down list
of the SharePoint groups.
Note: If you select the Impersonate option
in the General tab, then the drop-down list
displays only the groups available for the
impersonator.

Each list has its own specific set of fields. You may add any field from this set. If this list requires a set of mandatory
fields, these fields will be assigned to the list item anyway. If the user has not specified the values of mandatory fields,
they will be set to the default values specific to the list.
Option
Name
Description
Enter field name either manually or select the name from
the drop-down list of the fields specific to the list. The
names of the mandatory fields are marked off with '*'.
Note: You can enter any custom field name, but
if the entered name is not specific to this list, the
list item will not be routed and an error message
will appear.
The components supports only the following
types of fields:
Value
Single line of text

Choice
Number
Currency
Date and Time
Yes/No
Person/Group
Hyperlink
Enter field value either manually or select it from the

drop-down list of the values specific to this field.
following forms:

\johns or johns;
johns@mydomain.com.

1171
Option
Description
06-20-2007 or Jun, 20, 2007.
following forms:

values.
dynamically set the value of the schema.
SharePoint 2007 component RRTs
Component RRT ID
The RRT ID for this component is SPS.
Name
Description
FileName
Counter

FileExt
Original file extension value.
DocumentURL
URL of the document stored in SharePoint 2007
ListURL
URL of the target list. Can be used alone to refer to the

list or jointly with the List Item ID to refer to the created
item.
ListItemId
Numeric identifier assigned to the list item stored (or

updated) on SharePoint 2007 server. Can be used as a
part of a URL to refer to the item.
ListItemURL
URL of the list item stored in SharePoint

2007. The ~SPS::ListItemURL~ RRT is
equivalent to ~SPS::ListURL~/DispForm.aspx?
ID=~SPS::ListItemId~.
Examples of usage of the above RRTN include:

~SPS::FileName~~SPS::Counter~ is replaced with the filename created by using SharePoint 2007
component.
~SPS::DocumentURL~ is replaced with http://sp2007/New_site/Shared Documents/MyDocument.doc.
~SPS::ListURL~ is replaced with http://sp2007/New_site/Lists/Tasks.
1172
~SPS::ListItemId~ is replaced with 26.

~SPS::ListItemURL~ is replaced with http://sp2007/New_site/Lists/Tasks/DispForm.aspx?ID=26.
Note:
~SPS::Counter~ can be used only on the Documents tab in Rename Schema field.
~SPS::ListItemId~ and ~SPS::ListItemURL~ cannot be used in the component configuration
settings. This is because the numeric identifier is assigned to the list item only after the list item is added or
updated on the SharePoint 2007 server.
Do not use ~SPS::DocumentURL~ and ~SPS::ListURL~ in Rename Schema field or Folder path
field on the Documents tab, because the values of those RRTs contain backslashes and if you choose to use
any of those RRTs in any of those fields, it will create an error since no file name or folder name can contain a
backslash.
When using SharePoint 2007 eConnector component, do not use ~SPS::DocumentURL~,
~SPS::ListItemURL~ and ~SPS::ListURL~ RRTs in subsequent component Rename Schemas. This
is because the values of those RRTs contain backslashes and if you choose to use any of those RRTs as part of
a Rename Schema, it will create an error as no file name can contain a backslash.
SSRTN
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
1173

~SPS::%Y~-~SPS::%m~ will be replaced by 2010-04.
There may be instability while working with the files of big size. The maximal limit is near 100-150Mb and it
depends on parameters of a computer and the SharePoint limitation.
The components supports only the following types of fields for documents and list items:
Single line of text

Choice
Number
Currency
Date and Time
Yes/No
Person/Group
Hyperlink
The impersonation in this component is partial. This means the following:
1. At configuration stage, switching Impersonate option on the General tab does not affect the component
controls behavior except for the controls available in Permission settings dialog box and its child dialog
boxes. The functionality of these dialog boxes (getting lists of permissions and groups, user validation) works
under the impersonator account.
2. At run time, the documents and list items are sent under the impersonator account.
The component can upload files by using two different methods:
1. Upload with buffering in the Workflow Server computer memory. In this case, the size of the sent document is
limited by available virtual memory on this computer.
2. Streaming upload. This method is used automatically if the anonymous access is allowed to the
following file: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\ISAPI\_nsi
\NsiSp2007UploadHandler.aspx on the computer with SharePoint 2007 Server. In order to allow the
anonymous access, in the IIS settings select the site, select the _vti_bin/_nsi folder, open Authentication for
NsiSp2007UploadHandler.aspx and set "Enable" status for Anonymous Authentication.
Use the most appropriate method for file uploading.
Problem description
The list of SharePoint sites is not visible for selection in
the Site field of the General tab.
Solution
1. Probably the component cannot connect to
SharePoint 2007 Server. Make sure that you have
entered correct connection parameters. If they are
correct, check if the user has sufficient access rights
to the SharePoint 2007 server. Contact your server
administrator.
2. Make sure that the correct version of web service is
installed on the SharePoint 2007 Server machine.
The Status Monitor shows the following message:
Probably the component cannot connect to SharePoint

2007 Server. Make sure that you have entered correct
Cannot connect to #Server#. Check site
connection parameters. If they are correct, check if the
name and login settings, where Server is
user has sufficient access rights to the SharePoint 2007
the specified Server address specified on the General
server. Contact your server administrator.
tab.
1174
Problem description
Solution
A document is not sent to the server. The Status Monitor

shows the following message:
Probably you have specified a non-existent library in the

Document library field on the Documents tab. Specify
the correct library name.
Document library #Libraryname# could

not be found, where Libraryname is the specified
name of the Document library.
A list item is not sent to the server. The Status Monitor
Probably you have specified a non-existent list in the

List field. Specify the correct list name.
List #Listname# could not be found,

where Listname is the specified name of the List.
A document is not sent to the server. The Status Monitor
Field #Fieldname# could not be found,
where Fieldname is a name of an added field.
A list item is not added to a list on the server. The Status
Monitor shows the following message:
List item is not created. Value does
not fall within the expected range.
A document or a list item is not sent to the server and
the Status Monitor shows one of the following error
messages:
Each document library has its own specific set of fields,

and you may specify only the fields from this set.
Probably Fieldname field does not belong to the set of
specified fields. Remove this field from the component
configuration.
Each list has its own specific set of fields, and you may
specify only the fields from this set. Probably some field
does not belong to the set of specified fields. Remove
this field from the component configuration.
These messages are concerned with SharePoint 2007
server failure. Try again later or contact your server
administrator.
1. The request failed with HTTP status

503: Service Unavailable.
2. The underlying connection was
closed: An unexpected error
occurred on a receive.
3. The server committed
a protocol violation.
Section=ResponseHeaderDetail=Header
name is invalid at
System.Net.HttpWebRequest.GetResponse().
When you enter "https://" followed by server name,
The reason of this problem is concerned with SSL
for example, https://sp2007 in Server address field, a
settings on the server. Do one of the following:
document is not routed and the Status Monitor shows the
1. Enter "https://" followed by IP address, for example,
https://192.168.0.178 in Server address field.
Request Entity Too Large. at
2. Make a request to your server administrator to check
System.Net.HttpWebRequest.GetResponse()
on the "Ignore user certificates" option.
at
WSS3Gateway.CWSS3Gateway.SendRequest(String
sUser, String sPassword, String
sDomain, String uri, Byte[] postBody,
Int64 postLength).
Status Monitor shows the correct component work, but
the routed document or list item is not visible on the
SharePoint site.
Probably the user has not sufficient access rights

to the SharePoint 2007 server. Contact your server
administrator.
1175
Problem description
Solution
When you are sending documents or list items to the

server having a Host Header, and use the Host Header in
the Server address text box, the error message appears
at run time:
For correct work with a server having a Host Header, add

Alternate Access Mappings for the Host Header on the
SharePoint 2007 server. This operation can be performed
by a SharePoint 2007 administrator via web access:
SharePoint 3.0 Central Administration/Operations/
Alternate Access Mappings. For more details see http://
blogs.msdn.com/b/sharepoint/archive/2007/03/06/whatevery-sharepoint-administrator-needs-to-know-aboutalternate-access-mappings-part-1.aspx.
Cannot check folder path. Web

application #HostHeaderAddress# could
not be found., where HostHeaderAddress is the
address of the site via Host Header, for example, http://
host123.
If you send a document to a document library where
the Require check out option in the Document Library
Versioning settings is set to No and the last version of the
file on server is checked in, the component creates more
than one new document versions.
Such behavior is related to the Share Point 2007

server that creates a new version when performing
each operation: saving file, assigning fields, assigning
permissions, and so on.
The Status Monitor shows one of the following error

messages:
These error messages may appear when the SharePoint

2007 server is overloaded. Contact your server
administrator.
1. The request failed with the

error message: <h2>Object moved
to <a href="http://hostname/
_layouts/1033/error.aspx?
ErrorText=Request timed
out.">here</a>.</h2>, where hostname is
replaced with the address of the SharePoint 2007
server.
2. Unable to connect to database.
Check database connection
information and make sure
the database server is
running. STACK TRACE: at
Nsi.SharePoint2007.Utilities.FileUploadRequest.ProcessResponse(WebResponse
oResponse)
If you are using the impersonation option, the Status
Monitor displays the following error message at run
time:
This problem may take place if the anonymous

access is enabled for the file /_vti_bin/
NSI_SP2007WS.asmx in the IIS settings on the
SharePoint 2007 server machine. To avoid this problem,
Internal error description: The
disable anonymous access for this file as the user with
parameter loginName cannot be empty or
anonymous access cannot be an impersonator.
bigger than 251 characters.
SharePoint
Welcome to the SharePoint component
SharePoint route/eConnector component allows users to store documents and list items into Microsoft SharePoint
Foundation 2010, Microsoft SharePoint Server 2010, Microsoft SharePoint 2013 Server or SharePoint Online (Office
365) Service. The component allows assigning necessary properties to the sent files, setting access rights to the routed
documents and list items, initiating workflows for routed documents and list items.
The component can be used both as a route or process component.
1176
The component is designed for using with Microsoft SharePoint Foundation 2010, Microsoft SharePoint Server
2010, Microsoft SharePoint 2013 Server, and SharePoint Online Service; each one further is referred to as SharePoint
Server.
Note: The component has a server module which represents a web service running on SharePoint 2010
Server. To properly connect to a remote SharePoint 2010 Server from a client machine, the user has to install
this web service on the SharePoint 2010 Server machine. The installation instructions can be found in the
folder Distributables\SharePoint 2010 within the Workflow Server installation folder.
Getting started
Feature highlights
Routing documents to the specified document library of SharePoint Server.

Granting access permissions of sent documents to users or groups.
Support for both authentication modes of SharePoint:
Claims-based authentication
Classic mode authentication
Creating list items and adding them to the specified list on SharePoint Server.
Ability to manage parameters of routed documents or created list items such as author, content type, fields,
associated workflow.
Certified work with SharePoint 2013 Server in Native Services connection mode.
Using the SharePoint component

Use this component to store documents into a centralized, unified interface for enterprise users and highly flexible
deployment options.
How to send documents into SharePoint 2010 from an MFD
Scan documents from an MFP device, save directly into a folder within SharePoint 2010 Server.
1. Design a workflow process with MFP component corresponding to the selected type of MFP device and
SharePoint Route component.
2. Configure SharePoint Route component to route scanned documents into SharePoint folder and to assign
properties that uniquely identify the document.
scanned document with the configured properties is routed directly into SharePoint 2010 Server.
How to send emails into SharePoint 2013
Send emails directly into SharePoint 2013 Server.
1. Design a workflow process with SMTP Capture component, SharePoint eConnector component and Send to
Folder Route component.
2. Activate the SharePoint eConnector component using the Activate option on the General tab.
3. Configure all 3 components and start the server.
Now all incoming emails sent to an SMTP gateway are saved into a pre-configured folder on the SharePoint 2013
Server for archival, management or sharing purposes and routed to the desired folder on the computer or network
folder according to Send to Folder configuration. You also can configure SharePoint Process component to route list
items with email information to take stock of emails on the server.
Configuring the SharePoint component
The component configuration window consists of three tabs.
1177
Tab
Description
General Tab
Use this tab to set general connection parameters to log

in to SharePoint Server.
Document Tab
Use this tab to specify the parameters of the routed

document.
List Item Tab
Use this tab to specify the attributes of the list items that
you want to add to a list of SharePoint Server.
General tab
Use this tab to set general connection parameters to log in to SharePoint Server.
Note: You can use RRT in all text boxes on this tab except for the Password field.
Option
Description
Activate

to a condition. This combo box is enabled only in the
eConnector configuration dialog box. If the activation is
OFF, the component won't perform any actions during
files processing.
Server and Site collection
Enter the address of the SharePoint server or complete

URL of site collection. The http:// prefix is used by
default. To provide SSL connection, specify https://
prefix before the server address. The server address can
be specified as a domain name, an IP address or a host
header, with an optional port number. You may also
specify a site in the server address. For example, if the
name of a machine is "myserver", IP is "192.168.0.1",
host header is "hostheader.ourcompany.com", and
domain name is "myserver.ourcompany.com", then value
of the server address can be specified as follows:
myserver
myserver:1000
myserver.ourcompany.com
myserver.ourcompany.com:1000
http://myserver
http://myserver:1000
http://myserver.ourcompany.com
http://myserver.ourcompany.com/site
http://myserver.ourcompany.com:1000
http://hostheader.ourcompany.com
https://myserver
https://myserver:2000
https://myserver.ourcompany.com
https://myserver.ourcompany.com:2000
https://hostheader.ourcompany.com
192.168.0.1
192.168.0.1:1000
http://192.168.0.1
http://192.168.0.1:1000
https://192.168.0.1
1178
Option
Description
https://192.168.0.1:2000
Note: When you use Native services
connection method, you should enter the
complete URL of site collection.
It is highly recommended to check the URL
in the browser on the machine where your
workflow server is installed.
SharePoint connection method
Select the connection method which will be used for

accessing the server. There are three available connection
methods:
AutoStore Add-on ServicesSelect this method if

you want to access to the SharePoint server that uses
AutoStore web service. This a default connection
method.
Native ServicesSelect this method if you
want to access to the SharePoint server that does
not use AutoStore web service. This method has
some restrictions indicated in the Restrictions and
Limitations topic. You can use this connection
method for access to the SharePoint 2013 server.
Office 365 ServicesSelect this method if you
want to access to the SharePoint Online service.
This method has some restrictions indicated in the
Restrictions and Limitations topic.
Security Token ServicesSelect this method if
you want to access the SharePoint using a custom
identity provider. When you select this method, you
should specify the path to the custom assembly in the
Cookie provider text box. This method means that
during configuring and processing the component
loads a custom assembly that implements the special
interface to get an authentication cookie.
Note: The Forms authentication
credentials type is set by default, when you
select this connection method.
Credentials type
Select the authentication type for connecting to the

server in this combo box. The component supports two
possible authentication types:
Cookie provider
Windows authenticationSelect this option if

you want to access to the server using the integrated
Windows authentication method. This is the default
option.
Forms authenticationSelect this option if you
want to access to the server using the Forms-based
authentication method.
Enter the path to a custom assembly that will be used for

defining an authentication cookie. You can enter the path
manually or click the browse button (...) and browse to
1179
Option
Description
it through the folder trees. This field is enabled only for
Security Token Services connection method.
For more information on the custom cookie provider
assembly, see Cookie provider assembly
User name
Enter the user name which will be used to log in to the

server in one of the following forms: "User", "Domain
\User", or "User@domain.com".
Select this check box if you want to use an RRT as a

password. Enter the RRT into the Password RRT text
box.
Password
Enter the user password that will be used to log in to

the server. This password will be saved in the encrypted
form. This text box is disabled if the Obtain password
via RRT check box is selected.
Password RRT
Enter the RRT that will be used as a password. In this

case the password is not encrypted. This text box is
enabled only if the Obtain password via RRT check
box is selected.
Impersonate
select this option to change the author of the sent

document or list item on the server. If this check box
is not selected, the author will be the user specified in
the User name text box. This option is available only
for AutoStore Add-on Services connection mode with
Windows Authentication credentials type; otherwise, it is
disabled.
Note: If you use the Impersonate option,
the user specified in the User name text box
should be a site collection administrator of
the SharePoint site where you want to store
the documents or list items. The impersonator
should have the 'Write' permissions for the
selected directory.
If you use the Impersonate option, both the
User name and the impersonator name should
be entered in one of the following forms:
"Domain\User" or "User@domain.com".
The impersonation is applied at the
configuration stage and at run time. At the
configuration stage, getting lists of data from
the SharePoint server is performed using the
impersonator account permissions. As an
exception, the list of sites is displayed using the
permissions of the user specified in the User
name text box. At run time the impersonator
permissions are used for saving documents and
list items.
Site

to store the documents or list items. You can click the
1180
Option
Description
browse button (...) to open the Select Site dialog box
in which you can select a site from the displayed site
tree. You can specify a subsite of the site entering its
name after the parent site name followed by "/"; for
example, SubSite1/SubSite1_1. If a site is not specified,
the component will store documents or list items in the
base SharePoint directory.
Server log file
Enter full path to the file on the server side which is

used by the web service for logging. This log file can
be used for debugging/support purposes. If this path is
not specified, the web service will not create the log file.
This option is available only when AutoStore Add-on
Services connection mode is selected; otherwise, it is
disabled.
Note: For correct logging, ensure that the
WSS_ADMIN_WPG Windows group on the
web service computer has Full Control and
the WSS_WPG Windows group has Read
& Execute, List Folder Contents, and Read
permissions or higher on the folder containing
the trace log. To perform this procedure, you
must be a member of the Administrators group
on the local computer. For more details, see
Event ID 5400 (http://technet.microsoft.com/enus/library/cc561020.aspx).
Web protocol timeout (seconds)
Specify the timeout in seconds for uploading documents

or list items into the SharePoint Server. If problems
occur while uploading, or a very big file is being
uploaded, the component waits for this time and when
the timeout expires, the component aborts uploading
and rejects the document if the document has not
been uploaded. It is recommended to increase timeout
value when sending big documents or when sending
documents into the document library which already
contains a large number of documents.
Pass through
This check box is present only in the process component

configuration window. Select this check box if you
want the documents to be available to the rest of the

1181

Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
1182
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
1183

Constants
Examples:

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
1Boolean
2, 3Any
1184
Symbol
Description
Result type
Operands type
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
Cookie provider assembly

Use the following information to create your custom assembly for Cookie provider.
The SharePoint component allows the user to create his/her own assembly that will be used as a custom cookie
provider service for user authentication.
To create a custom cookie provider assembly, you should implement the ICookieProvider interface presented by
the special NSi.ICookieProvider assembly distributed together with the SharePoint component assemblies.
Your assembly must contain the only class with the implementation of the provided interface.
The following code represents the ICookieProvider interface which should be implemented in the custom
assembly:
namespace NSi.CookieProvider
public interface ICookieProvider

{
/// <summary>
/// This method sets a URL of the web application to be accessed.
/// </summary>
/// <param name="url">Web application URL that contains a protocol,
a server address and a port.</param>
void setWebApplication(string url);
/// <summary>
/// This method sets user credentials for authentication.
/// </summary>
/// <param name="claim">A claim can be any statement about an
entity; for example, the user name.</param>
/// <param name="password">User's password. </param>
void setUserCredentials(string claim, string password);
1185
/// <summary>
/// This method gets a cookie container that allows accessing the
recources of the desired SharePoint server.
/// </summary>
CookieContainer getCookieContainer();
}
Note: The input parameters of both setWebApplication(string url) and

setUserCredentials(string claim, string password) methods are retrieved from the
component and are entered by the user on the General tab.
Document tab
Use this tab to specify the parameters of the routed document.
In this tab you can specify the parameters of the routed document. You can use RRT in all text boxes in this tab.
Option
Description
Route
This combo box indicates whether a document will be

routed by the component or not. Document routing can
be activated according to a condition. If the activation
is OFF, the component won't route any documents (for
example, if you need to route list items only).
Document library
Specify the name of the document library that you want

to work in. If the specified library does not exist on
the server, the configuration can be saved, however
at run time an error will occur and the document will
be rejected. You can enter the document library name
manually or click the browse button (...) to open the
Select Document Library dialog box that allows
selecting one of the existing document libraries on the
server. It is mandatory to fill out this text box.
Folder path
Specify the folder where the routed files will be stored.

You can enter the folder path manually or click the
browse button (...) to open the Select Folder Path dialog
box in which you can select one of the existing folders
from the displayed folder tree. You can create a folder
dynamically by entering a new name for the folder.
You can also create a subfolder of the existing folder
by entering the subfolder name after the folder name
followed by "/"; for example, Folder1/New folder.
Rename schema
Select this check box if you want to rename routed

documents. In order to do this enter the schema for the
output file name in the field next to this check box. You
can use one or several available RRTs to dynamically
set the value of the schema. If this check box is not
selected, the routed file will keep its original name. If
this check box is selected and rename schema is not
specified, then at run time the default schema is used:
~SPF::FileName~_~SPF::Counter~~SPF::FileExt~.
For example, if the input file name is "File.tif", the
renamed file will be "File_1.tif".
Check in
If you select this check box, the file will be checked in

on the server. That means that the file will be available
1186
Option
Description
to other users for editing and check-out, if they have
appropriate permissions.
Overwrite
If you select this check box, the routed document

overwrites the existing document with the same name
in the specified path. Depending on the SharePoint
document library settings, the new version of the
document will be created or the routed document will
simply replace the existing document. If this check box
is not selected and a document with the same name in
the destination path is found, the error will occur and the
component will reject the routed document.
Allow buffering
Check this box to allow buffering, when uploading files

into SharePoint. If this check box is not selected, the
allocated memory does not increase and you can upload
large files. This check box is not available for AutoStore
Add-on services connection method.
Permissions

rights which users or groups will have for the routed
document. The Define Permissions dialog box will
open.
Workflow
Specify a workflow that will be initiated for the routed

document. The workflow is a sequence of operations
configured on the SharePoint server. You can click
the browse button (...) to open the Select Workflow
dialog box that allows selection of one of the existing
workflows. If the component processes a batch of
multiple documents, one workflow per document will be
started.
Content type
Specify a content type of the routed document. A content

type describes the set of properties of the document
SharePoint Server at the site level and can be applied to
document libraries or lists configured to manage them.
You can click the browse button (...) to open the Select
Content Type dialog box to select a content type.
ways:
text box.
2. Leave the Content type text box blank and
specify the value of the Content Type field
in the Fields list.
specified document library is configured to
use content types, the document will have the
default "Document" content type.
Fields

routed document.
1187
Option
Description
Note: Each document library has its own
specific set of fields. If this document library
requires a set of mandatory fields, these fields
will be assigned to the document anyway. The
mandatory fields are marked with sign at the
configuration stage. If you have not specified
the values of mandatory fields, they will be
set to default values specific to the document
library.
specified fields at the configuration stage. If you
have specified an incorrect field, the component
displays the
you have specified the document content type
in the Content type combo box, the component
will check if the fields configured in the Fields
list belong to the specified content type. When
component checks if the configured fields
document library.

Verify values
Check this box to verify the values in the fields. When

this check box is selected, then the component prevents
you from saving documents with invalid values.
Note: This option verifies the values only in
the Choice and Lookup fields, if they have a
restricted number of values, and the Number
field with the "from" - "to" restriction.
Add
Edit

Remove

List Item tab

Use this tab to specify the attributes of the list items that you want to add to a list of SharePoint Server.
List item is specified as a set of fields and their values. This may be useful, for example, for creating new
announcement item in the Announcement list or issue item in the Issues list.
Option
Route
Description
This combo box indicates whether a list item will be
routed by the component. The list item routing can be
activated according to a condition. If the activation
1188
Option
Description
is OFF, the component won't route any list items (for
example, if you need to route documents only).
List
Specify the list on the SharePoint server where the

routed list item will be stored. If the specified list does
not exist on the server, the configuration can be saved,
however at run time an error will occur and the list item
will be rejected. You can enter the list name manually
or click the browse button (...) to open the Select List
dialog box that allows selection of one of the existing
lists on the server. It is mandatory to fill out this text box.
Folder path
Specify the folder path where the routed list item will
be stored. You can enter the folder path manually or
click the browse button (...) to open the Select Folder
Path dialog box that allows selecting one of the existing
folders in the displayed folder tree. You can create a
folder dynamically by entering a new name for the
folder. You can also create a subfolder of the existing
folder by entering the subfolder name after the folder
name followed by "/"; for example, Folder1/New folder.
Overwrite
If this check box is selected, the component will compare

the existing items in the list with the one that is being
added, and if they coincide, the old items will be
replaced with the new one. Items are compared based
on the values of certain key fields. Click the Search
keys button to specify these fields. If this check box is
not selected, new items will be added to the list without
replacing old ones.
Search keys
This button is enabled only when the Overwrite check

box is selected. Click this button to specify the fields that
will be used as a basis for item comparison. The Define
Search Keys dialog box will open.
Note: If you use the Overwrite option and
specify a particular list item field as key field,
this field should be added to the Fields list for
correct replacement.
Permissions

rights which users or groups will have for the routed list
item. The Define Permissions dialog box will open.
Workflow
Specify a workflow that will be assigned to the routed

list item. The workflow is a sequence of operations
configured on the SharePoint server. You can enter the
workflow name manually or click the browse button
(...) to open the Select Workflow dialog box that allows
selection of one of the existing workflows.
Content type
Specify a content type of the routed list item. A content

type describes the set of properties of the list item
SharePoint Server at the site level and can be applied
to lists configured to manage them. You can enter the
content type manually or click the browse button (...)
1189
Option
Description
to open the Select Content Type dialog box to select a
content type.
ways:
text box.
2. Leave the Content type text box blank and
specify the value of the Content Type field
in the Fields list.
specified list is configured to use content types,
the list item will have the default "list item"
content type.
Fields

routed list item.
Note: Each list has its own specific set of
fields. If this list requires a set of mandatory
fields, these fields will be assigned to the list
item anyway. The mandatory fields are marked
with sign at configuration stage. If you have
not specified the values of mandatory fields,
they will be set to default values specific to the
list.
specified fields at the configuration stage. If you
have specified an incorrect field, the component
displays the
you have specified the list item content type in
the Content type combo box, the component
will check if the fields configured in the Fields
list belong to the specified content type. When
component checks if the configured fields
belong to the list of all possible fields of the list.

fields that are specified in the configuration but absent
Verify values
Check this box to verify the values in the fields. When

this check box is selected, then the component prevents
you from saving documents with invalid values.
Note: This option verifies the values only in
the Choice and Lookup fields, if they have a
restricted number of values, and the Number
field with the "from" - "to" restriction.
Add
1190
Option
Description
Edit

Remove

Define Search Keys dialog box

In this dialog box you can specify key fields that will be used to compare items.
Option
Description
List items search keys
This group contains a list of key fields and the buttons

Add
Click the button to add a new key field to the list. The
Add Search Key dialog box will open.
Edit
Select a key field and click this button to edit the

selected item. The Edit Search Key dialog box will
open.
Delete
Select one or several key fields and click this button to

delete the selected key fields from the list.
Add/Edit Search Key dialog box

Use this dialog box to add a new key field to the key fields list or edit a selected key field.
Option
Key name
Description
Enter name of a key field either manually or click the
browse button (...) to select a field in the opened Select
Field dialog box. The names of the mandatory fields are
marked off with '*'.

Each document library and each list on the SharePoint Server has its own specific set of fields. You may add any
field from this set. If this document library or list requires a set of mandatory fields, these fields will be assigned to
the document or list item anyway. If the user has not specified the values of mandatory fields, they will be set to the
default values specific to the document library or list.
Option
Name
Description
Enter field name manually or click the browse button (...)
to select one of the fields specific to the document library
or list in the opened Select Field dialog box. The names
of the mandatory fields are marked off with '*'.
Note: You can enter any custom field name,
but if the entered name is not specific to this
document library or list, the error will occur at
run time and the routed document or list item
will be rejected.
Multiple values
Select this check box if you want to enter multiple values

for this field.
1191
Option
Description
Note: There are four types of the fields where
you can enter multiple values: Multiple lines of
text, Choice, Lookup and Person or Group.
You may check this box only if there is no
connection to the server at configuring. If the
connection is established, then the component
enters the values itself, depending on whether
multiple values are possible for the working
field on the server and disables Multiple values
check box.
Value
Enter field value either manually or click the browse

button (...) to select one of values specific to this field in
the opened Select Field Value dialog box.
following forms:
Login name, for example, "mydomaincom

\johns" or "johns"
Display name, for example, "John Smith"
"johns@mydomain.com"

06-20-2010 or Jun, 20, 2010.
following forms:

values.
Define Permissions dialog box
In this dialog box you can indicate users or groups that can access routed documents or list item.
Column
Description
Type

Group.
Name
This column displays the name of corresponding user or

group.
Permissions
This column displays access right, the corresponding

user or group has.
1192
Option
Description
Inherit permissions from its destination
If this check box is selected, the document or the list

item will inherit permissions from its parent folder or
library. In this case, the buttons on the right side of this
dialog are disabled. If this check box is not selected, the
buttons are enabled.
Add

open.
Edit

Delete

Restore

permissions.
Note: The specified permissions are applied only to the created document or list item; the folders created by
the component always inherit permissions from the parent directory.
permission.
Option
Description
Type

Name
Enter the name of the user or the group that will have the
permission. You can click the browse button (...) to open
the Select User or the Select Group dialog box that
allows selection of a user or a group correspondingly.
If the "User" type is chosen, the browse button (...) is
disabled as long as this text box is empty and becomes
enabled when at least one symbol is entered. In this case
the Select User dialog box contains list of local and
domain users starting with symbols entered in the Name
text box.
Note: If you select the "User" type, you can
forms:
Login name, for example, "mydomaincom

\johns" or "johns"
Display name, for example, "John Smith"
"johns@mydomain.com"
To avoid confusion it is recommended to use

variants with the domain name if possible. You
can click the Check button next to this field
to make the component attempt to validate
the specified user. The component searches
the user in the SharePoint users' list, and if the
user is not found, searches it in the domain
1193
Option
Description
users' list. If the validation is successful, the
the following message will appear in the lower
resolved!".
Permissions
Enter a permission to be assigned to the corresponding

user or group either manually or click the browse button
(...) to open the Select Permission Level dialog box
that allows selection of one of the permission levels
configured on the SharePoint Server.
Note: The "Limited Access" permission
level is silently ignored and is not used by the
component.
Notes
Enter a comment to the permission.
SharePoint component RRTs

Component RRT ID
The RRT ID for this component is SPF.
Name
Description
~SPF::FileName~
~SPF::Counter~

~SPF::FileExt~
Original file extension.
~SPF::DocumentURL~
URL of the document stored in the SharePoint Server.

If the component processes a batch of multiple
documents, this RRT is replaced by the URL of the first
stored document. This RRT is applicable only for the
SharePoint eConnector component and can be used in
the subsequent components.
~SPF::ListURL~
URL of the target list. Can be used alone to refer to

the list or jointly with the List Item ID to refer to
the created item. This RRT is applicable only for the
SharePoint eConnector component and can be used in
the subsequent components.
~SPF::ListItemId~
Numeric identifier assigned to the list item stored (or

updated) on SharePoint Server. Can be used as a part of a
URL to refer to the item. This RRT is applicable only for
the SharePoint eConnector component and can be used
in the subsequent components.
1194
Name
Description
URL of the list item stored in SharePoint . The
~SPF::ListItemURL~ RRT is equivalent to
~SPF::ListURL~ ~SPF::ListItemId~. The
value of this tag is not supposed to be used in a browser
address bar. Its purpose is to represent the full path to the
item within the server. This RRT is applicable only for
the SharePoint eConnector component and can be used
in the subsequent components.
~SPF::ListItemURL~
Examples of usage of the above RRTN include:

~SPF::FileName~~SPF::Counter~ is replaced with MyDocument1.
~SPF::DocumentURL~ is replaced with http://sp2010/New_site/Shared Documents/MyDocument.doc.
~SPF::ListURL~ is replaced with http://sp2010/New_site/Lists/Tasks.
~SPF::ListItemId~ is replaced with 26.
~SPF::ListItemURL~ is replaced with http://sp2010/New_site/Lists/Tasks/26_.000.
Note: ~SPF::Counter~ can be used only on the Documents tab in the Rename schema box.
~SPF::DocumentURL~, ~SPF::ListURL~, ~SPF::ListItemId~, and ~SPF::ListItemURL~
cannot be used in the component configuration settings. This is because the numeric identifier is assigned to
the list item only after the list item is added or updated on the SP server.
When using SharePoint Process component, do not use ~SPF::DocumentURL~,
~SPF::ListItemURL~ and ~SPF::ListURL~ RRTs in subsequent component rename schemas. This is
because the values of those RRTs contain backslashes and if you choose to use any of those RRTs as part of a
Rename Schema, it would create an error because no file name can contain a backslash.
If you use the Overwrite option on the List Item tab for list items and the component updates several list
items, then the ~SPF::ListItemURL~ and ~SPF::ListItemId~ will be replaced for the list item with
the greatest ID.
SSRTN
Description
%a
%A
%b
%B
%d
%H
%I
%j
%m
1195
SSRTN
Description
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

~SPF::%Y~-~SPF::%m~ will be replaced by 2010-05.
The component can upload files by using two different methods (when using AutoStore Add-on services
connection method):
1. Upload with buffering in the Workflow Server computer's memory. In this case, the size of the sent document
is limited by available virtual memory on this computer.
2. Streaming upload. This method is used automatically if the anonymous access is allowed to the following
file: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions
\14\ISAPI\_nsi\NsiUploader.aspx on the computer with SharePoint 2010 Server. In order to allow
the anonymous access, in the IIS settings select the site, select the _vti_bin/_nsi folder, open Authentication
and set Enable status for Anonymous Authentication.
Use the most appropriate method for file uploading.

If you are uploading big files to the SharePoint 2010 Server, you should specify the appropriate size limitation on
the SharePoint 2010 Server: go to SharePoint 2010 Central Administration > Manage web application and
select your site, then go to General Settings > Maximum upload size and select your own maximum.
To work with this component, the user should have at least the "Contribute" permission level for the specified
folder, list, or document library.
To use impersonation, the user specified in the User name field should be a site collection administrator. With this
option on, the documents and list items will be saved with the permissions of the impersonator.
If you use Native services or Office 365 Services connection method, then the component will use Client Side
Object Model to access the server. This methods have some special restrictions:
1. The Impersonate and Server log file options in the General tab are disabled.
2. This must be able to successfully transfer files up to 200MB in size, but not more.
3. The site list is got only for the specified site collection.
The component supports only the integrated Windows authentication and Forms-based authentication methods.
The integrated Windows authentication methods rely on IIS authentication for SharePoint 2010 Web applications;
the methods are NTLM or Kerberos (IIS Windows Authentication). IIS settings should be checked after the Web
application is created: the Windows authentication method should be enabled. The Forms-based authentication
methods rely on IIS authentication for Claims-based SharePoint 2010 web applications. IIS settings should be
checked after the web application is created: the Forms-based authentication method should be enabled.
When using multiple level metadata in Microsoft SharePoint 2010, the hierarchy will be displayed on the device
panel as a list. However, the tree view will not be displayed. The full hierarchical path is displayed to make the
selection of the right metadata easier.
1196
The component supports the SharePoint 2013 server in Native Services connection mode only. All restrictions of
the SharePoint 2010 server in the Native services mode are applicable to the SharePoint 2013 server as well.
Native Services connection mode supports only SharePoint 2013 Workflow.
For a proper operation of the component, Windows Identity Foundation (WIF) for .NET Framework 3.5 version
should be installed on the machine, where workflow server is running.
The component is not able to retrieve and show more folders than the number specified in the List View
Threshold field in the General settings of a web application on the SharePoint site. By default, this number is
5000.
Note: You can check the number specified for the selected web application by the following path:
(SharePoint 2010) Central Administration >> Application Management
>> Manage Web Application >> web_application >> General Settings >>
Resourse Throtting >> List View Threshold, where web_application is the name of a
web application on the SharePoint site, for which you want to check the threshold.
Problem description
Solution
The component does not send documents or list items

when the Host Header of the SharePoint server is used in
the Server and Site collection text box in the General
tab.
For correct work with Host Headers, the SharePoint

administrator should correctly set the Host Header
in IIS on the SharePoint 2010 server machine. For
details, see Configure a Host Header for a Web
Site (http://technet.microsoft.com/en-us/library/
cc753195(WS.10).aspx).
The component does not connect to the server or site

collection when the Server and Site collection text box
contains IP address.
For correct connection to servers using IP addresses,

the SharePoint administrator should correctly set up the
Alternate Access Mappings. For more details, see
Plan for SharePoint Workspace 2010
(http://technet.microsoft.com/en-us/Library/
ee649106#altaccess).
Web service does not write information into the log file.
For correct logging, ensure that the WSS_ADMIN_WPG

Windows group on the web service computer has Full
Control and the WSS_WPG Windows group has Read
& Execute, List Folder Contents, and Read permissions
or higher on the folder containing the trace log. To
perform this procedure, you must be a member of the
Administrators group on the local computer. For more
details, see Event ID 5400 (http://technet.microsoft.com/
en-us/library/cc561020.aspx).
Documents processing fails and the Status Monitor

shows one of the following messages:
Such issues appear when you select the predefined

"Network Service" account for your Web application
pool as a security account and store the data in an
external data column. To resolve this problem, you
should grant access to a local SQL Server database to
this account. To solve this problem, grant access to the
"Network Service" account to the local SQL database.
FulfilConfiguration web method

exception: MethodInstance with
Name '' on Entity (External
Content Type) with Name '' in
Namespace '' failed unexpectedly.
The failure occurred in method
'' defined in class '' with the
message 'Cannot open database ''
requested by the login. The login
failed.' Login failed for user 'NT
AUTHORITY\NETWORK SERVICE'
For more information, see Use the Network Service

Account to Access Resources in ASP.NET (http://
msdn.microsoft.com/en-us/library/ff647402.aspx).
1197
Problem description
Solution
FulfilConfiguration web method

exception: Cannot connect to the
LobSystem (External System)
When configuring the component, you receive the

Could not load file or assembly
'Microsoft.IdentityModel,
Version=3.5.0.0, Culture=neutral,
PublicKeyToken= ...' or one of its
dependencies. The system cannot find
the file specified.
This error appears when there is no Windows Identity

Foundation (WIF) installed on the machine, where the
workflow server is running, and the .NET Framework
version is 3.5.
To resolve this problem, make sure that the Windows
Identity Foundation is installed on the machine, where
the workflow server is running.
To download the application, see Download Windows
Identity Foundation.
Note: Windows Identity Foundation is now
a part of .NET Framework 4.5; therefore, the
upgrade to this Framework version can also fix
the problem.
One of the following problems appears when the user

works with the component:
The possible reason for this problem is that the

component reaches the maximum limit, set in the
configuration of the web application. This limit is
The component does not retrieve more than 5000
set for the maximum number of items that can be
folders from a web application on the SharePoint
retrieved from the web application at the same time; by
server.
default, the limit is 5000. If there are less items than the
The component retrieves less than 5000 folders,
maximum number, than the component will retrieve all
although there are more folders in the selected
found folders, but if the number of items exceeds the
document library.
maximum limit, than the component will retrieve only
The component fails to upload documents and the
the folders found within the first max_number items,
following error message appears: The attempted where max_number is the current list view threshold.
operation is prohibited because
To solve this problem, increase the List View Threshold
it exceeds the list view threshold
by the following path: (SharePoint 2010)
enforced by the administrator.
Central Administration >> Application
Management >> Manage Web Application
>> web_application >> General Settings
>> Resourse Throtting >> List View
Threshold , where web_application is the name of
a web application on the SharePoint site, for which you
need to increase the threshold.
How to grant access to a local SQL Server database

The following steps describe how to grant access to the "Network Service" account to a local SQL Server database.
1.
2.
3.
4.
5.
6.
7.
8.
Start SQL Server Management Studio.

In the left panel, select the Security folder for your local SQL Server.
Right-click on the Logins subfolder to open the context menu and click New Login.
In the opened dialog box, enter NT AUTHORITY\NETWORK SERVICE in the Login name text box. Accept the
defaults for the other settings and click OK.
In the Databases folder, select your database.
Right-click Users in the Security folder, and then click New User.
In the opened dialog box specify the "NT AUTHORITY\NETWORK SERVICE" account.
In the Role Members list, select the db_datareader check box.
1198
9. Click OK, and then close the SQL Server Management Studio.
Sharp MFP (OSA)

Welcome to Sharp the MFP (OSA) component
The Sharp MFP (OSA) component allows you to capture documents from any OSA enabled Sharp MFP device and
route the documents to any of the route destinations that are supported by the server. When scanning documents with
the MFP, users can provide information about the documents that can be used to identify and route the documents
appropriately.
The Sharp OSA component provides the following features:

Forms are extensible through VB.Net. You can create more interactive forms and validate before a document is
scanned. Integrated editor with intellisense makes the creation of scripts easier.
destination.
Feature highlights
The Sharp OSA component provides the following features:

Forms are extensible through VB.NET. You can create more interactive forms and validate before a document is
destination.
Easy sharing of forms with the use of the save/load form from template functions
How to use the Sharp MFP component

Design and create a process that lets the users scan in documents via the Sharp MFP (OSA) device and store the
documents to a network folder.
This simple process consists of the Sharp MFP (OSA) capture component and the Send to Folder route component.
1. Drag the Sharp MFP (OSA) capture component to the Process Viewer.
2. Drag the Send to Folder route component into the Process Viewer.
3. Configure the Sharp MFP (OSA) capture component by following the instructions in Configuring General
Settings.
4. Create a form by following the instructions in Adding and Editing forms in a group.
5. Connect a device to the Server by following the instructions in Device Setup and Configuration.
After the device is configured to connect to the Server, you will see the list of forms when you enter the associated
OSA application.
6. To scan a document from the device using one of the configured forms follow the instructions in Scanning a
Document from the Device.
Configuring the Sharp MFP Capture component
Groups tab
Preferences tab
1199
Authentication tab
Runtime Replacement tags
Groups tab
A group is composed of the forms that will be displayed at the device panel and whether authentication will be
required or not. By default there is a single group called the Common Group. If you do not configure additional
groups, all devices will display the forms configured in the "Common Group". You can create additional groups and
assign certain devices to them; this way even though all devices are connecting to the same AutoStore server they can
be used for different functions.
Option
Description
Add Group
Click this button to create a group.
Add Form
Click this button to add one of the form types that are
supported by this component:
Basic Form
Send to Email Form
Send to Folder Form
Edit
Click this button to edit a selected group or form.
Remove
Click this button to remove the selected group or form.

Use groups to create separate menus and forms for different groups of users
Configure the following options for a group.
Option
Description
Name

component is equipped with a default group called
Common Group. You may add menus and forms to the
Common Group.
Select this check box to require that MFP devices in

this group should authenticate users. This check box
is enabled when the Authentication option is on the
Authentication tab is not set to None.
Query defice authentication settings for credentials
Select this check box to query the credentials of the user

that is logged into the Workflow Server. This option
depends on the Authentication setting:
None
No credentials need to
be entered. The user is
taken directly to the device
manu.
If this option
is selected,
~SenderRRT
variables use device
credentials.
If this option
is not selected,
1200
Option
Description
~SenderRRT
variables will be
empty.
Windows
If this option is
selected, the user will
be taken directly to
the device menu if the
credentials from the
device match Windows
user credentials. In this
case, ~SenderRRT
variables will use
device and Windows
user credentials.
Otherwise, credentials
need to be re-entered.
The user will be shown
a login screen where
credentials must be reentered. ~SenderRRT
variables will use
credentials entered on
the login screen
If this option is
not selected, then
credentials need to
be re-entered. The
user will be shown a
login screen where
credentials must be reentered. ~SenderRRT
variables will use
the login screen.
Netware
Regardless of whether
this option is selected,
user credentials need to be
reentered. The user will
be shown a login screen
where credentials must be
reentered. ~SenderRRT
variables will use
credentials entered on the
login screen.
Custom Script
Regardless of whether
this option is selected,
user credentials need to
be entered if there are any
prompts.
If this option is
selected, and custom
script authentication
1201
Option
Description
Associated MDP Addresses
succeeds,
~SenderRRT
variables will use
device credentials
and user credentials.
Otherwise, a login
failure screen will
be shown and user
credentials must be
reentered.
If this option is not
selected, then user
credentials need
to be reentered.
The user will be
shown a login screen
where credentials
must be reentered.
~SenderRRT
variables will use
the login screen.
Add the MFP devices that will be associated to this

group by entering the IP Address or host name of the
MFP in the MFP address list. The MFP address list must
contain at least one MFP.
Tip: Using the network name is preferable
because the IP address can change if IP
addresses are assigned using the Dynamic Host
Configuration Protocol (DHCP).
Adding and editing forms in a group

Basic Form Settings dialog box
This dialog box allows you to configure a basic form. The basic form settings are also available in the other form
types.
To add a form, configure settings on the following tabs.
General tab
Fields tab
Components tab
General tab
Option
Name
Description
The name of the form will be displayed in the forms
screen of the OSA application, so use a text that
describes the function of the form. For example: If this
form is used to send to the users home directory then
you can name the form Scan to Users Home
Directory. The maximum number of characters
allow in the form name is 25.
1202
Option
Description
Single Touch mode
Select this check box to start the scan immediately after

the user presses the form button on a device. You can
select this option if you do not want the user to enter any
information about the document.
Access Control
This group of settings regulates access policy to the

form. The options are:
Public AccessIf this option is selected, all users

can see and use the form.
Restricted AccessIf this option is selected, then
only users in the Allowed Users/Groups list can see
and use the form. If a user belongs to a group in the
list then this user can see the form.
When the authentication type is Windows, you can

use the browse button (...) to select Windows groups
or users. The browse button is disabled for all other
type:
Scanning Settings
WindowsDetermined by the Windows Groups

that this user belongs to.
NetwareGroups are not supported.
collection of the UserInfo object that represents the
authenticated user. For details on the object model
used in authentication scripts see the Sharp MFP
(OSA) Scripting documentation.
Configure the default settings for the scanned document.

The available settings are:
File FormatThe following file types are supported

PDF, TIFF, JPEG, and Encrypted PDF. Note that
the AR series devices do not support JPEG and
Encrypted PDF file formats, so the device default
will then be used if one of these types is selected as
default.
Resolution100, 200, 300, 400, or 600 dpi. Note
that the AR series devices do not support 100 dpi, so
the device default will then be used if this value is
selected as the default.
Number of SidesProvide a default value for the
Number of Sides; 2-Sides setting indicate duplex
scanning.
The following settings only apply to MX devices:
Color ModeThis can be one of the following

values:
Auto: If this option is selected the device will

detect if there are any color pages in which
case the document will be scanned using
the Full Color option. If no color pages are
1203
Option
Description
Dynamic Form
detected, the document will be scanned using

the Black and White option.
Full Color
Black and White
Grayscale
Color Document Quality: Select the default
quality for the document, low quality generates
smaller documents and high quality generates
larger documents. Note that this option is ignored
when the Color Mode is Black and White since
Black and White documents are always scanned
at the same quality.
Job BuildSelect this box if documents to be
scanned consists of multiple pages that must be
scanned as one scan job.
You can modify the standard behavior of a form by

responding to events. Some of the things you can do by
enabling dynamic form are:

a list field from a database).
scanned into AutoStore.
Enable Dynamic FormSelect this checkbox to
enable dynamic forms.
Script PathPath to the VB.NET script that
contains the code to respond to form and field events.
An existing script can be selected by clicking the
browse button (...) next to the Script Path box.
Edit Script CodeClick this button to open the
script editor with basic script code. For details on
the script editor window and the object model used
to respond to form and field events, click the help
button in the script editor window or refer to the
Sharp MFP (OSA) Script documentation.
Raise event whenSelect form events to be raised.
Form is loadedRaise an event on the server
every time the user enters the form.
Form is submittedRaise an event on the
server every time the user presses Scan in the
form.
box to attempt to run the script with the privileges
of the logged in user. Typically this is selected when
the logged on user would have privileges that are
not assigned to the the user name that is running the
workflow. This check box is only available if the
group requires authentication and the configured
authentication mode is Windows.
1204
Fields tab
Option
Description
Name
Type the name of the field. The name can be any

combination of alphanumeric characters. Special
characters (for example, ~, !, @, , $, %) are not
allowed. The maximum number of supported characters
for this field is 15.
Display
Type an alternative text to represent the field in the MFP

panel. If this entry is left empty for a field, then the field
name will be displayed to users.
Type
Choose how the data for the field will be collected. The
following field types are supported:
TextUse this field to allow users to enter unformatted text into a text box such as sentences,
names, numbers, date, and time.
ListUse this field to present users with a list of
choices from which users select the desired item.
TreeUse this field to present users with a list of
choices in a tree from which users select the desired
item.
CheckboxUse this field to allow users to set yes/
no or true/false values by adding or removing a check
mark from a small square box.
(required)
Select the check box in this column if the user must enter
a value for the field.
(notify server)
Select the Notify Server when Field Changes check

box to make the field trigger an event when the value of
the field changes. You can respond to this event in the
script that was configured for the dynamic form section
in the general tab. For details on how to respond to form
and field events refer to the Sharp MFP OSA Scripting
documentation.
(properties)
Configure the properties for a field by clicking the

browse button (...) in this column. A properties window
will be displayed based on the field type.
Text
List
Tree
Checkbox
Components tab
This tab allows users to configure process and route components. To configure a component, click the browse button
(...) in the properties ( ) column. This displays the configuration window of the component. Refer to the help for the
component for instruction to configure its properties.
Send to Email form
1205
commonly used in conjunction with the Send to SMTP and Send to Exchange Route components.
Configure the options in the General, Fields and Components tabs in the same manner as for a Basic Form.
Option
Description
Do not show a From Field
Select this check box to use the device logged in user's

email address check box to omit the FROM field. This
is usually selected if you plan to use the logged in user
emails address.
Show a CC field
Select thia check box to show the "CC: field in which

Show a BCC field

secretly.
Global Address List
Select this check box to allow the users to search the

the To, CC and BCC fields. In the Display As box type

associated to the device logged in user.
logged in user.
If there is no logged in user then the search will be
the service account for the AutoStore service.

Exchange Contacts
Select this check box under to allow users to search their

In the Display As box type the display value for this

search option.
Select Auto Discover Exchange Web Service URL
to automatically detect the Exchange Server. Note
that when using this option, Windows authentication
should be used. If this option is not selected, enter the
full address of the Exchange Server (IP address or
host name). If the address is unknown, contact your
system administrator.
If a secure socket layer (SSL) connection should be
used to connect to the Exchange Server, select the
Use SSL checkbox.
1206
Option
Description
LDAP Server
Select this check box under to allow the users to search

an LDAP Server for addresses that can be added to the
To, CC and BCC fields.
In the Display As box type the display value for this

search option.
In the LDAP Server box type the address or host
In the Search Root DN field type the distinguished
name for the node where the search should start. For
example: DC=Sales, DC=MyCompany, DC=com. If
this field is left empty then the starting point of the
search will be the root of the directory tree.
In the Email Address field type the name of the
LDAP attribute that represents the email address.
In the Name Field type the name of the LDAP
attribute that represents the name of the user.
Select the Login as Anonymous check box to
server.
Select the Login with following credentials check
box to log in to the LDAP server with the specified
Username and Password.
Note: if the LDAP server is an Active
will be used.
Specifies the maximum number of contacts that the

search will return.
Folder Form Settings

Option
Description
Base Directory

browse to select the destination of the document.
Type the default value that will be used for the document
name field.
Using form templates

A form template allows you to quickly reuse the same form settings in different groups.
Create a form template

Create a form from a template
Create a form template

Complete the following procedure to create a form template.
1. Go to the Groups tab in the Sharp MFP OSA settings dialog box.
2. Right-click the form you want to save as a template, and click Save as Template.
1207
3. In the Location box, enter the path to the folder where you want to save the template.
You can click the browse button ... to locate a folder.
4. If dynamic form is enabled, you can choose copy the associated .NET script to the same location where the
template will be saved.
5. Click Save.
If the procedure was successful, you will see a message indicating that the template was saved.
Create a form from a template
Complete the following procedure to create a form from a template.
1.
2.
3.
4.
Go to the Groups tab in the Sharp MFP OSA settings dialog box.
Click on the group where you want to add the form.
On the menu bar, click Add Form > Load From template.
In the Template file box, enter the location of the template.
This must be a form template saved previously with Save as Template.
5. In the Dynamic Form script file box, enter the path to the .NET script file associated to the template.
6. Click Create.
Field types
Checkbox field
A checkbox field creates a check box in a form.
Option
Description
True Value
Enter the value that will be sent to the server when the
field is selected.
False Value
Enter the value that will be sent to AutoStore if the field

is cleared.
Checked by Default
Select this check box you want the check box to be

already selected when the user enters the form.
List field
The list field type creates a list field in a form.
Option
Description
Value
Type the value associated to this option. This is the value

that will be sent to the Server and used for the field RRT.
Label
Type an alternative text. If the label is empty then the

value will be used for displaying this option in the MFP.
Default
Select this check box to make a value the default value

for the field. This option can only be selected for one
value at a time.
Select this check box to allow the user to select more

than one item from the list. When multiple selection is
enabled, the value of the RRT will be the list of selected
values separated by ;;.
If you selected Allow Multiple Selection, you can select

the Display Search Options check box, to allow the user
to search the list for an item that starts with the specified
criteria.
Allow selections to be edited
Allow the user to edit or type new items.
1208
Option
Description
Raise event after pressing the find button
Raise event after pressing the find button checkbox

to cause the field to fire an event when the user press
find. You can respond to this event in the script that
was configured for the dynamic form section in the
general tab. For details on how to respond to form
and field events refer to the Sharp MFP OSA Scripting
documentation.
Specifies the maximum number of search results.
Text field
A text field allows users to enter a text value.
Option
Description
Default
Enter the default value for the field.
Mode
Select one of the modes:

text box.
HiddenThe field will not be visible in the device
panel.
Tree field
The tree field type creates a tree field in a form.
Option
Description
Tree Items
This box displays the tree hierarchy.
Add
Click this button to add an item to the tree. The item will
be added under the currently selected item.
In the Display Text box, type the label of the tree

item. This is what the user will see in the device
when navigating the tree.
In the Value box, type the value of the item. This is
the value that will be sent to AutoStore.
Edit
Click this button to edit the Display Text or Value for

the currently selected item in the tree.
Remove
Click this button to remove the selected item in the tree
Preferences tab
Option
Home Directory
Description
Specifies the root directory where the server will create
all temporary directories and files necessary for running
the application. The service account for the AutoStore
service must have full control permission on this
directory.
1209
Option
Description
Web Server Port
Enter the number of the port that the web server uses to
communicate with devices.
Use SSL
Select this option to use Secure Sockets Layer (SSL) to

Choose Certificate
Click to browse for an existing certificate or to create

a new new self-signed certificate that will be used to
authenticate the component to the device.
Certificate Password
Enter the password for the certificate. If you created a

self-signed certificate, this value will be automatically
entered into the field based on the information you
provided when creating the certificate.
Repository Type
Select HTTP or Local FTP as the temporary file

repository type.
FTP Port
Specifies the port used by the FTP service.
Advanced
Click this button to enable activity logging for the FTP

service. In the Advanced FTP Server Settings dialog
box, select the Enable log check box to enable logging,
and in the Directory box, specify the location for the log
files.
Processed Files
files will be kept. If this option is enabled, a copy of
every file that has been routed successfully is saved in
the Processed Files directory. Make sure that sufficient
storage is available when using this option and that the
AutoStore service account has write permission to the
specified location
Rejected Files
Select this check box to keep a copy of all files that

failed to process completely without errors. Enter the
Make sure that sufficient storage is available when using
this option and that the AutoStore service account has
write permission to the specified location.
Authentication tab
Option
Authentication Type
Description
Select the authentication type that the server uses to
NoneServer authentication is not enabled.

Note: If a device is using third-party
authentication, the credentials for a user who
logs in to the device can still be retrieved.
WindowsThis will prompt the user for a Windows
user name, domain and password.
1210
Option
Description
NetwareThis will prompt the user for a Novell

Netware user name, password, context, and tree.
Custom ScriptThe administrator has full control
over the prompts that will be presented to the user as
well as how the prompts are validated.
Windows
For Windows authentication, enter the default domain in

the Domain box.
Netware
For Netware authentication, Enter the default NDS Tree

and NDS Context..
Custom Script
To configure Custom Script authentication, specify the

path to the VB.NET script that will authenticate users
in the Script File Path box. You can click the browse
button (...) to locate the file. You can click the Edit
Script button to open a script editor window with basic
script code. For details on the script editor window and
the object model used to authenticate users, refer to the
Sharp MFP (OSA) Script documentation. You can click
the Edit button to edit an existing scrip or to create a
new script.
To configure prompts that will be used to collect
user information, click the Prompts button. In the
Authentication Prompts dialog box, configure the
following values for each prompt:
NameSpecifies the name of a prompt. This setting

is used to label the FRTN that returns the value that is
entered by a user.
DisplayType an alternative text to use as the label
for the prompt at the MFP console. If the display
value is left empty then the prompt name will be used
as the label as well.
DefaultType a default value for the prompt (this
is optional).
(required)Select the check box in this column

to specify that a user must enter a value for prompt.
(masked)Select the check box in this column

to mask the text at the MFP console. This prevents
unauthorized individuals from viewing the value that
is typed at the MFP console.
Sharp MFP (OSA) component RRTs

Component RRT ID
The RRT ID for this component is SH2.
1211
Name
Description
FormName
Name of the form.
Sender

submitting document(s) is returned. If authentication
is set to None and third-party card authentication is
not used, this will return blank. If third-party card
authentication is used, the user credentials for the logged
in third-party card authenticated user will be returned.
SenderEmail
The email of the user. If authentication is set to None

and third-party card authentication is not used, this will
return blank. If third-party card authentication is used,
the email address for the logged in third-party card
authenticated user will be returned.
SenderDomain
The authenticated users domain name. This is available

Windows authentication has been turned on for the
MFP device or if Custom authentication is used and
the associated VB.NET script populates the Domain
property of the UserInfo object.
IP
HostName
ServerIP
The IP address of the Sharp OSA Web server which

should be the same as the AutoStore server.
ServerHostName
The Host Name of the Sharp OSA Web server which

should be the same as the AutoStore Server.
PageCount
Format
FileSize
TIFF
PDF
JPEG
EncryptedPDF
When third-party card authentication is used, Sender, SenderEmail, and SenderDomain will be set according to
credentials for the third-party card authentication system. When third-party card authentication is used with the
following authentication settings:
If authentication is set to None, Sender, SenderEmail and SenderDomain will be set according to device
information for the logged in third-party card authenticated user.
If authentication is set to Windows, Sender, SenderEmail and SenderDomain will be set according to device and
server authentication information for logged in third-party card authenticated users who have Windows logins.
Device information has priority for these three reserved RTNs.
If set to Netware, Sender, SenderEmail and SenderDomain will be set according to Netware authentication.
Device information will be discarded.
If set to Custom Script, Sender, SenderEmail and SenderDomain will be set according to device and custom script
information for the logged in third-party card authenticated users that are verifiable through the custom script.
Device information has priority for these three reserved RTNs.
1212

The RRT string ~SH2::%Client ID%~ will be replaced by "Company" if the user types in "Company" for the
field name called "Client ID".
If Custom authentication is used and there is a user attribute named "Display-name" with the value John Doe then the
RRT will look like:
The RRT string ~SH2::User,%FullName%~ will be replaced by "John Doe".
When third-party card authentication is used, all attributes will be pulled from the device and every attribute name
will be pre-fixed with the text MFPUserAttr- to distinguish normal user attributes. For example, if third-party card
authentication provides attribute "Display-name", the third-party card authenticated user's attribute name for this will
appear as "MFPUserAttr-Display-name". The RRT will look like:
The RRT string ~SH2::User,%MFPUserAttr-Display-name%~ will be replaced by "John Doe" with the
logged in user's display name from the third-party card authentication system.
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
1213
Name
Description
%Y

The connection between the device and AutoStore is done through a web application called ASWebForSharp.
To connect a Sharp Device to AutoStore:
Configure the device to connect to the Sharp OSA Web Application.
Configuring the device to connect to a Sharp OSA web application
Configure device models AR-31x/35x/45x/55x/62x/70x, MX-55x/62x/70x

Configure device models MX-230x/270x/350x/450x/550x/620x/700x
Configure Device Models AR-31x/35x/45x/55x/62x/70x, MX-55x/62x/70x

Use this procedure to configure device models AR-31x, 35x, 45x, 55x, 62x, 70x MX-55x, 62x, 70x.
1. Open your browser and navigate to the home page for the MFP device (http://MFP_IP_Address).
2. On the navigation menu, click Admin Mode.
3. Enter your administrator credentials.
4. Select External Applications on the navigation menu.
5. Select Standard Application on the main page.
6. Click Add.
7. Type the application name in the Application Name box.
8. In the Address for Application UI, type the address for the Sharp OSA Web Application.
Typically, this is http://Web_Application_IP_Address:Web_port/ASWebForSharp/
Default.aspx.
9. In the Timeout box, type the time that the MFP should wait for a response from the application (160 seconds).
10. Click Submit.
Configure Device Models MX-230x/270x/350x/450x/550x/620x/700x
Use this procedure to configure device models MX-230x, 270x, 350x, 450x, 550x, 620x, 700x.
1. Open your browser and navigate to the home page for the MFP (http://MFP_IP_Address).
2. On the navigation menu, click Application Settings.
3. On the navigation menu, click External Applications Settings.
4. Enter your administrator credentials.
5. On the navigation menu, click Standard Application Settings.
6. Click Add.
7. In the Application Name box, type the application name.
8. In the Address for Application UI, type the address for the Sharp OSA Web Application.
Typically, this is http://Web_Application_IP_Address:Web_port/ASWebForSharp/
Default.aspx.
9. In the Timeout box type the time that the MFP should wait for a response from the application (160 seconds).
10. Click Submit.
Scanning a document from the device
Perform this procedure on the Sharp OSA device.
1. On the device console, select the OSA application that was registered in Configuring the device to Connect to a
Sharp OSA Web Application.
2. If you are prompted for user credentials, enter your user information, and press OK.
1214
Skip this step if authentication is not enabled for the component.

3. Place the document you want to scan in the scan feeder or plate.
4. Select the form you want to use for scanning the document, and enter values in the form fields.
5. Press the SCAN button.
No restrictions or limitations currently identified.
Problem Description
Solution
The device does not show the Applications
The device is not properly configured to point to a

server. Check the device configuration and make sure the
device is pointing to the correct server. If you change the
configuration of the server to use a different port rather
than the default port, make sure the device is configured
to connect to the appropriate port. Apply the changes
made to the configuration and you should be able to see
the forms on the device after a few seconds.
Server fails to start.Log entry indicates cant create

directory
Check for: The folder path that appears under the

Preferences tab must all exist. The server attempts to
create these folders, but if not successful or if the folder
is deleted prior to starting the server, then the server
will not start properly.Solution: Make sure the folders
on Preferences tab exist and the server user id has full
access to them.
The MFP Device has the forms showing up but does not
display the right forms. Where are these forms coming
from?
There could be several setups that result in forms

displayed improperly:
The MFP displays the following message when a

document is scanned: ERROR: Could not send scanned
file to FTP server
Check for the following:

document is scanned: WARNING: Could not remove
scanned file from FTP
The Sharp OSA Web Application is pointing to the

wrong server. Check the server address and make
sure that it is pointing to the intended server.
The device is pointing to the wrong Sharp OSA Web
Application. Check the External Application Settings
configuration in the device and make sure that it
is pointing to the intended web application and the
correct Web port number.
The device is member of one of the device groups
and it is taking the forms from the device group (and
not from the Common Group). Also make sure that
the device only appears in one group.
The FTP server is unreachable. Make sure that the

FTP port is not blocked.
The FTP server does not allow write operations.
Make sure that the FTP server is configured to allow
user to put file in it.
This is usually due to the ASPNET account not having

permissions to delete files from the FTP folder where the
documents are created. See the Configuring the Sharp
OSA Web Application form more details.
1215
Problem Description
Solution

document is scanned: "Network error.(Timeout error)
Consult your network administrator."
This is likely due to the timeout for HTTP runtime

execution being short. Increasing this timeout value will
fix the issue.
RRT of user's credential through third-party card

authentication is empty.
Check for the following:
When format="password", the value displayed is not

replaced with "*" on the software keyboard. Instead of
"*", the plain text displays on the software keyboard.
Query device authentication session for

credentials in Group Settings should be checked.
The key for each user attribute from third-party card
authentication is preceded with "MFPUserAttri-"
and user attribute is case sensitive.
The version for SharpCapture.dll should
be V.6.0.1.28 or above and the version for
ASWebForSharp should be V 1.0.0.19.
The timer for third-party card authentication should
be shorter than the MFP device energy saver timer.
Do not initialize the password type fields.
SMARTicket Component
SMARTicket component
Introduction to the SMARTicket Component
SMARTicket provides users with document capture and workflow automation tools which assist in capturing,
defining and implementing business rules. A SMARTicket administrator can configure workflows within AutoStore
and create tasks or combination of tasks, termed "Combo", using the SMARTicket Process Designer. Embedded
within workflows, tasks or combination of tasks are business rules determined by the organization. A SMARTicket
user can reference the tasks through the creation of a SMARTicket. Scanning the SMARTicket with the document to
be processed initiates the automated workflow developed by the SMARTicket administrator.
SMARTicket terminology
Task
A SMARTicket Task is a unit of workflow that consists

of any number of Process components and only one
Route component. Once a Task is published and a
SMARTicket is created from this Task, users will have
the ability to execute the task using the SMARTicket. A
Task is not available for use until it has been published.
Once a Task is published, the user will be able to view
this Task in order to create a SMARTicket. Refer to the
SMARTicket Process Designer documentation for details
of how to create a Task.
Note: A Task may also be referred to as a
Single-Flow Item.
Combo
A SMARTicket Combo is a bundle of more than

one Task. The Combo can be used to create multiple
workflows. Up to 24 Tasks can be included in a Combo.
Once a Combo is created and a SMARTicket is created
from this Combo, users have the ability to execute the
1216
Combo using the SMARTicket. Refer to SMARTicket

Process Designer documentation for details of how to
create a Combo.
Note: A Combo may also be referred to as a
Multi-Flow Item.
Client
A client is an application that helps create a

SMARTicket. Client creates a SMARTicket from either
Tasks or a Combo. Create a SMARTicket using any
supported Client.
SMARTicket
A SMARTicket (paper or electronic) has all the

workflow information about Tasks and Combos along
with the required indexing information embedded in
it. A user initiates the AutoStore workflow process by
sending the document (along with the SMARTicket) into
the workflow.
Note: A SMARTicket may also be referred to
as a SMARTicket coversheet or a SMARTicket
barcode coversheet.
How SMARTicket works

This topic steps through a typical end-to-end workflow.
1.
2.
3.
4.
5.
The SMARTicket administrator creates a SMARTicket Task or Combo workflow.

The SMARTicket administrator creates a AutoStore workflow and configures a SMARTicket route component.
The SMARTicket administrator starts the AutoStore service.
Users create SMARTickets based on available Tasks or Combos.
The user scans the document along with the SMARTicket.
AutoStore
AutoStore allows for designable workflows that automate document capture and eliminate the manual steps that slow
down a business process.
Applications designed around AutoStore take advantage of the AutoStore workflow automation and connect these
powerful features to users. Examples of these clients are:
AutoCapture
An application that provides users with the ability to

directly submit electronic files into AutoStore workflows
through Windows.
OpenScan
A scanning desktop application that allows fast document

scanning, reviewing, validation, indexing and automatic
connection of scanned image files into business
applications using AutoStore workflows.
SMARTicket is also a business process automation application based on the AutoStore technology. SMARTicket,
like AutoCapture and OpenScan, is built around the concept of submitted electronic documents to AutoStore using
workflow tags or attached to SMARTickets. Using SMARTickets, users can tag a document with a workflow
identifier and submit those tagged documents into AutoStore for processing.
An administrator should be familiar with AutoStore concepts such as:
Document workflow analysis, concept and design

AutoStore server configuration and startup parameters
Connecting MFPs to the AutoStore server
AutoStore server monitoring and runtime setup
1217
With a thorough understanding of these concepts, an administrator can effectively manage SMARTickets.
Configuring the SMARTicket component
To configure the AutoStore workflow process, create a plan that takes into account the following:
The SMARTicket server and the associated relational database.

Any additional servers that will run child AutoStore process or processes.
List of available SMARTicket Tasks and Combos.
The type of SMARTickets that end-users will be using.
Preferences tab
Configure preferences options on this tab.
Option
Description
Profile
A list of available profiles will be displayed by selecting

the browse button (...). An existing profile may be
modified or a new profile can be created. A profile
contains the definition of service and how specific tasks
for that service are run.
Recognizing a SMARTicket
There are three options:
Removing a SMARTicket
UncheckedNo attempt to search for SMARTickets

will be made. Instead, a SMARTicket ID will be
passed through the component.
CheckedThe process will attempt to search for
SMARTickets.
Conditionally CheckedClick twice on the check
box and the browse button (...) appears next to the
check box. Click on the browse button to enter
a condition for when the process will attempt to
recognize SMARTickets. If the condition is not
met, the process will not attempt to recognize any
SMARTickets.
There are three options:
UncheckedIf a SMARTicket has been recognized,

the page with the SMARTicket information will
remain in the final output.
CheckedIf a SMARTicket has been recognized,
the page with the SMARTicket information will be
removed from the final output.
Conditionally CheckeClick twise on the check
box and the browse button (...) appears next to the
check box. Click on the browse button to enter
a condition for when the SMARTicket will be
removed. If the condition is not met, the process will
not remove the SMARTickets from the final output
For more detail, please refer to SMARTicket Recognition

Scenarios.
SMARTicket ID
If the choice to not recognize SMARTickets is made,

enter the ID of a SMARTicket representing the workflow
1218
Option
Description
that should be processed. An RRT should be entered if a
SMARTicket form is used.
SMARTicket Lock Code
Provide the Lock Code the SMARTicket may require

before it can be used. An RRT may be entered in this
field.
Encrypted
Select this check box to encrypt the password. Note that

encryption only works with static passwords. It does not
work with password that use RRTs.
SMARTicket User Notification
By default, the user who creates a SMARTicket will

receive status messages on the SMARTicket Web
Client application related to SMARTicket processing.
Additional users can be added to those already receiving
SMARTicket notifications by adding their user name
separated by a comma (,) or semicolon (;).
SMARTicket Reject Path
Enter the destination to store documents from failed jobs.
PDF Load Options
Set the image and color resolution before loading PDF

documents into the SMARTicket component.
Image ResolutionEnter a value between 200 and

600 DPI
Color ResolutionValid values are 1, 8 or 24
Profile dialog box

This dialog box displays a list of all defined profiles.
Click the Add button to create a new profile. A profile can be edited or deleted by selecting Edit or Remove.
General tab
Field Name
Description
Name
Enter a name for the profile. This is a required field.
Description
Enter a brief description of the profile.
Server
Enter the Server Name or IP address and port of

the Web Service Address. The required format is
http://servername : port or http://IPaddress : port . If
secure socket layer (SSL) is enabled, the required format
is https://servername : port or https://IPaddress : port .
Home Path
Choose the folder path where the SMARTicket server

will retain all processing information. This is a required
field. It is suggested that a UNC path is used.
Task tab
The Published Tasks dialog box has been divided into two sections. The upper half displays all the Tasks that use the
default setting to start a SMARTicket Task service. The lower section displays all the tasks that have been customized.
1219
Select a Task from the upper half and click on Customize to modify the service start-up attributes for that Task. If
the attributes have been modified, and the changes have been accepted, the Task is moved to the customized section.
Changes can be made to a customized Task by clicking on the Edit button.
To undo the customization of a Task, select the Task from the customized section and click on Reset.
Note: Only Published Tasks are displayed and SMARTicket Combos are not displayed.
SMARTicket recognition scenarios
Single page document with one SMARTicket.
Remove SMARTicket OFF: Each task will run with the original document and associated SMARTicket
metadata
Remove SMARTicket ON: Each task will run only with the metadata associated with the SMARTicket
Multi-page document with one SMARTicket. Although it is recommended to place the SMARTicket page as the
first page of the document, the SMARTicket page can be located anywhere in the document. The SMARTicket
page is not reordered after recognition.
Remove SMARTicket OFF: Each task will run with the original document and associated SMARTicket
metadata
Remove SMARTicket ON: SMARTicket page is removed from the original document. Each task will run with
the remaining document along with the metadata associated with the SMARTicket.
Multi-page document with multiple SMARTickets. Each recognized SMARTicket is split into a new job
containing the pages as defined below.
The first SMARTicket can be in any page prior to the second SMARTicket. The resulting job will contain all
pages up to the second SMARTicket.
After the first SMARTicket, each remaining SMARTicket page is treated as a pre-separator for the resulting
job.
Fields tab
By selecting this tab, a SMARTicket administrator can assign values to the fields that were created in the task.
External fields are created for a SMARTicket Task through the SMARTicket Process Designer interface. An external
field can be used in an AutoStore workflow to dynamically capture index values from the capture component. A
external field becomes available to the AutoStore workflow as a field where the value of this field comes from the
capture component as metadata.
Example Process
An example would be where an AutoStore workflow

process is created where the capture component is a
Multi-Functional Peripheral (MFP) followed by the
SMARTicket component. And within the SMARTicket
Process Designer a SMARTicket Task is created
using the Send to Folder route component. The goal
is to provide metadata captured at the MFP to the
SMARTicket Task.
Example process
In SMARTicket Process Designer, create a Task with a Send to Folder route component.
An example would be where an AutoStore workflow process is created where the capture component is a MultiFunctional Peripheral (MFP) followed by the SMARTicket component. And within the SMARTicket Process
Designer a SMARTicket Task is created using the Send to Folder route component. The goal is to provide metadata
captured at the MFP to the SMARTicket Task.
1. In SMARTicket Process Designer, create a task with a Send to Folder route component.
2. Configure an external field called "Employee ID".
3. Save and publish the Task. The value for the external field will be made available through the AutoStore capture
component.
1220
4. Within the AutoStore Process Designer, create a process using a MFP capture device followed by SMARTicket
route component. Within the MFP capture component, create a form with field name "ID" defined as string type.
Go to the Components tab and configure the SMARTicket component by clicking on the ellipses in the rightmost
column.
5. The SMARTicket component will be displayed. Specify server attributes in the Profile and other information in
6. Select the Fields tab. Once the server information is inputted, the SMARTicket component will query the server
for all Tasks with external fields.
7. Select the Task which was previously created. The external field "Employee ID" will be displayed. The RRT popup window appears with "Employee ID" as an available RRT.
8. Drag and drop the value for field name "Employee ID" from the RRT pop-up window. This copies the ~MFP::
%ID%~ into the value field for Employee ID (where MFP is the RRT ID of the desired MFP device).
In this example, the user-entered value for "Employee ID" is passed from the MFP component to the SMARTicket
component. As SMARTicket spawns a child AutoStore process (in this example the child AutoStore process is Send
to Folder), the metadata entered at the MFP device is passed to the child AutoStore process. Now configure the Send
to Folder component to create a folder based on called "Employee ID".
SMARTicket component RRTs
Component RRT ID
The RRT ID for this component is REF.
Name
Description
GUID
The GUID (Globally Unique Identifier) that uniquely

identifies a Server Job (independent of SMARTicket)
and is generated by SMARTicket component. The GUI
can be used as a key for identifying data corresponding
to a Server job.
Server
SMARTicket server name.
MainStart
Start time of the main Server Job.
MainEnd
End time of the main Server Job.
MainJobStatus
Status of the main Server Job.
UseCoverPage
0The Server Job has successfully been processed

by the SMARTicket component
non zeroA number that refers to the status of the
Server Job.
Valid values are:
0No coversheet
1With coversheet
InputDocCount
Number of input files (documents) that SMARTicket

receives.
ST_Name
SMARTicket name
ST_Count
Number of SMARTicket coversheets.
1221
Name
Description
ST_DocCount
Number of documents corresponding to a SMARTicket

Example: If there is one SMARTicket for 5 documents,
the ST_DocCount returns 5. However, if there are
two SMARTickets corresponding to 5 documents, the
ST_DocCount returns 10.
ST_Status
Number representing the status of the job relating to a

SMARTicket.
ST_StatusDesc
Status description relating to ST_Status
ST_TaskID
Task ID of a SMARTicket
ST_TaskName
SMARTicket task name
ST_CreatedBy
SMARTicket create by: domain\username
ST_CreatedOn
Date/Time the SMARTicket was created.
ST_ShareType
SMARTicket Share Type value:
0 - Private
1 - Public
2 - Shared
ST_TaskVersion
Task Version of the SMARTicket
ST_ID
SMARTicket ID; you can use this RRT for creating

reports
ST_JobTrackingID
Tracking ID in the SMARTicket application.
ST_Start
SMARTicket start time
ST_End
SMARTicket end time
The RRT string ~REF::ST_TaskVersion~ is replaced with the value 2 when the version of task used is 2.
This component does support FRTNs and replacement of field names generated from the MFP devices. The following
The RRT string ~REF::%Client ID%~ is replaced by Company if the user types in Company for the field
Notification messages logged for users can be mapped as an RRT in the SMARTicket AutoStore component.
This component does not support any Special Set Replacement Tag Names.
SMARTickets should not be resized.
Best practices
To increase accuracy of SMARTicket recognition:
Scan a SMARTicket with a minimum DPI of 200 in text mode
1222
Use bright paper to ensure a crisp, clean barcode.

OMR checkboxes should be properly checked with a black pen or marker.
Note that using a higher DPI or scanning the SMARTicket in color mode the slower it will be to process it.
Smarticket Configuration Manager

Notable Solutions Smarticket Configuration Manager
The Notable Solutions Smarticket Configuration Manager provides the following features:
Ability to setup configuration settings for the Smarticket Service in a central location.
Database creation and user connectivity verification.
Database server scheduling.
Web server and Web client configuration.
Web server and Web client startup.
Backup and restore from existing backups web service options and client configurations.
Option
Smarticket Service
Description
Shows the current status of the Smarticket Service.
StartingThe service is starting.

RunningThe service has been started and is
running.
StoppingThe service is stopping.
StoppedThe service has been stopped and is not
running.
Stop
Click this button to start the Smarticket Service. This

button is available when the service is running.
Start
Click this button to start the Smarticket Service. This

button is available when the service is stopped.
Service Options
Click this button to open the Smarticket Service

Properties dialog box to configure the Smarticket
Service. You can also configure the service options using
the Services console in Windows Administrative Tools.
For information about the service settings, see Smarticket
Service Options.
Web Service tab

Web Client tab
Licensing tab
Backup tab
Smarticket Service options
Configure Smarticket Service options in the Smarticket Service Properties dialog box. You can open this dialog box
by clicking the the Service Options button in the Notable Solutions Smarticket Configuration Manager dialog
box. Smarticket Service settings may also be configured in the Services console in Windows Administrative Tools.
In addition to the options described here, the Services console provides Recovery and Dependencies options. For
additional information about configuring services, refer the Windows Help and Support topics.
1223
In the Smarticket Service Properties dialog box configure service settings on the General and Log On tabs. The
controls at the top of the dialog box allow you to view and change the status of the service:
Option
Service Status
Description
Service status can be one of the following:
StartingThe service is starting

running
StoppingThe service is stopping
running
Start
Click this button to start the service. This option is

available when the service is stopped.
Stop
Click this button to stop the service. This option is

available when the service is running.
Pause
Click this button to pause the service. This option is

unavailable.
Resume
Click this button to resume the service when it is paused.

This option is unavailable.
General tab
On this tab you can view information about the service and configure how the service starts.
Option
Description
Service name
The name of the service. This is read only.
Display name
The displayed name of the service. This is read only.
Description
The description for the service. This is read only.
Path to executable
The name and location of the executable file for the

service. This is read only.
Startup type
The startup type for the service can be one of the

following:
AutomaticThe service is started automatically

upon a system reboot.
ManualThe service can only be started manually.
DisabledThis disables the service so that it cannot
be started.
Log On tab
On this tab, enter the information for the account a that will be running the service.
Option
Local System account
Description
Specifies that the service logs on to the LocalSystem
account rather than a user account. The Local System
account is a predefined local account used by the service
control manager to run services. This account is not
recognized by the security subsystem and does not have
1224
Option
Description
a password. It has extensive privileges on the local
computer, and acts as the computer on the network.
This account
Allows you to specify that the service runs under

user account. Click the Browse button to select the
user account to run the service. In the Password and
Confirm password boxes, specify the password for the
account. This service should have write access to folder
locations, such as error log directories.
Web Service tab

Under this option, the web service may be enabled or disabled and can be hosted either by Internet Information Server
(IIS) Host or by the Smarticket Service Host. Settings for the web service must be configured to support connections
by the Smarticket Service.
Option
Description
Enable web service on this computer
Select this check box to enable the connection to the

web service on the local host. If you clear the option, the
Smarticket service connects to a web service on another
machine.
Smarticket Service Host
Choose this option to use the native web service

supported by the Smarticket Service.
Click the Configure button to open the Web Service

Identification dialog box to configure web service
bindings or to enable and configure SSL for the Web
service.
For more information about settings for the Smarticket

Service web service identification settings, see Web
Service tab.
Internet Information Server (IIS) Host
Choose this option to use Internet Information Services

(IIS) running on the host machine.
Note: The IIS option is available only if IIS is
installed. To install IIS, see Installing Internet
Information Services (IIS).
Click the Configure button to configure web service

bindings for the IIS web server:
Web SiteEnter the web site. The default is

Default Web Site.
AddressEnter the IP address. The default
is All Unassigned. With All Unassigned, all
incoming traffic will be routed to the web site.
TCP PortEnter the TCP port. The default is
80.
Connect over SSLSelect this check box if the
connection must use SSL.
Database tab
Configure database connection parameters, create databases and set-up database maintenance activities.
1225
Option
Description
Type
Specify the database management server type.
Server
Specify the IP address or server name of the database

management server.
Database
Specify the name of the database.
Smarticket Login ID
The user account used to connect to the database server.

This user account must have access to the database.
Password
The password for the user account.
Max Connections
Enter the maximum number of user connections that may

connect to the database management server.
Verify Database
Click this button to test the connection to the database

server.
Database Manager
Click this button to enter database connection

parameters, create databases and set-up database
maintenance activities. For details, see Database
Manager.
Smarticket Database Manager dialog box

Use this dialog box to enter database connection parameters, create databases and set-up database maintenance
activities.
Note: Creating, modifying, or updating the database system require logon information for a database system
user that has create and update permissions
Database Setup tab
Option
Database tab
Description
Use this form to create a new Smarticket database or
upgrade from a previous version.
Choose Create new to create a new database or Update
existing to upgrade an existing database. You can click
the Copy from Database User tab hyperlink to copy the
information entered on the Database User tab into the
options on this tab.
DBMSThe name for database management

server. This entry cannot be edited.
ServerEnter the IP address or server name for the
database management server.
DatabaseEnter the name of the database.
If you chose the Create new option, click the Create

Database button. If you chose the Upgrade existing,
click the Upgrade Database button.
Database User tab
Configure optios on this tab to ensure the login for the

Smarticket database exists. You can click the Copy from
Database tab hyperlink to copy the information entered
on the Database tab into options on this tab.
DBMSThe name for database management

server. This entry cannot be edited.
1226
Option
Description
Verify Login/User
ServerEnter the IP address or server name for the

database management server.
DatabaseEnter the database name.
Smarticket Login Id/User IdEnter the database
user credentials for the database management server
and database.
PasswordEnter the password for the database
user.
Click this button to test that the database and user

settings are valid.
Database Maintenance tab

Settings for the Database Maintenance Service can be configure on this tab. The editable settings for the service are
can also be configured in the Settings console in the Windows Administrative Tools.
Option
Status
Description
The status can be one of the following:
StartingThe service is starting.

running.
StoppingThe service is stopping.
running.
Start
Click this button to start the service. This button is

Stop
Click this button to stop the service. This button is

Options
Click this button to open the Smarticket Database

Manager Service Properties dialog box to configure
the service properties. For details, see Smarticket
Database Manager Service Options.
Job Maintenance
Notification Maintenance
Delete Expired JobsSelect this check box to

delete all expired maintenance jobs.
ScheduleClick this button to change the job
deletion schedule.
Delete NowDeletes all expired maintenance
jobs immediately without the use of the scheduling
mechanism.
Delete Notifications older thanSelect this check
box to delete all notification older than the specified
number of days (1-99).
ScheduleClick this button to change the
notification deletion schedule.
Delete NowDeletes all expired notifications
immediately without the use of the scheduling
mechanism.
1227
Smarticket Database Manager Service options

Configure Smarticket Database Manager Service options in the Smarticket Datbase Manager Service Properties
dialog box. You can open this dialog box by clicking the the Options button on the Data Maintenance tab in the
Smarticket Database Manager dialog box. Smarticket Database Manager Service settings may also be configured
in the Services console in Windows Administrative Tools. In addition to the options described here, the Services
console provides Recovery and Dependencies options. For additional information about configuring services, refer
the Windows Help and Support topics.
In the Smarticket Service Properties dialog box configure service settings on the General and Log On tabs. The
controls at the top of the dialog box allow you to view and change the status of the service:
Option
Service Status
Description
Service status can be one of the following:
StartingThe service is starting

running
StoppingThe service is stopping
running
Start
Click this button to start the service. This option is

Stop
Click this button to stop the service. This option is

Pause
Click this button to pause the service. This option is

unavailable.
Resume
Click this button to resume the service when it is paused.

This option is unavailable.
General tab
On this tab you can view information about the service and configure how the service starts.
Option
Description
Service name
The name of the service. This is read only.
Display name
The displayed name of the service. This is read only.
Description
The description for the service. This is read only.
Path to executable
The name and location of the executable file for the

service. This is read only.
Startup type
The startup type for the service can be one of the

following:
AutomaticThe service is started automatically

upon a system reboot.
ManualThe service can only be started manually.
DisabledThis disables the service so that it cannot
be started.
1228
Log On tab
On this tab, enter the information for the account a that will be running the service.
Option
Description
Local System account
Specifies that the service logs on to the LocalSystem

account rather than a user account. The Local System
account is a predefined local account used by the service
control manager to run services. This account is not
recognized by the security subsystem and does not have
a password. It has extensive privileges on the local
computer, and acts as the computer on the network.
This account
Allows you to specify that the service runs under

user account. Click the Browse button to select the
user account to run the service. In the Password and
Confirm password boxes, specify the password for the
account.
Active Directory tab

Use settings on this tab to specify the user with Active Directory access and to verify the user information. The user
should have read access to the Active Directory and be able to perform searches for user and Exchange lookups.
Option
Description
Username
Enter the user name or click the browse button (...) find
the user.
Password
Verify User
Click this button to verify the user name and password

settings.
Admin Group
Select the appropriate adminstrator group.
General tab
On this tab, specify the path information.
Option
Description
Coversheet Logo
Enter the location of the file that is the Logo to be placed

on the Smarticket. Recommended logo specifications
are 150x150 black & white. Select Set to browse to the
location. Select View to view the file.
Error Log Directory
Enter the location where error log files for the Service
will be stored. Additional debugging information can
be added to the log file by selecting Enable trace
debugging. Select Set to browse to the location. Select
View to view the file.
Enable trace debugging
This option can be used by Notable Solutions service

personnel for troubleshooting and diagnostics.
Installing Internet Information Services (IIS)

Enabling support for Internet Information Server (IIS) and ASP.NET for:
Windows Server 2003

Windows Server 2008 or Windows Server 2008 R2
1229
Windows Server 2003

1. Click Start > Administrative Tools > Manage Your Server.
2. In Manage Your Server, click Add or remove a role to open the Configure Your Server wizard.
3. On the Peliminary Steps page, click Next.
4. On the Server Role page, click Application Server (IIS, ASP.NET), and then click Next.
5. On the Application Server Options page, click Next.
6. On the Summary of Selectionspage, click Next.
Wait while the Windows Components Wizard makes changes to the server. You may need to provide the Windows
2003 Server installation disk.
7. Click Finish to close the wizard.
Windows Server 2008 or Windows Server 2008 R2
1. In Server Manager, use the Add Roles Manager to add the following roles to the server:
Application Server
Web Server IIS
2. When the wizard displays the subcomponents for Application Server role, make sure that the Web Server (IIS)
Support option is selected.
3. When the wizard displays the subcomponents for Web Server role, make sure that the following are selected:
Option
Description
Common HTTP Features
Static Content
Default Document
HTTP Errors
HTTP Redirection
Application Development
ASP.NET
.NET Extensibility
ISAPI Extensions
ISAPI Filters
Security
Request Filtering
Performance
Static Content Compression
Management Tools
IIS Management
Web Client tab

On this tab, you can enable or disable the web client and specify whether the web client is hosted on by the native
Smarticket web server or by Internet Information Services (IIS). Settings for the Web Client must be configured.
Smarticket Service Host
Option
Description
Enable web client on this computer
Select this check box to enable the connection to the

Web Client on the local host. Clear this option if the
Web Service and Web Client are located on different
machines.
Smarticket Service HostChoose this option to

use the Smarticket service to host the web client.
1230
Option
Description
Click the Configure button to configure web client

bindings or to enable SSL.
Internet Information Server (IIS) HostChoose
this option to use Internet Information Services (IIS)
to host the web client. Click the Configure button
to configure web client bindings. This option is only
available if IIS is installed on the local machine.
If this option is selected, you can edit settings on the

Web Service tab to configure the connection settings and
Web Service address. See Web Service Tab.
Web Client Bindings
Web Client SSL Setup
Web SiteThe default setting is Smarticket Web

Client. This setting is read only.
AddressThe default is All Unassigned. This
setting is read only.
TCP PortEnter the TCP port number. The default
is 9715.
Enable SSLSelect this option to use the Secure
Socket Layer (SSL) protocol. A certificate will be
required to complete the SSL configuration.
Self-SignedSelect this option to create a selfsigned certificate. When prompted after you click
OK, enter Company and Expiration Date and
Password. If a self-signed certificate has already
been created, you will be given the option of
recreating the certificate. If you do not recreate the
certificate is not recreated, the existing certificate will
remain in use.
If this option is not selected, you can associate
an proprietary certificate or a certificate obtained
through a 3rd-party vendor.
Certificate FileIf Enable SSL is selected but
Self-Signed is cleared, the path to the certificate file
must be specified.
Internet Information Services (IIS) Host

Note: The IIS option is available only if IIS is installed. To install IIS, see Installing Internet Information
Services (IIS).
Option
Web Client Bindings
Description
Web SiteEnter the web site. The default is

Default Web Site.
AddressEnter the IP address. The default is All
Unassigned. With All Unassigned, all incoming
traffic will be routed to the web site.
TCP PortEnter the TCP port. The default is 80.
Connect over SSLCheck the box, if the
connection must use SSL.
1231
Open Web Client

Option
Web Client
Description
This displays the address for the Web Client. Click the
hyperlink to open the Web Client.
Web Service tab

Option
Connect Through
Description
Specify to connect to the Web service through one of the
following means:
Web Service Address
Network Named PipesThis is the fastest

connection option and works only when both
the Web Service and Web Client are on the same
machine.
WS Hypertext Transfer Protocol (HTTP)The Web
Service connects over the HTTP protocol.
Basic HTTPThe Web Service connects over the
HTTP protocol. This option is used when backward
compatibility is necessary.
This is the address for the Web Service. This option

cannot be changed when the Web Service and the Web
Client are located on the same machine.
This address can be edited when the Web Service is
located on a different machine. Enter the machine name
where the Web Service is located. The required format
is:
SSL enabled:
https://server_name:port
https://ip_address:port
SSL not enabled:
http://server_name:port
http://ip_address:port
Open Web Service
Click this button to open the Web Service.
Cache tab
Option
Description
Coversheet Cache Location
Enter the path where Smarticket coversheets will be

stored.
User with Write Permissions
Enter a domain and user information for a user with

write permissions to the coversheet cache location.
Verify User
UsernameEnter the username.

PasswordEnter the password for the user.
Click this button to ensure that the user has write

permissions to the coversheet cache location.
1232
General tab
Under the General tab, make the following selections:
Option
Description
Single Sign On
Click Yes to use the credentials of the logged on user to

run the Web Client. When this option is not enabled, any
user may log on to use the Web Client.
Ticket Display Type
The display format for the Smarticket when displayed

within the Web Client.
Log Directory
PDFDisplays in PDF format.

PNGDisplays in PNG format.
The location where the error logs for the Web Client
will be stored. Additional debugging information can
be added to the log file by selecting Enable trace
debugging. Click Set to browse to the location. Click
View to view the file.
Licensing tab
The Smarticket Configuration Manager opens upon completion of the installation process. Once the web service has
been configured and started, the user can create license requests to add and update licenses. The status of the license
can be viewed by selecting the Licensing tab.
Option
Licenses
Description
Shows licenses for this component.
Licensed Users
Web LicenseClick this button to open the

Notable Solutions licensing web page.
Add KeysOnce a license request has been
created, a license file is generated. Click this button
to add licensing information from the file or to update
existing licenses.
Create RequestClick this button to create a
license request.
RefreshClick this button to refresh license status
information.
Licensed users of the Smarticket Web Client can be

managed by clicking the Add, Remove, Export, and
Import buttons.
Backup tab
The backup function allows the user to backup web service and client configurations. Web service and client
configurations can be restored from existing backups and saved backups can be deleted.
Option
Description
Backup Now
Click this button to back up the configurations. Enter

a name for the backup in the Input Required prompt
dialog box.
Delete
Click this button to delete a previously stored backup.
1233
Option
Description
Restore
Click this button to restore from a previously stored

backup.
Smarticket Process Designer

Smarticket Process Designer
Introduction
Smarticket provides users with document capture and workflow automation tools which assist in capturing, defining
and implementing business rules. A Smarticket administrator can configure workflows within AutoStore and
create tasks or combination of tasks within the Smarticket Process Designer. Embedded within workflows, tasks
or combination of tasks are business rules as required by the organization. A Smarticket user can reference the
tasks through the creation of a Smarticket. Scanning the Smarticket with the document to be processed initiates the
automated workflow developed by the Smarticket administrator.
Smarticket concepts and terminology
A Smarticket Task is a unit of workflow that consists of
any number of Process components and only one Route
component. Once a Task is published and a Smarticket
is created from this Task, users will have the ability to
execute the task using the Smarticket. A Task is not
available for use until it has been published. Once a Task
is published, the user will be able to view this task in
order to create a Smarticket. Refer to Smarticket Process
Designer documentation for details of how to create a
Task.
Task
Note: A Task may also be referred to as a

Single-Flow Item.
A Smarticket Combo is a bundle consisting of more
than one Task. A Combo can be used to create multiple
workflows. Up to 24 Tasks can be included in a Combo.
Once a Combo is created and a Smarticket is created
from this Combo, users have the ability to execute the
Combo using the Smarticket. Refer to Smarticket Process
Designer documentation for details of how to create a
Combo.
Combo
Note: A Combo may also be referred to as a

Multi-Flow Item.
Client
A client is an application that helps create a Smarticket.

Client creates a Smarticket from either Tasks or a
Combo. Create a Smarticket using any supported Client.
Smarticket
A Smarticket (paper or electronic) has all the workflow

information about Tasks and Combos along with the
required indexing information embedded in it. A user
initiates the AutoStore workflow process by sending the
document (along with the Smarticket) into the workflow.
1234
Note: A Smarticket may also be referred to as

a Smarticket coversheet or a Smarticket barcode
coversheet.
Optical Mark Recognition (OMR) technology provides
a means of data collection from paper/electronic forms.
OMR technology detects the absence or presence of a
mark, but not the shape of the mark. Smartickets can
be configured to have OMR check boxes, with each
OMR check box relating to a different workflow. The
Smarticket user places a mark in the OMR check box
corresponding to the desired workflow and submits the
Smarticket to Smarticket application for processing.
OMR
AutoStore
AutoStore allows for designable workflows that automate document capture and eliminate the manual steps that slow
down a business process.
Applications designed around AutoStore take advantage of the AutoStore workflow automation and connect these
powerful features to users. Examples of these clients are:
AutoCaptureAn application that provides users with the ability to directly submit electronic files into
AutoStore workflows through Windows.
OpenScanA scanning desktop application that allows fast document scanning, reviewing, validation, indexing
and automatic connection of scanned image files into business applications using AutoStore workflows.
Smarticket is also a business process automation application based on the AutoStore technology. Smarticket like
AutoCapture and OpenScan is built around submission of electronic documents into AutoStore using pre-defined
workflow tags or Smarticket. Using Smarticket, users can tag a document with a workflow identifier and submit those
tagged documents into AutoStore for processing.
An administrator should be familiar with AutoStore concepts such as:
Document workflow analysis, concept and design

AutoStore server configuration and startup parameters
Connecting MFPs to the AutoStore server
AutoStore server monitoring and runtime setup
With a thorough understanding of these concepts, a Smarticket administrator can effectively manage Smarticket.
How Smarticket works
The following is a typical end-to-end workflow:
1.
2.
3.
4.
5.
Smarticket administrator creates a Smarticket Task or Combo workflow.

Smarticket administrator creates an AutoStore workflow and configures a Smarticket route component.
Smarticket administrator starts the AutoStore service.
Users create Smartickets based on available Tasks or Combo.
User scans the document along with the Smarticket.
Smarticket components
The Smarticket Process Designer is comprised of process and route components. No capture components are defined
in Smarticket as the capture component of the workflow is a part of the AutoStore Service configuration.
For Smarticket process components, create a Task by selecting the desired process components that are available
on the Process tab of the Toolbox.
For Smarticket route components, create a Task by selecting the desired route component that is available on the
Process tab of the Toolbox.
Remember: Every Task must have a Route component.
1235
Getting Started
Getting started with Smarticket is straightforward. On the Windows desktop, click Start > Programs > NSI >
Smarticket > Smarticket Process Designer. This opens the application and displays the Smarticket Process
Designer interface. From there you can perform the following operations:
Connecting and disconnecting from the Smarticket server

Workflow file management
Managing Tasks
Managing Combos
ManagingSmartickets
Registering Clients
File menu tasks

Connect to the Smarticket server
On the File menu, click Connect to open the Connect to Smarticket Server dialog box.
Option
Description
Server
Enter the Server Name or IP address and the port for the
Web Service in the following format:
HTML
http://server_name:port or http://ip_address:port
HTML with Secure Socket Layer (SSL) enabled
https://server_name:port or https://ip_address:port
Note: This setting can be copied directly from
the Smarticket Configuration Manager.
The Web Service Address is listed on the Web
Service tab and the Web Client tab.
Get
If the Web Service is running on the local machine, click

this button to automatically populate the Server field
with the Web Service information.
Select this check box for the Smarticket Process

Designer to automatically connect to the Web Service
when the application is starts up.
Disconnect from the Smarticket server

On the File menu, click Disconnect. This will disconnect the Smarticket Process Designer from the Web Service.
Save a workflow file
On the File menu, click Save, and specify the location for the Workflow file.
Close a workflow file
On the File menu, click Close.
Tasks
A Smarticket Task is a unit of workflow that consists of one or many process components and only one route
component. Use the Smarticket Process Designer to create a Smarticket Task.
1236
A Task is a workflow that is initiated from the Smarticket component within the AutoStore process.
A Task is comprised of the following attributes:
PropertiesEncompasses Task processing, access and security attributes

WorkflowRepresentation of the process components and route component for a workflow.
ScriptChange the default behavior of the controls used to represent a Smarticket Task.
Task operations
Create a Smarticket Task
The Smarticket administrator creates a Task from the Smarticket Process Designer interface.
1. On the toolbar, click the Home tab
2. In the Tasks section, click New.
This opens a form with several tabs that define the characteristics of the task:
Properties tab
Workflow tab
Script tab
Properties tab
Set the basic settings that determine the title, access rights, workflow definition, and Smarticket usage for this task.
General properties
Set the basic settings for a Task. This will determine access to the Task.
Option
Description
Name
Enter a unique name for the Task. The admin user will
use this name to differentiate between Tasks.
Description
Enter a description for the Task.
Type
From the drop-down list select a registered client type.

The administrator registers the client types in Smarticket
server, after which client type appears in the drop-down
list for this field. The client type ultimately dictates the
types of Tasks that can be created.
Operation
This field is set to Standard Smarticket. If the client

registration supports other operations, those additional
operations will be available in the drop-down list.
Grant Access Only to
An administrator can choose to allow only certain users

access to the Tasks. This will limit users to a certain
Tasks.
Usage properties
These properties apply to Smartickets created using a task.
Option
Unlimited
Description
Select this box if the Smarticket created from this Task
has no usage limit. The Smarticket created using this
Task will never expire.
If you clear this check box, you must specify a maximum
number of uses for the Smarticket created from this Task.
For example, if five uses are entered, the Smarticket
created based on this Task can be used five times.
1237
Option
Description
Expires After
Enter Smarticket lifetime duration. Any Smarticket

created based on this Task will have a maximum lifetime
of days, hours and minutes based on entered values.
If you clear this check box then a Smarticket created
based on this Task will never expire.
Allow Users to Change Default Usage Settings
>Select this box to permit users to override the

Smarticket usage settings listed above (Unlimited or
Expires After) at the time of creation of a Smarticket.
Process settings
Set the workflow process attributes that apply to this Task.
Option
Description
Work Path
Enter the location where the temporary files are stored.
Frequency
Enter the frequency at which the workflow process

will process Smartickets. The default is set to every 20
seconds.
Schedule
Select this check box and enter begin and end times to
schedule processing times for Smartickets.
Retry on Failure
If any component fails during processing of a

Smarticket, that component will retry processing the
failed Smarticket based on the retry parameters specified
here. The number and schedule of retries dictates the
how the retry is performed.
Enter the desired number of retry attempts by a

component to process the Smarticket.
By checking the Schedule checkbox retries can
be scheduled. Specify begin and end times for the
retries.
The retries are distributed uniformly during the specified

schedule. For example, if the number of retries is set to
5, and the schedule duration is 1 hour, every 12 minutes
a retry attempt will be made. The maximum number of
retries will be 5.
If the Schedule option for retries is not selected, the retry
attempts will be made according to the Task frequency.
File Options
There is an option to keep the processed or rejected files

for future use.
Enter the folder path for where processed files will be

saved.
Enter the folder path for where rejected files will be
saved.
These folder paths can be the same path the

administrator used within AutoStore. An administrator
can create a separate process in AutoStore to poll this
folder.
1238
Option
Debug
Description
Select this check box box and set the debug level to get
the log messages displayed on the status monitor. The
higher the debug level, the higher the detail log messages
that will be displayed.
Note: If the debug level is set too high, this
option may use large amounts of disk storage.
Workflow tab
The Workflow tab allows for the definition of the workflow processing assigned to the task. Index fields that will be
required for this task can also be specified.
Workflows created here are also referred to as child AutoStore workflows. You can drag multiple process components
onto the Workflow tab, but only one route components is allowed.
Define and configure the input fields associated with the components in the workflow process.
Option
Description
Field Name
This can be any series of alphanumeric characters.

Use of special characters (such as ~, &, <, >, %) is not
recommended.Enter metadata information related to the
workflow task (Contract ID, Matter ID, Date, and so
forth).
Type
This component supports the following field types:
Boolean
Date and Time
Exchange Contacts
External
Numeric
String
String List
Required checkbox
Select this check box if the field entry is required.
Caption
Displayed name of the field.
Help
The help message is displayed on the client as a tool tip

window when the mouse cursor is moved over a field on
the form. This should be used to guide to the user when
creating task.
Properties
Configure the property field for each field value.
Boolean field
Option
Description
Default
The value shown here will automatically populate the

field until or unless changed by a user.
False Value
Allows the administrator to type in what the false value

represents.
Show in Smarticket
Choosing Yes means that the field value name will

appear on the Smarticket barcode sheet when printed.
1239
Option
Description
True Value
Allows the administrator to type in what the true value

represents.
Date Time field

Option
Description
Custom Format
Allows the administrator to create a unique schema.
Default
The value shown here will automatically populate the

field until or unless changed by a user.
Mode
Show in Smarticket

DateEntry for date only

TimeEntry for time only
Date and TimeEntry for date and time
Defined Date Time formats

Name
Format Specifier
Example
Short Date
1/1/2011 12:35:45 AM -> 1/1/2011
Long Date
1/1/2011 12:35:45 AM -> Saturday,

January 1, 2011
Short Time
1/1/2011 12:35:45 AM -> Saturday,

January 1, 2011 12:34 AM
Long Time
1/1/2011 12:35:45 AM -> Saturday,

January 1, 2011 12:34:45
Short Date and Time
1/1/2011 12:35:45 AM -> 1/1/2011

12:34 AM
Long Date and Time
1/1/2011 12:35:45 AM -> 1/1/2011

12:34:45 AM
Custom Date Time formats

Use the time separator : and the date separator / in custom date time format strings.
Description
Format Specifier
Examples

through 31
1/1/2011 12:35:45 AM -> 1

through 31
dd
1/1/2011 12:35:45 AM -> 01

the week.
ddd
1/1/2011 12:35:45 AM -> Sat
The full name of the day of the week
dddd
1/1/2011 12:35:45 AM -> Saturday
The tenths of a second in a date and

time value
1/1/2011 12:35:45:7348592 AM -> 7
1/1/2011 12:35:45:01 -> 0
1240
Description
Format Specifier
The hundredths of a second in a date

and time value
ff
Examples
1/1/2011 12:35:45:7348592 AM ->
73
1/1/2011 12:35:45:003 -> 00
The milliseconds of a second in a

date and time value
fff
1/1/2011 12:35:45:7348592 AM ->

734
1/1/2011 12:35:45:0005 -> 000
The ten thousandth of a second in a

date and time value
ffff
1/1/2011 12:35:45:7348592 AM ->

7348
1/1/2011 12:35:45:00001 -> 0000
The hundred thousandths of a second fffff

in a date and time value
1/1/2011 12:35:45:7348592 AM ->

73485
1/1/2011 12:35:45:000004 -> 00000
The millionths of a second in a date

and time value
ffffff
1/1/2011 12:35:45:7348592 AM ->

734859
1/1/2011 12:35:45:0000006 ->
000000
The ten millionths of a second in a

date and time value
fffffff
1/1/2011 12:35:45:7348592 AM ->

7348592
1/1/2011 12:35:45:00000008
0000000
If non-zero, the tenths of a second in

a date and time value
If non-zero, the hundredths of a

second in a date and time value
FF
1/1/2011 12:35:45:7348592 AM -> 7

No output for 1/1/2011 12:35:45:010
1/1/2011 12:35:45:7348592 AM ->
73
No output for 1/1/2011 12:35:45:005
If non-zero, the milliseconds in a

date and time value
FFF
1/1/2011 12:35:45:7348592 AM ->

734
No output for 1/1/2011
12:35:45:0005
If non-zero, the ten thousandths of a

FFFF
1/1/2011 12:35:45:7348592 AM ->

7348
12:35:45:00005
If non-zero, the hundred thousandths

of a second in a date and time value
FFFFF
1/1/2011 12:35:45:7348592 AM ->

73485
12:35:45:000005
If non-zero, the millionths of a

FFFFFF
1/1/2011 12:35:45:7348592 AM ->

734859
1241
Description
Format Specifier
Examples
12:35:45:0000005
If non-zero, the ten millionths of a

FFFFFFF
1/1/2011 12:35:45:7348592 AM ->

7348592
12:35:45:00000005
The period or era
g or gg
1/1/2011 12:35:45 AM -> A.D.
The hour, using a 12-hour clock from h

1 to 12
1/1/2011 12:35:45 AM -> 12
The hour, using a 12-hour clock from hh

01 to 12
1/1/2011 12:35:45 AM -> 12
The hour, using a 24-hour clock from H

0 to 23
1/1/2011 12:35:45 AM -> 0
The hour, using a 24-hour clock from HH

00 to 23
1/1/2011 12:35:45 AM -> 00
Time zone information
1/1/2011 12:35:45 AM Kind

Unspecified -> no output
The minute, from 0 through 59
1/1/2011 12:35:45 AM -> 35
The minute, from 00 through 59
mm
1/1/2011 12:35:45 AM -> 35
The month, from 1 through 12
1/1/2011 12:35:45 AM -> 1
The month, from 01 through 12
MM
1/1/2011 12:35:45 AM -> 01
The abbreviated name of the month
MMM
1/1/2011 12:35:45 AM -> Jan
The full name of the month
MMMM
1/1/2011 12:35:45 AM -> January
The second, from 0 through 59
1/1/2011 12:35:45 AM -> 45
The second from 00 through 59
ss
1/1/2011 12:35:45 AM -> 45
The first character of the AM/PM

designator
1/1/2011 12:35:45 AM -> A
The AM/PM designator
tt
1/1/2011 12:35:45 AM -> AM
The year from 0 to 99
1/1/2011 12:35:45 AM -> 1
The year from 00 to 99
yy
1/1/2011 12:35:45 AM -> 11
The year, with a minimum of three

digits
yyy
1/1/2011 12:35:45 AM -> 2011
The year as a four digit number
yyyy
1/1/2011 12:35:45 AM -> 2011
The year as a five digit number
yyyyy
1/1/2011 12:35:45 AM -> 02011
Hours offset from UTC, with no

leading zeroes
1/1/2011 12:35:45 AM -07:00 -> -7
1/1/2011 4:35:45 AM -> 04
1/1/2011 3:35:45 PM -> 15
1/1/0001 12:35:45 AM -> 001
1242
Description
Format Specifier
Examples
Hours offset from UTC, with a

leading zero for a single digit value
zz
1/1/2011 12:35:45 AM -07:00 -> -07
Hours and minutes offset from UTC
zzz
1/1/2011 12:35:45 AM -07:00 ->

07:00
Exchange Contacts field

This is a specialized String List field where the list items (values and text) are obtained from a search of Contacts that
is stored in the logged in users Personal Address Book in the associated Exchange Server (if there is one) and in the
Default Global Address List in Active Directory. The user will select the values from a customized Lookup string list.
Note that the lookup box will not be preloaded with the list values, but the user needs to specifically provide search
criteria in order to retrieve any matches.
Option
Description
Custom Text Property
If field type is Custom, then this property must be set.

Set this property to a valid exchange store property the
contents of which will be used to populate the display
text of the list items. For example, if the property is set to
urn:schemas:contacts:fileas then the display text of the
list items will be set to the name of the contact. For a full
list of properties refer to the Exchange Store Schema in
the Exchange Server SDK documentation.
Custom Value Property
If field type is Custom, then this property must be set.Set

this property to the valid exchange store property the
contents of which will be used to populate the value
of the list items. For example, if the property is set to
urn:schemas:contacts:bday then the value of the list
items will be set to the Birthday of the contact. For a full
list of properties refer to the Exchange Store Schema in
the Exchange Server SDK documentation.
Exchange Service
Enter the WebDAV or Exchange Web Service (EWS)

URL. Note that for a EWS service, the URL is optional
because the EWS API will automatically discover the
URL using the users email address that is retrieved from
Active Directory.
Default
This value will automatically populate the field until

changed by the user.
Generates OMR
This generates OMR on the Smarticket for the user to

place a mark in the selection box.
Height
The use of the property varies when Display Mode is set

to Lookup:
If Display Mode is List Box, then this property

defines the number of items that are visible at the
same time in the list box.
If Display Mode is Lookup, then this property
defines the number of lines of the text box control
that holds the selected values.
If Display Mode is Button List this property is
ignored.
1243
Option
Description
If Display Mode is Ticket Only this property is

ignored.
Max Items
The maximum number of items found that will be

displayed in the lookup list, if the value in the property
is 0 then all values will be displayed. It is recommended
that a value is entered for this property since an
unlimited search can be slow depending on the number
of contacts in the Exchange Server and in Active
Directory.
Separator
Symbol chosen by administrator to separate selected

values.
Shown in Ticket

Type
Width
EmailIf selected, the list will contain the email

information for the contacts, the values of the list will
be filed with the email address of the contacts, the
display value will be the name of the contact.
FaxIf selected, the list will contain the fax
information for the contacts, the values of the list
will be filed with the fax number of the contacts, the
display value will be the name of the contact.
CustomThis is an advanced option that lets the
administrator specify which properties will be used
to populate the values and displays for the list by
entering a value in the Custom Text Property and
Custom Value property, if Custom type is selected
then the lookup will only be done to the personal
address book, the Default Global Address List will
not be searched.
This property is only used if the Display Mode is lookup,

in which case this property is used to indicate the Width
in characters of the text box that holds the values entered
or selected by the user.
Custom Properties
Custom properties that are used with the Custom Text Property and Custom Value Property for the Exchange
Contact field type are listed below. Note that although both property name standards for both WebDAV and Exchange
Web Service (EWS) can be used with Smarticket Process Designer, it is recommended that the property name
standards for Exchange Web Service (EWS) be used.
WebDAV
Exchange Web Service (EWS)
urn:schemas:contacts:cn
DisplayName
urn:schemas:contacts:department
Department
urn:schemas:contacts:o
CompanyName
urn:schemas:contacts:facsimiletelephonenumber
BusinessFax
urn:schemas:contacts:officetelephonenumber
BusinessPhone
1244
WebDAV
Exchange Web Service (EWS)
urn:schemas:contacts:title
JobTitle
urn:schemas:contacts:manager
Manager
urn:schemas:contacts:secretary
AssistantName
urn:schemas:contacts:bday
Birthday
urn:schemas:contacts:businesshomepage
BusinessHomePage
urn:schemas:contacts:givenName
GivenName
urn:schemas:contacts:initials
Initials
urn:schemas:contacts:middlename
MiddleName
urn:schemas:contacts:nickname
NickName
urn:schemas:contacts:location
OfficeLocation
urn:schemas:contacts:profession
Profession
urn:schemas:contacts:sn
Surname
urn:schemas:contacts:secretaryphone
AssistantPhone
urn:schemas:contacts:office2telephonenumber
BusinessPhone2
urn:schemas:contacts:callbackphone
Callback
urn:schemas:contacts:organizationmainphone
CompanyMainPhone
urn:schemas:contacts:homePhone
HomePhone
urn:schemas:contacts:homePhone2
HomePhone2
urn:schemas:contacts:mobile
MobilePhone
urn:schemas:contacts:otherfax
OtherFax
urn:schemas:contacts:othertelephone
OtherTelephone
urn:schemas:contacts:pager
Pager
urn:schemas:contacts:telephoneNumber
PrimaryPhone
urn:schemas:contacts:telexnumber
Telex
urn:schemas:contacts:ttytddphone
TtyTddPhone
urn:schemas:contacts:email1
EmailAddress1
EmailAddress2
EmailAddress3
Other custom property names that can be used with Custom Text Property and Custom Value Property are:
DisplayName
Mileage
CarPhone
HomeFax
Isdn
RadioPhone
ImAddress1
1245
ImAddress2
ImAddress3
External field
The field value comes to the child AutoStore that is spawned by Smarticket component within AutoStore parent
process.
This field implies that the field value is being transferred from the AutoStore process to the child process and there
are no additional properties to configure.
Numeric field
Option
Description
Default
This is the default value for the field until changed by the
user.
Max Value
The maximum value.
Min Value
The minimum value.
Show in Smarticket

String field
Option
Description
Default
The initial value in the field.
Max Length
The maximum amount of characters that can be entered

by a user.
Rows
The number of rows of data that can be entered by a user.
Show in Smarticket
Yes specifies that this field name will be shown on the

printed coversheet.
Text Mode
Single LineField contains a single line of text.

Multiple LinesField can contain multiple lines of
text.
PasswordContent is obscured so the value cannot
be read at the console.
Visible
Specifies whether the field is visible to the user.
Width
Specifies the width of the text box in number of

characters.
String List field

This field presents a list of predefined values that the user can select.
Option
Description
Default
This value will be the default for the field until changed
by the user.
Display Mode
List BoxIf this option is selected, the user will

select values from the list using a list box.
Button ListIf this option is selected, the user will
select values from the list using radio buttons.
1246
Option
Description
Look-upIf this option is selected, the user can

either type the values or select them from the list of
predefined values. To access the list of values, the
user will need to click on the browse button. The user
can then select the value or use the find options to
narrow the list.
Ticket OnlyIf this option is selected, the contents
of the list will not be displayed when creating the
Smarticket. However, the contents of the list be
displayed in the Smarticket as an OMR List. This
option can only be selected if Generates OMR is set
to Yes.
Generates OMR
This generates OMR on the Smarticket for the user to

place a mark in the selection box.
Height
The use of the property varies depending on the contents

of Display Mode:
If Display Mode is List Box, this property defines the

number of items that are visible at the same time in
the list box.
If Display Mode is Lookup, this property defines the
number of lines of the text box control that holds the
selected values.
If Display Mode is Button List,this property is
ignored.
If Display Mode is Ticket Only, this property is
ignored.
List
The administrator creates the list from which the user

selects the appropriate value.
Selection Mode
SingleA single value can be selected

MultipleMore than one value can be selected
Note: The value of this property is ignored if
the display mode is ticket only because OMR
lists always allow for multiple selections.
Separator
Symbol chosen by administrator to separate selected

values.
Show in Smarticket
Choosing Yes means that this field name will be shown

on the printed Smarticket barcode sheet.
Width
This property is only used if the Display Mode is set to

lookup, in which case this property is used to indicate the
width in characters of the text box that holds the values
entered or selected by the user.
Script tab
Change the default behavior of the controls used to represent a Smarticket Task. The button is located to the left of the
Name column.
Note: Currently only Visual Basic .NET is supported for writing scripts.
1247
Client Script
This tab is only available if the client that is associated

with the Task supports scripting. If the client configured
for the Task supports scripting, use this section to
provide the script. This script will be used by the client.
Each client manages scripting differently; therefore,
reference the scripting documentation for the client that
is used.
How to delete a Smarticket Task

You can remove a Smarticket Task from the Smarticket database in the following ways:
On the Smarticket Process Designer toolbar, click the Delete button.

This deletes the active Smarticket Task from the database.
In the Tasks pane, right-click the Task you want to delete, and click Delete on the shortcut menu.
How to publish a Smarticket Task

Before you can begin using a Task in a Smarticket you must first publish the Task.
1. On the File menu, click Save to save the Smarticket Task.
2. On the Home tab of the toolbar, click Publish.
Import or export a Task or Combo
Importing or exporting Tasks or Combos may be useful in cases where you want to make backups of Task and Group
files and move them between various Smarticket servers.
Import a Task or Combo

Export a Task or Combo
How to Import a Task or Combo

An existing Task or Combo can be imported into the workspace. This may be useful when you have backups of Task
and Combo files, and you want to move files between various Smarticket servers.
1. On the Home tab of the toolbar, click Import.
2. Browse for the XML (.xml) file that represents a Task.
How to Export a Task or Combo
You can select a Task or Group and export it to a file for future reference.
1.
2.
3.
4.
In the Tasks or Combos pane, select the Task or Combo that you want to export.
On the Home tab of the toolbar, click Export.
Browse to the location that you want to save the file and specify the file name for the exported Task or Combo.
Click the Save button.
How to modify a Smarticket Task

1. In the Tasks window, double-click on the Task to be modified.
This displays the Task.
2. On the tabs, make desired changes.
3. Make sure to save your changes before closing the task.
How to copy and paste a Smarticket task
Perform this task to copy and paste a Smarticket Task from the Smarticket database.
1. In the Tasks pane, select the Task to copy.
2. Right-click the task, and click Copy on the shortcut menu.
3. In the same pane, right-click again and click Paste.
1248
The newly created Task name has a suffix n, where n is the ordinal count of copies of the Task.
Version history
A published Task cannot be edited or modified. Any attempt at editing a published Task will create a working version
of that Task and saves the most recent published version of the Task as an active version of the Task.
The version history of a Task can be viewed by right-clicking on any Task and clicking Version History on the
shortcut menu. This view displays a list of all Tasks versions.
Using the Task Version History view the user can:
View a previous version and see how the previous version of a Task was configured.
Activate a previous version of this Task. An Activated Task can still be used for processing Smartickets.
Deactivate a previous version of this Task. A Deactivated version of a Task cannot be used to process any Tasks.
From the drop-down menu, users can also:

MigrateThe user can select a different version of a task for an existing Smarticket to use
ManageThe user can manage Smartickets. Smartickets can be searched based on name, ID, Created by, Share
Type, a date within a range when the Smarticket was created, last used or expired or by a specific task used within
the Smarticket. The list of matching Smartickets is displayed. The Smarticket can be viewed or deleted.
Combo
A Smarticket Combo is a bundle consisting of more than one Task. A Combo can be used to create multiple
workflows. Up to 24 Tasks can be included in a Combo. Once a Combo is created and a Smarticket is created from
this Combo, users have the ability to execute the Combo using the Smarticket. Combos extend the capabilities of
Tasks by allowing multiple tasks to be run as part of a single Smarticket. Without Combos, several Smartickets are
needed for multiple tasks. Refer to Smarticket Process Designer documentation for details of how to create a Combo.
Smarticket Combo properties
Combos extend the capabilities offered by Tasks when there is a need to run multiple tasks as part of a single
Smarticket. Without a Combo, multiple Smartickets are needed for multiple tasks.
Option
Description
Name
Enter a name for the Combo. Combo Name can be based

on the tasks that are bundled in the Combo.
Description
Provide a description of the Combo
Client Type
From the drop-down list select the desired client type.

The selection you make narrows down the tasks you can
include in this Combo. Please refer to Tasks.
Grant Access Only to
Select this check box to limit access to specified users.
NameClick to browse for users for whom you want

to grant access to this Smarticket Combo. Based
on this field, the selected users can view/edit the
Smarticket Combo from the selected Client Type.
Clear this check box to allow access to the Combo to all

users in the domain where the Smarticket Web Service
was installed.
Tasks
Click Add to open the Add Tasks window. Select the

desired tasks and click OK.
The Add Tasks window displays the published Tasks
corresponding to the Client Type. Depending on the
Combo function, select a specific Task more than once.
1249
Option
Description
Display Tasks as OMR checkbox(es) on the

Smarticket
Select this this check box to display the tasks as Optical

Mark Recognition boxes where the user can place a
mark.
If this check box is selected and a task that includes a
OMR generating field is added, the Combo cannot be
saved.
Only one set of OMR generating fields are allowed, so if
two tasks with OMR generating fields are used within a
Combo, the Combo cannot be saved.
Usage
The following fields apply to the life span of a

Smarticket that is using this Smarticket Combo.
UnlimitedSelect this check box if you want a

Smarticket created using this Smarticket Combo
have unlimited lifetime and can be used indefinitely.
Otherwise, you can select the number of times
Smarticket can be used before it expires.
Expires afterEnter the time that you want the
Smarticket to expire after the Smarticket has been
created.
For example "Smarticket123" using "Combo abc"
was created at 1:04 pm. The Expires after checkbox
is selected and the interval is set to 20 minutes. Then
Smarticket123 will expire at 1:24 pm.
Note: Expired Smartickets will disappear from
the Smarticket client window.
Allow user to change default settings
Select this check box to allow users to change the default

settings when creating the Smarticket.
Combo operations
How to create a Smarticket Combo
Perform this procedure to create a Smarticket Combo.
1. From Smarticket Process Designer toolbar, click the File > New > Combo.
2. Enter the name and other properties for the new combo.
For more information, see Smarticket Combo Properties.
3. Click OK.
The new Como shows in the Combos pane of the Smart Process Designer window.
How to delete a Smarticket Combo
Perform this procedure to delete a Smarticket Combo from the Smarticket database.
Use either of the following two methods to delete a Smarticket Combo.
On Smarticket Process Designer toolbar, click the Delete button to delete the active Smarticket Combo.
In the Combos pane, right-click a Combo and click Delete on the shortcut menu.
How to modify a Smarticket Combo

Perform this procedure to modify a Smarticket Combo.
If you modify a Task from within a combo definition, the newly modified Task is not used by the Combo until the
Task is published. After the task is published all Combos using the Task will use the newly published version of the
Task.
1250
In the Combos pane of the Smarticket Process Designer, double-click on the Combo to be modified.
How to copy and paste a Combo
1. In the Combos window, right-click the Combo that you want to copy, and click Copy on the shortcut menu.
2. In the same window, right-click and click Paste.
The newly created Combo name has is suffixed by a number n designating the n-th copy of the Combo.
Tools
How to manage Smartickets
Perform this procedure to view or delete Smartickets that are currently saved in the Smarticket database.
1. On the Home tab of the toolbar, click the Manage Smarticket button.
2. Enter the criteria to search for available Smartickets.
Smartickets can be searched based on name, ID, Created by, Share Type, a date within a range when the
Smarticket was created, last used or expired or by a specific task used within the Smarticket.
3. This opens the list of matching Smartickets.
4. You can view or delete any Smarticket in the list.
Smarticket client
A Smarticket creator can view existing Smarticket Tasks or Combos by using any supported Smarticket client.
How to register a client
Perform this procedure to register a client.
To register a client:
1. On the Smarticket Process Designer tool bar, click Manage Clients.
This displays the Client Registration dialog box.
2. Click the Register button and browse to the registration .xml file for the desired client.
3. Select the .xml file and click Open.
The client is registered and be available for managing Smartickets and viewing Tasks and Combos.
Troubleshooting
Error codes
The following table shows the code, type, and description for errors in Smarticket Process Designer.
Code
Type
Description
Unknown Error
Error captured from the system.

Check error log for detailed
troubleshooting information>
External Error
Error captured from external

Smarticket dependent components.
Invalid Id
Attempt to retrieve an invalid object

id.
Invalid Request
Service request call failure.
Database Error
Error captured from database server.
Job Expired
Smarticket job has expired.
Job Max Uses Reached
Maximum number of uses for the

Smarticket job has been reached.
Job Incorrect Password
Incorrect password used for the

Smarticket job.
1251
Code
Type
Description
Invalid Client Id
Client id that is passed is invalid.
10
Invalid Operation Id
Operation id that is passed is invalid.
11
Server License Expired
Web service license has expired.
12
Client License Expired
Web client license has expired.
13
Client License Info Not Found
Web client has not been registered.
14
Server License Not Found
Web service has not been registered.
15
Not Registered With ASL
Web service not registered with

AutoStore.
16
Database Corrupted
Database is corrupted.
17
Job Inactive
The Smarticket job is inactive.
18
Operation Not Allowed
User operation is not allowed.
19
Max User License Reached
Maximum number of users allowed

has been reached for the web service.
20
Coversheet Error
Coversheet file cannot be generated.
21
Migrate New Version Inactive
Not Used.
22
No Host Name
Not Used.
23
Service Registration Failed
Web service registration has failed.
24
Configuration Error
Configuration setting is invalid.
Smarticket Web Client

Smarticket Web Client
The Smarticket Web Client offers a central location to manage, use and configure Smartickets. From the Smarticket
Web Client, users can view custom Smartickets, publicly shared Smartickets and Smartickets restricted to specific
users as well as use basic and advanced functionality to search for Smartickets. Smarticket Web Client users also have
the ability to configure their web client display.
The Smarticket system provides users with document capture and workflow automation tools which assist in
capturing, defining and implementing business rules. A Smarticket administrator can configure workflows within
AutoStore and create tasks or combination of tasks within the Smarticket Process Designer. Embedded within
workflows, tasks or combination of tasks are business rules for the organization. A Smarticket user can reference
these Tasks and Combos through the creation of a Smarticket. Scanning the Smarticket with the document to be
processed initiates the automated workflow developed by the Smarticket administrator. In turn, these Smartickets can
then be accessed by the Smarticket Web Client user.
About the Smarticket Web Client component
In this section, you will learn of some the fundamentals of the Smarticket Web Client component. There are four areas
that which will be covered:
Smartickets
Workflows
Optical Mark Recognition
Notifications
1252
What Is a Smarticket?
A Smarticket is a paper or electronic document that has all the Workflow information about Tasks and Combos along
with the required indexing information embedded in it. The Smarticket Web Client is used to create, configure and
manage Smartickets. A Smarticket Task is a unit of Workflow. A Smarticket Combo is a combination of Tasks that are
bundled. Tasks and Combos are managed by the Smarticket administrator through the Smarticket Process Designer.
The Smarticket is scanned or sent along with the documents to be processed. The barcode displayed on the Smarticket
determines the Workflow to be used as well as any other processing requirements.
1253
1254
From the Smarticket Web Client display, Smartickets can be accessed by selecting the Tickets tab (see Figure 2).
Access modes are set for Smartickets. Smartickets created by the Smarticket Web Client user will be displayed in the
My Tickets tab. Smartickets that are accessible by all Smarticket Web Client users can be found in the Public Tickets
tab. Specific Smarticket Web Client users can be granted permission to use a Smartickets. All Smartickets where the
user has been granted permission to access will be located within the Shared Tickets tab.
Figure 12: Figure 2

What is a Notification?
Notifications are status messages about the Smarticket. Notifications are created and configured by the Smarticket
administrator along with Tasks and Combos within the Smarticket Process Designer. When Tasks or Combos are
created, a Notification can be enabled. Additional users who can receive Notifications can be added by the Smarticket
1255
administrator. The Smarticket Web Client can be customized to display certain types of information. See Setting
Display Options for more information.
What is a Workflow?
A Workflow is a sequence of connected operations that capture, route and process information.
What is Optical Mark Recognition?
Optical Mark Recognition (OMR) technology provides a of data collection from paper or electronic documents. OMR
technology detects the absence or presence of a mark, but not the shape of the mark. And based on the existence or
non-existence of the mark, the document will be processed in a certain manner. There are two ways that a OMR can
be used with Smartickets: List and Workflow.
1256
Figure 13: Figure 1

The Smarticket Web Client user can configure Smartickets have OMR check boxes, with each OMR check
box relating to a different workflow (see Figure 1). The Smarticket user places a mark in the OMR check box
corresponding to the desired Workflow and submits the Smarticket along with the document to be processed to the
Smarticket application for processing. Based in which box a check mark is placed, processing will occur using those
Workflows.
1257
Figure 14: Figure 2

A Smarticket that uses OMR for list-based choices is also available (see Figure 2). But note that options presented as
a list must be configured by the Smarticket administrator through the Smarticket Process Designer. Using this type
of OMR enabled Smarticket is the same as with a Smarticket that displays Workflow choices. The Smarticket user
places a mark in the OMR check box corresponding to the desired choice and submits the Smartickets along with
the document to be processed to the Smarticket application for processing. Based on where a check mark is placed,
processing will occur using those values.
Features
The Smarticket Web Client provides the following features:
Ability to create Smartickets in a central location

Use basic and advanced search functionality to search for Smartickets
Configure Smarticket Web Client display
Access Tips, Tools and Options
1258
View My Tickets, Public Tickets or Shared Tickets

View recently used Smartickets
Ability to read notifications for Smartickets
Login screen
When you open the Smarticket Web Client, the Login web page is displayed.
UsernameEnter the domain and username.

PasswordEnter the password for the username.
Click Log In to log on to Smarticket. If the logon is successful, the main web page for Smarticket Web Client is
displayed.
1259
Options, Help and Logout links
Located at the top of the main page are the links to Options, Help and Logout. Selecting Options allows you
to customize the display. You user can adjust the number, the metadata and search styles for Smartickets and
Notifications. You can click Help to access help documentation or Logout to log off of the Smarticket Web Client.
1260
Tickets tab
From the Tickets tab, Smarticket Web Client users have the ability to search for Smartickets and can view My
Tickets, Public Tickets and Shared Tickets. By selecting these tabs, users can access Smartickets that they have
created, Smartickets that are accessible by all Smarticket users and Smartickets where the user has been specifically
granted access.
1261
Notifications tab
From the Notifications tab, Smarticket Web Client users can view Notifications that have been set-up for a
Smarticket. Notifications are status messages about the Smarticket. Users can select the type of information to be
displayed. See Reading Notifications for more information.
1262
My Tickets, Public Tickets and Shared Tickets tab
From the Tickets tab, users can view Smartickets that have been created. Smarticket Web Client have the ability to
view My Tickets, Public Tickets and Shared Tickets. By selecting these tabs users can access Smartickets that they
have created, are accessible by all Smarticket users and Smartickets where the user has been specifically granted
access.
1263
New Ticket button
Smarticket Web Client users can create Smartickets by selecting the New Ticket button. Note that the New Ticket
button is visible from the Tickets tab. Upon selecting New Ticket, users will be step-by-step process where they will
configure and then create the Smarticket. See Creating a new Smarticket for more information.
1264
Accessibility modes
Certain display options such as Tools, Tips, drop-down menus and the ability to switch between Standard Search
and Advanced Search options are displayed when Accessibility Mode is turned OFF. When Accessibility Mode is
turned ON, these options are not displayed. See Setting Display Options for more information.
1265
Tips link
Figure 15: Figure 1
1266
Figure 16: Figure 2

Selecting the Tips link (see Figure 1) will give Smarticket Web Client users a guided map of their Smarticket Web
Client display (see Figure 2). Each important section of the Smarticket Web Client will display a short description
of that section. Note that the Tips link will not be displayed when Accessibility Mode is turned OFF. For more
information on Application Options, see Setting Display Options.
1267
Tools link
By selecting the Tools link Smarticket Web Client users will see options to Print, Download, Copy or Delete the
selected Smarticket from the displayed list. Users can check the checkbox and perform the desired function. Note that
the Tools link will not be displayed when Accessibility Mode is turned OFF. For more information on Application
Options, see Setting Display Options.
1268
Recent Tickets section
Recently used Smartickets will be displayed in this section. The number of recently used Smartickets displayed can be
changed by accessing the drop down menu. Note that the drop down menu will not be displayed when Accessibility
Mode is turned OFF. For more information on Application Options, see Setting Display Options.
Search options
Smarticket Web Client users have two options to search for Smartickets: Standard Search and Advanced Search.
With Standard Search, users can enter a Ticket ID or Ticket Title to search for a Smarticket (see Figure 1).
1269
Figure 17: Figure 1

With Advanced Search, users can search for Smartickets by Ticket ID, Ticket Title or by Created Date (see Figure
2).
1270
Figure 18: Figure 2

The type of search that is displayed on the Smarticket Web Client display can be changed. See Setting Display
Options for more information. In addition, the type of search that is displayed can be changed by selecting the
ADVANCED SEARCH link (see Figure 1) or STANDARD SEARCH link (see Figure 2) located at the bottom of
the search box. For more information on searching, see Search for Smartickets. Note that the ADVANCED SEARCH
and STANDARD SEARCH link will not be displayed when Accessibility Mode is turned OFF. For more
1271
Getting started
The Smarticket Web Client interface is a straightforward display which allows the user to manage, create, modify,
download and print Smartickets online. In this Getting Started section, basic steps to work with the Smarticket Web
Client will be described. These steps include the following:
Step 1Logging into the Smarticket Web Client

Step 2Setting Display Options
Step 3Creating a new Smarticket
Step 4Print & Scan or Save & Send the Smarticket
Step 5Reading Notifications
Step 6Edit, Delete or Search Smarticket
Step 1Logging into the Smarticket Web Client
Figure 19: Figure 1
1272
1. On opening the Smarticket Web Client, the Login web page will be displayed (see Figure 1).
UsernameEnter the domain and username.
PasswordEnter the password for the username
2. Click Login.
If the logon is successful, the main web page for Smarticket Web Client will be displayed.
Step 2Setting display options
The Smarticket Web Client user can modify use these options to customize the display.
Figure 20: Figure 1
1273
Figure 21: Figure 2

1. Select Options to change display options for the Smarticket Web Client can be modified (see Figure 1).
1274
2. From the Application Options page, the following options can be modified to customize the display (see Figure
2):
Position
A
Name
Accessibility Mode
Description
Option to control optimized
functionality for screen readers.
Tickets Listing Columns
OffTurn off optimized

functionality
OnTurn on optimized
functionality
Information to be displayed about

each ticket:
Check Boxdisplays a check

box which allows the user to
select a specific Smarticket
IDThe ID of the Smarticket
TitleThe title of the
Smarticket
# UsesThe number of uses
for the Smarticket
ExpirationThe expiration
date of the Smarticket
Created ByDisplays the user
who created the Smarticket
CreatedThe date the
Smarticket was created
Last ModifiedThe last
modified date of the Smarticket
Ticket Listing Rows
The number of rows of Smartickets

to be displayed.
Ticket History Display
The number of most recently used

Smartickets to be displayed.
Preferred Language
Language settings for Smarticket

Web Client
Preferred Search Style
Select the Search style to be

displayed:
Notifications Listing Columns
Information to be displayed about

each Notification:
StandardUsers can enter

a keyword to search for the
Smarticket
AdvancedUser can search
for Smartickets by ID, Title or a
created by date period
IDThe ID for the Smarticket

JobThe name of the job.
StatusThe status of the job.
1275
Position
Name
Description
Notifications Listing Rows
Activity TimeThe date and

time the message was reported.
The number of rows of

Notifications to be displayed.
3. Once selections have been made, select Save.

Step 3Creating a new Smarticket
This procedure shows how to add a new Smarticket with one Task. Adding additional Tasks repeats this process.
You can create Smartickets by selecting the New Ticket button (see Figure 1). Note that the New Ticket button is
visible from the Tickets tab. Upon selecting New Ticket, follow the steps in the process to configure and then create
the Smarticket.
1276
Figure 22: Figure 1

1. Click New Ticket.
1277
After you click New Ticket, you are prompted to select the Tasks that will be included in the Smarticket.
You must select from one of the listed Tasks. You also have the option of copying from a previously created
Smarticket. If this option is selected, you can perform a keyword search to locate the Smarticket.
2. Once a Task is selected or a previously created Smarticket is copied, click Next.
3. Enter a Title for the Smarticket. In addition, you may change advanced options. These options can be changed if
the Task created in the Smarticket Process Designer has been configured to allow the Smarticket Web Client user
to change these advanced options:
Option
Description
# Uses
The number uses is unlimited or restricted to a specific

number.
1278
Option
Expiration
Security
Description
An expiration date for the Smarticket or restricted to a
specific range.
Security levels for the Smartickets. Options include:
Enable OMR
PrivateOnly the logged in user can use the

Smarticket
PublicAll Smartickets users can use the
Smartickets
SharedA specific set of users can use the
Smarticket. This group can be configured by
entering users separated by a semicolon in the box.
Select the ellipses to search for users.
Require lock codeThe Smarticket can be
password protected. Enter a lock code for the
Smarticket. The format for the lock code can be
any sequence and number of letters, numbers or
symbols.
Optical Mark Recognition (OMR) technology provides

a means of data collection from paper/electronic forms.
OMR technology detects the absence or presence of a
mark, but not the shape of the mark. Smartickets can
be configured to have OMR check boxes, with each
OMR check box relating to a different workflow. The
Smarticket user places a mark in the OMR check box
corresponding to the desired workflow and submits the
Smarticket to Smarticket application for processing.
1279
Data will be prompted for within the Workflow data section, if the Task has been configured to accept such data.
Tasks are created and configured to accept Workflow data in the Smarticket Process Designer.
4. A summary page is displayed. Users have the option to Edit or Delete the Smarticket. Selecting Edit will direct
the user back to 3 on page 1278. Selecting Delete will delete the Task from the Smarticket.
1280
5. Once one Task has been included with the Smarticket, other Tasks can be added. Additional Tasks can be added by
selecting Add Workflow.Users will be directed back to the screen displayed in 1 on page 1277.
Note: Although users are directed to Step 1, users will no longer have the option of copying from a
previously created Smarticket.
Creating the Smarticket
6. Once you complete configuring and adding workflows to the Smarticket, you can preview the Smarticket by
selecting Preview.
You have the ability to copy the image, by right-clicking the image and using the Copy function.
7. You can also save the Smarticket. Save the Smarticket by clicking Save.
If the save was successful, you will see a window stating that the Smarticket was saved successfully.
8. You can now proceed with several options:
Option
Print Ticket
Description
To print the Smarticket.
1281
Option
Ticket
Mini
Notifications
Edit
Delete
Download
Copy
Description
To view the Smarticket.
To view the mini version of the Smarticket.
To view notifications for this Smarticket.
To edit the Smarticket.
To delete the Smarticket.
To download the Smarticket into a PDF format.
To copy the Smarticket.
1282
9. You can return to the main page for Smarticket Web Client by selecting the Tickets tab.
1283
Step 4Print & Scan or Save & Send the Smarticket
Figure 23: Figure 1

Position
A
Option
Check box next to Ticket
Description
Check the box to select the
Smarticket. Once selected, select
the link Tools to Print, Download,
Copy or Delete.
1284
Position
Option
Description
Tools
Drop down menu is displayed.

Options include: Print, Download,
Copy or Delete.
View
Select to view the Smarticket. The

user can now proceed with several
options:
Print TicketTo print the

Smarticket
TicketTo view the Smarticket
MiniTo view the mini version
of the Smarticket
NotificationsTo view
notifications for this Smarticket
EditTo edit the Smarticket
DeleteTo delete the
Smarticket
DownloadTo download the
Smarticket into a PDF format
CopyTo copy the Smarticket
See Creating a new Smarticket for

more information.
The user can now print the Smarticket or save the Smarticket. The Smarticket is then submitted along with the
documents to be processed.
Step 5Reading Notifications
From the Notifications tab, Smarticket Web Client users can view Notifications that have been set-up for a
Smarticket. Notifications are status messages about the Smarticket. These Notifications are created and configured by
the administrator who creates the Task within the Smarticket Process Designer. The type of information displayed for
Notifications can be changed. See Setting Display Options for more information.
1285
Step 6Edit, delete or search Smartickets
Figure 24: Figure 1

Position
A
Option
Check box next to Ticket
Description
Check the box to select the
Smarticket. Once selected, select
the link Tools to Print, Download,
Copy or Delete.
1286
Position
Option
Description
Tools
Drop down menu is displayed.

Options include: Print, Download,
Copy or Delete.
View
Select to view the Smarticket. The

user can now proceed with several
options:
Print TicketTo print the

Smarticket
TicketTo view the Smarticket
MiniTo view the mini-version
of the Smarticket
NotificationsTo view
notifications for this Smarticket
EditTo edit the Smarticket
DeleteTo delete the
Smarticket
DownloadTo download the
Smarticket into a PDF format
CopyTo copy the Smarticket
See Creating a new Smarticket for

more information.
Search for Smartickets
There are two ways to search for Smartickets: Standard Search and Advanced Search.
1287
Figure 25: Figure 2
1288
Figure 26: Figure 3

Smarticket Web Client users have two options to search for Smartickets: Standard Search and Advanced Search.
With Standard Search, users can enter a Ticket ID or Ticket Title to search for a Smarticket (see Figure 2). With
Advanced Search, users can search for Smartickets by Ticket ID, Ticket Title or by Created Date (see Figure
3). The type of search that is displayed on the Smarticket Web Client display can be changed. See Setting Display
Options for more information. In addition, the type of search that is displayed can be changed by selecting the
ADVANCED SEARCH link (see Figure 2) or STANDARD SEARCH link (see Figure 3) located at the bottom of
the search box. For more information on searching, see Search for Smartickets. Note that the ADVANCED SEARCH
1289
and STANDARD SEARCH link will not be displayed when Accessibility Mode is turned OFF. For more
SMTP Capture
Welcome to SMTP capture component
This component provides a way to capture content from any SMTP-enabled devices into your workflow process. Use
this component to capture emails with or without attachment and manipulate the email content and attachment content
through a variety of process components and finally storage in a desired Route component.
Getting started
Feature highlights
The following are some of the features of the SMTP Capture component:
Specify a Subject title for emails that you want captured.
Once email is captured by this component, you have the option to route the email to the SMTP gateway or process
it through subsequent processing and routing components in the workflow.
You have the option to pass through email attachments for processing.
Using SMTP capture component

Use the SMTP Capture component to capture emails into a process. The following provides one scenario using this
component.
Capture all incoming email that have a specific subject title "Invoice" and store all such email into a database table.
In this example, the database table becomes a backup to email of a specific subject. You can design a process with
SMTP Capture component followed by Send to Database Route component. This capture component extracts
all email with the subject title of "Invoice and saves it as a file and sends off the file to Send to Database route
component. Configure the Send to Database component to specify the name of a table, which stores all the email with
subject title of Invoice and call that table "Invoice Emails". When you run this process, all email with the subject
"Invoice" will be saved into the table "Invoice Emails". You can then sort the emails by date.
Configuring the SMTP capture component
Topics in this section describe how to configure options for the for the SMTP capture component.
To configure the SMTP capture component, double-click the component icon in a workflow to open the SMTP
Configuration dialog box, and configure options on the following tabs.
Tab
Description
SMTP Subjects tab on page 1290
On this tab specify how you want the email message to

be handled by the service.
SMTP Gateway tab on page 1294
This tab specifies the SMTP gateways that you want this
component to use for sending outgoing email messages.
Security tab on page 1294
You can restrict transmittal from a certain devices to

prevent transmissions from unidentified sources.
Preferences tab on page 1295
Enter the service attributes in this tab.
SMTP Subjects tab

On this tab specify how you want the email message to be handled by the service.
If the email does not have a subject, or does not match one in the subject list, it will be processed under the using the
Default Subject configuration. This does not change an unspecified subject to Default Subject.
1290
Option
Description
Add
Click this button to create a new subject category. This

opens the Subject Configurations dialog box.
Remove
Click this button to remove a selected subject category.
Edit
Click this button to edit the subject attributes for

incoming emails.
Subject Configurations dialog box

This dialog box defines how documents will be scanned and configures other process or routing components in a
workflow.
General tab
The device setting defines how the documents will be scanned. With some capture devices, you may have the option
of selecting to scan one page per file. Therefore, if you place 5 pages on the tray and scan, it will attach 5 attachments,
each with one page. With this type of devices, if the option of selecting one page per file is not selected, then all 5
pages would be saved into one attachment.
Some other types of multifunctional devices will automatically scan the pages as separate files (5 pages = 5
attachments), unless there is an option setting to allow for multi-page tiff capture.
Field Name
Description
Subject
Enter the subject name that you want SMTP Capture to

use for extracting incoming email. Subjects are sorted
alphabetically, however the Default Subject is always the
first subject entry.
Use Expression Matching
Select this check box to use expression matching in the

Subject box. The Subject box supports the following
regular expression matching operators:
^
Matches the beginning of

the input.
Matches the end of the

input.
Matches the preceding

character zero or more
times. For example
Cu*p will match Cp,
Cup, Cuup.

character one or more
times. Cu+p will match
Cup or Cuup, but will
not match Cp".

character zero or one
time. For example, "a?
ve?" matches the "ve" in
"never". (pattern) Matches
pattern and is used for
1291
Field Name
Description
nesting. For example
abc(def)+ will match
abcdef, abcdefdef
but not abcd or abcde
since def is enclosed in
parenthesis.
x|y
Matches either x or y. For

example, "hi|lo" matches
"hi" or "lo". "(hi|lo)t"
matches "hit" or "lot".
[xyz]
A character set. Matches

any one of the enclosed
characters. For example,
"[abc]" matches the "a" in
"plain". Please refer to the
Troubleshooting tips for
further clarification.
[^xyz]
A negative character set.

Matches any character not
enclosed. For example,
"[^abc]" matches the "p"
in "plain".
[a-z]
A range of characters.
Matches any character in
the specified range. For
example, "[a-z]" matches
any lowercase alphabetic
character in the range "a"
through "z". By the same
token [1-9] matches any
number between 1 and 9
inclusive.
[^m-z]
A negative range
characters. Matches
any character not in
the specified range.
For example, "[^m-z]"
matches any character not
in the range "m" through
"z".
Escape character matches

the next character as
a literal character. For
example, the sequence
"\\" matches "\" and the
sequence "\(" matches "(".
For examples of expression matching, see Examples of

Expression Matching.
Process Email
Select this check box to process the email message

through the workflow.
1292
Field Name
Description
Pass Through
Select this check box to pass the email message through

as an attachment (.eml file) to the job. If this box is not
checked, only attachments from the email message, if
there are any, will be attached onto the job. In order to
pass through an email message, the Process Email check
box must be selected.
Route to SMTP Gateway
Select this check box if you want to send the captured

email to an SMTP gateway.
Components tab
Click on the components tab to configure the remaining components in your process. Simply click on the last column
entry corresponding to the component that you want to configure and proceed to configure the component.
Examples of expression matching
Example
^(Invoice[a-z]*[1-9]+)$
Description
Matches all subjects that start with the word "Invoice",
followed by 0 or more characters, followed by at least
one numeric digit, and no other characters after it.
Therefore, possible matches are:
Invoice2
InvoiceForShipment23
This expression will not match the following:
ShipmentInvoices, ShipmentInvoices34,
ShipmentInvoices34A, Invoice, InvoiceA2B.
(Invoice[a-z]*[1-9]+)
Matches all subjects that contain the word "Invoice",

followed by 0 or more characters, followed by at least
one numeric digit.
Invoice2
ShipmentInvoices34
ShipmentInvoices34A
InvoiceA2B
InvoicesForShipment23
This component will not match the following:
ShipmentInvoice, ShipmentInvoices (because it still
requires at least one numeric digit following Invoice [az]* )
([123]+[^a-c](start|end)+)$
Matches all subjects that begin with any set of

characters, followed by at least one occurrence of 1, 2, 3,
followed by only one letter not in the range a-c, followed
by the word "start" or "end" one or more times, and no
other characters following it.
Invoice23Mendstartend
Invoice12Send
1293
Example
Description
SimpleInvoice1d
This component will not match the following: mEnd
(because there is no starting matching sequence with
1, 2, or 3), 1mstartFile (because no characters should
follow the word end/ start), or 1start (because there
is no character in between 1 and start that is in the
range of c-z ).
SMTP Gateway tab

This tab specifies the SMTP gateways that you want this component to use for sending outgoing email messages.
The SMTP gateways are listed by priority order and the SMTP Capture component attempts a connection to each
server starting from top of the list.
Option
Description
Add SMTP Gateway
Click this button to add an SMTP Gateway. You can

add SMTP Gateways using the server IP address or the
server host name.
Edit SMTP Gateway
Click this button to modify the SMTP server address for

the currently selected SMTP Gateway entry.
Remove SMTP Gateway
Click this button to remove a selected SMTP Gateway

entry from the prioritized list of gateways. The system
will prompt for confirmation prior to removing any
entry. You cannot undo this operation after you remove
an entry.
Test
Click this button to test the validity of the a selected

SMTP Gateway entry.
A test consists of opening the SMTP Gateway port to the
server and sending a test message to the server to ensure
a valid SMTP Gateway is present. The test finishes
by displaying a message that shows the status of the
gateway.
Move
The move buttons change the priority list order. The

server attempts to use the prioritized list of SMTP
Gateways in the order appearing on this list. The top
most SMTP Gateway is first to be used and the bottom
entry is the least likely to be used.
Click on an SMTP server in the list and change its
position by clicking the up or down arrow.
Security tab
You can restrict transmittal from a certain devices to prevent transmissions from unidentified sources.
Option
Limit to Addresses below
Description
Select this option to limit transmittal of email messages
from specified device IDs.
1294
Option
Description
Address List
Shows IP addresses for devices that can transmit email

messages.
Add
Click this button to specify the IP address for a device.
Remove
Click this button to remove a selected address.
Preferences tab
Enter the service attributes in this tab.
Option
Description
Home Directory
The root directory that the service creates to save all

temporary directories and files. The server must have
proper permission to write to that directory.
Use Default IP Address
Select this check box to use the default IP address of the

computer to listen for SMTP messages. When there are
multiple network cards with multiple IP addresses on the
computer, you can clear this check box to specify the IP
address that listens for SMTP messages.
Port
The IP port number that is used between the component

and the service for getting all the email and attachments.
Keep
Keep the files in:
Processed filesThis directory stores captured files

upon completion of successful routing. If you turn
this attribute on, all files are stored into the Processed
Keep in mind that if this is turned on, a copy of
every file that has been routed successfully is saved
on this directory. Make sure that proper disk storage
is allocated for this directory.
Rejected filesThis directory is used for storing
any files that failed to store into the final destination
location. The failure could be due to any number of
reasons and it must be researched through searching
the application log file entries. Typically, it is
beneficial to have a secondary process that takes
this directory as an input and routes messages out to
system administrator and warns them of failure.
Reject EmailsThis directory is used to store any
outgoing eMails that were rejected as Undeliverable
eMail by the receiving SMTP server.
Any SMTP Server rejection will force the service
to reject the email message. The subsequent SMTP
Servers are not attempted once any one SMTP Server
explicitly rejects the message.
1295
Option
Description
Important: The service must have sufficient
rights to access and write to the specified
locations.
SMTP Capture component RRTs

Component RRT
The SMTP Capture component RRT ID is SMP.
The following table describes the reserved RRTN values for the Schema field of this component.
Name
Description
AttachmentCount
Number of attachments within the email
FileSize
File size of the attachment.
Subject
Subject of the email.
To
To address of the email.
From
From address of the email.
Cc
List of addresses that are Ccd.
Bcc
List of addresses that are Bccd.
Body
Body of the email.
The RRT string ~SMP::Body~ is replaced with body of the email.
This component does support any SSRTNs.
Problem Description
Solution
SMTP Capture component is not receiving email.
Make sure the port on the preferences tab is open/

available. If the service fails to start, check for another
process (for example, SMTP server) that could be
locking the port.
Email (eml) files appear on Reject email directory.
The external SMTP Gateway is a valid SMTP server and

it is rejecting any incoming MAIL. This could be due to
several factors, such as:
The email address is not a valid Internet email

address.
The SMTP Gateway has no way of handling the
message and it is rejecting it.
1296
Problem Description
Solution
To resend the rejected emails, Outlook Express to
open and manually correct the issue with each email
message. Once the messages are corrected, use Outlook
Express to resend the messages. To get notification of
the email failures, create a process that has the Rejected
email as its input and Send to mail Recipient as the
route component. Configure this process to send the
administrator an email once a .eml file appears in this
directory. There is no automated method of resending
these files, as there are many causes to this type of
failure.
Note: External in this context means the SMTP
Gateway that appears on the list of the server
MFP.
Files are appearing in the HOME DIRECTORY\OUT

QUEUE.
The SMTPCapture Component is attempting to contact

outgoing SMTP Gateways (the server list appears as
part of the component configuration) and none of the
SMTP Gateways are up and running. The OUT QUEUE
directory is the retry directory for the server. As long
as the server has not been able to properly contact and
send email out, it will keep retrying until all email are
out.
Having problems using the subject such as John[11-45].
Any character in John[11-45] will be matched. However,

not as in the range of numbers from 11-45. The matched
set is 1, 1-4**, and 5. As a result, when you attempt
to match John9, it will fail. It will successfully match
John10 as $ was not denoted at the end of the string, it
matches anything following John1, such as John10. **
1-4 matches any number in the range of 1 to 4 (1, 2, 3,
4).
The subject field is space sensitive, but case insensitive.

If an email comes through that does not have a subject specified on the subject list, it will always be categorized as
"Default Subject".
The Default Subject is not removable.
The file size of the documents that can be processed by the SMTP Capture component is limited to 25 MB.
You can select to either Process Email, Route to SMTP Gateway or both under the Subject Configurations, but
you must have at least one of those options selected.
TRIM Captura (4.x)

Welcome to TRIM Captura (4.x)
TRIM Captura is a Route component that is used to store documents into a document management system, where
records can be searched for, identified, and a system of active and inactive records can be used.
TRIM is a unique tool for Records Management, because it is both "object-oriented", and it can be configured to your
requirements through the use of "record types" which may be hierarchically arranged. To say that TRIM is "objectoriented" means that the "objects" or items within the database e.g. files and folios, are the focus of attention and not
1297
the processes performed on them. Therefore, if a task were to be performed on a record, it's just a matter of choosing
which record and then what task (move it, delete it, etc).
The hierarchy model allows TRIM to reflect a real-world environment. The ability of TRIM to contain records within
other records means that performing a task against a file (for example, a movement) can also apply to the contained
correspondence.
Getting started
Feature highlights
Find, update, or create a record. When finding a record, you have the option of creating a new version and to
check in the record.
Change the values of the fields associated with the record, and you can also use the rename schema, for multiple
files with the same name.
Access the records in a secure manner by way of providing a username and password.
Using the Trim Captura component

If you want to protect valuable corporate information, ensure that an organization complies with reporting
requirements, and enable the organization to easily access data, you would want to use TRIM. To batch store records,
you can create a process using Poll Directory as capture component, and place the records in your input folder of the
Poll Directory and use TRIM Captura as your store.
To create a new version of an existing record, simply setup your process with the appropriate Capture component and
TRIM Captura Route component. Set up the TRIM Captura attributes, select the Find Record checkbox, and enter the
value of the record that you want to make a new version of. You have the option of entering a comment regarding the
change. If this is a new record, click on the New Version checkbox. Now, instead of replacing the document, a new
version of the document will be created.
Do not use the Find option if you want to create a brand new record. With the Find option, you can create new
versions of existing records and not a new record.
Configuring the TRIM Captura component
General tab
On this tab, enter the general attributes of a record.
Option
Description
User Name
Enter the user name for the TRIM database.
Password
Enter the login password for the TRIM database.
Database
Enter the database name.
Find Record
If you want to find an existing record, select this box. To

create a new one, do not select this box. Depending on
which you choose, you have to fill out the appropriate
information.
Comments
Enter a comment to the document.
New Version
Select this check box for the document to replace the

latest version of the document currently attached to
the record. This parameter is ignored if there is no
electronic document already associated with the record.
1298
Option
Description
Checkin
The user can choose whether or not they want to check

in the file. If they decide to check in the file, others can
access the file and make changes in TRIM context. This
allows for only one copy of the file to be updated at any
one time by putting a lock on the file.
When a document has been checked out, TRIM takes a
copy of the document and places in a file directory or
sends it to a program called TopDrawer. The document
then can be accessed and edited as required. When the
document is returned or checked back into TRIM, it will
be checked back in under the same TRIM record number.
Record Type
Select from all electronic record types, by clicking the

browse button (...).
Title
The title of the document, which can later be used for

searching. This field cannot be left blank.
Container
Select from the containers, by clicking the browse

button. A container allows you to place a record inside
another (for example, a document inside a file).
Enclose
Select this check box to make the current location for a

record the container record that you selected. Later on,
this allows for easier searching in the database.
Security Level
Distinguish records by a successive classification. For

example, records that are classified TOP SECRET
are higher in restriction than those classified as
UNCLASSIFIED. Security Levels ensure that records
may only be accessed by Units, Staff Positions and Staff
Members who have the same security level or a higher
security level than that allocated to a record.
Priority
Enter the priority of the document.
External Reference
Set the external reference of the document.
Barcode
Use this field to set the barcode of the document.
Field Values tab

Manage field name and values in this tab.
Option
Add
Description
You can add field name entries and field values to a
record that is being stored in TRIM Captura. You can
add field names from a list of names already in TRIM
database.
Click on the Add button and the Field Values dialog
box appears. Select the field name from the drop-down
list of available field names that are already defined in
1299
Option
Description
TRIM database. Enter the corresponding value for the
field name.
For example, if you want to change the title of the
document, you can change it by selecting the Add button
and under the Field Values dialog box, you can select
the Title of the document, and place a new value for it.
Modify
Click on this button to modify field values of a record

that is being stored in TRIM Captura.
Remove
Use this option to remove Field Name entry.
Rename File Schema
If you check this check box, you can enter the new file
schema name that is being processed in to the TRIM
Captura component.
For example, if a file is named test.txt, for
Rename File Schema, you can enter the string
example_%n.%e. When the component is running
and the file test.txt comes in for processing by
TRIM Captura, the component renames the file to
example_test.txt, where %n is replaced by the
file name (test) and the %e is replaced by the file
extension (txt).
You can add a counter suffix (%c), to add an incremental
counter to a file name that has already been used. For
example, if the original file name is test.txt, then
the rename schema renames files to test1.txt,
test2.txt, test3.txt for reoccurrences of
test.txt.
Replace invalid characters with
If the file name has invalid characters, this feature

specifies a valid character to replace each invalid
character.
For example, if "/" occurs when processing files with
the Barcode, you can choose to replace the character
with the valid character "_".
TRIM Captura component RRTs

For example, when POP3Email is the capture (source) component, the "Record Type" parameter can be set to
~POP::Subject~ to dynamically set the record type using the subject field of the email.
Problem Description
The field value list does not have anything for me to
select from.
Solution
This may occur for any of the following reasons:
There are no field values to be set (unusual).

The component cannot connect to the database
because of an invalid database name or credentials.
TRIM Captura is not installed.
1300
The container record must have a greater level record type than the current record. If it is a lesser level record
type, then an error message is displayed when the application is run as a service.
To create a brand new record, do not select the Find Record check box on the General tab.
The Title option on the General tab is a required field.
The External Reference, Priority, and Security Level options on the General tab are optional fields.
TRIM Context
Welcome to the TRIM Context Component
The purpose of this component is to process documents into a TRIM Context document management system, where
records can be searched for, identified, and a system of active and inactive records can be used.
The Trim Context Route and Process components are identical except the TRIM Context Route component solely
stores the files and doesn't pass the files on as it is the last component in the process. The TRIM Context process
component passes the files onto the next component in the process.
TRIM Context is based on the Microsoft Distributed Component Object Model (DCOM). It also uses a multi-tier
network architecture model, which adds additional options to distribute processing activity, reduce network traffic,
and reduce the activity on the database server. It generally improves application performance.
The TRIM Context needs to be installed on the server in order for files to be stored.
Getting started
Feature highlights
The major features of this component are:
Finds and updates a records.

Create new records.
Optionally create a new version of a record.
Add, modify, or remove fields and values associated with a record.
This component can be used with the Digital Sender and the Poll Directory to pick up files and store them into a
TRIM Context data base.
Any document or image file can be used as input to TRIM context component.
This component is not a blocking component.
Using the TRIM component

If you want to protect valuable corporate information, ensure that an organization complies with reporting
requirements, and enable the organization to easily deal with issues in the event that documents are subject to
litigation, you would want to use TRIM. Keeping the document safe within TRIM is what would be a best fit.
You can create a process with Poll Directory as the Capture component , and archive documents into TRIM Context
using this route component.
Use scanners or Multi-functional Devices (MFD) to convert paper documents into images and store them into TRIM
Context for long term archival. You can use OneStep with your desktop ISIS or TWAIN compliant scanner to capture
data as well as images.
Configuring the TRIM component
General tab
Use the options in this tab to identify the database and its attributes.
1301
Option
Database
Description
Enter the name of the database that you would like to use
for saving all the files in.
If the database exists, you can select the name of the
database by clicking on the browse button.
If the database name does not show up at either of those
places, the database probably does not exist.
Find Record
To add a file into TRIM Context, you can either replace a

record or you can create a New Record.
Select Find Record to replace an existing file.
Record Number
Click on the browse button to select the desired record

number.
New Version
When you select the Find Record check box, you have
the option of specifying if you want to make a new
version of the record.
If you check this box, the electronic document will be
added as a new version of the document. As a result,
the new document replaces the latest version of the
document currently attached to the record, preserving the
existing version of the document.
Each record has a unique record identifier or URI, hence
if you decide not to replace the old version, both records
are saved under the same name, however, they will have
different URIs.
This parameter is ignored if there is no electronic
document already associated with the record.
New Record
Select this option to create a new record.
Record Type
To create a new record, simply specify the record type in

this field. Record types are either TRIM Context default
record types or user defined record types.
For example, a record type can be Document.
After selecting the record type, you can specify the
corresponding Container for the record.
Container
Enter the container name associated with the record.

When setting the container, you have to specify the
container URI (unique record identifier). This will set
the container of the current record to be the record with
a URI of the container you choose. Note that no two
objects can have the same URI.
The container record must be of a higher level record
type than the current record. When setting the container,
you must also specify whether or not you want to
Enclose the record.
1302
Option
Description
Enclose
Check this box if you want to enclose the record in the

container you defined.
Pass-through
This option is only available for the TRIM Context

When this option is selected, the document is passed to
the next component in the process.
Properties tab
Option
Description
Title
Enter the title for the document.
Security
Select the security level for the document.
Classification
Browse for a classification for the document.
Notes
Enter notes or comments for the record.
Author
Choose the author of the record.
Keywords
Choose keywords to be associated to the document.

Separate keywords with commas.
Finalize
Select this check box to make the current version the

final version of a record. This implies that no more
changes can be made to the record.
Field Values tab

Use this tab options to add, modify and remove fields to the record.
Option
Add field values
Description
You can add field name entries and field values to a
record that is being stored in TRIM Context. You can
add field names from a list of names already in TRIM
database.
Click the Add button, and in the Field Values dialog
box, select the field name in the drop-down list of
available field names that are already defined in TRIM
database. Enter the corresponding value for the field
name.
For example, if you want to change the title of the
document, you can change it by selecting the Add button
and under the Field Values dialog box, you can select
the Title of the document, and enter a new value for it.
1303
Option
Description
Modify field values
Click on this button to modify field name entries and

field values of a record that is being stored in TRIM
context.
Remove field values
Click on this button to remove fields from the record,

then click Remove.
TRIM component RRTs

Component RRT ID
The RRT ID for this component is TRM.
Name
Description
URI
Location in the database table for a record..Each record

in TRIM Context is held in the database in its own
unique position in the appropriate database table. The
URI (Unique Record Identifier) is the location in the
database table for each of these records. Note that no two
objects can have the same URI.
RECORD
The record number of the document just stored into

TRIM Context.
The RRT string ~TRM::URI~ returns the value of the URI. The Unique Row Identifier (URI) of a record is an
internal unique number that is transparent to the everyday user of TRIM. It is the primary key on the TSRECORD
table in the database and provides an internal unique identifier for every record. This value can be used by anyone
who wants to develop another application for TRIM and wants to reference a record that already exists in TRIM,
using the TRIM SDK.
For RRT string ~TRM::RECORD~ returns the record number. Every record in TRIM has a unique record number,
which follows a pattern defined by the record type and can be manually entered by the user or set to be automatically
generated by TRIM. Although the commonly used term is number, it is more correctly an identifier, as it is a string
that may contain alphanumeric characters. Unlike the URI of a record, the value of the record number is visible to the
everyday user of TRIM.
This component does not support any SSRTNs.
1304
Problem
Solution
Field value list does not have items to select from.
Either there are no field values to be set (unlikely) or it

cannot connect to the database because it is an invalid
database name or TRIM is not installed.
An error message is displayed when running the

application as a service.
The container record must be of a higher level record

type than the current record.
The container record must be of a higher level record type than the current record. If it is not, an error message is
displayed when running the application as a service.
The URI (Unique Record Identifier), uniquely identifies objects of a given type and is assigned internally and is
transparent to TRIM Context users. Users cannot manipulate the URI setting.
VB/J Script
Welcome to the VB/J Script component
Use this component as Process (Filter) or Route (Destination) with the most common scripting languages to
manipulate and create your own custom built capture application. You can now create your own custom capture
component by simply writing your scripts for accessing external databases, manipulating internal files, or validating
index data fields. Access external data sources, lookup information that adds value to your capture process and merge
the necessary external data elements.
Scripts allow the user to do various activities, and provide a greater flexibility to the user. Create custom built capture
components in fraction of a time and customize your capture processes according to your needs As files come in, you
can run a designated script to alter the files, do various tasks such as saving them somewhere on the machine, or many
other desired tasks.
This component supports VBScript and JScript scripting languages.
Getting started
Feature highlights
This component allows you to choose the desired scripting language. The two available language options are:
JScript
VBScript
This component can be used as a Process or Route component, and it can be used in any process.
Any file type can be processed by this component.
Using the VB/J Script component
Access external database files from within your capture task and validate captured data elements against your internal
databases.
Manipulate and reformat the file in mid-stream to match your custom needs.
Apply other application wrappers on files to provide yourself with custom control over the document format, security
and presentation.
Add, delete, or modify field index data values to the process data space, reduce manual data entry and increase your
data throughput
1305
Use this component when a specific file type file is received and there is a need to inform certain people. You can run
a script which sends an email every time that particular file type is received. This provides a lot of flexibility to the
users.
If this component is used as Router, the script you choose should provide the Route functionality.
Configuring the VB/J Script component
The VB/J Script component is configured on tabs in the VB/J Script Configuration dialog box.
General Tab
Fields Tab
General tab
On this tab, enter the general script attributes.
Option
Description
Activate
Select this check box to activate the component in a

workflow.
Name
Enter the name of the function that you want to run.

For the examples (see Sample Scripts), you may have
many different _OnLoad functions in your script. You
have to specify which one you want to use. If you
specified Test as the value of your Name field, then
the Test_OnLoad function will run.
Language
Select the desired option from the drop down box to

specify the type of script. You can specify either of the
following:
Script
VBScript
JScript
Click the browse button (...) to locate the Script that you
want to run. The script must be available on the same
directory location at runtime.
Fields tab
On this tab, enter the field names and values that you want to use in the script.
Option
Description
Add
Add a new field to be used within a script. The field

name will be the variable name used within a script and
the field value will be the value of the variable within the
script.
Modify
Click on Remove button to remove the field.
Remove
Click on Modify button to modify the field value.
VB/J Script component RRTs

For example, when POP3Email is the capture (source) component, the "Script Name" parameter can be set to
~POP::Subject~ to dynamically run a script based on the subject of the email.
1306
Problem Description
Solution
Clicking OK does not close the dialog box.
You have either failed to enter a Name, select a

Language, or specify a Script in the VB/JScript
Configuration dialog box.
VBScript/JScript error.
Make sure the file that you selected as your script is a

valid file, with a valid file extension.
You have to specify the Name, Language and Script.

The script you specify has to be a valid script.
Standard JScript and VBScript limitations exist when it comes to variable naming conventions.
Field name cannot start with a number. If it does start with a number, the number will be removed from the field
name.
Field name cannot start with the underscore character (_), although it may contain any number of underscores
within the variable name.
All spaces in a field name will be replaced with the underscore character (_).
All double and single quotes will be removed.
All other invalid characters for field names will also be removed (such as %, $, or ).
Sample scripts
JScript
Create a new process and configure the Name to be SampleRun and the Language JScript.
Create a new text file and add the following code:
function SampleRun::OnLoad(eventObj)
{
EKOManager.StatusMessage(m_Field1);
}
Add a new field with Name "m_Field1" and the Value "This is the value for m_Field1".
When you run the script, the Status monitor will display "This is the value for m_Field1".
VBScript
Create a new process and configure the Name to be SampleRun and the Language VBScript.
Create a new text file and add the following code:
sub SampleRun_OnLoad
On Error Resume Next
EKOManager.StatusMessage(m_Field1);
end sub
sub SampleRun_OnUnload
end sub
Add a new field with Name "m_Field1" and Value "This is the value for m_Field1". When you run the script, the
Status Monitor will display "This is the value for m_Field1".
1307
Figure 27: General settings
Figure 28: Fields settings
1308
VIP
Welcome to the Virtual Image Processing component
Virtual Image Processing component (VIP) is a process component used for image processing intended to improve
the quality of subsequent image recognition by the subsequent OCR components. VIP provides a set of the following
image filters for this purpose:
Adaptive thresholding
Color dropping
Color extraction
Color resolution
Deskew
Despeckle
Dilation
Dot Remove
Flip
Invert
Inverted text
Line Remove
Resize
Reverse
Rotate
Sharpen
Stretch Intensity
Thresholding
This component allows creation of multiple filter profiles, which can be saved for use with an existing or newly
created AutoStore processes.
Within a filter profile you can apply several filters for image processing. The same filter with different settings can be
included several times inside one profile if necessary.
Note: It is advised to keep the number of filters reasonably small since image-processing tasks are very
processor and memory intensive.
Thirteen of eighteen filters have configuration settings allowing adjusting output image quality with the use of
image preview window within filter configuration dialogs. The preview image can be zoomed in and out, as well as
moved within the preview pane in order to display any part of the preview image, in case the image is bigger than the
preview window. You can also set the order in which filters will be applied to images. At configuration stage, every
filter configuration dialog of a particular profile displays the result of all preceding filters' application in the preview
image window.
The component uses LeadTools technologies for image processing.
Getting started
Feature highlights
Many business processes dealing with image documents face the challenge of insufficient scanned document
image quality for automated OCR. Virtual Image Processing component helps to optimize image quality for better
recognition results using LeadTools technologies.
Documents with irregular color or patterned background have lower OCR success rates than ones with plain
background. Adaptive thresholding, Color dropping, Color extraction and Thresholding filters and their combinations
allow significant improvement of such images increasing their recognition rate.
1309
Correct image alignment sometimes is a key feature to recognition success and is not always respected in scanned
documents. This problem is solved using Deskew filter of VIP.
Color resolution filter increases/decreases bits per pixel, provides dither method, palette and color order parameters.
One of the most serious problems decreasing the quality of document OCR output is speckles (visual garbage) on
original documents, especially faxes. Despeckle filter of VIP allows reducing the number of visual document flaws
impeding the recognition process.
Dilation filter enlarges black objects in the image (omnidirectional, horizontal, vertical, diagonal dilation). This
function is useful for making text easier to recognize, especially, when it is affected by copying or faxing.
Dot Remove filter removes dots of the specified size on 1 bit b/w document scans.
Flip filter flips the image.
Invert filter inverts all image colors.
Inverted Text filter inverts text inside black box and removes the box itself. It helps in extracting text, for example,
from the table headers.
Line Remove filter removes horizontal or vertical lines on the scanned 1bit black and white document images. If line
passes through text, the filter can be configured to remove the text or keep it. This feature is useful to improve the text
recognition quality; for example, on the forms where text is printed over table borders or lines.
Resize filter allows changing output image size.
Reverse filter reverses the image (left to right) to produce a mirror image.
Rotate filter rotates the image to a fixed angle (90, 180, 270). This feature helps, when? for example, there is a batch
of images resulting from documents incorrectly fed to a scanner.
Sharpen filter increases or decreases sharpness of the image.
Stretch intensity filter increases the image contrast by centering, maximizing, and proportioning the range of intensity
values.
How to use Virtual Image Processing
The following example illustrates using of this component: Improving scanned image quality, recognition and sending
in to the predefined destination
1. Configure a workflow with an MFP component corresponding to the selected type of MFP device, Virtual Image
Processing component, OCR component and a necessary route component.
2. In a Virtual Image Processing configuration select Desckew and Despeckle filters to be applied to the images.
3. Configure other components in the workflow and start the server.
scanned documents are desckewed and despeckled, recognized by OCR and the documents in searchable format
are ultimately sent to the desired destination.
Configuring the Virtual Image Processing component
Virtual Image Processing component configuration comprises:
Selection of the way initial images will be processed (modification of original image or its copy).
Activation/inactivation of a filter profile.
Creation and editing of a filter profile.
Configuration of filters for the profile:
Setting filters' application sequence.

Setting parameters for particular filters in the profile.
1310
Main dialog box

VIP configuration dialog box provides the following options.
Option
Description
Activate filter

this box is not checked, the component won't perform
any actions during files processing.
Reject job on failure
Select this check-box to reject a job when the component

input file. If this check-box is not selected the component
File options
This group of options allows you to specify the way of

processing initial files.
Modify original image
If this option is selected, original image will be modified.
Copy and modify
If this option is selected, initial image is copied to the

working directory; the copy is modified by VIP filter.
This configuration keeps both files (original image and
modified copy) for further processing by the workflow.
Delete original image
This check box is enabled only if the Copy and modify

option is selected. If you select the combination Copy
and modify & Delete original image, initial image is
copied to working directory; the copy is modified by VIP
filter profile; and the original image is deleted from the
source directory.
Profile
Select or create a new profile. Profile is an XML

file containing a combination of filters used by the
component and the output format settings.
Active profile
Select an existing profile. This will bring up standard

Windows browse dialog box. The path to the selected
filter profile will be displayed in the text box. You can
New profile
Click this button to create a new profile. The component

will ask to save the new profile as an XML file. After
saving the file, the component will open the Edit Profile
dialog box to configure the profile.
Edit profile
Click this button to open the Edit Profile dialog box.
Edit Profile dialog box

This dialog box allows configuring of a profile; that is, the set of filters for image processing and the order of their
application as well as setting of the output format.
Note: The profile settings are stored in an XML file.
Option
Description
Profile
This text box shows the path to the profile file.
Optimization filters
This window displays filters currently included in the

profile. The selected filters marked with a check mark
are active.
1311
Option
Description
Add
Click this button to add a new filter. This button opens

the Filters dialog, which contains a list of all filters
available in Virtual Image Processing component.
Configure
Select a checked filter in the list and click this button to

bring up a configuration dialog for the selected filter.
This button is enabled only if the selected filter has
additional settings. Deskew, Despeckle, Stretch intensity,
Flip, Reverse, and Invert filters do not have any settings.
Remove
Select a filter in the list and click this button to remove

the selected filter from the list.
Note: Removal of a filter from the list is
irreversible.
Move up/Move down
By clicking these buttons, you can set the order of the

filters. The filter displayed on top of the list will be
applied first.
Output format
This group allows you to select the output format for

processed images.
Convert to
Select this check box to change the format of the output

image. By default, the output image has the same format
as the input one. Click
to open the Output format
dialog box to configure the settings for the output
files. See the list of supported output formats in the
Restrictions and Limitations chapter.
Advanced
This button opens the Advanced Settings dialog

box, which allows you to set up additional options for
opening documents that contain vector information.
Preview
This group of settings allows you to preview the result of

applying filters.
Browse
Select the image on which you want to test the filters.

The selected image will be displayed in the Original
image window and in the Preview window.
Preview
Click this button to display the result of modification in

the Preview window.
You can capture and move the images to view their
different parts within Original image and Preview
windows by placing mouse cursor over the images and
moving it while holding left mouse button.
buttons above the image windows are used to

zoom the image in and out.
buttons are used to display the image in
its original size and to shrink the image to fit the
preview window.
1312
Option
Description
buttons are used to browse between

document pages in two directions if you are
previewing a multi-page file.
Auto preview
If this check box is selected, the component

automatically displays the result of applying selected
filters in the Preview window.
Quick view
If you are performing filter profile configuration on a

large image file, it is advised to select this check box to
speed up image processing calculation. In this case, not
the whole image is processed but only real image pixels
currently visible in the preview window.
Save
Click this button to save modifications to the profile file.
Save as
Click this button to save the settings in a new XML file.

This dialog box allows setting options for opening documents that contain vector information.
The component works with such documents as with raster images and allows you to specify the parameters of
rasterization while opening the document. This dialog box consists of three tabs:
Tab
Description
PDF Tab
Use this tab to configure parameters for opening PDF, PS

and EPS documents.
XPS Tab
Use this tab to configure parameters for opening XPS

documents.
Vector Tab
Use this tab to configure parameters for opening PCL,

HPGL, DXF, DWG, DWF documents.
PDF tab
Use this tab to configure parameters for opening PDF, PS and EPS documents.
This tab defines color and resolution settings for the images produced out of PDF, PS or EPS files. Since these are
vector formats, the component rasterizes the input image when displaying the preview or converting it into a raster
image. The following options are available:
Option
Description
Input PDF files resolution

Use the same horizontal and vertical
Select this check box to use the same value for both
horizontal and vertical resolutions.
Horizontal resolution (DPI)
This combo box allows you to set up horizontal

resolution in DPI. You can enter the value manually.
Vertical resolution (DPI)
This combo box allows you to set up vertical resolution

in DPI. You can enter the value manually.
Input PDF files color

Color depth (BPP)
Set up color depth. For example, 24 BPP (bits per pixel)

denotes true color images, 1 BPP denotes black-andwhite images. The default value is 24 BPP.
1313
Option
Description
Text anti-aliasing (bits)
Enter the level of text anti-aliasing: 1 (means no antialiasing), 2, or 4 (gives maximum anti-aliasing). The
default value is 4 bit.
Graphic anti-aliasing (bits)
Enter the level of graphics anti-aliasing: 1 (means no

anti-aliasing), 2, or 4 (gives maximum anti-aliasing). The
default value is 1 bit.
XPS tab
Use this tab to configure parameters for opening XPS documents.
To open an XPS document for preview or for conversion into a raster format image, the component performs
rasterization of the input document. This tab specifies vertical and horizontal resolution for the rasterized image.
Option
Description
Select this check box to use the same horizontal and

vertical resolution.
Set horizontal resolution for opening image. The default

value is 150 dpi.
Set vertical resolution for opening image. The default

value is 150 dpi.
Vector tab
Use this tab to configure parameters for opening PCL, HPGL, DXF, DWG, DWF documents.
The component rasterizes vector images and subsequent operations are performed on the raster images.
Option
Description
Select this check box to use the same horizontal and

vertical resolution.
Set horizontal resolution. The default value is 150 dpi.
Set vertical resolution. The default value is 150 dpi.
Pages Size
Set the page size of the output image. You can either
select a page size from the drop-down list or enter
page width and height in Width (in) and Height (in)
boxes correspondingly. If the image area does not fit
the specified size, the image will not be stretched. For
example, if you specify A4 page size (8.27x11.69 in)
and process a square image, the resulting image will be
8.27x8.27 in.
Note:
VIP does not support vector-specific
transformations and saving in vector formats.
If you plan to process vector images via VIP,
you have to configure conversion to one of
supported raster formats.
Some vector formats such as DWF, DWG can
contain definitions of 3D objects. VIP does not
perform any 3D transformation on the input
1314
Option
Description
images, so the resulting image will contain a
projection of 3D model to default plane.
LeadTools opens PCL files as black and white
images even if they are colored.
Filters Configuration dialog boxes

To configure a particular filter, select the filter in the Optimization filter window and click Configure next to the
window. Clicking this button will bring up a corresponding filter configuration dialog.
Note: Deskew, Despeckle, Stretch intensity, Flip, Reverse and Invert filters do not have any configuration
settings.
Adaptive Thresholding
This filter converts the image to a black-and-white one.
The component selects a square area around every pixel and calculates the threshold value for this area based on the
specified value and overall brightness of the area. If the brightness of the pixel is less than the calculated value, then
the pixel is replaced with a white one, if the brightness value is greater with a black one. In addition, if the contrast
in brightness in the area, that is the difference between maximum and minimum value of brightness, is less than the
specified value, the pixel is replaced with a black one (the algorithm is known as Bernsen Thresholding).
Option
Value of square size
Description
Set the size of the area for around each pixel to calculate
the brightness threshold for the pixel.
Note: When configuring Adaptive
thresholding filter, set Value of square size
comparable to document character thickness.
Value of contrast
Specify the maximum value of contrast in brightness

within the area around a pixel, that is, the difference
between maximum and minimum values of brightness. If
the contrast is less than the specified value, the pixel will
be replaced with a white one; otherwise, the brightness
of the pixel will be compared to the arithmetical means
of max and min values of brightness.
Value of threshold
Set threshold value within the range of 0% to 100%. All

pixels whose brightness is less than the threshold value
will be replaced by black pixels.
Preview windows controls

Option
Description
Auto preview
If this check box is selected, preview image will be

recalculated every time you make a change in the dialog
settings. If this box is unchecked, all changes you made
will be calculated after you click the Preview button.
Quick view
If you are performing filter configuration on a large

image file it is advised to check this box to speed up
image processing calculation. The program will choose
the optimal processing algorithm.
1315
Color Dropping filter

The filter replaces the colors from a specified range with another color.
The range is specified as a deviation in hue, luminosity and saturation from a selected color measured as a percentage
of full scale. The color to be substituted and the substitution color can be selected using the eyedropper tool
or
specified through the standard color selection dialog. The colors that do not enter the color range will not be affected
by the filter.
Option
Drop color
Description
This button opens the color pickier to choose the
color to be substitute. Specify the range by selecting
hue, luminosity and saturation in the right half of the
configuration window. The area above the Drop color
button displays the selected range of colors.

Option
Description
Auto preview

Quick view

Color Extraction filter

This filter retains the colors with hue, luminosity and saturation close to specified ones, while all other colors are
replaced with the user selected color.
Configuration of this filter is similar to Color Dropping filter configuration.
You can use the eyedropper tool for selecting desired color right from the preview window.
Option
Description
Auto preview

Quick view

Color Resolution filter

This filter allows the user to change the color resolution (also called color depth) of the image.
The component applies dithering methods to create the appearance of more subtle shape by mixing in pixels of
different colors.
1316
Deskew filter
This filter deskews the image.
This filter does not require a dialog box for its configuration, since it does not provide any configurable settings.
Note: This filter is intended for deskewing images that contain enough text to detect the skew. Applying this
filter to straight oriented images without or with little text may produce skewing effect.
Despeckle filter
The filter removes speckles from the image.
Dilation filter
The filter allows enlarging black objects in the image.
You can select the omnidirectional, horizontal, vertical or diagonal way of dilation.
Option
Description
Auto preview

Quick view

Dot Remove filter

The filter finds and removes dots of the specified size from black and white images.
You can set minimum and maximum dot width and height in the respective input boxes.
Option
Description
Auto preview

Quick view

Flip filter
The filter flips the image.
Invert filter
The filter inverts the colors of the image.
1317
Inverted Text filter

The filter inverts white text inside a black box so that it turns into black text on white background.
The dialog box allows adjusting the text box dimensions and the percentage of black pixels in the box for the box to
be inverted.
An example of the filter usage:

Option
Description
Auto preview

Quick view

Line Remove filter

The filter removes horizontal or vertical lines from the 1-bit image.
This filter might be very useful for OCR optimization of printer filled forms with misplaced text.
You can also instruct the component what kind of lines to remove. Set minimum line length, maximum line width,
and wall height in pixels using the input fields. Walls are slices of a line that are too wide to be considered a part of
the line.
Option
Description
Auto preview

Quick view

Resize filter
The filter allows changing output image size.
You can select the desired resizing method and resolution value.
There are three resize methods available:
normal
resample
bicubic
1318
Reverse filter
The filter reverses the image (left to right) to produce a mirror image.
Rotate filter
This filter rotates the image by a fixed angle (90, 180, and 270).
You can select the desired value from the Angle drop down list to rotate the image.
Sharpen filter
The filter increases or decreases sharpness of the image.
You can set sharpness value by moving the Sharpen slider or typing desired percent value in the input box to the left
of the scale.
Option
Description
Auto preview

Quick view

Stretch intensity filter

This filter increases the image contrast by centering, maximizing, and proportioning the range of intensity values.
The filter does not require a dialog box for its configuration, since it does not provide any configurable settings.
Thresholding filter
The filter converts the image to a black-and-white one.
All pixels with the brightness less than the specified level (threshold) become white, the others become black.
Option
Threshold
Description
Set threshold value within the range 0% to 100%.
Output Format dialog box

This dialog box allows configuring settings for saving the output file.
Option
Save as type
Description
Select the format of the output file. See the list of
supported output formats in the Restrictions and
Limitations section.
Note: Not all formats have a multipage support.
If the component receives a multipage document
and converts it to another format that does
not have a multipage support, the component
will generate a separate output document
for each page of the input document. These
documents will have the same name as the
input document with an index; for example,
inputdocname_1.jpg, inputdocname_2.jpg.
1319
Option
Description
BPP
Select color depth of the output image, in bpp.
Subfile type
Select a subfile type from the drop down list. This setting
is enabled only for some formats.
QFactor
Specify value of an option to determine the degree of

loss in the compression process. This setting is enabled
only for some formats. Commonly, the QFactor is a
numeric value that varies in the range 2255, however
there are some exceptions to this rule and some special
predefined values for some formats. If the format has
such predefined values of QFactor, you can select one
of them using the combo-box. If QFactor takes only
numeric values from given range, its value can be set
using the text box. The below table lists the non-standard
QFactor values for different formats:
Progressive options
JPEG 16 BPP: 0 only

LEAD CMP:
2255
(-1) Perfect quality 1
(-2) Perfect quality 2
(-3) Quality far more important than size
(-4) Quality more important than size
(-5) Quality and size equally important
(-6) Size more important that quality (sharp)
(-7) Size more important than quality (less tiling)
(-8) Maximum compression keeping quality
(-9) Maximum compression
PNG: 09
ABC, TIFF with ABC compression:
(0) Lossless compression

(1) Virtual Lossless compression
(2) Remove Border compression
(3) Enhance compression
(4) Modified1 compression
(5) Modified1 fast compression
(10) Lossless fast compression
(11) Lossy fast compression
ECW: 1100
Using this option, you can save multiple representations

of image at different resolutions without any extra
storage overhead. The image will be saved in the lowresolution in the first pass; subsequent passes will
improve the resolution. Specify the number of passes
1320
Option
Description
that are required to complete the image. This setting is
enabled only for some formats.
Progressive order
Select the order of progression from the drop-down list.

This setting is enabled only for some formats.
Compression
Select the method that should be used for determining

the compression. This setting is enabled only for some
formats. The compression method may be one of the
following:
J2K options
LosslessCompress the file without loss.

Compression RatioCompress the file based on the
value entered in the Comp. ratio text box.
Target File SizeCompress the file based on the
value entered in the Target size field.
Quality FactorCompress the file based on the
quality factor specified in the QFactor combo box or
text box.
This button becomes enabled when you save the image

in the JPEG 2000 format. Click this button to configure
the JPEG 2000 file options in the Advanced JPEG 2000
Options dialog box.
Advanced JPEG 2000 Options dialog box

This dialog box allows you to determine the settings for saving JPEG 2000 files.
Option
Description
Offset
This group allows setting the offset of the image from

the origin of the reference grid.
Horizontal
Enter horizontal offset from the origin of the reference

grid to the left side of the image area.
Vertical
Enter vertical offset from the origin of the reference grid

to the top of the image area.
Tile Size
This group allows setting the size of a reference tile.
Width
enter width of one reference tile, with respect to the

reference grid. The default value is 1000000.
Height
Enter height of one reference tile, with respect to the

reference grid. The default value is 1000000.
Tile Offset
This group allows setting the offset of the first tile from
the origin of the reference grid
Horizontal
Enter horizontal offset from the origin of the reference

grid to the left side of the first tile.
Vertical
Enter vertical offset from the origin of the reference grid

to the top of the first tile.
General Settings
This group allows configuring the general image

encoding settings.
1321
Option
Description
Use Color Transform
Select this check box to convert an RGB image to YUV

space before compressing. (YUV space provides greater
compression with higher image quality.)
Use Derived Quantization
Select this check box to use derived quantization or

expounded quantization.
Decompress Level
Enter number of resolution levels in the compressed file.

The maximum number of levels depends on the size of
the image. Passing values that are too large will cause the
save operation to fail. Each resolution level is one-half
the size of the previous resolution, starting with the full
image resolution. The default value is 5.
Guard Bits
Enter the number of extra bits to consider when encoding

an image. This prevents coding overflow. Possible values
are 07. The default is 2.
Markers
This group allows indicating which markers should be

used.
Use SOP Marker
Select this check box to use the SOP marker.
Use EPH Marker
Select this check box to use the EPH marker.
Code Block
This group allows you to set the size and options for
code blocks.
Width
Enter width of the code block, following wavelet

transformation. The value must be a power of 2. It must
be at least 4 and less than or equal to 1024. The default
value is 64.
Height
Enter height of the code block, following wavelet

transformation. The value must be a power of 2. It must
be at least 4 and less than or equal to 1024. The default
value is 64.
Code Block Options
You may select one or several options from the following

list:
Selective AC bypass
Reset Context On Boundaries
Termination On Each Pass
Vertically Causal Context
Predictable Termination
Error Resiliences Symbol
Derived Base
This group allows setting a base for derived quantization.
Mantissa
Enter the base mantissa used for derived quantization.
Exponent
Enter the base exponent used for derived quantization.
Alpha Channel
This group allows setting alpha channel information to

indicate level of transparency.
Lossless
Select this check box to set alpha channel information

without loss of transparency.
1322
Option
Description
Active bits
Select the number of active bits in alpha channel from

the drop-down list.
ROI Options
This group allows setting the region of interest (ROI) for

the image. When a region of interest is set, the functions
modifying pixel values act on the region, rather than the
whole image.
Use ROI
Select this check box if you are going to use a region of

interest.
Control
Indicate which region of interest to use. You can select

Default options
RegionUse the LEAD bitmap region to define the

region of interest. In this case you should indicate a
region weight in the Weight text box.
RectangleUse the rectangle with the coordinates
specified in the Left, Top, Right, and Bottom boxes.
Click this button to set the default values for all settings.
Virtual Image Processing component RRTs

Virtual Image Processing component supports the following file formats:

Format
Subformats
Multipage
support
Reading
Writing
ABCABC
Format
AFPAFP/
PTOCA Format
BMPWin Bitmap 1, 4, 8, 16, 24, 32

Formats
BPP
BMPOS2 Bitmap 4, 8, 24 BPP; 1 BPP:

Format
OS/2 BMP version
1.x; 1 BPP: OS/2
BMP version 2.x
CLPMicrosoft
Windows Clipboard
8, 24 BPP
CMPLEAD
Compressed
8, 24 BPP
CUTDr Halo
8 BPP
DWFDesign
Web Format
DWG
1323
Format
Subformats
Multipage
support
Reading
Writing
DXFDrawing
Interchange Format
ECWEnhanced
Compressed Wavelet
EPSPSEncapsulated
PostScript
EXIFExif
Formats EXIF
EMFWindows
Metafile Format
8, 24 BPP
FLCFLC and
FLI-Flic Animation
8 BPP
FPXFlashpix
Format
8 BPP; 24 BPP:
+
FlashPix, with no
compression; 24
BPP: FlashPix,
compressed with the
single color method;
24 BPP: FlashPix,
compressed with
JPEG, using the
default Q factor;
24 BPP: FlashPix,
compressed with
JPEG, using a
specified Q factor
GIFCompuserve
Graphics
Interchange Format
HPGLHewlettPackard Graphics
Language
IFFInterchange
File Format
1, 2, 3, 4, 5, 6, 7, 8,
24 BPP Interchange
File-RLE
Compressed: 38,
24 BPPInterchange
File-multiple
images per file-RLE
Compressed: 38,
24 BPPInterchange
File-Uncompressed:
18, 24
BPPInterchange
File-multiple
images per file-
only CAT and CAT

RLE compressed
subformats
1324
Format
Subformats
Multipage
support
Reading
Writing
Uncompressed: 1
8, 24 BPP
JBGJBIG2
Format
JP2JPEG 2000
Compressed
JPGJPEG
Compressed
MRC
LEADTOOLS
Mixed Raster
Content
MRCMixed
Raster Content
NITF
National Imagery
Transmission Format
(version 2.1 only)
PBMPortable
Bitmap Utilities
Format
PCLPrinter
Command Language
Format
JBG-JBIG Format
1, 2, 3, 4, 5, 6, 7, 8,
12, 16, 24, 32 BPP
PCTMacintosh
Pict Format
1, 4, 8, 16, 24 BPP
PCX
PCExchange
Format
1, 4, 8, 24 BPP
PDFPortable
Document Format
1, 2, 4, 8, 24
BPP1 BPP: JBIG2
Compression 24
BPP: Lead MRC
Compression
PGMPortable
Bitmap Format
8 BPP
PNGPortable
Network Graphics
Format
PPMPortable
Bitmap Format
PSPostScript
24 BPP
1325
Format
PSDAdobe
PhotoShop Format
Subformats
1, 8, 24 BPP
PSPPaint Shop
Pro Format
Reading
Writing
RASSUN Raster
Format
4, 8, 24, 32 BPP
SCTScitex
Continuous Tone
24 BPP
SFFStructured
Fax File Format
SGISilicon
Graphics Image
Format
8, 24, 32 BPP
TGATruevision
TARGA Format
8, 16, 24, 32 BPP
TIFTagged
Image File Format
2, 3, 4, 5, 6, 7, 8,
+
16, 24, 32, 48 BPP;
1 BPP: JBIG2,
ABIC; 4 BPP:
ABIC; 12 BPP:
Uncompressed,
Packbits (RLE),
Lossless JPEG,
JPEG (Gray)
YCbCr, LZW,
JPEG 2000 Stream,
Wavelet CMP, JBIG;
16 BPP: JBIG; 24
BPP: CMP, LEAD
CMP, JBIG; 32 BPP:
JBIG
WMFWindows
Metafile Format
8, 24 BPP
WPG
1, 4, 8 BPP
WordPerfect Format
XPMXPicMap
8, 16, 24, 32 BPP
XPSXML Paper
Specification
Multipage
support
XWDX
WindowDump (10)
1, 4, 8 BPP
XWDX
WindowDump (11)
1, 8, 4, 16, 24, 32
BPP
This component cannot process PDF files of size greater than 2 GB. This is the restriction of the LeadTools
technologies used by this component. It is recommended to use compression when you process PDF documents.
1326
Since the LeadTools rasterizes PDF and other vector format files, the output file can be much bigger in size than
the input file.
VIP does not support vector-specific transformations and saving in vector formats. If you plan to process vector
images via VIP, you have to configure conversion to one of supported raster formats.
Some vector formats such as DWF, DWG can contain definitions of 3D objects. VIP does not perform any 3D
transformation of the input images, so the resulting image will contain a projection of 3D model to default plane.
LeadTools opens PCL files as black and white images even if they are colored.
LeadTools opens only the first page of multi-page PS/EPS file, and its not possible to process such files via VIP.
See: http://support.leadtools.com/SupportPortal/CS/forums/34924/ShowPost.aspx.
Not all formats have a multipage support. If the component receives a multipage document and converts it
to another format that does not support multipage documents, the component will generate a separate output
document for each page of the input document. These documents will have the same name as the input document
but with an index; for example, inputdocname_1.jpg, inputdocname_2.jpg.
Multipage PCT images are not supported. All pages of the multipage PCT image will be lost except for the last
one.
Problem description
Error in processing the images by VIP. One of the
following messages displayed:
"Cannot get File_path\file_name file info. Invalid file
format."
Solution
The input file format is not supported. Review files
that are included in your process and make appropriate
changes.
"Cannot load the image file J2K support is locked."

Poor image optimization results.
Check applied filter profile settings.
When processing PDF, PS or EPS documents, output

files have lower color resolution than input files (for
example, black-and-white or gray except true color)
PDF, PS and EPS files are opened with the color

resolution defined in the advanced settings for these
formats. If the specified color resolution is lower than in
the input files, then color resolution will be lower in the
output files as well. Adjust color resolution for input files
according to your needs.
Watermark
Welcome to the Watermark component
Document protection is one of the key areas of any document archival and management system. Using the Watermark
component, captured documents can be permanently watermarked with either images such as company logos or text
such as Confidential or Do Not Copy. Once watermarked, the security information travels with the document as a
permanent part of the document itself.
In cases such as litigation support, documents can be watermarked using important indexing information such as bate
numbers and other document/page specific information. Such watermark information can help maintain the index
information as part of the document itself. You can also use VB/Java Scripts to look up watermark text and create a
dynamic content-based watermark for your documents.
Powerful and easy to implement, the Watermark component is a plug-in that no content capture server should be
without.
Getting started
Feature highlights
This component provides several features:
1327
Permanent watermark using image files.

Permanent watermark using static or dynamic text.
Tile or stretch watermark on a portion of the image or the entire image.
These options are configured in the Watermark settings for the component.
You can also use RRT tags from other component to create dynamic watermark values that are linked to the images
and documents being processed. Dynamic watermarks provides a powerful method of customizing your watermarks
based on content.
Using the Watermark component
There are many applications of Watermarks within a business process. Use cases shown here provide a sample of
such applications:
Table 61: Examples of watermark applications
Use
Description
Confidentiality marks
Use Watermark to accurately reflect confidential status

of documents.
Status Marks
Use Watermark prior to printing to show the document

status (such as certified or non-certified).
Copyright
Use Watermark to properly reflect copyrights and

ownership of information.
Ownership marks
Prevent unauthorized representation of information by

watermarking documents you own.
Dynamic marks
Based on the capture content select an RRT for the

watermark value and create a dynamic watermark that
ties the document to the business process. Examples
of such use include watermarking documents with
user name, scanner ID, or other similar process based
variables.
Watermark licenses
There are 3 types of licenses for this product:
License
Description
Evaluation
30 day fully functional evaluation licenses are provided

upon the first installation of this component.
Licensed
Fully licensed component provide full functionality

(same as evaluation) indefinitely.
Expired
Failure to license this component beyond the evaluation

period will change the license to Expired and component
will not process any documents at that point.
Configuring the Watermark component

Watermark options
Identify the type and region for the watermark that is being applied.
1328
Option
Description
No watermark
Choose this option if you do not want watermarking

for a specific route. This option is used to activate or
inactivate this component within a process.
For example if you are using MFP device with
multiple configuration routes, you may enable/disable
watermarking for specific routes.
Image watermark
Choose this option if you would like to use an image

such as a company logo as the watermark.
After choosing this option, click the Select File button to
choose the image file.
Text watermark
Choose this option if you would like to use a text such as

"Confidential" or "Do Not Copy" as the watermark.
After choosing this option, enter the watermark text in
the text box. Click the Select Font button to configure
the font settings.
Fail job on error
Select this check box to reject a job when the component

input file. If this check box is not selected the component
Fill type
The watermark text or image can either be Stretched or

Tiled to fill the target document or a defined document
region.
Region
If a region is defined for the target document, the

watermark is applied to the region, not to the whole
document.
Unit type
Specifies the unit type as millimeters or hundredths of an

inch (inches/100) for the region.
Coordinates
You can specify the coordinates of where the watermark

is applied.
Click the browse button (...) to locate the image and open
the image file in the Region Rectangle image view.
In the image view, click and drag to define the region
coordinates for the watermark, then click OK.
Watermark component RRTs

For example, when POP3 eMail is the capture (source) component, the Text option in the Watermark component
settings can be set to ~POP::From~ to watermark the images received by the email alias specified by the From
field on an email.
Description
Cannot place a watermark image on a TIFF file.
Solution
Click the Paste option (which enables the Stretch option
by default) for the watermark to appear on the image.
1329
Description
Cannot apply a text watermark to a TIFF image.
Solution
Manipulate the font size to a bigger and smaller
size. And define the coordinates under the Regions
configuration section.

This component does not support color watermarks.
Only raster image files being processed and graphical watermarks are supported.
PDF is not a supported file type.
Web Capture
Welcome to the Web Capture component
Web Capture is a capture component whose purpose is to allow users to capture documents into the workflow process
via a web service. It provides web-based user interface that is accessible through the Internet.
The component allows for configuration of any number of forms and assigning a different workflow to each form.
Besides defining the metadata to fill out and workflow settings, forms provide security settings in order to restrict
access of different users/groups.
You can use dynamic form functionality to create Web forms that respond to events. Dynamic forms can add or
remove fields, change field content, and validate document content before it is sent to the server.
Web Capture provides further functionality that facilitates the organization of the workflow process with the Send to
Folder, SharePoint 2010/2007 or Send to Mail Recipient components.
Getting started
Feature highlights
The Web Capture component provides the following features:
Capturing documents through web interface using a web browser.

Providing information about the captured documents by adding fields to the forms. Supported field types are Tree,
List, Text, Checkbox, Numeric, Date and Lookup List.
Support for different authentication mechanisms to restrict the access to the forms.
Customizing the standard behavior of the forms by using custom VB.Net scripts.
Pre-defined forms that can be used in conjunction with the Send to Folder, Send to Mail Recipient and SharePoint
2007/2010 components.
Ability to create own client applications that will interact with the component via WCF Endpoint (provided that
you have the Custom Development license).
Web user interface

The documents are sent into the workflow by means of Web UI. When the administrator starts the service, the
component launches a web application that provides Web UI through which users can interact with the service,
namely send documents into the workflow. The default web page URL of the service is
http://<workflow server ip/hostname>:3290/ASWCCapture/default.aspx
After opening the web page, a user is asked to enter the credentials to be authenticated according to the authentication
method chosen by the administrator.
The next page contains the Menu/Form tree whose structure is exactly the same as that of Menu/Form tree on the
Menus tab of the main configuration window.
1330
Select a form in the tree and click the Next button to view the form page.
Forms
A form contains two sections labeled as Fields and Documents. The Fields section contains the fields that will be
associated with the documents. The number of fields depends on the type of the form and on which forms are defined
on the Fields tab of the configuration window. Here is an example of a Basic Form with one text field.
In the Documents section you can can add documents that are to be sent into the workflow.
After filling in the necessary fields and adding documents, click the Send button.
How to use the Web Capture component
The Web Capture component allows for capturing documents into the workflow using a web service.
Consider the following example in which we want to process documents from different computers connected to the
local network while processing documents differently for each user. Design the process with the following steps.
1. Add the Web Capture component to a new workflow.
2. Add all route components that will be used in the workflows of either user.
At this point you have to add all the components to make them available for use in the workflows. We will activate
selected components to construct a specific workflow for each user.
Now we configure different forms for the different users. You can click the Help button in the Web Capture
component settings dialog box for details about options on any of the tabs.
1331
3. Double-click the Web Capture icon, and add a form for the first user on the Menus tab of the Web Capture
component settings dialog box.
4. On the General tab of the form settings dialog box, choose Restricted Access in the Access Control settings, and
in the Allowed users/groups box specify the user name for the first user.
This allows only the specified user to access the form.
5. On the Fields tab, configure the fields that you want to be associated with the documents sent with this form.
The values of the field will be passed to the subsequent components as Field Replacement Tag Names (FRTNs).
6. On the Components tab, configure the components that will take part in the process for this form and configure
each component according to your requirements.
If you don't activate a component it will not take part in a user's workflow.
7. Repeat steps 3 on page 1332 through 6 on page 1332 to configure a form for the second user.
How to use the dynamic form
This procedure describes how to use the dynamic form.
You can modify the standard behavior of a form by responding to events. Some of the things you can do by enabling
dynamic form are:
Add and remove fields

Change field contents (Example: load the contents of a list field from a database).
Validate field contents before the document is send to the server.
1. On the Menus tab of the Web Capture settings dialog box, click a menu to select it, and then click Add to add
one of the forms:
Basic Form
Send to Email Form
Send to Folder Form
2. On the General tab of the form settings dialog box, select the Enable dynamic form check box.
3. In the Script path box, enter the path to the VB.NET script that contains the code to respond to form and field
events.
To use an existing script, click the browse button (...).

To create a new script, click the Edit script code button.
The Edit script code opens the script editor window with basic script code that can be modified. For details on
the script editor window and the object model used to respond to form and field events, open to the Web Capture
Scripting documentation by clicking the Help button in the script editor window.
4. Select the form events that will be raised by the form.
Option
Description
Form is loaded
Causes the form to force fire an event every time the

Form is validated
Causes the form to fire an event every time the user

presses Send in the form.
Form is submitted
Causes the form to fire an event every time the

document uploading are finished.
5. If you need the script to run under the authentication context of the logged in user, select the Run as device
logged in user check box.
This option should be used carefully and only in cases where you need to access a system that requires explicit
identification. Whenever possible specify username and passwords in your script (use available .NET technologies
such as encrypting to hide the passwords from view when editing the script).
Remember: The Run as device logged in user option is only available if the group requires
authentication and the configured authentication mode is Windows.
1332
Configuring the Web Capture component

Web Capture dialog box
Double-click the Web Capture component icon in a work flow to open the Web Capture settings dialog box. This
dialog box has three tabs:
Menus tab defines the properties of forms.

Preferences tab allows you to customize common settings of the component.
Authentication tab is used to define the authentication method.
Mobile Server tab is used for configuration of the mobile server.
Menus tab
On this tab you can configure the list of menus and forms that will be displayed on the Web UI.
This tab contains the toolbar at the top and below it the Menu/Form tree box. The Menu/Form tree represents the tree
that will be displayed on the Web UI. Each node of the tree can be either a menu or a form.
A menu is an element that is used for grouping other elements. It can contain other menus and forms. You can restrict
the access to a menu and by doing so restrict the access to all its sub forms. A form corresponds to a web form
element on the Web UI that allows users to attach documents, enter data associated with the documents and send them
to the process server.
A form on the Web UI contains:
A list of fields(metadata) that will be associated with the documents.

A document section in which the user can select a list of documents that will be sent to the workflow server.
The tree supports copying of elements by grabbing a menu or form and dragging it to a new location in the tree. You
can open the context menu on an element of the tree by right-clicking on it. For example, to save a form as template,
right-click the form object and click Save As Template on the shortcut menu.
The toolbar contains the following buttons:
AddAdds menu or a form
EditEdits a selected menu or form
RemoveRemoves a menu or a form
Adding a Menu
Click menu in the Menu/Form tree, click the Add button on the toolbar, and click Menu to add a new menu as a
submenu on the selected menu. This opens the Menu Properties dialog box in which you can set the parameters of
the new menu.
The Add button is disabled if the selected item is a form because only menus can contain other menus.
Adding a Form
Click a menu in the Menu/Form tree, click the Add button on the toolbar, and then click one of the form types:
Click this form type
To opens this dialog box
Basic Form
Basic Form Settings
Send to Email Form
Send to Email Form Settings
Send to Folder Form
Send to Folder Form Settings
Send to SharePoint Form Settings
From Template
Create Form from Template

To load a form from a template.
The Add button is disabled if the selected item is a form because only menus can contain forms.
1333
Editing menu or form

Either double-click a menu in the Menu/Form tree or click Edit to change its properties. For a menu, this opens the
Menu Properties dialog box. For a form, this opens the appropriate form settings dialog box.
Deleting a menu or form
To remove a menu or form, click the menu or form in the tree and click the Remove button on the toolbar menu.
Forms
The Web Capture component supports four types of forms:
Basic Form
Send to Email Form
Send to Folder Form
You can configure the properties of a particular form on the corresponding settings dialog box:
Basic Form Settings

Sent to Folder Form Settings
Send to Email Form Settings
Sent to SharePoint Form Settings
For every form the dialog box contains three basic tabs, which are described for the Basic Form:
General tab
Field tab
Components tab
In addition, for every form except Basic Form this dialog box contains an additional tab that depends on the form
type:
Send to Email Fields tab

Send to Folder Fields tab
Send to SharePoint tab
Basic Form Settings dialog box

This dialog box is used to configure the parameters of a Basic Form.
General tab
Select the General tab to configure general properties of the form.
Option
Description
Name
The name of the form that will be displayed on the Web

UI. The maximum number of characters allowed in the
form name is 36.
Icon
The path to an icon image that will be used for this form.
An optional field. If the icon is not specified, the default
one will be used.
Description
A brief description of the form. This field is optional.
File Upload Restrictions
This section contains options to restrict the files that are

uploaded when using this form. The options are:
1334
Option
Description
Minimum number of filesEnter the minimum

number of files that can be sent when using this form.
The default value is 0.
Maximum number of filesSpecify the maximum
number of files that can be sent when using this form.
The default value is 10.
Maximum file sizeSpecify maximum allowable
size of uploaded files. Enter the value and select the
unit of size.
Limit format of uploaded files(any format by
default)Select this checkbox to specify the
file formats that can be sent through this form. If
unchecked, there is no restriction to the file format.
Access Control
File formatsClick the browse button (...) to

add file formats to be accepted, for example, txt,
doc, pdf.
This group of settings regulates access policy to the

form. The options are:
Public AccessIf this option is selected, all users

can see and use the form.
Restricted AccessIf this option is selected, then
only users in the Allowed Users/Groups list can see
and use the form. If a user belongs to a group in the
list then this user can see the form.
Note: Access control settings are disabled
when LDAP authentication type is selected. All
users will see and use the form.
Dynamic Form
You can modify the standard behavior of a form by

attaching a script that contains VB.Net code that will be
run when certain events are received from the Web UI.
This functionality is referred to as Dynamic Form. For
details on the script editor window and the object model
used to respond to form and field events please refer to
the Web Capture Scripting Documentation.
Enable Dynamic FormSelect this checkbox to

enable Dynamic Form.
Script PathPath to the VB.Net script that
contains the code to respond to form and field events.
An existing script can be selected by clicking the
browse button (...) next to the Script Path box.
script editor with basic script code.
Raise event whenSelect form events to be raised.
Form is loadedRaise an event on the server

every time the user enters the form.
Form is validated Raise an event on the
server every time the user presses Send on the
Web UI to submit the form.
1335
Option
Description
Form is submittedRaise an event on the
server every time when the documents are sent
into the process.
box to attempt to run the script with the privileges
of the logged in user. Typically this is selected when
the logged on user would have privileges that are
not assigned to the the user name that is running the
workflow.
Fields tab
On this tab you can configure the list of fields used to collect metadata about the documents. The values of the fields
will be passed to the subsequent components in the workflow process as Field Replacement Tag Names (FRTNs).
To add a new field, type a field Name in the last row of the table (marked with the *). To delete a field, click in the
first column to select the row, and then press the Delete key.
Name
Type the name of the field. The name can be any

combination of alphanumeric characters. Special
characters (for example, ~, !, @, , $, %) are not
allowed. The maximum number of supported characters
for this field is 64.
Display
Type an alternative text to represent the field on the Web

UI page. If Display column is left empty then the field
name will be used instead. The maximum number of
supported characters for this field is 23.
Type
Choose how the data for the field will be collected

by selecting an option from the Type column. The
following field types are supported:
TextUse this type to allow users to enter

unformatted text into a text box such as sentences,
names, numbers, date, and time.
ListUse this type to present users with a list of
choices from which users select the desired item.
TreeUse this type to present users with a list of
choices in a tree from which users select the desired
item.
CheckboxUse this type to allow users to set yes/
no or true/false values by adding or removing a check
mark from a check box.
NumericUse this type to allow users to enter
numeric values.
DateUse this type to allow users to enter date
values based on selected date formats.
Lookup ListUse this type to allow users to
dynamically retrieve values from an ODBC Data
Source.
Button Use this type to allow users to create
custom buttons on the form.
1336
Label Use this type to allow users to create a static

text on the form.
Signature Use this type to allow users to add
signatures to the uploaded documents.
(required)
Select the Required check box if you want to make this

field required.
(hidden)
Select the Hidden check box to hide the field.
(notify server)
Select the Notify server when field changes check box

to make the field trigger an event when the value of
the field changes. You can respond to this event in the
script that was configured for the dynamic form section
on the General tab. For details on how to respond to
form and field events refer to the Web Capture Scripting
Documentation.
(properties)
Configure the properties of a field by clicking the browse

button (...) in this column. This displays a properties
window based on the field type:
Text
List
Tree
Checkbox
Numeric
Date
Lookup List
Button
Label
Signature
Components tab
This tab allows users to configure process and route components. To configure a component, click the browse button
(...) in the properties ( ) column. This displays the configuration window of the component. Refer to the help for the
component for instruction to configure its properties.
Send To Email Fields Settings dialog box
A Send to Email form is a variation of a Basic Form that allows you to configure a form intended for collecting
information to send documents to an email destination. This form on the Web UI contains additional fields: From, To,
Subject, Message. These fields will be passed to the workflow as RRTs. A Send to Email form is commonly used in
conjunction with the Send to Mail Recipient eConnector and route components.
Send to Email Fields tab
Options
Description
If this checkbox is selected then the form will not
display the FROM field. This is usually selected
if authentication has been enabled for this group
and the administrator plans to use the logged in user
1337
Options
Description
emails address for the FROM field in the Send to Mail
Recipient component.
Show a CC field
This will show the "CC" field in which the user can
specify a secondary list of people that will receive the
message.
Show a BCC field
This will show the "BCC" field in which the user

can specify people who will receive the message
without showing in the To or Cc fields visible to other
receipients.
Global Address List
Allows the user to search the Global Address List for

fields. In the Display as box type the display value for
this search option.
Note: The Global Address List that will be
searched will be decided based on the following
criteria:
If Windows/Active Directory Authentication

is used, then the search will be performed
on the Global Address List associated to the
logged in user.
authentication code populates the domain
field, then the search will be performed on
the Global Address List associated to the
logged in user.
If there is no logged in user then the search
will be performed on the Global Address
List associated to the service account for the
workflow service.
Note:
Regardless of which Global Address List is
used, the user account for the workflow service
must have enough permissions to perform this
search.
Exchange Contacts
If this option is selected, the users can search their

can be added to the To, CC and BCC fields. This option
is disabled when Integrated Windows authentication is
used.
Display as
Enter the display value for this search option.
Server
Enter the address of the Microsoft Exchange server.
Use SSL
Select this checkbox to use secure connection to the

server.
LDAP Server
Select this checkbox to allow users to search an LDAP

Server for addresses that can be added to the To, CC and
BCC fields.
1338
Options
Description
Display asThe display value for this search

option.
LDAP ServerThe IP address or host name of the
LDAP server.
Search Root DNThe distinguished name for the
node where the search should start. For example:
DC=Sales, DC=MyCompany, DC=com. If this field
is left empty then the starting point of the search will
be the root of the directory tree.
Email Address fieldThe name of the LDAP
attribute that represents the email address. When this
value is used then the email address that is passed
to the server is retrieved from this attribute, a valid
value for a windows environment LDAP would be
mail (LDAP attribute names vary depending on the
LDAP implementation and configuration).
Name fieldThe name of the LDAP attribute that
represents the name of the user. When a value is
found then the display text for the item is retrieved
from this attribute.
Login as AnonymousIf selected, the connection
to the LDAP server will be established as
anonymous.
Login with following credentialsIf this is
selected, the connection to the LDAP server will
be established using the specified username and
password.
Test LDAPPress this button to open the Test
dialog box. In the LDAP Search Test window enter
a search term in the Search Criteria box, click Find
Contacts. If the settings are correct and there are
users that match the search criteria, you should see
the appropriate results (a maximum of 25); otherwise
an error will be returned.
The maximum number of contacts that the search will

return.
Send to Folder Form Settings dialog box

A Send to Folder form is a variation of a Basic Form which is intended for collecting information to send documents
to a folder destination. This form on the Web UI will contain two standard fields: Directory and Document name.
components.
Configure the options on the General, Fields and Components tabs in the same manner as for a Basic Form.
Send To Folder Fields tab
Options
Base Directory
Description
The base path to the folder. The tree of subfolders of this
folder will be displayed on the web page, and the user
will be able to browse this tree to select the destination
1339
Options
Description
of the document. The base directory can be a UNC path
as well.
The default value that will be used for the document

name field.
Use authenticated user credentials
If this option is selected, the component will try

to impersonate the authenticated user and display
folders and files for which that user has read and write
permissions. In case this option is not selected or
impersonation does not succeed, the workflow service
user account will be used to access the file system.
The user credentials that will be used to access the file
system depend on the authentication method that is
selected on the Authentication tab in the Web Capture
settings dialog box:
Integrated WindowsThe credentials of the logged

in user will be used.
Active DirectoryThe credentials used to access
the Web UI will be used.
LDAPThe credential used to access the Web UI
will be used.
Custom scriptIn this case, you should add
a WinPassword field to the logon page and set
the UserName property of the UserInfo object in
the script. The values of this property and of the
WinPassword field will be used as user name and
password to access the file system. If WinPassword
field is not defined, an empty password will be used.
Send to SharePoint Form Settings dialog box

A Send to SharePoint form is a variation of a Basic Form, this form is intended for collecting information to send
documents to a SharePoint 2007/2010 server destination. The form on the Web UI contains a number of fields that
provide information that is necessary to send a document to the SharePoint Server. The fields include Site, Document
Library, Folder Path, Content Type . The form also contains the fields that correspond to the columns in the selected
SharePoint library. A Send to SharePoint form is commonly used in conjunction with the SharePoint 2007 and
SharePoint 2010 eConnector and route components.
Note: If you use the SharePoint component in the workflow, the documents will be sent to SharePoint under
the user that is specified in the SharePoint component, not under the user that is specified in this tab.
Note: In order to use this form, either the SharePoint 2007 or SharePoint 2010 component must be installed.
Send to SharePoint tab
Options
SharePoint version
Description
The version of SharePoint that this form targets. If only
one version of SharePoint is installed in the machine
then the list contains a single item that cannot be
changed.
1340
Options
Description
Server address
The url of the SharePoint Server where the documents

will be stored. This field can contain "http://" or
"https://" followed by server name or IP address.
For example: http://sp2007 or https://192.168.0.178.
Alternatively, it can contain only the server address, e.g.
sp2007 - in this case the component will insert "http://"
before it automatically.
User name
The user name which will be used to log in to the server.

If you are using a domain user account to connect to
SharePoint 2007 or SharePoint 2010, enter the user name
with the domain name, e.g. ORGDOMAIN\SpUser.
The local server users can enter only the user name, e.g.
SpUser.
Password
Enter the user password that will be used to log in to the

server.
Use authenticated user credentials
Select this option to use the credentials of the logged

in to the Web UI user to access SharePoint. The user
credentials that will be used to access SharePoint depend
on the authentication method that is selected on the
Authentication tab in the Web Capture settings dialog
box:
Active DirectoryThe credentials used to access

the Web UI will be used.
LDAPThe credential used to access the Web UI
will be used.
Custom scriptIn this case, you should define a
password field with the name WinPassword and
set the property UserName of the UserInfo object
in the script. The values of this property and of the
WinPassword field will be used as user name and
password to access SharePoint.
For more information, see Authentication tab.

Note: If this option is selected, the user name
and password provided in this tab are used to
access SharePoint only at configuration time.
Note: When using this option, you can
configure the WebCapture and SharePoint
components by means of RRTs so that the
documents are sent to the SharePoint server
under the same user that logs into the web form.
To do this, select the Use authenticated user
credentials option and specify the username in
the SharePoint component configuration in the
following RRT string: ~WCC::UserDomain~
\~WCC::UserName~. See Component RRTs
for details.
Site
The name of the SharePoint site where you want to

store the documents, this can be done either manually
or by selecting a value from the drop-down list. You
1341
Options
Description
can specify a subsite of the site entering its name after
the parent site name followed by "/", for example,
SubSite1/SubSite1_1.
Allow user to change site
Select this checkbox to allow users to change the site on

the Web UI.
Document library
The name of the document library to which you want to

send the documents. This can be done either manually or
by selecting a value from the drop-down list.
Allow user to change document library
Select this option to allow users to change the document

library on the Web UI.
Default folder path
The name of the default folder where the routed files

will be stored, this can be done either manually or by
browsing to the desired folder. Use the browse button
next to the box to open the Select Folder dialog box
Allow user to change folder
Select this option to allow users to change the folder on

the Web UI.
Content type

to the document. This can be done either manually or
by selecting a value from the drop-down list. Note that
the user will only be able to select a Content Type on the
Web UI if there is more than one content type assigned to
the selected document library; otherwise the content type
is assigned automatically.
Allow user to change content type
Select this option to allow users to change the content

type on the Web UI.
Web Capture form fields

Text field
This field is used to enter unformatted text, such as sentences and names, into a text box.
Options
Description
Max length
Enter maximum number of characters for the field. The

default is 255, which is the maximum as well.
Multiline
Select this check box to allow multiline text in this field.

If this check box is selected, the Password check box is
disabled.
Number of lines to display
in this field, choose the number of lines that will be

displayed on the form. This field is only available when
Multiline check box is selected.
Read only
Select this check box if you want to prohibit editing this

field by the user.
Password
select this check box if the field is reserved for

passwords. The text in the field will be masked. When
this check box is selected, the Multiline and Read only
check boxes are disabled.
Default text
The default value for the field.
1342
List field
A List field is used to present users with a list of choices from which they can select the desired item.
Options
Description
Value
Type the value associated to this option. This is the value

that will be sent to the Server and used for the Field
Replacement Tag Name (FRTN). Maximum length is
150.
Label
Type an alternative text that will be visible to the user.

If the label is empty, then the Value setting will be used
for displaying this option in the Web UI. The maximum
length is 150.
Default
Select this check box to make the value in the Value

column be the default value for this field.
Import Items
Click this button to import the List items values from a

file of comma separated values (CSV file).
Export Items
Click this button to export the List items values to a

CSV file for reuse in other List fields.
Select this check box to allow the user to select more

than one item from the list. When this option is enabled,
the value of the RRT will be the list of selected values
separated by the semicolon (;).
When the Allow Multiple Selection check box is

selected, you can select this check box to allow the user
to search the list for an item that starts with the specified
criteria.
Raise event after pressing the find button
Select this check box to cause the field to fire an event

when the user presses the search button at the Web
UI. You can respond to this event in the script that can
be configured for the Dynamic form section on the
General tab of the form settings dialog box. This option
is enabled only if Display Search Options is enabled.
Specifies the maximum number of result items to display

in the list.
Tree field
A Tree field is used to present users with a list of choices in the form of a tree in which the user can select the desired
item.
Options
Description
Add
Click this button to add an item to the tree. This displays

the Add/Edit Tree Item dialog box.
Remove
Click this button to remove a selected item in the tree.
Edit
Click this button to edit a selected item in the tree.
Add/Edit Tree Item Dialog Box
1343
This dialog box allows you to edit the value and label for a tree item.
Options
Description
Value
sent to the server.
Display Text
see when navigating the tree on the web page.
Checkbox field
Checkbox is used to allow users to set yes/no or true/false values.
Options
Description
True value
Enter the value that will be sent to the server if the field
is checked. The default is 1. Maximum length is 255.
False value
Enter the value that will be sent to the server if the field
is unchecked. The Default is 0. Maximum length is
255.
Checked by default
Select this check box to make the check box initially

selected when the user enters the form.
Numeric field
A Numeric field allows the user to enter a numeric value in a form.
Options
Description
Default
Enter the default value for the field. This value cannot be
larger than the Maximum value setting or less than the
Minimum value setting.
Minimum
Specifies the minimum value that can be entered in a

numeric field. This setting is optional.
Maximum
Specifies the maximum value that can be entered in a

numeric field. This setting is optional.
Precision
Enter the number of positions required after the decimal

point. If the precision is set to zero, the device will
only accept whole number values. The default is 0. The
maximum is 5.
Date field
A Date field is used to collect date information.
Options
Description
Date Format
Select the desired Date Format.
Select this check box to restrict date entries to a specified

range of dates.
FromSpecifies the earliest date that may be

entered.
ToSpecifies the latest date that may be entered.
Lookup List field
1344
Lookup list is used to present users with a list of choices retrieved from an ODBC database.
Options
Description
ODBC data source
Select the desired ODBC data source. Only system

data sources can be selected as a data source. If no data
ODBC source was previously created, a new ODBC data
source can be created by selecting the <New> option.
User Id
Enter the user name for accessing the ODBC data source.
Entering a value for this field is optional. If no entry is
made, then the user account running the workflow server
will be used.
Password
Enter the password that corresonds to the User ID.
Retrieve data from
In this section you can specify from where the data will
be loaded and how it will be presented in the lookup list.
Table/ViewThe name of the table/view can be

selected from the drop down menu.
Value ColumnIn this field you must select
the name of the column from which values
will be loaded into the lookup list. This field is
mandatory for the Table/View option.
Display ColumnIn this field you may select
the name of the column the values from which
will be used in the lookup list as display values.
This field is optional. If nothing is entered, the
values listed from the Value Column will be
displayed.
QueryChoose this option if you want to provide
an SQL query to produce the results which will
populate the lookup list. For more information on
SQL scripting syntax see General SQL syntax.
Maximum number of rows to pre-loadSpecifies
the maximum number of rows to preload into the
display when the lookup list is first displayed.
Test data retrievalClick this button to test the
connection and lookup settings.
Display mode
Select the desired display mode from the drop-down list.

There are three modes available:
Drop-down list
Control list
Modal dialog
If selected, the user will be able to make multiple

lookup list.
If selected, the user will be able to insert their own


value is 200.
1345
General SQL syntax

A simple SQL query:
select <ValueField>,<Display Field>
from <Table>
select <ValueField>
from <Table>
select "Customer Id", "Customer Name"
from "Customers"
where "Customer Name" = Fred
In this example, all customers where Customer Name is "Fred" will be returned.
select "Customer Id", "Customer Name"
from "Customers"
where "Customer Name" like %Johnson
In this example, all customers where Customer Name ends with the text "Johnson" will be returned. For example,
customers where Customer Name is "FJohnson", "FredJohnson", "Johnson" or "3Johnson" will be returned.
SQL wildcard syntax is used with the like operator. The wildcard % is used to specify a one or more characters.
Button
Button type is used for custom buttons.
Option
Label
Description
Tooltip
Enter the text of the tooltip in this text box.
Enable
Select this check box to make the button available for

clicking on the site. If this check box is cleared, the
button will be disabled.
This type is used for labelling various text information; for example, hyperlinks.
Option
Description
Text
Enter a text that will be displayed as a label on the site.
Tooltip
Enter a tooltip text for the label.
Font size
Select the font size for the label text.
1346
Option
Description
Render as hyperlink
Select this check box if you want the label to represent a

hyperlink.
URL
Enter the destination URL. It should be entered in the

full format; for example: http://www.somesite.com/
somepage.
Enable
Select this check box to enable the label. If this check

box is cleared and the label contains a hyperlink, then the
text of the label will not represent a working hyperlink.
Signature
This type is used for users signatures. Users could leave their signatures in the Signature field, using stylus or
computer mouse.
Option
Description
File type
Select an image file type that will be used for signature

storage. There are three types available:
PNG
BMP
JPEG
Size
Select the size for the field on the site.
Process signature file as attachment
Check this box if you want to attach the image file with
signature to the submitted documents.
Extended Fields Properties

The Extended Fields Properties form displays the properties and values that have been assigned to a field and allow
additional properties and values to be added.
The properties and values added to the field in this dialog must have already be defined using the Extended Fields
Property Manager. The Extended Fields Property Manager can be access from this form as well as from the Web
Capture Preferences tab.
The Extended Field Properties (XFP) for each field are listed one-per-row where the first column (Name) contains a
drop-down list box for selecting the property name and a second drop-down list box, to the right (Value), for selecting
the applicable property values. The property value selection is hierarchical and the options available will depend on
the selected property within the same row.
This dialog box is used to configure menu properties.
Option
Description
Menu Name
The name of the menu. The name of the menu must be

different from that of other menus and forms at the same
level. The maximum number of characters allowed in the
menu name is 36.
Icon
Enter the path to the icon file or locate the icon by

clicking the browse button (...).
Access Control
Public AccessAll users are allowed to browse the

forms and menus under this menu.
1347
Option
Description
Restricted AccessOnly users in the Allowed

Users/Groups list are allowed to browse the forms
and menus under the menu.
Allowed Users/GroupsThe list of users that are
allowed to browse the menu and all its submenus and
subforms.

Use this dialog box to save a form as a template to allow form settings to be reused.
This dialog box is opened by right-clicking a form on the Menus tab of the Web Capture settings dialog box and
licking Save as Template on the shortcut menu.
Option
Description
Location
Enter the file name under which the template will be

saved.
Template Name
Enter the template name.
Save copy of dynamic script in the same location
Select this checkbox to save a copy of the script of

dynamic form in the same directory in which the
template will be saved.
Create Form from Template dialog box

In this dialog box you can select a preexisting template for creating a form and attach a Dynamic Form script file to it.
Option
Description
Template file
The location of the template. This must be a form

template saved previously with the Save as Template
command.
Dynamic form script file
Enter the location of the .Net script file associated to the

template.
OK
Click this button after you specify the Template file and
Dynamic form script file to open the Add Form dialog
box with the configuration values set by the selected
template.
Preferences tab
Configure options on this tab to set up general Web Capture properties.
Option
Description
Home directory
The directory where the server will create all temporary

directories and files necessary for running the
application. The user account for the service must have
full control permission in this directory.
Web server port
The port used by the embedded web server to

communicate with clients. This is the port that is used
when clients access the Web UI url. The default value is
3290.
1348
Option
Description
The default Web UI url is
http://<workflow server ip/
hostname>:3290/ASWCCapture/
default.aspx
SSL
Select this check box to use secure channel(SSL mode)

to access the Web UI. In this case, the default Web UI url
is
https://<workflow server=""
ip=""/hostname>:3290/ASWCCapture/
default.aspx
Data service port
The port used by third party clients to access the

WCF Endpoint to interact with the service. For more
information refer to Interaction through WCF Endpoint.
SSL
Select this check box to use secure channel (SSL mode)

to access the Web UI. In this case the prefix for the Web
UI will be https.
Service password
The password required for third party clients in order to

interact with the service through the WCF Endpoint.
Note: This service is available only with the
Custom Development license.
Choose certificate
Select the private key file (.pfx) that will be used to

secure the connection.
Certificate password
The password to the private key file.
Processed files
Select this check box to retain copies of all files that are
processed without errors on the server. Enter the location
to keep the files in the adjacent box.
Rejected files
Select this check box to retain copies of all files that

failed to process. Enter the location to keep the files in
the adjacent box.
Web session timeout
This option specifies the timeout for the web session in

minutes. Default value is 20 minutes.
LDAP timeout
This option specifies the LDAP connection timeout in

seconds.
ODBC timeout
This option specifies the ODBC connection timeout in

seconds.
Exchange timeout
This option specifies the timeout in seconds of the

Exchange connection used to receive contacts when a
Send to Email form is used.
Extended Field Properties Manager
Click this button to open the Extended Field Properties

Manager. The Extended Fields Property manager may
be used to assign custom properties and their values
to any field in Web Capture. These custom properties
are carried forward into the user interface, where they
1349
Option
Description
may be used by custom clients to determine additional
behaviors or rendering for the field. These properties
may also be used for custom styling in clients, including
the Web Capture client, by adding markup to the HTML,
which can be targeted by Cascading Style Sheets (CSS)
selectors.
Extended Fields Properties Manager

The Extended Fields Property (XFP) manager may be used to assign custom properties and their values to any field in
Web Capture.
These custom properties are carried forward into the user interface, where they may be used by custom clients to
determine additional behaviors or rendering for the field. These properties may also be used for custom styling in
clients, including the Web Capture client, by adding markup to the HTML, which can be targeted by Cascading Style
Sheets (CSS) selectors.
Web Capture includes some prepopulated properties for supporting NSi Mobile Server and they cannot be modified or
deleted. For more information on using the XFP for NSi Mobile, see the NSi Mobile Server configuration guide.
The properties panel in the Extended Field Properties Manager form displays each property and its values. The
Applicable Fields panel displays all the fields Web Capture supports and which fields are associated to the XFP
currently selected in the Properties panel.
The toolbar at the top of the form allows your own custom properties to be added, edited, and deleted. The Add and
Edit toolbar buttons will open the Property Detail form, where the property name is defined with its list of values and
whether more than one value can be selected for the property.
Authentication tab
This tab is used to configure the authentication settings that will be used to authenticate a user that connects to the
Web UI.
Note: Authentication is always required for this component.
Option
Authentication type
Description
Specifies the type of authentication used by the
component.
Integrated Windows
Active Directory
LDAP authentication
Integrated Windows
In this mode the logon credentials of the user are used.

No additional configuration is necessary on this tab.
Active Directory
This mode uses Active Directory to authenticate users.

Users must provide their windows user name, domain
and password.
LDAP authentication
DomainEnter the default domain name that will

be displayed by the client. The password field will
be shown at the Web UI as a masked field. All fields
will be required.
This mode uses authentication against an LDAP server.

This option requires values for the following options:
LDAP serverThe address or host name of the

LDAP server.
1350
Option
Description
Root DNThe distinguished name for the LDAP

tree node where the search should start. For example:
DC=Sales, DC=MyCompany, DC=com. If this field
is left empty then the starting point of the search will
be the root of the directory tree.
Note: When you select the LDAP
authentication type you cannot edit Access
control in the Basic Form Settings dialog box.
Custom script
With this method the administrator must provide a

VB.NET script that contains the code for responding to
the event that will be sent to the server when the user
presses the login button. The current field values are
passed to the script using the Web Capture object model.
This option is only allowed if an unlimited license is
available for the server.
Script file pathSpecifies the path to the script

file.
script in the Script Editor to view or modify it. If the
script is not specified, a script with a basic code will
be opened. For more information, see Script Editor.
FieldsClick this button to open the
Authentication Fields dialog box, in which you can
set up the fields that will be displayed on the logon
page.
Use an LDAP search to retrieve additional user

information
Select this check box to have the application perform a

lookup on a designated LDAP server to find the email
address and other attributes of an authenticated user.
Configure
Click this button to open the LDAP Lookup Settings

dialog box to specify parameters for performing the
LDAP search.
Authentication Fields dialog box

This dialog box allows you to set up the fields that will be displayed on the login page and whose values will be
passed to the VB script to perform custom authentication.
This dialog box contains two predefined fields UserName and WinPassword. Note that when the Use authenticated
user credentials check box is selected, for a Send To Folder or Send to SharePoint form, the WinPassword field will
be used to login to access the file system or to login to the SharePoint server.
Option
Description
Name
Specifies the name of a field.
Display
Specifies the label displayed for a field. If no value is

specified for a field, the Name value is displayed.
Default
Specifies the default value for a field. This entry is

optional.
(required)
Select the check box in this column to require users to

enter a value in a field.
1351
Option
Description
Masks the field value.
(mask value)

This dialog box allows you to configure the parameters for the LDAP Search.
Option
Description
LDAP Server
Enter the address or host name of the LDAP server.
Root DN
The distinguished name for the node where the search

should start. For example: DC=Sales, DC=MyCompany,
DC=com. If this field is left empty then the starting point
of the search will be the root of the directory tree.
Login as anonymous
Choose this option to connect to the LDAP server as

anonymous.
Login with following credentials
Choose this option to connect to the LDAP server using

Directory type
The type of directory that will be searched. The search

will be performed using predefined attributes that depend
on the selected value.
Active Directory
eDirectory
Custom
If Custom is selected then you must specify which fields

to use when doing the search.
Match user name against
The name of the LDAP field that must match the

username of the authenticated user.
The name of the LDAP field that contains the email

address of the user.
Additional attributes
A semicolon separated list of LDAP fields that contain

additional user attributes (that is, homeDirectory).
Replacement Tag Names(URTNs).
Test Lookup
To test the search setting, enter a sample username in the

User name box and click Test.
Mobile Server tab

Use this tab to configure settings for mobile service.
Option
Description
Mobile service port
Port used by the mobile server to interact with the server.
SSL
Select this check box to use secure channel(SSL mode)

to access the Web UI. In this case the prefix for the Web
UI will be https.
Choose certificate
Select the private key file(.pfx) that will be used to

secure the connection.
Certificate password
The password to the private key file.
1352
Script Editor
The component provides a built-in script editor. It facilitates the creation and edition of scripts, provides intellisense
and allows for the compilation of scripts. To compile a script click the Compile button in the script editor window, if
errors are found you can double click the error message to go to the associated line of code.
To find more information about scripting, click the Help menu in the editor window.
Interaction through WCF endpoint
When Custom Development license is used, third party clients can connect to the component web service. This
functionality is provided by the Windows Communication Foundation, an API in the .NET Framework. A third
party client can interact with the service via an Endpoint. The Endpoint is accessed through net.tcp://hostname:port/
NSiAutoStoreWebCaptureWcfService with the following settings:
hostnameThe hostname or IP of the embedded server.
portThe port to access the service. It is defined on the Preferences tab in the Web Capture component
settings dialog box.
Refer to the Web Capture API Documentation for more information.

Licensing the Web Capture component
There are three license modes for this component:
User based license. In this license mode, only a set number of users (based on the level of the license) will be
allowed connection to the web UI. The blocking/unblocking features of the AS licensing can be used to prevent/
allow users to access the web client. If this license mode is used, then at runtime, the component must enforce that
windows authentication (integrated or forms) is used.
Unlimited access license. In this mode there is no restriction on the number of users that can connect to the web
UI. This license takes precedence over the User based license.
Custom development license. In this model a third party client can connect to the component web service.
Web Capture component RRTs

Component RRT ID
The RRT ID for this component is WCC.
Name
Description
FormName
UserName

UserEmail
The email address of the authenticated user. This RRT is

populated under one of the following conditions:
When Active Directory authentication is selected.

When Integrated Windows or LDAP authentication
is selected, the email address is searched for in
the LDAP server if the Use an LDAP Search to
retrieve additional user information option on
the Authentication tab is selected and the search
parameters in the LDAP Lookup Settings dialog
box are properly configured.
1353
Name
Description
UserDomain
When Custom Script authentication is selected,

this RRT is populated if the associated .NET script
defines the Email property of the UserInfo object.
The authenticated user's domain name. This RRT is

populated under one of the following conditions:

authentication.
The component has been configured to use Active
Directory authentication.
The component has been configure to use LDAP
authentication. In this case, the domain will be
defined if the user enters his name in the following
forms: Domain\User or User@domain.com.
The Component has been configured to use Custom
authentication and the associated .NET script
object.
UserIp
The IP address of the client.
UserHostName
The resolved host name of the client.
FileSize,N
The size in bytes of the captured file, where N is the

number of the file.
WebServerIp
The IP address of the web server.
WebServerHostName
The resolved host name of the web server.

RRT for Send To SharePoint Form
Path
The path to the folder in which the documents are saved.
DocName
The name of the document.

RRT for Send to Email Form
To
The list of recipients of the email message.
From
The sender address. Unavailable if the option Do not

show a From field. Use the device logged in user's
email address is selected.
Subject
The subject of the email.
Message
The message.
CC
The list of secondary recipients. This RRT is available if

the Show a CC field option is selected.
BCC
The list of recipients who will receive the message

without anyone else seeing who they are. This RRT is
available if the Show a BCC field option is selected.
RRT for Send To SharePoint Form
Site
The name of the SharePoint site.
DocumentLibrary
The name of the document library to which the

documents are sent.
1354
Name
Description
FolderPath
The name of the folder where the documents are stored.
ContentType
The name of the content type.
User Attributes Replacement Tag Names (URTN)

following provides some examples of usage of URTN:
If Custom authentication is used and there is a user attribute named FullName with the value John Doe then the
RRT will look like:
The RRT string ~WCC::User,%FullName%~ will be replace by "John Doe".

If an LDAP Search is used to retrieve additional attributes, and you entered displayName on the Additional
Attributes box, then for an authenticated user which displayName is Jane Doe:
The RRT string ~ WCC::User,%displayName%~ will be replaced by Jane Doe.

The component supports Field Replacement Tag Names and replacement of field names. The following example
The RRT string ~WCC::%Client ID%~ is replaced by Company if the user types in Company for the field
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
1355
SSRTN
Description
%y
%Y
Supported browsers:
Internet explorer 8.0 and greater.

Firefox 4.0 and greater.
Chrome 10.0 and greater.
The LDAP authentication type configured on the Authentication tab does not support access control setting to the
forms
To allow the component to work correctly with Internet Explorer, do not use the underscore character ( _ ) in
machine and server names. This is a restriction of Internet Explorer browser. It does not work with the servers if
their names contain the underscore character.
WebCapture
About WebCapture UI
The WebCapture site is a web UI of the WebCapture component that lets users to capture their documents into the
workflow.
Signing in or out of the WebCapture site
When you try to access to the WebCapture site for the first time, you will need to provide valid user credentials to
sign in to the site.
The start window contains provides fields to enter your user credentials. These fields are configured by the server
administrator. The required fields are marked with asterisk (*).
The WebCapture signin window has three required fields:
Username
Password
Domain
1356
Figure 29: WebCapture signin window

To sign in to the WebCapture site, enter you user name, password, and domain, and then click Log In.
To end your session, click the Log Out button in the upper right corner of the site page.
Forms tree
The main window of the WebCapture site consists of the menus and forms, arranged into the tree.There may be only
one parent menu.
Figure 30: Forms tree in the main WebCapture window

To use this window, select a form in the tree and click the Next button to view the form page.
Note: If the logged on user does not have sufficient rights to access the site, then WebCapture displays the
1357
Insufficient permissions to access the forms menu. Try to login as different user.
Forms in a WebCapture site
Form is basic notion of the WebCapture site. Forms allow users to capture documents, add them into the workflow
and route them into the desired destination.
A form consists of the two main sections:
Fields sectionFields that can contain any amount of additional information that can be added to the captured
documents.
Documents sectionShows a list of documents to be uploaded.
Each form also has a Send button to begin uploading documents and Back button to return to the main WebCapture
site page.
Fields in a form
Fields section contains the fields that will be associated with the documents. The number of fields depends on the type
of the form and on which forms were added in the Fields tab of the configuration window.
The following figure shows an example of the fields on the form:
1358
The form may contain the fields of the following types:

Field type
Description
Text
This type is used to enter unformatted text to the

documents. This text box may contain sentences, names,
numbers, dates, time an so on. Enter the desired values
into this field by hand.
List
There are two types of list fields:
Single selection listA list where only one item

can be selected. Usually this type represents a
1359
Field type
Description
drop down list. This type may contain additional
functionality (search, adding unspecified values),
in such a case the corresponding field will have the
browse (
) button; click it to get to the additional
functionality.
Multiple selection listA list where multiple
items can be selected at the same time. Click
to
browse to the list of choices. Use navigation buttons (
and
for a single value;
and
for all values) to select/unselect values from the list
of choices. This list may be presented as a number of
check boxes.
Note: Depending on server settings both types
of the list fields may allow searching through
the existing values and adding new values.
Tree
This type presents a node tree of choices for users. You

can enter the value manually in this field or click
navigate through the nodes to the desired value.
and
Note: If you enter manually the value in this

field and there is no such a value in the tree,
then the error message will be shown.
Check box
This type allows users to select the simple values (yes/no

of true/false).
Numeric
This type is used for numeric values. You can enter a

non-numeric value into this field, but this will cause an
error.
Date
This type is used for dates. You can enter the date
manually. When you try to enter the date a pop-up
calendar will be shown, where the current date will be
selected. You can change the date by hand.
Button
This type is used for custom buttons. For example, for

changing metadata entered or updating the form.
Label
This type is used for labeling various text information,

for example, hyperlinks.
Signature
This type is used for users' signatures. Users could leave

their signatures in the Signature field, using stylus or
computer mouse.
Note: This is not necessary that the fields of all types are presented on the form.
The list of fields on the form may change dynamically depending on the form settings on the server.
The server administrator may configure the form so that all fields automatically get filled in when you enter a value
for either one of them.
Documents in a workflow
You may add one or more documents into the workflow through the Documents text box.
1360
Adding documents into the uploading queue depends on the browser. Internet Explorer allows adding only one
document at a time time, while Google Chrome and Mozilla Firefox allow adding multiple documents simultaneously.
Option
Add
Description
Click this button to browse to the directories on your
local machine, where you want to upload documents
from.
All the selected documents will be shown in the
Documents list box.
Note: The server administrator may set the
maximum number of the files that can be added
at the same time. If this number is exceeded, the
Add button will be disabled.
Remove
Click this button to remove a selected document.
Back
Click this button to return to the main window of the

WebCapture site.
Send
Click this button to proceed to the uploading page.
Uploading documents
The Uploading page shows the status as you are uploading documents and allows you to cancel the upload.
1361
You can use buttons on this page to cancel an upload, return to the current form, or return to the main WebCapture
page.
Option
Description
Cancel
Click this button if you want to cancel uploading. This

button is available only while an attempt to upload
documents is running.
Return To Form
Click this button to return to the particular form that you

are using to upload your documents.
Done
Click this button to return to the main window of the site.
WebDAV
Welcome to the WebDAV component
WebDAV Route/eConnector component is used for sending files to WebDAV (Distributed Authoring and Versioning
Protocol for the World Wide Web)servers, such as SharePoint and WebDAV folders. The component allows assigning
necessary properties to the files.
The component can be both used as a process and route component.
Getting started
Feature highlights
Route documents to WebDAV (Distributed Authoring and Versioning Protocol for the World Wide Web) servers.
Use Integrated Windows identification.
Select folder tree from the tree of folders.
Add properties to the routed documents.
How to use the WebDAV component

The example of this component usage may be as follows: Scan documents from an MFP device, save directly into a
folder within WebDAV Server.
1. Design a workflow process with MFP component corresponding to the MFP device type and the WebDAV Route
component.
2. Configure the WebDAV Route component to route the documents into a WebDAV folder.
3. Specify the properties that uniquely identify the document.
scanned document with the configured properties is routed directly into WebDAV Server.
Configuring the WebDAV component
The component configuration window consists of two tabs:
Tab
Description
General Tab
Use this tab to set the parameters for the DAV server
connection and the output file destination.
Properties Tab
Use this tab to specify the properties of the routed

documents.
1362
General tab
Use this tab to set the parameters for the DAV server connection and the output file destination.
Option
Description
Activate

option is present only in the eConnector component
Connection
This group allows you to set connection parameters for

the WebDAV server.
WebDAV server
Enter the path to the WebDAV server. This path should

contain "http://" or "https://" followed by the server
name or IP address. For example, http://server1 or
https://192.168.0.178. Alternatively, it can contain only
the server name or IP-address, for example, server1 or
192.168.0.178. It is mandatory to fill out this text box.
NT Authentication
Select this check box to log on to the server by using

Integrated Windows identification instead of password
authentication. If this check box is not selected, you
should enter the user name and the password for
authentication.
User name
Enter the user name to log on to the server. If NT

Authentication check box is not selected, this entry is
required.
Password
Enter the password.
Destination
This group allows you to set the destination where the

file will be stored on the WebDAV server.
Folder
Enter the path to the output files destination folder on the

server or click
to open the WebDAV Folder dialog
box that allows you to select the desired folder from the
folder tree. The component allows you to create folder
path dynamically. You can use RRTs in this text box.
Rename file
Select this check box to specify the file name for the
output document using the Schema text box. If this check
box is not selected, the input file name will be used.
Schema
Determine the output file name by using renaming

schema. This text box can contain RRTs.
Note: If the Rename file check box is selected

and a rename schema is not provided, then
at run time the Schema name defaults to:
~DAV::FileName~_~DAV::Counter~~DAV::FileExt~
For example, if the input file name is
File.tif, the renamed file will be
File_1.tif.
If you select this check box, and a file under the

specified name already exists in the output folder, the
component overwrites this file. If this check box is not
selected, and a file under the specified name already
1363
Option
Description
exists in the destination folder, an error message is
generated.
Pass-through
Check this box if you want documents to be available

to the rest of the components in your process. This
check box is present only in the eConnector component


Expression
Description
YES
NO
~CMP::SomeRrt~

or 1.

Expression
Description

"Y" + "e" + "S"



Expression syntax
1364

logic_expression
math_expression
math_expression_mul
unary_expression
(expression)
constant
identifier
operation_cmp ::=
==
!=
>
<
>=
<=
operation_add ::+
operation_mul ::*
/
unary_operation ::+
!
string_constant
1365

Constants
Examples:

1366

Boolean).
value False.
Identifiers
Operators
Symbol
Description
Result type
Operands type
?:
Conditional select
Same as operand
Logical OR
Boolean
Boolean
&
Logical AND
Boolean
Boolean
Equal to
Boolean
Any
==
Equal to
Boolean
Any
!=
Not equal to
Boolean
Any
>
Greater than
Boolean
Integer or string
<
Less than
Boolean
Integer or string
>=
Boolean
Integer or string
<=
Boolean
Integer or string
Add or concatenate
Same as operands
Integer or string
Subtract
Integer
Integer
Multiply
Integer
Integer
Divide
Integer
Integer
Boolean
Boolean
Plus (unary)
Integer
Integer
Minus (unary)
Integer
Integer
(expression)
Parentheses
Same as operand
Any
1Boolean
2, 3Any
WebDAV Folder dialog box

This dialog box displays the folders of the WebDAV server in a tree view manner.
Select the folder where the routed documents will be stored and click OK.
Properties tab
Use this tab to specify the properties of the routed documents.
Each property is identified by name, value and server.
1367
Option
Description
Name
Displays the name of the property in the following

form: [namespace] name, where [namespace] is a
namespace. Namespaces vary depending on the server
type. The common namespace for the servers that
support WebDAV is "DAV:". The possibility to configure
standard properties of "DAV:" namespace depends on the
specified WebDAV server properties.
Value
Displays property value.
Server
Displays server type.
Use the following three buttons for managing the properties from the list.
Add
Click this button to add a new property to the list. The

Add Property Field dialog box will open.
Edit
Click this button to edit a property from the list. The

Edit Property Field dialog box will open.
Delete
Select one or several properties and click this button to

remove the selected properties from the list.
Note: Removing a property is permanent and
cannot be undone. If you click Cancel after
removing a property and then reopen the tab, the
removed item will not appear.
Add/Edit Property Field dialog box

Use this dialog box to add a new property to the list or edit selected one.
Option
Description
Server
Choose a server type from the drop-down list of the

available types.
Name
Enter the property name or select the property from the

drop-down list of standard properties associated with
the server. The entered name must have the following
form: [namespace]name, where [namespace] is some
string that should end with ":" symbol. This string is
interpreted as a namespace. Namespaces vary depending
on the server type. The common namespace for the
servers that support WebDAV (Distributed Authoring
and Versioning Protocol for the World Wide Web) is
"DAV:". The possibility to configure standard properties
of "DAV:" namespace depends on the specified WebDAV
server properties. It is mandatory to fill out this field.
Note: If you specify the property name as
"[namespace]name, the resulting property on
the WebDAV server will have the following
form: "[namespace]:name"; that is ":" symbol
will be inserted between namespace and
name. For example, if you specify "My:time"
or "DAV:displayname" properties, these
properties will look like "My::time" or
"DAV::displayname" on the WebDAV server.
1368
Option
Description
Description
Displays the property description if you choose one of

the standard properties associated with the server.
Value
Enter the value of the property. The component verifies

whether the entered value is applicable for the property
and can be used in combination with the other properties.

WebDAV component RRTs
Component RRT ID
The RRT ID for this component is DAV.
The following table describes the reserved RTN values for the component:
RRTN
Description
FileName
Counter

FileExt
DocumentURL
URL of the document stored in the WebDAV server. This

RRT is present only for eConnector component and is
available to the subsequent components in the workflow.
Here is the sample use case of the RRTN:

~DAV::FileName~~DAV::Counter~~DAV::FileExt~ will be replaced by "MyDocument2.txt", if the
original file name is MyDocument.txt, and MyDocument1.txt file already exists in the output folder.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
1369
SSRTN
Description
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Here is the sample use case of the SSRTN:

~DAV::Y~-~DAV::m~ can be replaced by 2010-06.
There may be instability while working with big size files. The maximum limit is about 50-100 Mb and it depends
on the parameters of the computer and the WebDAV server limitation.
When you use the WebDAV component to send files to the SharePoint server and the type of the sent files
differs from the type specified for the SharePoint document library, the unique file name cannot be guaranteed
when using ~DAV::Counter~ RRT, hence the documents can be overwritten. In this case you should use an
additional method to guarantee a unique file name; for example, using SSRTN in the rename schema.
Problem Description
The NT Authentication check box is selected the
General tab, and the error message Cannot connect
to #Server# appears, where Server is the name of
the selected WebDAV server.
Solution
Try to use the WinHTTP proxy configuration utility
Proxycfg.exe to set the WinHTTP proxy configuration
settings correctly. To enable NT authentication between
Client (computer with the WebDAV component)
and Server (computer with WebDAV server), at the
command prompt of the Client type,
proxycfg -p proxy_server " <local> ; domain "
where proxy_server is the name of the computer
with the proxy server. If there is no proxy server in
the network, specify some other computer name.
Execute this command. For details about using the
ProxyCfg.exe tool, see Netsh.exe and ProxyCfg.exe
Proxy Configuration Tools in the MSDN library.
Note: When you use this method, there may
be problems with connection to the WebDAV
server when using an IP-address specified by
the WebDAV Server option on the General tab.
1370
Problem Description
The Status monitor shows the following message:
Error WebDAV Route: Cannot set file
properties. The file is not sent to the WebDAV
server.
Solution
Probably, you have set a property which is not applicable
to the specified server or some property is read-only and
cannot be configured. Contact you server administrator
to make sure that the configured properties are applicable
to the specified WebDAV server and are not read-only.
When you use many processes with the component at the The issue is connected with high load of the IIS
same time, not all of the processed files are routed to the server where the WebDAV server is located. For
output folder.
more information see Microsoft KB article 831711
(support.microsoft.com/kb/831711): FIX: A WebDAV
request to IIS causes a 500 internal server error.
The Status monitor shows the following messages:
Send file request failed with status
= 414; status text = 'REQUEST URI TOO
LONG'
Cannot route <filename> to <URL
address>. Please make sure that your
access rights, WebDAV folder URL, user
name and password are correct
These messages appear when you are trying to upload

the file of the format that is not supported by the
WebDAV folder (for example, some non-document type
like .exe, .chm, .dll). Do not try to upload the files of
non-supported formats.
The file is not sent to the WebDAV server.
Workflow Tracker
Welcome to Workflow Tracker component
Use this component to track and archive your workflow activities. This component tracks events and workflow
activities by storing indexing information retrieved from documents into ODBC compliant database tables for long
term archival and record keeping.
This component does not store documents into a database.
Getting started
Feature highlights
Select from multiple data sources in which you want to store indexing data.
Select multiple tables in which you want to store field values.
Uses user name and password for access security.

The most common use of this component is for tracking and archival of your workflow activities. This component
tracks events and workflow activities by storing indexing information retrieved from documents into ODBC
compliant database tables for long term archival and record keeping. This component does not store documents into a
database.
This component can use RRTs generated from any component in the workflow process. Prior to designing a
workflow, you must consider the available RRTs and their usage for workflow tracking purposes. Examples include:
Cost accounting by tracking of user menu usage on the MFP and copier devices. Setup this component to log a
record per menu option selected by a user.
Cost recovery by tracking of activities related to files routed to LAN Fax server. Log the associated billing codes
used in fax operations.
1371
Configuring the Workflow Tracker component

Workflow Tracker dialog box
Option
Activate
Description
Select this check box to enable the Workflow Tracker
process component. This check box provides a threestate activation. The three states for the Activate option
are:
State
Appearance
Description
Active (selected)
The component
is active for all
workflow jobs.
Inactive
(cleared)
The component
is inactive for all
workflow jobs.
Conditionally
active
The component
becomes active
only if the
conditional
statement is
True.
The Activate check box is useful when your process

involves creation of device function keys. This
component can be turned ON or OFF per device function
key by selecting or clearing the Activate check box.
Add
Click this button to add open the Data Source dialog

to add a data source. For more information, see Data
Source dialog box.
Modify
Click this button to change the data source attributes.
Remove
Click this button to delete the selected data source.
Expression dialog box

Use the expression dialog box to enter a conditional expression to activate the Workflow Tracker component.
Option
Checked on if
Description
Drag an RRT from the Available RRTs dialog box

into the first text box. The test will be made using the
value returned by the RRT at run time.
Choose a comparison operator from the operator list.
= equal to
! not equal to
> greater than
< less than
>= greater than or equal to
<= less than or equal to
1372
Option
Description
Enter the value to be test against in the second text

box.
Data Source dialog box

Use this dialog box to configure and activate a dialog box.
Click the Add button in the Workflow Tracker dialog box opens this dialog box.
General tab
Option
Activate
Description
Select this check box if you want specified fields placed
into the data source based on a condition. This activation
button offers three states.
State
Appearance
Description
Active (selected)
The data source

is active for all
workflow jobs.
Inactive
(cleared)
The data source

is inactive for all
workflow jobs.
Conditionally
active
The data source

becomes active
only if the
conditional
statement is
True.
Data Source
Provide the data source name that you want to save

workflow activities in (for example, Microsoft Access).
User Name
Enter the user name to log in to the data source
Password
Enter the password to log into the data source.
Table Name
Select the table to which you want to connect. This is a

required field.
Fields tab
This tab lists field listed from the table specified by Table Name on the General tab.
Option
Description
Name
Specifies the name of the field.
Type
Specifies the type of the field.
Value
Enter the desired value for the field. Use the RRT
Popup window to drag and drop desired values.
1373
Workflow Tracker component RRTs

If you need to create a database table, you should do so from within the database and create the tables from there. You
cannot create tables dynamically from this component.
The Data Source and Table Name specifications in the Workflow Tracker settings are mandatory and must be
configured.
Error displayed when selecting the Table browse buttonYou either do not have a valid user name and password, or
you have not entered a valid data source. Make sure that the data source specified in the Workflow Tracker settings is
connected and configured properly.
Worldox
Welcome to the WORLDOX component
WORLDOX route and eConnector components are used to copy documents into the directories of WORLDOX,
an enterprise-capable document management system from World Software Corporation. Supported versions of the
WORLDOX software are WORLDOX GX , WORLDOX GX2 and WORLDOX GX3.
The component receives input files and configures output documents by adding WORLDOX metadata based on the
component's configuration, which includes settings for document's profile group, field values for each field of the
document profile and document relations.
Communication with the WORLDOX system is performed via WORLDOX API. Since the API does not validate
data, the component performs field length validation and table validation itself. If data validation or document
placement fails then the component rejects such document.
Getting started
Feature highlights
The component working process can be started without having WORLDOX client running. You can specify
Worldox user in the component configuration in order to connect to WORLDOX.
You can determine the document profile parameters such as description, additional comments and field values in
the component configuration.
The component performs field length validation for profile fields. If the validation fails, the component rejects
such document.
The component can set parent-child relations, defined on the Document Relations tab, for the output files. The
output document will be specified as a child document to another document in the same group of input documents
or to a file that already exists in a WORLDOX folder.
You can map all necessary network drives in the component configuration.
How to use the WORLDOX component

Use the component for a complete preparation of your documents for working with WORLDOX documentmanagement system. You can use the component for copying existing documents from your folders to WORLDOX
directories. You can also use it as a route component in a workflow, where documents are processed by one or several
process components and need to be stored into the WORLDOX system immediately after processing.
The following example illustrates how the component can be used: Scan documents from an MFP device, recognize
text from the scanned images and save text and image files directly into WORLDOX profile group:
1374
1. Design a workflow process with an MFP component corresponding to the selected type of MFP device, the
OCR component and the WORLDOX component.
2. Configure OCR to generate plain text output files.
3. Specify the desired WORLDOX profile group and the output folder corresponding to it in the General tab of
WORLDOX.
4. In the Document Profile tab, enter file description, additional comments and configure profile fields by selecting
field values of the routed documents.
5. In the Document Relations tab, select the Set another document as parent check box and set parent document
number to "-1".
6. In the Network drives tab, map the network drive to the specified Profile group folder.
7. When all three components are configured, start a process.
Now when the MFP user enters a pre-configured function key on the MFP's control panel, the scanned image is
recognized and routed directly into the specified WORLDOX profile group with the corresponding text file as a child.
Configuring Worldox
Tab
Description
General Tab
Use this tab to define general settings concerning

WORLDOX user information, profile group and the
name of the output document.
Document Profile Tab
Use this tab to configure metadata associated with the

document or WORLDOX document profile.
Document Relations Tab
Use this tab to specify the WORLDOX document

"parent-child" relations of the output files.
Network Drives Tab
Use this tab to configure all the necessary mapped

network drives for a proper operation of the component.
General tab
Use this tab to define general settings concerning WORLDOX user information, profile group and the name of the
output document.
Option
Description
Activate
Select this check box if you want to store captured

document into the WORLDOX system. If this check box
is not selected, the component won't perform any actions
during file processing. This check box is present only in
the eConnector component configuration window.
Pass-through
this check box is present only in process component

to pass the documents to the subsequent components in
the process.
Worldox user
In this section you can set the parameters that allow you
to start the component working process without starting
the WORLDOX client. In the first field, select a user
identification method. If you use Specify user code, you
must enter WORLDOX user code in the second field.
If you select System user, the component will try to
connect to WORLDOX using your system login name.
In this case the second field becomes disabled. If you use
1375
Option
Description
Specify user code and leave the second field empty, the
component will be able to work only if the WORLDOX
client has been already launched. You can define user
code via RRT.
Note: In general case it is recommended to
start the WORLDOX client before starting the
process to avoid WORLDOX API failure.
Reconnect
Click this button to check the connection to the

WORLDOX server. If the connection can be established,
the component displays the following message:
Worldox client software initialized
successfully.
Note: If the WORLDOX client software was
started previously, the current WORLDOX
client credentials are used for initialization in
the following situations:
When you select Specify user code in the

first field of the Worldox user section and
leave the second field empty.
When you enter some value that is neither
Specify user code nor System user in the
first field.
If the WORLDOX client software is not running

and you enter some value that is neither Specify
user code nor System user in the first field
of the Worldox user section and click the
Reconnect button, the component will not be
able to connect, and an error message will be
displayed.
Profile group
This group allows you to determine profile group for the

document.
In the first field you can select one of two methods of
determination:
For output folderThe profile group is determined

by its base folder entered in the Output folder field.
Specify identifierYou can enter the profile group
identifier in the second field and the third field will
display profile group name. Alternatively, you can
click the browse button

to select one of the
profile groups available for the currently logged
WORLDOX user in the Select Profile Group dialog
box. You can use RRT in this field.
Output folder
Specify the output folder. You can use RRTs in this field.
You can also select one of the special values by clicking
.
The special values are:
1376
Option
Description
Base folder for the profile group, determined at run

time.
Network drive mapped to the base folder for the
profile group, determined at run time.
Network resource path of the drive mapped to the
base folder for the profile group, determined at run
time.
Output folder corresponding to the documents
profile (field values), determined at run time.
Currently available base folder for the specified
profile group.
Currently available network drive for the specified
profile group.
Currently available network resource path for the
specified profile group.
Auto name
Select this check box if you want the component to

automatically set the names for new documents. The
auto name represents an automatically generated
document ID number. The document ID format is
configured in WORLDOX system settings.
Rename file
By selecting this check box, the user can specify file

name for the output document using Renaming schema
field. This field can contain RRTs.
Replace existing file
Selecting this option makes the component overwrite the

existing file with the same name in the output directory.
Add as new version
Selecting this check box causes the output file to be

written and saved as a new version of the existing
file. The existing file will be preserved as the older
WORLDOX's version of the file. WORLDOX allows
you to create up to 15 file. If this option and the Replace
existing file option are turned off, the document will be
rejected in the case if a file with the same name already
exists in the output folder.
Select Profile Group dialog box

Use this dialog box to select one of the available profile groups for the user.
Option
Description
Current user
Displays current WORLDOX user name and user code.
Select one of the available profile groups
Displays the list of the available profile groups for the

user.
Network map
Displays network drive mapped to the base folder for the

selected profile group.
Document Profile tab

Use this tab to configure metadata associated with the document or WORLDOX document profile.
Option
Description
Description
Enter the description of the document.
1377
Option
Description
Additional comments
Enter additional comments to the document.
Fields
Create a list of the Profile fields. To do so, use the Add

and the Edit buttons. This list can contain up to 7 fields
determined by the profile group.
Add
Click this button to add a new field to the profile field

list. This opens the Add Field Value dialog box.
Edit
Click this button to edit a field value from the

document's profile field list. This opens the Edit Field
Value dialog box.
Remove
Select one or several fields and press this button to

remove the selected fields from the document profile.
Edit Field Value dialog box

Use this dialog box to edit a field value from the document profile fields list.
Option
Description
Field
First field in this section displays the selected field

number. The second field displays the selected field
description.
Field value source
Use the combo-box to choose one of four alternatives:
Specified value
Determine default for saving at runtime
Determine default for copying at runtime
Determine default for moving at runtime
Note: If one of the last three options is selected,
then the component will determine default value
at run time. In this case the Specified value
field becomes disabled.
Specified value
If you have selected the Specified value option for

the Field source value, enter field value manually or
click . This button brings up a menu with following
alternatives:
Default for saving

Default for copying
Default for moving
Select value from the table
First three items fill the Specified value field with the
defaults currently available to the Worldox user. The
last alternative opens the Select Field Value dialog box.
This dialog box displays an available field table for the
currently configured field. You can select a value from
the table. If there is no field table for the selected field,
the menu will contain only first three alternatives. You
can use RRT in this text box.
Value description
Displays description of the Specified value, if the value

is a table item.
1378
Option
Field flags
Description
Displays some information about the options of the field.
The options cannot be selected by the user, they are the
settings for the selected profile group.
Add Field Value dialog box

Use this dialog to add a field value to the document profile fields list.
Option
Description
Field
In the first field in this section you can select a new field
number. The second field displays the selected field
description.
Field value source
Use the combo-box to choose one of four alternatives:
Specified value
Determine default for saving at runtime
Determine default for copying at runtime
Determine default for moving at runtime
Note: If one of the three last alternatives is
selected, the component will determine default
value at run time. In this case the Specified
value field becomes disabled.
Specified value
If you have selected the Specified value option for the

Field source value, enter the field value manually or
click . This button brings up a menu with following
alternatives:
Set default value for saving

Set default value for copying
Set default value for moving
Select value from the table
First three items fill the Specified value field with the
defaults currently available to the Worldox user. The
last option opens the Select Field Value dialog box.
This dialog box displays an available field table for
the currently configured field. You can select a value
from the table. If no field table for the selected field is
available, the menu will contain only first three options.
Value description
Displays a description of the Specified value, if the

value is a table item.
Field flags
Displays some information about the options of the field.

The options cannot be selected by the user, they are the
settings for the selected profile group.
Select Field Value dialog box

Use this dialog to select a value from the profile field value table.
Select field value from the tableThis table corresponds to the WORLDOX profile field value table for the
selected field. It contains the value code column and the value description column. Select a row from the table and
click OK to set the value for the currently configured field.
1379
Document Relations tab

Use this tab to specify the WORLDOX document "parent-child" relations of the output files.
Option
Description
Set another document as parent
Select this check box to specify the output document as

a child document to another document in the same group
of input documents. This option can be useful, if in the
workflow the WORLDOX component is placed after the
component that generates several output files.
Parent document number
You must enter the index of the parent document in

this field. A positive number is considered as an index
number of the file in the input documents list. A negative
number is considered as a reverse-order number : -1 for
the last (Nth) document, -2 for the last but one document,
etc. If the specified number is out-of-bounds (is greater
than the number of input documents), then no relation
will be set. If the parent file is the document which has
not been placed yet, the component delays relationship
until the parent file is placed into the output folder. For
example, when the WORLDOX component follows
after the OCR component in the workflow, the original
image can be set as a "parent" document to the
generated text files.
Set file as parent
Select this check box to specify the output document

as a child document to a file that already exists in a
WORLDOX folder. User should specify parents file
path (including directory and file name). This field can
contain component RRTs. If the parent file is the same as
the child file, the component does not set relation.
Set relation only if parent exists
This option is available only if you choose the Set file

as parent option. When the option is turned off and the
selected file does not exist in the specified folder, the
component delays relationship until the parent file is
placed into the specified folder. If the option is on, the
relation is not set.
Network Drives tab

Use this tab to configure all the necessary mapped network drives for a proper operation of the component.
A network drive with WORLDOX server and a network drive containing base profile group folder should be mapped.
Option
Map network drives
Description
Displays the list of mapped network drives. If some
network drives have already been mapped without the
use of the component configuration, it is not necessary
to add them to the Map network drive list. In this case
you have to make sure that the Workflow service user
has access to these drives.
Note: In general case it is recommended to
add already mapped network drives to the Map
network drive list.
Add
Click this button to map a new network drive. This opens

the Add New Network Drive Mapping dialog box.
1380
Option
Description
Clicking this button is equivalent to double clicking
the Map network drives field when no network drive
selection is made.
Edit
Click this button to edit mapping parameters of the

selected network drive from the list. This opens the Edit
Network Drive Mapping dialog box. Clicking this
button is equivalent to double clicking the selected drive
in the Map network drives field.
Remove
Select one or several network drives and press this

button to remove the selected network drives from the
list.
Add currently mapped drives
Click this button to open the Select Network Drives

dialog box, which displays the list of currently mapped
drives. In this dialog box you can select one or more
currently mapped drives and add them to the list.
Network drive user authentication
Enter user credentials necessary for mapping network

drives.
Use current user credentials
Selecting this option causes the component to use current

user authentication parameters for Workflow service. If
this option is not selected, you must enter user name and
password.
Select this option if you want to specify the password

through RRTs.
Add New Network Drive Mapping dialog box

Use this dialog box for mapping a new network drive.
Option
Description
Drive letter
Enter the letter for naming new network drive; for

example, Z:.
Resource path
Enter the path to a resource corresponding to a new

network drive.
Use distinguished authentication settings for this

drive
Select this option to determine credentials in the This

network drive mapping authentication section. If this
option is not selected, the section is disabled.
This network drive mapping authentication
In this section you can enter user credentials necessary

for the network drive mapping. If you select Use current
user credentials, the component uses current user
authentication parameters for component service.
Otherwise, you must enter the user name and password.
With checking the Obtain password via RRT option
you can use one or several component RRTs for
password determination.
1381
Edit Network Drive Mapping dialog box

Use this dialog box for editing mapping parameters of the currently mapped network drive.
Option
Description
Drive letter
Displays the letter corresponding to selected network

drive.
Resource path
Enter the path to the resource corresponding to a new

network drive.
Use distinguished authentication settings for this

drive
Select this option to determine credentials in the This

network drive mapping authentication section. If this
option is not selected, the section is disabled.
This network drive mapping authentication
In this section you can enter user credentials necessary

for the network drive mapping. If you select Use current
user credentials, the component uses current user
authentication parameters for component service.
Otherwise, you must enter the user name and password.
With checking the Obtain password via RRT option
you can use one or several component RRTs for
password determination.
Select Network Drives dialog box

Use this dialog box to select one or more currently mapped drives and add them to the list.
Select one or more network drive mapping - this table presents a list of currently existing mapped network drives.
The columns are: drive, network resource and configured mapping. Select one or more table rows and press OK to
add them to the list of mapped network drives in Network Drives tab.
WORLDOX component RRTs
Component RRT ID
The RRT ID for this component is WRC.
This component supports two groups of the reserved RTNs:
Table 62: File specific RRTNs

Name
Description
FileName
The original file name
FileExt
The original file extension
Counter

names found within the directory. The counter value
concatenated with the name provides a unique file
name.
Note: ~WRC::Counter~ can only be used in the Renaming schema field.
1382
Table 63: Profile group specific RRTNs

Name
Description
BaseFolder
Base folder for the profile group
NetworkDrive
Network drive to which the base folder for the profile

group is mapped
NetworkPath
Network resource path where the base folder for the

profile group is located
ProfileFolder
Output folder corresponding to the documents profile

(field values)
Note: Replacement of the Profile group specific RRTs is performed after the Document Profile settings
have been loaded and the profile group determined. These RRTs can be used inside the Document Profile
settings only if you select Specify identifier for profile group determination on General tab. If you use
the For output folder method, these RRTs cannot be used inside the Document Profile settings.
~WRC::BaseFolder~~WRC::FileName~.~WRC::FileExt~ is replaced with the value M:\image1.tif if the
base folder for the profile group is M:\, and the input file is image1.tif.
Name
Description
Day
The day of month (131) when the file was placed into
WORLDOX
YearDay
The day of year (1366) when the file was placed into
WORLDOX
Hour12
The 12-based hour (112) when the file was placed into
WORLDOX
Hour24
The 24-based hour (023) when the file was placed into
WORLDOX
Locales
A.M./P.M indicator for 12-hour clock when the file was

placed into WORLDOX
Minutes
The minute (0059) when the file was placed into

WORLDOX
Month
Full (JanuaryDecember) month when the file was

placed into WORLDOX
MonthAbbr
Abbreviation (JanDec) month when the file was placed

into WORLDOX
MonthDigital
Digital (112) month when the file was placed into

WORLDOX
1383
Name
Description
Seconds
The second (0059) when the file was placed into

WORLDOX
WeekDay
Full (SundaySaturday) when the file was placed into

WORLDOX
WeekDayAbbr
Abbreviated (SunSat) week day when the file was

placed into WORLDOX
WeekDayDigital
Digital (06) week day when the file was placed into
WORLDOX
WeekSunday
The number of the week in year (153) when the file

was placed into WORLDOX (Sunday is the first day of
week)
WeekMonday
The number of the week in year (153) when the file

was placed into WORLDOX (Monday is the first day of
week)
Year
Full 4-digit year when the file was placed into

WORLDOX
Year2Digit
2-digit (0099) year when the file was placed into

WORLDOX
Example of the SSRTN includes:

~WRC::%Y~-~WRC::%m~ will be replaced by 2010-06.
The last WORLDOX GX build the component was tested with is 5C6.941.E04 SR1.
The last WORLDOX GX2 build the component was tested with is 5DE.C01.00E 11.0.
The last WORLDOX GX3 build the component was tested with is 6F.F8A.CF2. 11.0.
The component's service should have all permissions required to communicate with the WORLDOX software and
to access the output folders.
The user must have a user code for identification in WORLDOX system. The user code will be checked for
validity during the document processing.
The network drive with WORLDOX server and the network drive containing base profile group folder must be
mapped.
Problem description
Solution
The component does not generate an output file. Status

The component service may not have connection to
Monitor displays the following message: "Worldox failed WORLDOX system. If you used the Specify user code
to initialize API. Error: Operation failed".
connection method in the General tab, the entered user
code may be incorrect. Check it and enter correct user
code. Click the Reconnect button to make sure that the
connection was successful.
If you used the System user method, your system login
name may not belong to a Worldox user codes list.
1384
Problem description
Solution
Contact your WORLDOX administrator or try another
connection method.
Status monitor displays the correct operation of the

component but there are no files in the output directory.
Maybe data validation has failed and output file has

been rejected. The field length of some profile field
may be incorrect. Check if the profile field values in the
Document Profile settings have a proper length.
"Parent-child" relations are not set when you use the

option.
The specified number of the parent document may be

out-of-bounds. It means that its absolute value exceeds
the number of input documents. Enter the correct parent
document number.
"Parent-child" relations are not set when you use the Set
another document as parent option on the Document
Relations tab.
1. The parent file is the same as the child file. Use

another file as a parent.
2. If the Set relation only if parent exists option is off,
and the selected file does not exist in the specified
folder, place the selected file into the specified folder,
and the component will set relationship.
3. If the Set relation only if parent exists option is on,
and the selected file does not exist in the specified
folder, the relation cannot be set. Use an existing file
in the folder as a parent.
The document profile parameters determined with the

use of RRTs are empty or not replaced.
Maybe you used profile group specific RRTs for

document profile parameters determination and the
Profile group specified on the General tab was
determined with the For output folder method. You
may use these RRTs for document profile settings only if
the Profile group is determined by the Specify identifier
method. Change the profile group determination method
or do not use these RRTs inside the settings on the
Document Profile tab.
Add as new version option on the General tab is on, but Probably there are already 15 versions in the output
the new version of the output file does not occur in the
folder, thus WORLDOX limitation has been exceeded.
output folder.
Specify another output file name.
No file is placed into the output directory. Status monitor
displays the following message: "Worldox failed to copy
file name to ". Error returned: destination file already
exists", where .name is output file name with the path.
Maybe the file with the same name already exists in

output directory and neither the Replace existing file,
nor the Add as new version options on the General tab
is selected. Select one of the options.
When you send files with .tmp extension, the Status

Monitor shows the following message: "Worldox failed
to set document profile. Error returned: Cannot get first
item in the list." and the file is rejected.
The .tmp extension is related to the internal WORLDOX

file format; therefore, files with this extension cannot be
processed correctly. Try to change the file extension.
~WRC::ProfileFolder~ RRT fails to be

generated or is generated incorrectly. For example,
if ~WRC::BaseFolder~ is Y:\ and the profile has
two subdirectory fields: FLD13 and FLD23, then the
~WRC::ProfileFolder~ is replaced with Y:\
instead of Y:\FLD13\FLD23\. This behavior has irregular
nature and depends of background programs running, set
of input files, and so on.
This problem is connected with WORLDOX API

software instability. To improve stability of WORLDOX
API it is recommended to make sure that there are no
viruses in the system and remove all background file
scanners; that is, indexing services, real time virus
scanner, and so on. However in some situations this does
not help.
1385
Problem description
Solution
To avoid this problem do not use
~WRC::ProfileFolder~ RRT in the Output
folder field on the General tab. Instead this field
should contain manually-formed output path. For
example, if the selected profile contains two subfolder
fields FLD13 and FLD23, then the output folder
should contain ~WRC::BaseFolder~FLD13\FLD23.
Although this will not prevent warnings about
~WRC::ProfileFolder~ RRT, all documents will
be processed correctly.
Sometimes, when the component configuration dialog

opens, the component service window hides under
another window.
This problem is not critical and is related to the RRT

window that is displayed before the component
configuration dialog. The problem can be resolved by
minimizing another window.
When network connection to the WORLDOX GX

server is broken during processing, after restoration
the component refuses to process files and writes
error messages into the log. Windows displays error
messages about failure of WAAPI.EXE or Worldox API
Controller.
The problem is related to the WORLDOX GX API

unstable work in case of network connection failures.
Depending on the operating system and workflow
environment, one of the following work-arounds can be
used to avoid this issue:
1. The Workflow service is running while the user
logs on the machine. In this case it is recommended
to permanently have WORLDOX client software
running on the machine).
Note: This approach does not necessarily
resolve the issue if the Workflow service is
running on Windows 2000.
2. The Workflow service is running while there are
no users logged on the machine. If the operating
system on the workflow machine is Windows XP or
Windows 2003, it is recommended to disable error
reporting and notifications about critical errors (on
the Control Panel->System->Advanced tab->Error
Reporting dialog). No recommendations can be
given in case of Windows 2000, though the correct
processing is usually restored after 5-10 minutes.
When you use the Auto name option on the General

tab, the file is not placed into the output directory and the
Status Monitor shows the following message: "Worldox
failed to produce automatic file name for the output
directory path. Error returned: Operation failed",
where path is the output folder path.
WORLDOX software may be configured incorrectly

to produce auto name for the routed file. Apply to
WORLDOX administrator or use the Rename file option
instead of the Auto name option.
Status monitor shows the following message: "Worldox There may be a problem with the output folder, for
failed to copy file name to ". Error returned: Operation example, the place limit may be exhausted.
failed.". The file is not placed to output folder or placed
If the file size is rather big, the reason may be in
with incorrect profile.
WORLDOX API feature that concerns copying files
of a size about 600Mb and larger. In this case the file
profile is not created correctly even if the file is correctly
copied. Try to decrease the size of the file.
1386
Xerox EIP Connect

Welcome to the Xerox EIP Connect component
The Xerox EIP Connect component allows you to capture documents from any Xerox device that is custom services
(EIP) enabled, and send the documents to any of the route destinations that are supported by the Workflow server.
When scanning documents with the MFP, users can provide information about the documents that can be used to
identify and route the documents appropriately.
The Xerox EIP Connect component provides the following features:

Support for Tree, List, Text, Checkbox, Numeric, Date and Lookup List field types to provide document indexing
flexibility.
destination.
Forms are extensible through VB.net. You can create more interactive forms and validate before a document is
Device Setup & Configuration Prerequisites
Vista Enterprise Edition
Vista Enterprise Edition

1. Install ASP.NET.
2. In Windows Control Panel, open Programs and Features.
1387
3. Click Turn Windows features on or off.

4. In the Windows Features dialog box, select the check box next to ASP.NET.
5. Click OK.
6. Complete the installation.
Supported devices
For a current list of supported devices visit the Xerox MFDs page on the Notable Solutions website.
Using the Xerox EIP Connect component
You can design custom scanning processes for Xerox devices to capture, process, and route documents. These
processes include the Xerox EIP Connect capture component. To add the Xerox EIP Connect component to a
workflow, expand the Capture section of the Toolbox, and drag the Xerox EIP Connect component to a task in the
AutoStore Workflow Process Designer window.
For additional information about how to create a process, refer to the Process Designer section of the AutoStore
Process Designer help.
Configuring the Xerox EIP Connect Capture component
The procedures in this section describe how to configure component level settings and authentication.
The Xerox EIP Connect capture component settings determine the behavior of the component of a workflow as well
as default settings for the component groups, menus, and forms.
How to configure Preferences settings
1. If necessary, double-click the Xerox EIP Connect component in a workflow to open the Xerox EIP Connect
3. In the Home Directory box, enter the path to the root directory where the server will create all temporary
directories and files necessary for running the application.
5. Optional: To use a secure connection between devices and the AutoStore server, select the Use SSL check box.
a) In the Choose Certificate box, click to browse for an existing certificate or to create a new self-signed
certificate.
b) In the Certificate Password box, type the password for the certificate.
If you created a self-signed certificate, the password you provided when creating the certificate is entered
automatically.
6. In the FTP Port box, enter the port on which the internal FTP service will use to communicate with the device.
Note: When Use SSL is selected, the SSL port for some models must be set to 443 to display the the
selected AutoStore icon and the description for the EIP service on the device panel. If the SSL port is set
to different number, the default Xerox logo will display along with ????? instead of the expected service
description.
7. To configure logging and passive FTP options for the FTP server, click the Advanced button.
a) To enable logging for the embedded ftp server, select the Enable Log check box, then in the Directory box
enter the path to the directory where the logs should be created.
b) In the Data Port Range box, enter the port range that will be used when receiving passive FTP connections
from a device. The default is ports 35000 through 49000.
This must be configured on any device that you want to connect using passive FTP mode. By default devices
are configured to use active FTP.
c) Click OK to save changes to settings in the Advanced Server Settings dialog box.
8. In the Keep settings, configure whether to retain processed and rejected files.
1388
Select this check box

Processed Files
To do this
Retain copies of all files that are processed without
errors. Enter the path to the folder where you want to
keep these files.
Warning: If you enable this option, a copy of
saved in the Processed Files directory. Make
sure that sufficient disk space is allocated
when using this option.
Rejected Files
Retain copies of all files that are not successfully

captured. Enter the path to the folder where you want to
keep these files.
9. Optional: If necessary, set up Additional Temporary Repositories.
To use a folder on an FTP server as a temporary repository for storing images scanned at the device, select the
Local FTP check box, and then configure the FTP server settings for the folder.
Note: To specify this FTP folder when enabling authentication at the group level, select External
FTP for Temporary Repository in the Group Settings dialog box. For more information, see How to
Enable Group Level Authentication.
To use a network shared folder as a temporary repository for storing images scanned at the device, select the
Network Share check box, and then configure the host settings for the shared folder.
Note: To specify the network share when enabling authentication at the group level, select External
SMB for Temporary Repository in the Group Settings dialog box. For more information, see How to
Enable Group Level Authentication.
How to register devices

Device registration options allow you to register AutoStore on devices. Device registration groups allow you to
specify default administrator credentials for a group of devices so that you can quickly register multiple devices
without logon errors.
Through the device registration component, you can:

Adding multiple devices
2. Click the Device Registration tab.
3. Click the Start Registration Manager button.
Define custom registration groups:
4. Click Add Registration Group on the menu bar to open the Edit Device Group dialog box.
Note: This dialog box opens initially when there are no device groups.
5. For Device Group Name, enter the name for the registration group.
6. For Connect to Server using Address, enter either the name or IP address of the machine where the workflow
server is installed.
7. For General Device Access Settings, enter the Admin User name and Password.
1389
8. In the Get Community Name box, type public or private to match the GET Community Name SNMP
configuration value specified on devices in the group.
9. In the Set Community Name box, type public or private to match the SET Community Name SNMP
configuration value specified on devices in the group.
10. Click OK to save your changes in the Edit Device Group settings dialog box.
Add device to registration group:
11. Click Add Device to open the Add Device dialog box.
12. For Device Address, enter either the name or IP address of the device.
13. To use access settings configured the group, select the Use Group Access Settings check box and skip to step 17
on page 1390.
14. Enter Admin User name, Password, and AutoStore menu position for the device.
Note: The AutoStore menu position determines where the AutoStore icon will appear in the list of
external applications by the MFP.
15. In the Get Community Name box, type public or private to match the GET Community Name SNMP
configuration value specified on the device.
16. In the Set Community Name box, type public or private to match the SET Community Name SNMP
configuration value specified on the device.
17. Click OK to save changes to settings in the Add Device dialog box.
Register devices
18. In the Device Registration dialog box, select the registration group to be registered.
19. Click Register on the menu bar.
You must ensure that the AutoStore icon is placed in the correct menu position on each MFP. This action will
effectively overwrite previous values.
You will see a status bar at the bottom of the window, which will display the number of devices that were
successfully registered.
Adding multiple devices:
You can open a comma separated list of device addresses parameters into the Registration Manager. For details about
the device list format, see Import Device List.
20. In the Device Registration dialog box, click the device group to which you want to import devices
21. click the Import Device List hyperlink.
22. In the Open dialog box, specify the CSV file that contains the list
23. Click Open.
How to enable authentication for the component
Enable authentication for the Xerox EIP Connect component in a workflow to allow authentication for all groups,
forms, and menus that are defined on the component. When authentication is enabled for the component, you can still
enable or disable authentication at the group, menu, or form level.
1. If the Xerox EIP Connect settings dialog box is not open already, double-click the Xerox EIP Connect
component in the workflow.
Authentication Type
None
Windows
Description
1390
Authentication Type
Description
is also displayed.
Netware
Specifies to use a Novell NetWare authentication

server. Under Netware, enter the default NDS tree in
the NDS Tree box and the default Novell context for
NetWare authentication in the NDS Context box.
type NDS, then the provided credentials
NDS, then in addition to workflow server
login screen, the device authentication screen
is also displayed.
Custom Script

lookup data.
In the Script File Path box, enter the full path to the
script file.

button (...).
script code.
in the script editor to refer to the Xerox EIP Connect

1391
address is needed.
5. When you finish editing the Xerox EIP Connect component settings, click the OK button to save your changes.
How to restrict access to menus and forms using Xerox Secure Access
To restrict access to groups and menus using Xerox Secure Access, use the following steps:
Enable Authentication for the Xeriox EIP Connection Component:
1. If the Xerox EIP Connect configuration dialog is not open already, double-click the Xerox EIP Connect
3. In the Authentication Type box, select Windows.
4. Type the default domain in the Domain box.
The domain must be the same domain as used by the external authentication agent. Do not use the fully qualified
Domain Name Server (DNS) domain name or top level domain qualifiers such as .com, .net or .org.
For example, if the user is listed as mydomain/user1 or user1@mydomain.domain.com, then type mydomain, not
mydomain.domain.com.
6. Click the group where the authentication settings will be configured, and click Edit on the menu bar to open the
Group Settings dialog box .
8. Select the Requires Authentication and Use Global Authentication Settings check boxes.
Restrict access to menus or forms:
11. Click the menu or form that you want to edit, and click Edit on the menu bar.
12. Click Restricted Access.
13. In the Allowed Users/Groups box, enter the groups that will have access to the menu.
Use device authenticated credentials for a group:
16. Click the group that you want to configure, and click Edit on the menu bar.
18. Select the Query device Authentication session for credentials check box.
19. Click OK to save changes to the Group Settings, then click OK to save changes to the Xerox EIP Connect
settings.
Configure the agent:
20. On the Home tab of the AutoStore Workflow Process Designer ribbon, click Save to save changes to the
configuration.
21. Click Restart to restart the service.
The SMARTdocument Travel logon screen will not be displayed if Xerox Secure Access and the MFP are properly
configured.
Managing groups
Device groups allow you to apply different settings to different groups of devices.
A group applies menus and forms that will be displayed on the device panel. Authentication settings may also be
defined for a group. By default there is a single group called the Common Group. This group cannot be deleted. If you
do not configure additional groups, all devices will display the forms and menus that are configured for the Common
1392
Group. The Common Group will always use the default authentication settings that you configure for the Xerox EIP
Connect component. These options appear on the Authentication tab of the Xerox EIP Connect configuration dialog
box.
If you need to use separate sets of forms and menus on different devices, then you will need to create additional
groups and assign devices to them. This allows devices to be used for different functions. You can configure separate
authentication settings for a group or choose to use the default settings that you configure for the device. Even when
you create your own groups, my may still want to define menus and forms for the Common Group, as any device that
is not explicitly assigned to a group will belong to the Common Group.
How to add a group
Create a device group to configure forms, menus, and authentication settings for a particular group of MFP devices.
dialog box.
2. On the Groups tab, click Add Group on the menu bar.
This opens the Group Settings dialog box in which you can configure General and Authentication settings..
3. On the General tab, type a name for the group in the Name box.
This name does not appear on the MFP display and it is used strictly for identification purposes.
4. In the Associated MFP Addresses box, add the MFP devices that will be associated to this group:
For each device, type its IP address or host name in the blank row marked by the *.
The network name is preferable, because the IP address can change if you are using DHCP.

5. If the MFP devices in this group should authenticate the user, click the Authentication tab, and select the
Requires Authentication check box.
To configure authentication settings that only apply to the devices in this group, select an Authentication
Type and configure the options that are available for that type.
You can click the Help button for information about all of the options on the Authentication tab.
To use the default authentication settings that have been configured for the Xerox EIP Connect component,
select the Use Global Authentication Settings check box.
All Authentication settings are then unavailable except for the Query device authentication session for
credentials check box.
6. If workflow server should query the credentials of the user logged onto the device, then select the Query device
authentication session for credentials check box.
Tip: Click the Help button for more information about this option and how it behaves for the different
7. When you finish configuring settings for the group, click OK.
How to edit a group
You can edit properties for any existing group other than the Common Group.
dialog box.
2. On the Groups tab, click the Group that you want to edit.
3. Click the Edit button on the menu bar.
This opens the Group Settings dialog box.
4. You can change the setting for any General or Authentication option.
For additional information about options on either tab, click the Help button.
5. When you finish making changes, click the OK button.
1393
How to remove a group

Removing a group deletes the group and its device definitions and all menus and forms in the group.
You can remove any group except for the Common Group.
dialog box.
2. On the Groups tab, click the Group that you want to remove.
3. Click the Remove button on the menu bar.
4. When prompted whether to remove the group, click Yes.
How to enable group level authentication
You can enable and configure authentication for devices in a group.
A group uses the authentication settings if you do not enable authentication for the group.
dialog box.
2. On the Groups tab, click on the group and then click Edit on the menu bar.
3. Click the Authentication tab and select the Requires Authentication check box.
4. If you want to use the same authentication settings that were configured for the component, select the Use Global
Authentication Settings box, and then skip to step 7 on page 1395.
Authentication Type
None
Windows
Description
is also displayed.
Netware
Specifies to use a Novell NetWare authentication

server. Under Netware, enter the default NDS tree in
the NDS Tree box and the default Novell context for
NetWare authentication in the NDS Context box.
type NDS, then the provided credentials
NDS, then in addition to workflow server
1394
Authentication Type
Custom Script
Description
login screen, the device authentication screen
is also displayed.
lookup data.
In the Script File Path box, enter the full path to the
script file.

button (...).
script code.
in the script editor to refer to the Xerox EIP Connect

address is needed.
7. Optional: To query the device for credentials, select the Query device authentication session for credentials
check box.
8. Click the General tab.
9. For Temporary Repository, select one of the following:
Internal FTPThis option will use internal FTP settings for the component.
External FTPThis option will use the local FTP server that was configured for creating optional temporary
repositories by the Local FTP settings on the Preferences tab of the Xerox EIP Connect configuration dialog
box.
External SMBThis option will use shared network folder that was configured for creating optional
temporary repositories by the Network Share settings on the Preferences tab of the Xerox EIP Connect
10. In the Associated MFP Addresses list, add or remove devices to which you want to apply the new settings.
11. When you are finished editing the group, click the OK button.
How to add a menu
Menus allow users to access different forms for a workflow. A menu can be added to a group or menu.
dialog box.
2. On the Groups tab, click a group or menu item, and click Add Menu on the menu bar.
3. In the Menu Name box, type a name for the menu.
1395
The name must cannot match the name of another menu or form at the same level in the menu hierarchy.
4. Optional: To display an icon for the menu on the device console, enter the full path to an image file in the Icon
box.
Maximum size: 24 KB
5. If authentication is enabled for the group that contains the menu, then you can configure the Access Control
options to specify users who can use the menu:
Click this
To
Public Access
menu to use the menu.
Restricted Access
Limit access to specific groups or users.

Enter groups or users who can see the form in

For details on the object model used in authentication scripts see the Xerox EIP Connect Scripting
documentation.
How to restrict access to a menu

If authentication is enabled for a group, you can configure authentication for menus in the group to restrict or change
access to the menus.
1. If the Xerox EIP Connect settings dialog box is not open already, double-click the Xerox EIP Connect
2. On the Groups tab, click the menu you want to edit, and click Edit to open the Menu Properties dialog box.
3. In the Access Control settings choose the access you want to apply to the menu:
Access
Description
Public Access

group to use the menu.
Restricted Access

menu. Separate users or groups in this list with the
NoneAuthentication not used for the menu.
1396
Access
Description
authentication scripts, see the Xerox EIP Connect
4. When you finish configuring settings for the menu, click the OK button.
Adding and editing forms
Add a form when your workflow process requires capturing data prior to scanning. A form can be added at the group
or menu level.
The procedures in this section step you through managing forms for the Xerox EIP Connect component.
How to add a form
Add a form to collect information and pass it to a workflow.
2. Click the group or menu where you want to add the form. Then, on the menu bar, first click Add Form and then
click type of form that you want to create.
Form Type
Use to
Basic Form
Collect general information for a workflow.
Send documents to a DocuShare repository
Send to Email Form
Send documents to an email destination.
Send to Folder Form
Send documents to a folder.
Send documents to a SharePoint 2007 or SharePoint

2010 server.
Send documents to a Smarticket repository.
This displays the Form Settings dialog box with three basic tabs (General, Fields, and Components) plus the
form type tab for any type except the basic form.
3. In the Name box, type a name for the form in the Name.
For example, if a form is to send to the home directory for a user, then you can name it "Scan to Users Home
Directory".
4. Optional: To display an icon for the form on the device console, enter the full path to an image file in the Icon
box.
Maximum size: 24 KB
5. Optional: If you do not want the user to enter information about the document, select the Single Touch mode
check box.
1397
Selecting this option starts the scan immediately after the user presses the form button on the device without
prompting for further information.
6. If authentication is required for the group that contains the form, then you can configure the Access Control
options to specify users who can use the form:
Choose
To
Public Access
menu to use the form.
Restricted Access
Limit access to specific users or groups.

Enter groups or users who can see the menu in

NetwareGroup are not supported.
For details on the object model used in authentication scripts see the Xerox EIP Connect Scripting
documentation.
7. In the Scanning Settings box, configure default settings for scanning documents.
For additional information about each of the settings, see Basic Form.
8. To modify the standard behavior of a form by responding to events, select the Enable Dynamic Form check box,
and configure options for Dynamic Form.
For more information, see Enabling a Dynamic Form
9. Click the Fields tab, and add fields to the form.
For more information, see How to Add Fields to a Form.
10. Click the Components tab to activate and configure subsequent components in a workflow.
To activate or configure a component, click the browse button (...) in the

Components list.
(properties) column of the
For information about how to configure a component, click the Help button in a component properties window.
11. For any form type except the basic form, click the form-specific tab and configure type-specific properties for the
form.
For more information about properties on this tab, click the Help button.
12. Click OK when you finish configuring the form.
How to edit a form
This topic describes how to edit form settings, cut, copy, paste, delete, and reorder forms.
2. You can do any of the following:
To
Do this
Open the Form Settings

dialog box to edit a form.
Click the form to select it, then click the Edit on the
menu bar. You can also double-click a form.
1398
To
Do this
Cut or copy a form

shortcut menu.
Paste a cut or copied form
Right-click a group or menu, and click Paste on the

shortcut menu.
Tip: To quickly copy a form to another group
or menu, click and drag the form to the desired
location. This will not remove the form from
its original location.
Delete a form
button.
Reorder forms on menus
To change the order that forms are displayed on the

device panel, right-click the form, and click Move Up
or Move Down on the shortcut menu.
Save the form as a template
To save the form as a template for reuse in other menus

or groups, right-click the form and click Save As
Template on the shortcut menu.
For more information, see Saving a Form as a
Template.
How to restrict access to a form

If authentication is enabled for a group, you can configure authentication for forms in the group to restrict or change
access to the forms.
The form you want to edit must be open in the AutoStore Workflow Process Designer. See How to Edit a Form.
1. In the Form Settings dialog box, click the General tab.
2. In the Access Control settings choose the access you want to apply to the form:
Access
Description
Public Access

group or menu that contains the form to use the form.
Restricted Access

form. Separate users or groups in this list with the
NoneAuthentication not used for the form.

authentication scripts, see the Xerox EIP Connect
1399
To restrict access to groups and menus using Xerox EIP Connect Authentication Agent and SmartCard
authentication, see Restricting Access Using Xerox Secure Access.
3. When you finish configuring settings for the form, click the OK button.
How to enable a dynamic form
You can modify the standard behavior of a form by responding to events.
Editing a Form.
Some of the things you can do by enabling dynamic form are:

Change field contents, such as loading the contents of a list field from a database.
1. On the General tab of the Form Settings dialog box, select the Enable Dynamic Form check box.
events.
To use an existing script, click the browse button (...) to locate the script file. To edit the script, click the Edit
Script Code button.
To create a new script, click the Edit Script Code to open a Visual Basic Script template with empty
subroutines to respond to Form_OnLoad and Form_OnSubmit events.
For details about the script editor and the object model used to respond to create and handle events, click the
button in the Edit Script Contents window to view the Xerox EIP Connect Scripting documentation.
3. For Raise an event when, select form events that must be responded to by the script:
Option
Description
Form is loaded

Form is submitted

user presses Scan in the form.
4. To run under the authentication context of the logged on user, select the Run as device logged in user.
This option should be used carefully and only in cases where you need to access a system that requires
explicit identification. Whenever possible specify user names and passwords in your script. You can use .NET
technologies, such as encryption, to hide the passwords from view when editing the script.
Note: The Run as device logged in user option is only available if the when authentication is enabled for
the group that contains the form and the authentication mode is Windows.
How to add fields to a form
Add fields to a form to gather information from users and pass values from the form to subsequent components in a
workflow.
Editing a Form.
1. In the Form Settings dialog box, click the Fields tab.
2. In the Name column of the last row of the table, type the name of the field.
are not allowed. The maximum number of characters for this field is 64.
3. In the Display column, type an alternative text to represent the field on the MFP console.
If this column is left empty, then the field name will be displayed on the MFP console.
4. In the Type column, choose how the data for the field will be collected by selecting an option:
1400
Field Type
Allows users to
Checkbox
Set yes/no or true/false values by selecting or clearing a

check box.
Date
Enter date values based on selected date formats.
List
Present users with a list of choices from which users

Lookup List
Numeric
5.
6.
Dynamically retrieve values from an OBDC data

source.
Enter numeric values.
Text
Enter unformatted text into a text box such as

sentences, names, numbers, date, and time.
Tree
Select an item from a tree list.
Optional: To require users to enter a value for a field, select the check box in the
column.
To trigger an event when the value of the field changes, select the
check box.
The event can be responded to in the script specified in the Dynamic Form section on the General tab.
7.
To configure properties for the field, click the browse button (...) in the
column.
This opens a window that allows you to configure properties for the specified the field type. For information about
options for a field, click the Help button
8. Repeat this procedure for each field that you want to add to the form.
You can save a form to a template file to reuse the form in another group.
You must create and configure a form before you can perform this procedures. See Adding a Form.
A form template is an XML formatted file that saves the all of the settings that are required to copy a form to a
different Xerox EIP Connect group or menu.
2. On the Groups tab, right-click the form you want to save and click Save as Template on the shortcut menu.
This opens the Save Form as Template dialog box.
3. In the Location box, enter the full path to the folder where you want to save the template.
You can click the browse button (...) to locate a folder.
4. In the Template Name box, type a name for the template.
5. Optional: If Enable Dynamic Form is selected in the form settings, then you can select Save copy of dynamic
script in the same location to copy the associated .NET script to the same location.
6. Click the Save button to save the template.
The template file is saved to a file with the name specified by Template Name, with the .xml extension is
appended to the file name.
You can use a form template to add a form to a group.
A form must be saved for the component to a template file before you can perform this procedure. See Saving a Form
as a Template.
A form template is an XML formatted file that saves the all of the settings that are required to reproduce a form in a
different Xerox EIP Connect group or menu.
1401
2. On the Groups tab, click the group or menu where you want to add a form from a template.
3. Click Add Form > From Template on the menu bar.
4. In the Template file box, enter the full path to the form template file.
You can click the browse button (...) to locate the template file.
5. Optional: If the template is for a dynamic template, enter the full path to the template script file in the Dynamic
Form script file box.
You can click the browse button (...) to locate the script file.
6. Click the Create button.
7. Enter a new name and make any other necessary changes to the form settings.
8. Click the OK button when you are finished editing the form.
Completing this procedure adds a new form based on the template to the selected menu or group.
Groups tab
This tab is used to add and configure groups, menus, and forms for the Xerox EIP Connect component.
devices pointed to in the workflow server will display the menu structure under the Common Group.
Option
Description
Add Group
Add Menu

menu item.
Add Form
Select a group or menu, and click this menu and select a

form type to add a form.
Basic Form
Send to Email Form
Send to Folder Form
Edit

menu, or form.
Remove

menu, or form.

Options in this dialog box configure settings for device groups.
Add a group on the Groups tab of the Xerox EIP Connect configuration dialog box.
1402
To add a group, click Add Group on the menu bar. Then, in the Group Settings dialog box, configure options on
the General and Authentication tabs.
General Tab
Option
Description
Name
Type a name for the group. This name does not

identification purposes.
Temporary Repository
Specify the protocol that will be used to connect to

temporary repositories:
Internal FTPThis option uses internal FTP

settings.
External FTB This option uses the external
FTP folder that is configured for creating optional
temporary repositories in the Local FTP settings
on the Preferences tab of the Xerox EIP Connect
External SMBThis option uses a network shared
folder that is configured for creating optional
repositories in the Network Share settings on
the Preferences tab of the Xerox EIP Connect
Enter the IP address or host name for each device that

you want to add to the group. This list must contain at
least one MFP device.
Tip: A network name is usually preferable,
because an IP address can change if you are
using Dynamic Host Configuration Protocol
(DHCP).
Authentication Tab
Options on this tab configure authentication settings for devices in a group.
Option
Description
Select this check box to require that MFP devices in this

group authenticate users.
Use Global Authentication Settings
If authentication has been enabled on the

Authentication tab of the Xerox EIP Connect
component settings, then you can select this check
box to apply the component authentication settings
for the group. When this check box is selected, the
Authentication Settings options are unavailable.
Authentication Settings
Choose the Authentication Type to be used:
NoneNo authentication method specified.

1403
Option
Description
Windows
NetwareSelect this option to use Novell Netware

authentication. After you select this option, configure
the Netware and User Info Lookup options.
options.

Netware
Specify the NDS Tree and NDS Context for Novell

Netware authentication.
Custom Script

User Info Lookup

existing script.
button
in the code editor to refer to the Xerox EIP Connect
users.

1404
Option
Description
box.
address is needed.
Query device authentication session for credentials
The behavior determined by this check box depends on

the Authentication Type setting:
NoneThe user is not prompted for credentials.
If this check box is selected, the sender RRTs will

use the logon credentials for the device.
If this check box is cleared, the sender RRTs will
be empty.
WindowsThe user is prompted for credentials
except for the following cases:

been configured to use Windows authentication.
been configured to use third-party authentication
that passes valid Windows credentials (name
and domain). If the domain is not passed, then a
user must be in the default domain that has been
configured for Windows authentication.
In these two cases, the sender RRTs will use the

logon credentials for the device. Otherwise, the
sender RRTs will use the credentials that the user
Netware or Custom ScriptThe user will always be
prompted for user credentials even when this check
box is selected. The sender RRTs will use credentials

Options in this dialog box configure settings for a menu.
Add a menu on the Groups tab of the Xerox EIP Connect configuration dialog box.
To add a menu, click a group or menu, then click Add Menu on the menu bar. Then, in the Menu Properties
dialog box, configure options for the menu.
Option
Description
Menu Name
Specifies a unique name for a menu.
Icon
Specifies an icon image that will be displayed on the

device for the menu. This entry is optional. You can click
the browse button (...) to locate an image.
1405
Option
Description
Access Control
FormatPNG or GIF with transparent background

DimensionsMust be 44x44 pixels
Maximum size24 KB
Choose whether to restrict access to a menu:
Public AccessChoose this option to allow all

users to access the menu.
Restricted AccessChoose this option to only
allow users listed in Allowed Users/Groups. Click
the browse button (...) to select Windows groups or
users.
the authentication type is Windows.
Group membership depends on the authentication type:
WindowsDetermined by the Windows Groups to

the authenticated user. For details on the object model
used in authentication scripts see the Xerox EIP
Connect Scripting documentation.
Forms
Add a form to workflow when the process needs to capture data prior to a scanning process. There are several types of
forms that you can use to capture information for different processing and routing options.
Add a form on the Groups tab of the Xerox EIP Connect configuration dialog box.
To add a form, first, click a group or menu node, then click Add Form on the menu bar, and then click one of the
form types.
Basic form
Use a basic information to collect general information for a workflow.
Add forms on the Groups tab of the Xerox EIP Connect configuration dialog box. To add a basic form to a process,
first click any group or menu node and then click Add Form > Basic Form on the menu bar.
These tabs provide options that may be configured for every type of form.
General Tab
Fields Tab
Components Tab
General Tab
Option
Name
Description
1406
Option
Description
The maximum number of characters allwed in the form
name is 25.
Icon

the path where the image is stored. The image must have
the following characteristics.
PNG or GIF with a transparent background

Maximum size: 24 KB
Single Touch Mode

Access Control
Scanning Settings

the form.
2 Sided ScanningSpecifies single side or two

side scanning. Choose 1 Sided, 2 Sided, or 2 Sided
Rotate Side 2. The rotate side 2 option rotates side 2
of the pages for top-binding pages of a document.
Color Document QualitySpecify High, Medium,
or Low for scanning quality of color documents.
Higher quality takes longer to scan and creates larger
files.
document will be rendered in Full Color, Grayscale,
or Black & White. Choose the Auto option to detect
color pages and scan documents containing color
pages using Full Color and documents without color
pages using Black and White.
Note: This setting is ignored and all scans
will be monochrome for a device that can
only scan in monochrome.
For the following Xerox WorkCentre models, the
Auto option is supported only when PDF is selected
for File Format. If the Auto option and another
File Format option are selected, File Format will
automatically change to PDF:
52xx
72xx
73xx
1407
Option
Description
74xx
4112
4127
7120
550
560
File FormatSpecifies the file format in which to
save scanned documents:
PDFSaves scanned pages in PDF format.

Multiple Page TiffSaves multiple pages into a
single file in TIFF format.
Single Page TiffSaves each page into a
different file in TIFF format.
JPEGSaves scanned pages in JPEG format.
Note: JPEG File Format and Black and

White Color Mode cannot be selected at the
same time. If a user tries to select Black and
White at the device console while the file
format is JPEG, then the file format will be
changed to PDF and the console will display
a warning.
Image QualityClick the button for this setting
to configure the following settings in the Image
Quality Settings dialog box:
Auto Background SupressionThis option
automatically reduces or eliminates the dark
background resulting from colored paper or
newspaper originals. This option is disabled if the
Original Type is Photo.
ContrastThis option controls the differences
between the image densities within the image.
Select a lower setting to improve the copy quality
of pictures. Select a higher setting to produce
more vivid blacks and whites for sharper text and
lines.
Lighten/DarkenThis option controls how the
scan service processes the images of the scanned
input document so the output document appears
either lighter, darker, or the same as the original
input document.
between sharp text and moir (patterns within
the image). This feature allows you to increase
or decrease the sharpness level of fine lines and
edges. Adjust the sharpness values from sharper
to softer, based on the quality of the input images.
Original SizeSpecifies the size of the original
documents: Auto, Mixed, 8.5 x 11 LEF, 8.5 x 11
SEF, 8.5 x 14 SEF, 11 x 17 SEF, 5.5 x 8.5 LEF,
5.5 x 8.5 SEF, 8.5 x 13 SEF, A4 LEF, A4 SEF,
A3 SEF, A5 LEF, A5 SEF, B5 LEF or B5 SEF.
1408
Option
Description
Note: LEF (Long Edge Feed) and SEF

(Short Edge Feed) describe the manner in
which the documents are feed into the MFP.
Original TypeSpecifies text and photos in the
original documents:
Dynamic Form
TextUse this option to copy documents that

contain text only. Select this option when text
must be clearly copied.
PhotoUse this option to copy documents that
contain photographs only.
Photo and TextUse this option to copy
documents that contain both text and
photographs. Text and photographs are
automatically identified and an appropriate
quality mode is selected for individual areas.
Settings are 100 dpi, 200 dpi, 300 dpi, 400 dpi, or
600 dpi.
Enable Dynamic FormStandard behavior of
a form can be modified by responding to events.
Select this check box to allow the workflow sever to
load form snap-ins. Here are some examples of what
enabling dynamic forms can do:

Script pathEnter the path to the VB.NET script
that contains the code to respond to form and field
a script file.
Edit Script CodeYou can click this button
to open a code editor window and edit the script
code. If you do not specify an existing script in the
Script path box, this button opens a new script
with stub routines for the Form_OnLoad and
Form_OnSubmit events. For details about the
code editor window and the object model used to
respond to form and field events, refer to the Xerox
EIP Connect Scripting documentation by clicking
Help in the code editor window.
Raise event when:The following options specify
when the form raises events:

enters the form.
1409
Option
Description
Run as device logged in userSelect the

check box if you need the script to run under the
authentication context of the logged on user. This
option should be used carefully and only in cases
where you need to access system resources that
require explicit authentication. Whenever possible
specify user names and passwords in the script.
You can use .NET Framework features, such as
encryption, to hide passwords from view when
editing the script. Keep in mind that the Run as
device logged in user option is only available if the
group requires authentication and the Authentication
Type specified on the Authentication tab is
Windows (see Authentication Tab).
Fields Tab
Configure the fields that will be presented to the user. Add a field by entering data on the last line, which is marked in
the first column by the asterisk (*).
Column
Description
Name

if the field name is "Field1", the RRT is ~XED::
%Field1%~.
Display

panel.
Type

to
(Required)

DateAllow users to enter date values based on
selected date formats.
ListAllow users to select an item from a list of
choices.
Lookup ListAllows users to dynamically retrieve
values from an ODBC data source.
NumericAllows users to enter numeric values.
TextAllows users to enter plain text, such as
sentences, names, numbers, dates, and times.
TreeAllows users to select an item in from a list of
choices in a tree.
Select this check box to require a user to enter a value in

a field.
1410
Column
Description
Select this check box to trigger an event when the value
the script specified in the Dynamic Form section on the
General tab.
(Notify server)

(Properties)
Components Tab
browse button (...) in the configure column
for a row. This opens the configuration dialog box for the component.
Option
Description
True Value

if the check box field is selected. "1" is the default value.
False Value

if the check box field is cleared. "0" is the default value.
Checked by default

Date field options

A Date field allows users to enter dates.
Option
Description
Date Format
Click a format for dates in this field. For information

about date formats, see Date Formats.
Select this check box to restrict entries in this box to a

range of dates. Enter the beginning and end dates for the
range in the From and To boxes.
Date
Select the desired Date Format.
To select a date range, select the Restrict to date range check box and enter the start and end for the range in the
From: and To: boxes.
Date type
Device Short Date
Description
language setting.
Examples
12/31/2012 (en-US)
31/12/2012 (fr-FR)
31/12/2012 (es-ES)
Device Long Date

language setting.

lunes, 31 de diciembre 2012 (es-ES)
1411
Date type
Description
Examples
Montag, 31. Dezember 2012 (de-DE)
MM/DD/YYYY

delimited
12/31/2012
MM-DD-YYYY

delimited
12-31-2012
DD/MM/YYYY

delimited
31/12/2012
DD-MM-YYYY

delimited
31-12-2012
YYYY/MM/DD

delimited
2012/12/31
YYYY-MM-DD

delimited
2012-12-31
MM.DD.YYYY

delimited
12.31.2012
DD.MM.YYYY

delimited
31.12.2012
YYYY.MM.DD

delimited
2012.12.31
Note: There may be more or fewer patterns than those shown in this table.
List field options
A List field allows users to select from items in a list.
Option
Description
Value
Label

the label that is displayed on the MFP console.
Description
Provides space for you to briefly describe a value in a

list. This field is displayed in the details section of the
panels that display in color.
Default

list items in the list. When this option is selected, the
value of the RRT will be the selected values separated by
semicolons (;).
Select this check box to allow users to enter new values

at the device console.
1412
Option
Description
Select this check box to raise an event when a user

performs a search on this field. On device panels that
display in black and white, the button is labeled Search.
On device panels that display in color, the search button
is displayed as a search icon.
You can respond to this event in the script that was
configured for the Dynamic Form section in the
General tab. For details on how to respond to form and
field events refer to the Xerox EIP Connect Scripting
documentation.
Specifies the maximum number of list items displayed

that satisfy search criteria entered by a user.
Import Items

reuse a list.
Export Items


A Lookup List field allows users to specify items from a field a database table.
Option
Description
ODBC Data Source
Select an ODBC data source to connect with a data

provider. You can click "<New...>" to configure a new
ODBC data source item. Only system data sources can
be selected as a data source.
ODBC Data Sources Administrator
Click this button to open the Windows ODBC Data

Source Administrator application to add, delete, or
configure data sources with user data source names
(DSNs).
User ID
Enter a user ID that has permissions to the database.

This field is optional. If it is left empty the user account
running the AutoStore service will be used.
Password
Enter the password that corresponds to the User ID.
Connect
Click this button to connect to the ODBC Data Source.
Table View
Choose this option to select the table or view. Then

specify the following:

from which values will be loaded into the lookup list.
This value is required.
displayed in the lookup list. This value is optional.
If this value is left blank, values listed in the Value
Column will be displayed in the device console.
names displayed in the lookup list. This value is
1413
Option
Description
optional. Values from this column will be displayed
in the details section of the user interface. This option
is only available for device panels that display in
color.
Query
Choose this option to enter a SQL query to

produce results that populate the list. Entries for
in the SQL query.
For information about SQL scripting syntax see General
SQL Syntax.
Maximum number of rows to pre-load

displayed. The default value is 50, and the greatest
number of rows that can be specified for this option is
100. If more than 100 rows must be searched, the user
can use the search option located on the device panel.
Note that when Query is chosen, then only preloaded
rows will be searched.
Select this check box to allow users to make multiple

lookup list.
Select this check box to allow users to insert their own


value is 200.
General SQL syntax

A simple SQL query
from <Table>
select <ValueField>
from <Table>
A conditional select statement
from Customers
1414
A conditional select statement using wildcard characters
from Customers
SQL wildcard syntax is used with the like operator. The % wildcard character is used to specify one or more
characters.
Using an RRT pattern in a conditional select statement
Workflow form.
RRT pattern takes the following format: ~XED::%FieldName%~.
It is important to note that the % wildcard character used with RRT patterns does not function like the % delimiter
character used for field searches. With RRT patterns, the entire pattern between the two % delimiter characters will
be replaced with the field value that was entered by the user from the workflow form.
Example:
from Customers
where Customer Name like ~XED::%Customer%~
In this example, the workflow form has the RRT pattern Customer. Once a user enters a value for Customer,
~XED::%Customer%~ will get replaced with the value entered in the Customer field.
from Customers
Note that RRT patterns within SQL select statements can be used with other SQL syntax, including wildcard
characters. The following would be a valid SQL statement:
from Customers
where Customer Name like %~XED::%Customer%~%
An Numeric field allows users to enter numbers.
Option
Description
Default

device panel.
Minimum

1415
Option
Description
Maximum

Precision
Specifies the number of positions required after the

decimal point. If the precision is set to zero, then the
device will only accept whole number values. If the
precision is set to a value greater than zero, then the user
may press the * button on the device to input a value that
requires a decimal point. The default is 0. The maximum
is 5.
Text field options

A Text field allows users to enter unformatted text, such as sentences, names, numbers, date and time.
Option
Description
Default

the device panel.
Mode
For this option, select the list type:

text box.
HiddenThe field will not be visible on the device
panel.
Tree field options

A Tree field allows users to select an item from a tree.
Option
Description
Tree Items
This box displays items in a tree field.
Add
Click this button to add a the first (root) node to the tree.
To add a node under an existing node, click a node in the
tree and then click this button. Clicking the Add button
opens the Add/Edit Tree Item dialog box in which you
specify the Display Text and Value.
Edit
To edit the display text or value for an existing node,

click the node and then click this button.
Remove
To remove a node, click the node in the Tree Items

box, and then click the Remove button. This deletes the
selected node and any nodes under the selected node.
Add/Edit Tree Item dialog box

This dialog box specifies the display text and value for an item in a tree field.
Option
Display Text
Description
Enter the text that users will view for a tree item when
navigating the tree
1416
Option
Description
Value
Enter the value that will be sent to the server when a user
selects the tree item.
Send to DocuShare form

Use a Send to DocuShare form when you need to send the document to a DocuShare repository.
Add forms on the Groups tab of the Xerox EIP Connect configuration dialog box. To add a Send to DocuShare
form, click any group or menu, then click Add Form > Send to DocuShare Form on the menu bar to open the Send
to DocuShare Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components,
and DocuShare Settings tabs.
Note: This form type requires that the DocuShare component is installed on the AutoStore server.
DocuShare Settings Tab
This topic describes options on the DocuShare Settings tab. Refer to the Basic Form Options to configure settings on
Option
Description
Server Address

example, "http://dsserver" or "https://192.199.292.255".
dsserver, the component will insert "http://" before the
server address.
User Name
on to the DocuShare server in the format domain \
User Password
Domain
Enter the domain for the user address.

Prompt for document title

console to provide the title for the document that will be
displayed by DocuShare.
Default Collection
Click the browse button (...) and in the Select Collection

dialog box, either expand the Collections tree and select
the DocuShare collection to which to deliver documents,
or type a DocuShare collection ID in the Collection ID
box, and click OK.
To allow the user to change the collection at run time,
select the Allow user to change Collection check
box. This check box is disabled if you manually type
a collection ID rather than selecting a collection in the
Collections tree.
1417
Option
Description
Default Document Type
Enter the default document type.

To allow the user to specify a different document type
at run time, select the Allow user to change Document
Type check box.
Send to Email form

Use an Email form when you need to send the document to an email destination.
An Email form is commonly used in conjunction with the Send to SMTP and Send to Exchange Route components.
Add forms on the Groups tab of the Xerox EPI Connect configuration dialog box. To add a Send to Email form,
click any group or menu, then click Add Form > Send to Email Form on the menu bar to open the Send to Email
Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components, and Send to
Email Fields tabs.
Send to Email Fields Tab
This topic describes options on the Send to Email Fields tab. Refer to the Basic Form Options to configure settings
Option
Description

"From" field.
Show a CC field

Show a BCC field

secretly.
Global Address List
Select this check box to allow the user to search the

the To, CC and BCC fields. In the Display as box, type

logged on user.

1418
Option
Exchange Contacts
Description
Select this check box check box to allow users to search
their Microsoft Exchange contacts folder for addresses
that can be added to the To, CC and BCC fields. In the
Display as box, type the display value for this search
option.

If a secure socket layer (SSL) connection should be
used to connect to the Exchange Server, select the
Use SSL check box.
Note: When Use SSL is selected, the SSL
port for some models must be set to 443
to display the the selected AutoStore icon
and the description for the EIP service on
the device panel. If the SSL port is set to
different number, the default Xerox logo will
display along with ????? instead of the
expected service description.
LDAP Server

CC and BCC fields.

option.
LDAP ServerType the address or host name of
the LDAP server.
Search Root DNType the distinguished name for
the node where the search should start. For example:
will be the root of the directory tree.
Email Address fieldType the name of the LDAP
attribute that represents the email address.
Name FieldType the name of the LDAP attribute
that represents the name of the user.
Login as AnonymousSelect this check box to
server.
Login with following credentialsSelect this
check box to log on to the LDAP server with the
specified User name and Password. Note that if
the LDAP server is an Active Directory server, then
NTLM authentication will be used.
To test the LDAP search settings, click the Test LDAP

button. In the LDAP Search Test window enter a search
term in the Search Criteria box, click Find Contacts. If
maximum of 25), otherwise an error will be returned
1419
Option
Description
Specify the maximum number of contacts that the search

will return.

Directory domain.

Directory domain.

Empty
empty.
Result
Server belongs.

Example: LDAP://
empty.
directory server.
Example: LDAP://


used
server.
directory server.
Example: LDAP://
Standard LDAP: 389

LDAP over SSL: 636
Send to Folder form

Use a Send to Folder form send captured documents to a folder destination.
components.
1420
Add forms on the Groups tab of the Xerox EIP Connect configuration dialog box. To add a Send to Folder form,
click any group or menu, then click Add Form > Send to Folder Form on the menu bar to open the Send to Folder
Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components, and Send to
Folder Fields tabs.
Send to Folder Fields tab
This topic describes options on the Send to Folder Fields tab. Refer to the Basic Form Options to configure settings
Option
Description
Base Directory

browse to select the destination of the document. You
can click the browse button (...) to locate a folder.
Type the default name that will be used for the document
name field.
Send to SharePoint form

Use a Send to SharePoint form when you need to send documents to a SharePoint 2007 or SharePoint 2010 server.
Use a Send to SharePoint form to allow the user to browse document libraries, folders and list values at the device.
A Send to SharePoint form is commonly used in conjunction with the Send to SharePoint 2007/2010 eConnector and
route components.
Add forms on the Groups tab of the Xerox EIP Connect configuration dialog box. To add a Send to SharePoint
form, click any group or menu, then click Add Form > Send to SharePoint Form on the menu bar to open the
Send to SharePoint Form Settings dialog box. In this dialog box, configure settings on the General, Fields,
Components, and SharePoint Document Library Settings tabs.
Note: This form type requires that SharePoint 2007 or SharePoint 2010 be installed on the AutoStore server.
SharePoint Document Library Settings tab
Option
Server Version
Description
Server Address
SharePoint 2007

server address.
User Name
on to the SharePoint Server in the format domain \
1421
Option
Description
User Password


Site

Document Library

Library check box.
Default Folder

folder.
Content Type

Send to Smarticket form

Add forms on the Groups tab of the Xerox EIP Connect configuration dialog box. To add a Send to Smarticket
form, click any group or menu, then click Add Form > Send to Smarticket Form on the menu bar to open the Send
to Smarticket Form Settings dialog box. In this dialog box, configure settings on the General, Fields, Components,
and Smarticket Settings tabs.
1422
Note: This form type requires that the Smarticket component is installed on the AutoStore server.
Smarticket Settings tab
This topic describes options on the Smarticket Settings tab. Refer to the Basic Form Options to configure settings on
Option
Authentication
Description
Web Service

accessing the web service.
Enter the machine name or IP address where the
Smarticket web service is located, then click the Test
button to test the address setting.

is enabled:
SSL enabled
https://server
name:port
-orhttps://ip
address:port
SSL not enabled
http://server
name:port
-orhttp://ip
address:port
1423
Option
Description
General

Smartickets.

You can save a form to a template to reuse it in a different group or menu. A form template is an XML formatted file
that saves the all of the settings that are required to copy a form to a different Xerox EIP Connect group or menu.
Option
Description
Location
Enter the full path to the folder where you want to save
the template. You can click the browse button (...) to
locate a folder.
Template Name
Type a name for the template file. Do not include an

extension, as the .xml extension will be automatically
appended to the name that you enter here.
Save a copy of dynamic script in the same location
Select this check box to copy an associated .NET script

to the same location. A script is specified with the
Enable Dynamic Form option in the form settings
Preferences tab
Options on this tab configure settings for the component web server, retaining processed and reject files, and
additional temporary directories.
Server settings
Keep settings
Additional Temporary Repositories
Server
Specify the web server that captures scanned document images and associated metadata using HTTP or HTTPS.
This allows a web application or service to directly receive the data rather than monitoring for a file to appear at a
Option
Description
Home Directory
Enter the root directory where the server creates all

temporary directories and files necessary for running the
application and controlling device related traffic. The
service account must have full permission to write to this
directory. You can click the browse button (...) to locate a
folder on the host machine.
Web Server Port
Enter the port number that the web server uses to

Use SSL
Select this check box to use secure connections between

the web server and clients.
Choose CertificateSelect the certificate by which

data can be retrieved by the workflow server when
using HTTPS (SSL). To create a new certificate,
1424
Option
Description
select "<New self signed...>". To locate an existing

certificate, click "<Browse...>".
Certificate PasswordType the password for the
certificate. If you created a self-signed certificate,
this value will be automatically entered into the field
based on the information you provided when creating
the certificate.
Note: When Use SSL is selected, the SSL
port for some models must be set to 443 to
display the the selected AutoStore icon and the
description for the EIP service on the device
panel. If the SSL port is set to different number,
the default Xerox logo will display along
with ????? instead of the expected service
description.
FTP Port
Enter the port on which the FTP service will be running.

To enable FTP logging or to specify the data port range
for passive FTP, click the Advanced button to open the
Advanced Server Settings dialog box.
Keep
Option
Description
Processed Files
option.
Rejected Files

Additional temporary repositories
You can set up additional temporary FTP or network share repositories, although these selections are optional. These
FTP or network share settings can be accessed when enabling authentication at the group level.
To add a temporary FTP repository, select the Local FTP check box and configure the FTP settings. In the Group
Settings dialog box, you should select External FTP for the Temporary Repository setting. See Group Settings.
1425
Option
Description
Local FTP
Select this check box to use a local FTP server as the

temporary repository for storing images that have been
captured from a device.
FTP Port
Enter the FTP port number for the FTP server. The
default port number is 21.
FTP Folder
Enter the name of the subfolder where the scanned

documents will be temporarily stored.
Path to FTP Folder
Enter the local path to the FTP Folder on the host

machine.
Note: The workflow server account must have
permission to delete files from this folder.
FTP Login
Type a user name that has permission to log onto the

FTP server.
FTP Password
Type the password associated with the user name.
To add a temporary network share repository, select the Network Share check box and configure the host settings. In
the Group Settings dialog box, you should select External SMB for the Temporary Repository setting. See Group
Settings.
Option
Description
Network Share
Select this check box to use a network shared folder as

the temporary repository.
Host Name
Enter the name of the computer where the share is

located.
Share
Enter the path to the network shared folder. The format

must be share_name/folder_path.
Note: The workflow service account must have
read, write, and delete permissions to the shared
folder.
Login
Type the user name for accessing the windows share.
Password
Type the password for the user name.
Advanced Server Settings dialog box

Options in this dialog box configure settings for logging connections with devices and the port range for passive FTP
connections.
Option
FTP Logging
Description
Use these options to configure logging communicating
with MFP devices.
Enable LogSelect this check box to enable

logging for the embedded FTP server.
DirectoryEnter the full path to the directory
where logs should be created. You can click the
browse button (...) to locate a folder.
1426
Option
Passive FTP
Description
Configure the data port range that will be used when
receiving passive FTP connections from MFP devices.
In the Data Port Range box, enter the range of ports,
for example 6000-6500. The default range is ports
35000-49000.
Note: If you want a device to connect using
passive FTP mode it must be configured on the
device. Devices are configured by default to use
active FTP.
New Self Signed Certificate dialog box

Options in this dialog box specify settings for a new self signed certificate.
Option
Description
Company
Type the name of the company for the certificate.
Expiration Date
Enter the expiration date for the certificate in the format

m/d/yyyy. The default setting is 10 years from the
current date.
Password
Enter the password for the certificate.
Authentication tab
Settings on this tab allow you to enable and configure authentication settings for the component.
Option
Authentication Type
Description
Choose the authentication method to be used:
Windows

WindowsSelect this option to prompt users for
NetwareSelect this option to prompt users for
their Novell NetWare user name, password, context
and tree. After you select this option, configure the
Netware and User Info Lookup options.
options.

1427
Option
Description
Netware
Specify default settings for Novell NetWare

authentication server.
NDS TreeThis is the default NDS tree for

NDS ContextThis is the default Novell context
for NetWare authentication.
type NDS, then the provided credentials will be
used by workflow server. If the authentication
type of the device is other than NDS, then in
addition to workflow server login screen, the
Custom Script

User Info Lookup

existing script.
button
in the code editor to refer to the Xerox EIP Connect
users.

box.
Note: When Windows authentication is
selected as the Authentication Type, the email
address is retrieved automatically as part of the
1428
Option
Description
authentication and as a result an LDAP search is
not required if only the email address is needed.
Authentication Prompts dialog box

Options in this dialog box configure prompts that collect authentication information for users.
This dialog box is opened by clicking the Prompts button on the Authentication tab of the Xerox EIP Connect
dialog box.
Option
Description
Name
To add a prompt, enter a name in the last row

of the table. The GetData method on the
MetadataCollection class uses this name to get
the value that was entered for a prompt by the user at the
MFP console.
Display
Enter the label for the prompt that is displayed on the

MFP console. If this value is left empty, the prompt
name will be used for the label.
Default
Type a default value for the prompt in this column. This

entry is optional.
(Required field)
Select the check box in this column to require the user to

enter a value in this field.
(Masked)
Select the check box in this column to mask the prompt

value that is displayed on the MFP console for security.

LDAP server.
Option
Description
LDAP Server
Root DN

with LDAP://.
Possible LDAP Ports
Standard LDAP: 389

LDAP over SSL: 636
1429
Option
Description
Login as anonymous
Choose this option to establish an anonymous connection

with the LDAP server.
Choose this option to log on to the LDAP server using

Directory Type
Select the type of directory that will be searched. If an

option other than Custom is selected then predefined
attributes will be used to match the authenticated
username and retrieving the email address.


Additional attributes
Type the name of the user attributes separated by a

semicolon. If no attributes are specified in this box, then
only the email address will be retrieved. These attributes
will be available as User Attributes Replacement Tag
Names (URTN). For details on the format of these
URTNs, refer to Xerox EIP Component RRTs .
Test Lookup





Empty
Result
used.
Server belongs.

used.
Example: LDAP://

used.
1430
Result
Example: LDAP://

specified server.
Example: LDAP://
Device registration
Use this tab to register the AutoStore server on devices. Device registration groups allow you to specify default
administrator credentials for a group of devices so that you can register multiple devices without logon errors.
To open the Device Registration dialog box, click the Start Registration Manager button on the Device
Registration tab of the Xerox EIP Connect configuration dialog box . Configure options in this dialog box to do the
following:

Add multiple devices
Device Registration dialog box options

Option
Register
Description
To register all devices within a registration group, select
the registration group that will be registered and click
Register. You will see a status bar at the bottom of the
window. Once the registration process is complete, the
number of devices which were successfully registered
will be displayed.
Note: You must ensure that the AutoStore icon
is placed in the correct menu position on each
MFP. This action will effectively overwrite
previous values.
Add Registration Group
Click this button to create a new registration group. This

opens the Add Device Group dialog box. See Add/Edit
Device Group Dialog Box.
Add Device
Select a registration group and click this button to add a

device to the group. This opens the Add Device dialog
box. See Add/Edit Device Dialog Box.
Remove
Click a registration group or device and click this button

to delete it. Removing a group deletes all of the devices
in it.
Edit
Select a registration group or device and click this button

to edit the settings.
Import Device List
Click this hyperlink to add multiple devices

simultaneously. This option reads in device names and
1431
Option
Description
parameters from a comma delimited list. Each device
entry must appear on a single line formatted as follows:
device_IP,device_admin_user,device_admin_passw
Make sure that there are no spaces between values or
commas. The device IP address is required, so any
line missing an IP address will be ignored. All other
values are optional If a value is empty, then the value
specified for the group will be used. The group value for
the device administrator password is always used if the
device administrator user name is omitted.
When you omit values, retain the commas without
any spaces. For example, the following line omits the
device administrator user name (the device administrator
password is then ignored):
device_IP,,device_admin_password,AutoStore_men
The following line omits all values except for the device
IP address:
device_IP,,,
If the device IP address is entered by itself, then all
values except the IP address are copied from the group
settings and the Use Group Access Setting option is
enabled for the device. If at least one value (other than
the administrator password) is entered with the device
IP address, then missing values are copied but the Use
Group Access Setting option is disabled for the device.
That means that any subsequent changes to the group
settings will not change the device settings.
Add/Edit Device Group dialog box
Configure options in this dialog box to create or edit a device registration group.
Option
Description
Device Group Name
Type the name for the registration group.
Connect to Server using Address
Enter either the name or IP address of the machine where

the workflow server is installed.
Admin User Name
Enter the administration user name for the device.
Password
1432
Option
Description
Get Community Name
Enter either public or private. The default value is

public. This value must match the GET Community
Name SNMP configuration value specified on the
device. That is, if Get Community Name is set to
public on the device, then it must also be set to
public in this box.
Set Community Name

private. This value must match the SET Community
device. That is, if Set Community Name is set to
private on the device, then it must also be set to
private in this box.
Add/Edit Device dialog box

Use this window to add or edit a device in a device registration group.
Option
Description
Device Address
Enter either the name or the IP address for a device.
Use Group Access Settings
Select this check box if the settings configured for group

access are to be used. Clear this check box to configure
access settings for the device.
Admin User name
Enter the administrator user name for the device.
Password
Get Community Name

public. This value must match the GET Community
device. That is, if Get Community Name is set to
public on the device, then it must also be set to
public in this box.
Set Community Name

private. This value must match the SET Community
device. That is, if Set Community Name is set to
private on the device, then it must also be set to
private in this box.
Xerox EIP component RRTs

Component RRT ID
The RRT ID for this component is XED.
Name
Description
FormName
Name of the form.
Sender

1433
Name
Description
This RRT is populated in any of the following cases:

SenderEmail
SenderDomain
The authenticated users domain name.

Note: This RRT is populated in any of the
following cases:
The component has been configured to use

Windows authentication.
The component has been configured
to use Custom authentication and the
associated .NET script populates the Domain
property of the UserInfo object.
IP
HostName
ServerIP
The IP address of the EIP application server associated

with the device (IIS server IP address).
ServerHostName
Host name of the EIP application server associated with

the device (IIS server host name).
PageCount
Format
FileSize
MTiff ( Multi-Page TIF file)

Tiff (Single Page TIF file)
PDF
JPEG

example provides some examples:
The RRT ~XED::%ClientID%~ is replaced by "Company" if the user types in "Company" for the field name
called "Client ID".
This component supports URTNs and replacement of user attributes specfic to the authentication method used. The
following example provides some examples:
If Custom authentication is used and there is a user attribute named "Full Name" with the value" John Doe", then the
RRT ~XED::User,%FullName%~ is replaced by "John Doe" at run time.
Attributes box, then for an authenticated user where displayName is "Jane Doe" the RRT ~XED::User,
%displayName%~ is replaced by "Jane Doe" at run time.
1434

Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Problem Description
When performing a scan, it takes 15 seconds or more
for the scan to start. The problem is evident after the
service has been restarted or the device has been idle
for a few minutes. The user will also observe logged
events with id number 8 logged within the Windows
application log. The cause of this problem is because
the service is running on Windows 2003/Windows XP
and the option for Update Root Certificates is selected
when the server is not connected to the Internet or has
access to the Microsoft Windows update website.
Solution
Connect the server to the Internet or turn off the Update
Root Certificates component. To turn off the Update
Root Certificates component, follow these steps:
1. In Windows Control Panel, double-click Add/
Remove Programs.
2. Click Add/Remove Windows Components.
3. Clear the Update Root Certificates check box,
and then continue with the Windows Components
Wizard.
More information, see the Microsoft KB article 317541,
Event ID 8 is logged in the Application log, at the
Microsoft web site.

OCR component cannot OCR documents produced by a WorkCentre 7655/7665 when the following settings
are used: Full Color, Multiple Page Tiff, with a 300dpi resolution.
1435
Xerox
Welcome to the Xerox component
The Xerox component is a capture component that supports WorkCentre Pro and Document Centre systems. This
component may be used in a workflow definition in conjunction with the workflow process or route components. Use
this component to centrally program your Xerox multifunctional devices with custom keys and index fields.
Users can scan documents from the Xerox multifunctional device control panel into the workflow with the touch of a
single button.
The illustration below depicts the role of the workflow server as the middle-ware software for multifunctional
devices:
Getting started
Connectivity setup
SNMP setup
In order to use Xerox component, SNMP component needs to be installed on the Workflow Server, and listed in your
runtime path. These include the files:
mib.bin
mgmtapi.dll
snmpapi.dll
These files are distributed with Windows NT 4.0 and later versions as part of the SNMP Service offering.
Use the appropriate procedure for the operating system.
Install SNMP on Windows NT 4.0

Install SNMP on Windows 2000/XP/Server 2003
How to install SNMP on Windows NT 4.0

1. In Control Panel open Network.
2. On the Services tab, click the Add button and select SNMP Service.
How to install SNMP on Windows 2000/XP/Server 2003
1. In Control Panel, open Add/Remove Programs.
2. Click Add/Remove Windows Components and in Management & Monitoring Tools, install Simple Network
Management Protocol (SNMP).
FTP or SMB setup
The Workflow Server employs FTP or SMB to exchange information with the device. Make sure the Xerox MFP is
configured to communicate with FTP or SMB server.
Feature highlights
The main features provided by Xerox component include:
Capture index data and populate index fields into applications.

Designate the Template Pool.
Create Xerox scan templates for multifunctional devices.
Create groups of devices and maintain templates based on device groups.
Using the Xerox component

Create Xerox scan template
Create templates that program the device to

automatically route your scan documents to your defined
1436
workflow. You simply select the template at the device

control panel and start your job.
Capture documents from the
Xerox multifunctional device
Process and route the captured files through various

workflow service process and route components. (DMS,
or other applications).
Capture index data
You have the option of creating index fields for use by

the subsequent components in your process. The walk-up
user can populate the index fields at the time of scan.
Manage templates and device groups
You can define groups of devices into work groups that

will use the workflow processes that you define. The
component will make sure the templates are kept up
to date and that the defined devices are accessing the
correct set of templates.
Licensing the Xerox component

This component requires a license for each multifunctional device that is connecting to the server through the SMB
or FTP repository. The licenses are not device specific and can be assigned to a pool of devices up to the maximum
number of licenses purchased.
How to Start a Process
The following is a summary of steps that take place after you have configured a process using Xerox capture
component. The initialization of the process and route components in your process are beyond the scope of this
document.
1. Configure a process with the Xerox capture component and save the .cfg file in the desired folder.
2. From the Service Manager GUI, click on Stop and then Start to begin the service with the .cfg script that was
saved in step 1.
3. The Xerox component starts by checking the validity of the Home Directory and Work Directory folders.
4. The Xerox component checks for connectivity to the SMB or FTP repository.
5. The Xerox component collects information from each device in the group using the IP address or the host name of
the device. This is accomplished by utilizing the SNMP Get Community String. The information collected from
the device consists of model number, hardware and software version information, etc.
6. If the device is unknown, a message is displayed on the Status Monitor to inform the user about the nature of the
problem.
7. The service refreshes the template pool setting for that group. For each member of the group, perform 8 and 9.
8. At this point, the service verifies the device is pointing to the same template pool location that was configured
using the Xerox Capture component. In other words, the Xerox component checks to make sure the device's
and component's view of the Template Pool locations are the same. If the locations do not match, a warning is
displayed on the Status Monitor gui.
9. In the rare case where the device Template Pool IP address is set to 0.0.0.0 and the host name is blank, the Xerox
component (utilizing the SNMP Set Community String) forces the Template Pool setting to what was configured
in the Xerox component.
10. If the repository or Template Pool are invalid, the service won't start.
11. Steps 5, 6, 7, 8, and 9 are repeated for every group configured in Xerox component.
12. At this point the initialization of Xerox component has been completed successfully.
Preferences tab
In this tab, you can designate the folders where the service stores the program files for the job that is processing.
1437
Option
Description
Home Directory
The root directory where the service creates all

temporary directories and files necessary for controlling
the multifunctional device related traffic. The server
must have proper permission to write to this directory.
Keep
Allows you to keep processed or rejected files.

files (send to folder/application files) are stored into
Important: If this option is enabled, a
successfully is saved on this directory.
Make sure that proper disk storage is
allocated for this directory.
Rejected filesThe Rejected Files directory is used
for storing any files that failed to store into the final
destination location. The failure could be due to any
number of reasons and it must be researched through
searching the application log file entries. Typically,
it is beneficial to have a secondary process that takes
this directory as an input and routes messages to
The service must have sufficient rights to access this
directory.
Repository tab
The Xerox multifunctional devices store the scan output files to a folder. The server process reads Xerox scan output
files from the repository (FTP or SMB folder) for workflow processing. On this tab, choose whether the repository is
located on an FTP server or a shared network drive:
FTP
Choose this option when the template pool is located on an FTP server.
SMB
Choose this option when the template pool is located on a shared network drive.
Note: SMB is only supported on WCP and DC5x5 devices. See Restrictions and Limitations for further
details.
FTP
Choose FTP when the template pool is located on an FTP server and configure the following repository attributes for
an FTP server.
Option
Description
Server
Enter the FTP server name or the IP address of where the

Xerox device stores the scan output files.
Root Path
Enter the root path of where the multifunctional device

stores the scan output files.
1438
Option
Description
This path also specifies the location where the server
process reads the Xerox scan templates files and image
files from.
User name
Enter the user name that has access to the FTP server
and path specified. The user name must have read/write/
delete access rights to the designated directory.
This field may not be left blank.
Password
Enter the password associated with the user name you

specified.
Port
Enter the port number used by the service to access the

FTP server.
If a non-default port number is configured, the Server
setting must specify an IP address.
Test Connection
Click on this button to test connectivity from the

workflow Server to the FTP server.
This test checks for connectivity to the FTP site,
accessing a directory, writing, retrieving and deleting
a file from the specified directory. If any of the named
operations fail, this test will fail. In this case, you need to
check the FTP settings.
SMB
Choose the SMB option when the template pool is located on a shared network drive and configure the repository
attributes for the share.
Option
Description
Host Name
Enter the name of the shared network drive where the

scan output files are located.
Path
Enter the path name of where the scan output files are
stored.
This path specifies the location where the process picks
up the Xerox scan files for processing.
User name
Enter the user name that is used by the service to pick up

data form this directory.
This field may not be left blank.
Password
Enter the password associated with the user name.
Test Connection
Click on this button to test connectivity from the server

to the shared network drive.
This test checks for connectivity to the network drive,
accessing a directory, reading, writing, and deleting a
file from the specified directory. If any of the named
1439
Option
Description
operations fail, this test has failed. In this case, you need
to check the SMB settings.
Groups tab
A Group specifies the listed Xerox multifunctional devices sharing a single Remote Template Pool, and hence the
same scan templates. Use this tab to Add, Edit, or Remove a Group and/or a Template.
Option
Description
Add
Click on the Add button to create a group or template.
Remove
Select a group or template that you want to delete and

click Remove.
Edit
Select a group or template that you want to update and

click Edit.
Group
A group is defined as a list of the Xerox multifunctional devices that share the same General and Template Pool
attributes.
You can perform the following operations on a template or a group:
Copy a template and paste the template to a different group by right clicking on the template.
Move a template from one group to another group by dragging the template to a different group.
Create a template for a desired group by right-clicking the group and clicking Add.
General Settings
On the Groups tab, click on Add Group to create a group name for multifunctional devices that are logically
grouped together.
Field Name
Description
Name
Name of the group of devices.
SNMP Get Community String
Get community string sequence. This field may not be

left blank.
SNMP Set Community String
Set community string sequence. This field may not be

left blank.
Members
Enter the device IP address or host name of the devices

that belong to the group.
Click on Next to define the Template Pool attributes.

Template Pool
The template pool is the location of the FTP server or the SMB drive where the Xerox scan templates are stored.
When configured, the multifunctional devices read the template file from this location and display the templates on
the multi functional device control panel.
The template pool may be defined as:
FTP
1440
The Workflow Server employs FTP to exchange information with the device. Make sure the Xerox MFP is
configured to communicate with the FTP server.
SMB
The Workflow Server employs SMB to exchange information with the device. Make sure the Xerox MFP is
configured to communicate with the SMB server.
Note: SMB is only supported on WCP and DCx5 devices. Refer to Restrictions and limitations for further
details.
Template
Templates provide a way to preprogram scan job settings at the Xerox multifunctional device. You can customize
selected settings so that they are optimized for your particular workflow.
You can perform the following operations on a template or a group:
Copy a template and paste the template to a different group by right clicking on the template.
Move a template from one group to another group by dragging the template to a different group.
Create a template for a desired group by right-clicking the group and clicking Add.
General Settings
Enter the general template and scanning attributes.
Field Name
Description
Name
Enter the template name up to 20 characters long.
Description
Enter a description for the template name.
Format
Supported formats are:
TIFF (multiple page TIFF)

PDF
The server supports the above output formats. The

Xerox multifunctional device may support additional
file formats. Please refer to the downstream process and
route component requirements before selecting an output
file format.
Resolution
Select from the drop-down list:
200
300
400
600
The server only supports the above resolutions. The

Xerox multifunctional device may support additional
resolutions. Please refer to the downstream process
and route component requirements before selecting a
resolution.
Color Mode
Select an option from the drop down list:
Black and White

Full Color
Gray scale
1441
Field Name
Description
Not all Xerox multifunctional device support color
or grayscale. Please refer to the downstream process
and route component requirements before making a
selection.
Advanced Settings
Click this button to open the Advanced Settings dialog

box in which you can configure the following options:
SidesThis setting refers to the sides of the hard

copy which will be scanned. Select an option from
the drop down list:
One Side
Two sided rotate side 2
Two Side
Auto Background SuppressionThis option
automatically reduces or eliminates the dark
background resulting from colored paper or
newspaper originals.
Note: This option is disabled if the
Original Type is Photo.
ScreenSpecifies how to adjust the image to
accomodate source characterisitics.
AutoEliminates the risk of blotches or small
areas that have a different texture or pattern
appearance than the surrounding area, but
produces a slightly grainier picture than when
Special is used.
SpecialEnhances continuous tone photographs
or high frequency halftone images. It is used to
create smoother, less grainy output for continuous
tone and halftone images, but risk of blotchy copy
quality defects is higher than when Auto is used.
ContrastThis option controls the differences
between the image densities within the image.
Select a lower setting to improve the copy quality
of pictures. Select a higher setting to produce more
vivid blacks and whites for sharper text and lines.
DarknessThis option controls how the scan
service processes the images of the scanned input
document so the output document appears either
lighter, darker, or the same as the original input
document.
between sharp text and moire (Patterns within the
image). Adjust the sharpness values from sharper to
softer, based on the quality of the input images.
Document Management Fields

Once you have configured a template, you have the option to create, edit, and delete index fields for the scanned
document. You can create up to 6 index fields for your workflow. The user enters the index field values at the device
control panel.
1442
Note: Some Xerox multifunctional devices do not support index fields. Refer to Restrictions and limitations
before configuring these fields.
Field Name
Description
Prompt Name
Enter the prompt name. This name appears on the device

control panel.
Field Name
Enter a field name that is used for RRT designation.
Default Value
Enter the default value for the field name. This field is
optional. If a device does not support index fields, this
value will still be available as a static RRT.
Component settings
Use the Component settings to configure the remaining process components and route component in your workflow.
Click a component in the list that you want to activate or configure, and then click the Configure button to open the
component settings dialog box. For information about configuring a component, click the Help button in a component
How to use templates
Templates provide a way to preprogram scan job settings at the Xerox multifunctional device.
1. Configure a template via the Xerox Document Centre component.
This generates a Xerox Scan Template (.xst) file that gets placed in the FTP or SMB location that you have
already configured in the template pool.
2. From the Service Manager, stop and start the process that contains the Xerox capture component. This will
operation will update the template pool.
3. The multifunctional device reads the definition of the template file (.xst) from the template pool location and
displays it on the multifunctional device control panel.
Note: Some Xerox multifunctional devices require manual template refresh from the device control
panel. Refer to Restrictions and limitations.
4. When a user scans a job by selecting a template at the multifunctional device control panel, the Xerox scan
template (.XST) and image files defined in the template will be updated with user-entered meta-data (index data)
and get stored in the repository.
5. The process examines the updated .xst and image files that are stored in the repository (from step 4) and
determines how to process the file based on the process and route components defined in the workflow.
6. Select a group that you have defined and then click Add Template to define the template attributes by configuring
the following settings:
General
Document Management Fields
Component
Note: You can can perform the following operations on a template or a group:
Copy a Template and paste the Template to a different group by right clicking on the Template, or
Move a Template from one Group to another Group by dragging the template to a different Group, or
Create a Template for a desired Group by right clicking on the Group and selecting Add.
Xerox component RRTs

Component RRT ID
The RRT ID for this component is XRX.
1443

Name
Description
ImgFileSize
Size of the scanned image.
ImgFileType
Image file types:
TIF
PDF
TemplateName
Template Name
RepositoryName
Name of the repository. RepositoryName is an attribute

of file transfer service for the .XST file; the value of
which varies depending on the protocol specified for file
transfer. In the case of FTP, this field is the IP address
or host name of the FTP server. In the case of SMB, this
field is the host name of the SMB server.
UserName
If authentication is enabled, this is the user name that has

logged in to the device. If authentication is disabled, this
is NULL.
The RRT string ~XRX::ImgFileSize~ is replaced by the size of the image
The RRT string ~XRX::ImgFileType~ is replaced by TIF or PDF, depending on the file type.
This component does not support FRTNs and replacement of field names generated from the MFP devices.
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%J
%m
%M
%p
%S
1444
Name
Description
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Problem Description
Error starting the service. Cannot load XDCSS.
Solution
Confirm the Repository and Template Pool
configurations defined in the Xerox component exist
and are valid. Save the .cfg if there are any changes.
Make sure you use the updated .cfg when you start the
service.
Server(configured) templates are not visible/accessible at 1. The multifunctional device that you are trying to use
the multifunctional device.
is not listed as a member of the group within which
you defined your templates. Verify that the machine
IP address is properly entered in the member list.
2. The template pool setting on the multifunctional
device does not match the template pool setting for
the group. Change the template pool setting on the
multifunctional device to match the one specified for
the group.
New or updated templates do not appear on the
multifunctional device.
1. New or updated templates are accessible on the

device only after the process has been stopped and
restarted. If you have not restarted the process
since the time you made changes to your process
definition, restart the process and check the
multifunctional device again.
2. If you are using a Document Centre, this device
may not allow the server to update the template
list automatically. Follow the device procedures to
manually update the templates on the device.
3. Open the Server event log and review any warnings/
errors displayed. Follow the corrective action listed
for that warning/error.
Some of your non-server(configured) templates are

missing from the template pool.
The Server does not try to verify that a template you

created does not have the same name as a non-server
configured template. Be sure to check the template pool
for pre-existing template files prior to naming a new
server-configured template.
When I initiate a scan job, the multifunctional device

prompts me to enter a password even though I have
specified the password in the Xerox component
configuration.
Older Xerox devices do not support retrieving the filing

repository password from the Server. To avoid having to
enter the password repeatedly, define this repository as
one of the Network Scan Repositories on the device.
1445
Problem Description
Solution
It takes a long time for the Service Manager to start the

service.
If you have a large number of Xerox devices associated

within your device group members, or some of the
devices within your device group members are off-line,
it will take a longer time for the service to start up.
The files that I scanned did not reach their final

destination, as specified in my workflow definition.
1. If scan confirmation reports are not enabled on the

multifunctional device, enable them and try your job
again. Verify that the scan job was successful and
that the destination repository matches the repository
defined for the Xerox component.
2. If the scan confirmation report is indicating a login
failure, use the Test Connection function in the Xerox
Component configuration tool to verify that your
repository settings are correct.
3. If the scan confirmation report is reporting any other
failure, follow the corrective action implied by the
failure message.
4. If the scan confirmation report is reporting success,
check the Server event log to verify that the job was
received and processed. Also check the Processed
Files and Rejected Files directory to verify that your
scan job reached the Server repository.
The scan confirmation report is reporting a filing failure.
1. If the scan confirmation report is indicating a login

failure, use the Test Connection function in the Xerox
Component configuration tool to verify that your
repository settings are correct.
2. If the scan confirmation report is reporting any other
failure, follow the corrective action implied by the
failure message.
Bar codes do not get reliably read when scanning with a

Xerox multifunctional device.
1. The ability to successfully process barcodes is

highly dependent on the settings used to perform the
scan. When creating a new template, the settings
are automatically set to those that will provide
the optimal bar code recognition results. If you
change these settings either in the template or at the
device, these changes may adversely affect barcode
recognition performance. The following settings will
yield the best barcode recognition results:
Resolution: 300x300 DPI

Color: Black & White
Auto Exposure: On
Justify the settings for Contrast, Darkness and
Sharpness for the best image quality.
2. If you are using a WorkCentre Pro 32/40C (color)
device and the system software version is 0.1.0.60,
0.1.1.10, or 0.1.2.28 contact Xerox support for
assistance.
OCR results are not as good as other devices when
scanning with a Xerox multifunctional device.
1. The ability to successfully OCR is highly

dependent on the settings used to perform the scan.
When creating a new template, the settings are
1446
Problem Description
Solution
automatically set to those that will provide the
optimal OCR results. If you change these settings
either in the template or at the device, these changes
may adversely affect OCR performance. The
following settings will yield the best OCR results:
Resolution: 300x300 DPI

Color: Black & White
Auto Exposure: On
Justify the settings for Contrast, Darkness and
Sharpness for the best image quality.
2. If you are using a WorkCentre Pro 32/40C (color)
device and the system software version is 0.1.0.60,
0.1.1.10, or 0.1.2.28 contact Xerox support for
assistance.
The following table defines the set of Xerox WorkCentre Pro and DocumentCentre products that are supported by
the Xerox component. Newer Xerox devices that are not listed in this table but are branded as WorkCentre Pro, will
likely work with this software and have no limitations. Older products will have more restrictions/limitations than
newer products.
If you are defining a workflow that is to be used by a wide range of Xerox devices, you must adhere to the super-set
of limitations for all those devices. You might want to consider creating more than one group of Xerox devices, with
newer products in one group and older products in another group, if device limitations adversely affect your normal
workflow.
Xerox Devices and Software
Device Capability and Limitations
DC 220/230 ST Wave 2 (ESS 1.8.2) and earlier
The Notable Solutions Xerox capture component does

not support these devices.
DC220/230ST General Release (Wave 3) (ESS 1.12.8)

or higher DC 420/426 ST
These devices do not support SMB filing. You must

use FTP as the transfer protocol within the workflow
definition in order to scan from this device. These
devices do not support using the password specified
within the Xerox component definition. When
attempting to file using this template, the system will
prompt you to enter the password. Enter the password
by selecting the Login Name/Password button on the
Output tab on the device control panel. If you use this
template frequently, you can avoid having to enter
the password by defining this repository as one of the
Network Scan Repositories on the device. These devices
do not allow the Server to automatically update the
scan templates on the device. In order to use new or
updated templates, you must select the Refresh List and/
or Refresh Template button on the device control panel.
These devices do not support Index Field attributes
(also known as Metadata fields) that can be specified at
the device. These devices do not support PDF output.
You must use TIFF as the output file format within the
workflow definition in order to scan from this device.
DC 3xx ST

1447

do not allow the Server to automatically update the
scan templates on the device. In order to use new or
updated templates, you must select the Refresh List and/
or Refresh Template button on the device control panel.
These devices do not support Index Field attributes (also
known as Metadata fields) specified at the device.
DC240/255/265ST DC460/470/480ST less than

7.19.01.x

devices do not allow the Server to automatically update
the scan templates on the device. In order to use new or
updated templates, you must select Update Template
List. On DC 2xx More Scan Features > Update
Template List. These devices do not support Index Field
attributes (also known as Metadata fields) that can be
specified at the device. These devices do not support
PDF output. You must use TIFF as the output file format
within the workflow definition in order to scan from this
device.
DC460/470/480ST 7.19.01.x

the scan templates on the device. In order to use new
or updated templates, you must select the Update
Template List button on the device control panel. These
devices do not support Index Field attributes (also known
as Metadata fields) specified at the device.
DC432/440ST (2.x ESS) DC425/430/432/440ST (3.x

ESS)

do not allow the Server to automatically update the scan
templates on the device. In order to use new or updated
1448

templates, you must select the Update Template List
button on the device control panel.
DC460/470/480/490ST 7.0.19.02.x or higher

the scan templates on the device. In order to use new
or updated templates, you must select the Update
Template List button on the device control panel.
DC5xx ST
These devices do not allow the Server to automatically

update the scan templates on the device. In order to use
new or updated templates, you must select the Update
Template List button on the device control panel.
WCP 65/75/90 WCP 65/75/90WCP 35/45/55WCP 40/32 There are no known limitations
Color
XML Generator
Welcome to the XML Generator component
XML Generator component is used for mapping data received by means of RRTs to XML files. The structure of the
output XML file is defined by a template, which is also an XML file.
In particular, the component provides mapping of tabular data (including multi-dimensional tables) to XML format.
Such table data are generated by several components, for example, by OpenForms Capture or Barcode.
The XML Generator Route and eConnector components are identical except the XML Generator eConnector
component has the following additional options:
The Activate check box makes the component active. If this check box is not selected, the component won't
The Pass through check box for generated XML document. If this check box is selected, the XML document is
available to the subsequent components in the process. When this check box is not selected, the Output to option
is checked and disabled.
The Output to check box for generated XML document. When this check box is selected, the generated XML
document will be routed to the specified output folder. If the Output to check box is not selected, the Pass
through check box is selected and disabled. This behavior concerns only generated XML document.
The Pass through check box for original documents. If this check box is selected, the original document is
available to the subsequent components in the process. If the Pass through and the Output to options are not
selected, the original documents are excluded from subsequent processing.
Getting started
Feature highlights
The features of the component are:
Mapping data received by means of RRTs to XML files.

Loading of XML template file, displaying all nodes and their attributes as a tree for describing the output file
structure.
Setting output file node and attribute values based on the template using the component RRTs and RRTs generated
by other components.
Multiplying the desired node within parent node any number of times for displaying table data in output XML file.
Specifying destination and rename schema for generated XML document and for the original document.
1449
Using the XML Generator component

Use this component to store the metadata in the XML files. You can create you own XML templates to define data
mapping.
How to map data
An example of mapping a set of RRTs to an XML file.
Let us consider a set of RRTs generated by the POP3 eMail component. The RRTs are the parameters of an email
messages that the component receives from a POP3 email account: ~POP::Body~, ~POP::CC~, ~POP::Date~,
~POP::From~, ~POP::Subject~, ~POP::To~.
1. Design a workflow with POP3 eMail as a capture component and XML Generator as a route component.
2. Configure the POP3 eMail component.
3. Use the following XML template:
<?xml version="1.0" encoding="iso-8859-1" ?>
<email>
<info>
<from>FROM</from>
<subject>SUBJECT</subject>
<date>DATE</date>
<to>TO</to>
<CC>CC</CC>
</info>
<body>BODY</body>
</email>
4. Replace the tag values with the corresponding RRTs in the configuration window of the component.
5. Configure other settings and run the process.
The generated XML will contain the values of the RRTs as the tag values.
How to map a set of data of the same kind
An example of mapping a set of data of the kind in XML file.
If you have, for example, the result of recognition of a multi-page document, each set of data contains the RRTs
that correspond to a single page. Let us say you have the following RRT: ~FRO::%z%.PageNumber~, which is
actually an RRT produced by the OCR component, where PageNumber indicates the page number. If your
document consists of 5 pages, you will have five values for this RRT. To represent this data you can define a
counter for a node, the counter corresponding to a page number.
<Root>
<Document>
<Page number="n">data</Page>
</Document>
</Root>
1. Highlight the Page node in the tree and click the Properties button.
2. Define a counter in the opened Multiply Node Block dialog box. Set its values to be from 1 to 5.
3. Let us say the name of the counter is counter. Set the value of the number attribute to #counter#. Set the value
of the Page node to the following: ~FRO::%z%.#counter#~.
1450
This will produce the output in which there will be five nodes, each node having the number of the page in the
number attribute and the value of the corresponding RRT as the text value of the node:
<Root>
<Document>
<Page number="1">text from the first page</Page>
<Page number="2">text from the second page</Page>
...
<Page number="5">text from the fifth page</Page>
</Document>
</Root>
How to map tabular data

An example of mapping tabular data to XML file.
The component allows for mapping data that represents a table. An example of data containing tables may be
provided by the RRTs generated by Barcode component and representing barcode values for every page of a
document.
1. Consider a configuration with Barcode as a process component and XML Generator component.
2. In XML Generator configuration browse the following template.
<Root>
<Document>
<Page>
<Number>Data</Number>
<FirstBarcode>Data</FirstBarcode>
<SecondBarcode>Data</SecondBarcode>
</Page>
<AllBarcodes>Data</AllBarcodes>
</Document>
</Root>
3. Based on this template, set a configuration of the output file. First, multiply the Page node by inserting a counter m
with Min value=1 and Max value=3.
4. Next, replace the Number node value with m, the FirstBarcode node value with ~FRB::m,1~, the
SecondBarcode node value with ~FRB::m,2~ and the AllBarcodes node value with ~FRB::*,*~.
If the original document has 3 pages, with the first page containing 2 barcodes, for example, code1, code2, the second
page containing no barcodes, and the third page containing 2 barcodes, for example, code3, code4, then the output
XML file for this document is as follows:
<Root>
<Document>
<Page>
<Number>1</Number>
<FirstBarcode>code1</FirstBarcode>
<SecondBarcode>code2</SecondBarcode>
</Page>
<Page>
<Number>2</Number>
</FirstBarcode>
1451
</SecondBarcode>
</Page>
<Page>
<Number>3</Number>
<FirstBarcode>code3</FirstBarcode>
<SecondBarcode>code4</SecondBarcode>
</Page>
<AllBarcodes>code1, code2, code3, code4</AllBarcodes>
</Document>
</Root>
Configuring the XML Generator component

XML Generator Configuration dialog box
In the XML Generator Configuration dialog box you can load and view the structure of the XML template, set the
values of the nodes, set the parameters of the output of the generated XML document and of the original routed
documents.
Option
Description
Activate
This check box is present only in the XML Generator

eConnector configuration window. Select this check
box to make the component active. If this check box is
not selected, the component won't perform any actions
during file processing.
XML template
Using fields in this group you can load an XML template

that is used to generate the output XML file, view its
structure and change the element and attribute values.
Source
Select an XML template file.
Properties
Select an element from the tree and click this button to

set the element's properties.
In order to change the value of an attribute, select

the desired attribute in the template and click the
Properties button. Attribute value can be changed in
the opened Edit Attribute dialog box.
In order to multiply a node, select the required node
and click the Properties button. The options of
repeating one node within the parent node can be set
up in the opened Multiply Node Block dialog box.
In order to change a node value, select the required
node value and click the Properties button. The node
value can be changed in the opened Edit Node Value
dialog box.
Note: You can't set the value of a node if
it is not set in the template. In other words,
you can only change a preset non-empty
value of a node.
Generated XML document
This group contains the settings for the generated XML

file.
Pass through

eConnector configuration window. Select this check box
1452
Option
Description
to make the XML document available to the subsequent
Output to
For XML Generator eConnector configuration, this

element contains a check box and a field. When the
check box is selected, the generated XML file will be
routed to the specified output folder. If this check box
is not selected, the Pass through check box is selected
and disabled. Specify the destination for the generated
XML file in the text box. For the Route component,
this element contains only a text field in which you can
specify the destination folder of the generated XML file.
Rename schema
generated XML document under which it will be saved
in the output folder. You can use RRT to dynamically set
the value of the schema. The .xml extension will be set
automatically to the generated document.
If the Rename schema check box is
not selected, the default schema is used:
~XMR::FileName1~#Counter#.xml, where
Counter is a unique identifier based on the number
of files with the same name in the working directory.
For example, if the first original file is File.doc, the
generated XML file will be File1.xml.
Note: If the component has no input
documents, the default name of the generated
XML file will be "generatedXML1.xml".
If the Rename schema check box is selected
and the schema name is not provided, then
at run time the default schema is used:
~XMR::FileName1~_~XMR::Counter~.xml.
For example, if the first original file name is File.tif, the
renamed file will be File_1.xml.
Original documents
This group contains settings for the original documents.
Pass through

eConnector configuration window. Select this check box
to make the XML document available to the subsequent
Output to
If this check box is selected, the original documents

will be routed to the specified output folder. Enter the
destination folder in the text field next to the check box.
Note: You can check and uncheck the Pass
through and Output to options in any
combinations for the original documents. If the
Pass through and Output to options are not
selected, the original documents are eliminated
from subsequent processing.
1453
Option
Description
Rename schema
original document using the schema field. You can use
RRT to dynamically set the value of the schema.
If the Rename schema check box is not selected, the
original document name will be used.
If the Rename schema check box is selected and the
schema name is not provided, then at run time the
default schema will be used: ~XMR::FileName~_~
XMR::Counter~~XMR::FileExt~. For example, if
the input file name is File.tif, the renamed file will be
File_1.tif.
If this check box is selected, the component overwrites

an existing file with the same name in the output
directory. This option is related to both generated XML
document and original documents. If this option is
checked, both XML document and original documents
are overwritten. Otherwise, if this option is unchecked,
the presence of a file with the same name for the XML
document or the original document will cause an error
message and stop further processing for this file.
XML template
Read the general information about XML template used in the XML Generator configuration.
The structure of the output file is defined by a template. A template is an XML file that describes in what form the
data will be presented, and it contains all nodes with their values that will be in the output.
You can load a template file in the XML Generator Configuration to see its visual representation in a from of a tree.
You can change the text context of an element or the value of an attribute by highlighting it in the tree and clicking the
Properties button. Any values can be replaced by the available RRTs.
Note: The values of nodes in the original template file can contain the definitions of the available RRTs.
You can define a counter for a node to specify that the node should be repeated in the output XML file. The node will
be repeated for each counter value. You can specify a counter and its max and min values by highlighting a node and
clicking the Properties button. You can use the counter in values of nodes and attributes. A counter also can be used
inside RRTs definition. For example, if you have the following in the nodes in the template
<ParentNode>
<ChildNode id="ID">Data</ChildNode>
</ParentNode>
Specify a counter for the ChildNode Node and set its values to be in the range from 1 to 5. Set the counter for the
value of the id attribute. The result will be as follows
<ParentNode>
<ChildNode id="1">Data</ChildNode>
</ParentNode>
1454
Note: After the user enters the values and clicks OK, the component will change the values in the
configuration file for this process, it will not change the template file itself.
Edit Attribute dialog box
Use this dialog box to change the value of an attribute.
Option
Description
Attribute name
This field displays the name of the attribute.
Attribute value
Enter a new value of the attribute. The value can be

replaced by one of the available RRTs or a combination
of several RRTs.
Note: You cannot use ~XMR::Counter~ for
attribute value setting.
If namespaces are used in the XML file, the
namespace specification attribute cannot be
edited and all the child nodes have the same
namespace as the parent node by default. In the
old versions of the component, another behavior
took place, therefore when you open the old
version's configuration, the component asks to
update the configuration.
All RRTs must be replaced
If this option is on, the component cannot generate the

output XML file without replacing all RRTs used in the
attribute value structure by real data. By default, this
option is off and RRTs, if they are not replaced, appear as
blanks in the output XML file.
Reset
Click this button to return back to the original attribute

value, which is provided in the XML template.
Multiply Node Block dialog box

Use this dialog box to configure the options of repeating one node within a parent node.
Multiplying is useful when you want to output a repeated set of data of the same kind or when you want to map a
table data to xml. See the examples.
Option
Description
Node name
This field displays the name of the selected node.
Counter label
Enter any string that will be used as a counter for the

repeated node. Counter label is case-sensitive.
Note: Every occurrence of the Counter label
in the child nodes will be replaced by the value
of the counter. To prevent an unexpected data
change, make sure that the counter label does
not occur in any value of any child node.
Min value
Enter the minimum value of the counter.
Max value
Enter the maximum value of the counter.

Note:
1455
Option
Description
Maximum number of repeated nodes can be
Max value - Min value + 1.
Max value and Min value should be integer
values. If you enter non-integer value or RRT in
any of those fields, it will cause the following
error message: "Please, enter an integer value".
Max value and Min value can be both positive
and negative, but Max value must be greater or
equal to Min value.
If some RRTs defined by means of a counter
cannot be generated, the node that corresponds
to the counter value that produces an incorrect
RRT will not be included into the output.
Remove
Click this button to remove information about the

counter from configuration. It clears all fields in the
dialog box.
You can multiply one or several nodes. The order in which single and multiplied nodes appear in the output XML
document cannot be modified.
Edit Node Value dialog box
Use this dialog box to change the value of a node.
Option
Description
Node value
Enter one of the available RRTs (or a combination of

several RRTs) to replace node value.
Note: You cannot use ~XMR::Counter~ for
node value setting.
All RRTs must be replaced
If this option is on, the component cannot generate

output XML file without replacing all RRTs used in the
node value structure by real data. By default, this option
is off, and RRTs that cannot be replaced appear as blanks
in the output XML file.
Reset
Click this button to return back to the original node

value, which is provided in the template.

XML Generator component RRTs
Component RRT ID
Component RRT ID is XMR.
RRTN
FileName
Description
The file name of the original document without
extension.
1456
RRTN
Description
FileExt
The file extension of the original document.
Counter

found within the output directory. The counter value
FilePath
The file path to the original documents. This RRT

applies to the XML Generator eConnector component
only. It is available only for the subsequent components
in the workflow.
XMLFilePath
The file path of the generated XML document. This

applies to the XML Generator eConnector component
only. It is available only for the subsequent components
in the workflow.

FRTNs for this component have the following format:
FRTN
Description
FileContentIndex
(for example,~XMR::FileContent1~)
FileNameIndex
Base64 encoded content of the original document, by

index.
The file name without extension and path, by index.
(for example, ~XMR::FileName1~)

FileExtIndex
The file extension of the original document by index.
(for example, ~XMR::FileExt1~)

If XML Generator receives a batch of several files on input, the Index part will be replaced by the number of a file
in the batch. By default, the Index part is 1.
Note: RRTs with index should be commonly used for configuring the output XML structure. In rename
schema of the output files, it is recommended to use RRTs without index.
Name
Description
%a
%A
%b
%B
%d
%H
%I
%j
1457
Name
Description
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y
Examples of Component RRT Usage

If the component receives the batch of three files: Test1.pdf, Test2.pdf, Test3.pdf, the FRTN will be replaced as
follows:
~XMR::FileName1~ = Test1
~XMR::FileName~~XMR::Counter~ will be replaced with the value MyDoc5.xml if the name of the original
file is MyDoc.tif, and there are up to 4 (MyDoc1.xml to MyDoc4.xml) files already within the destination folder path.
~XMR::Year~-~XMR::Month~ will be replaced by 2011-03.
Note: All the component RRTs except for ~XMR::Counter~, ~XMR::FilePath~ and
~XMR::XMLFilePath~ can be used in the output XML file configuration.
Working with large counter values can make the XML Generator component take longer time than usually
because it requires saving a large amount of data into the configuration file. It is critical especially for the
components that store large sets of data in the configuration. For example, one pair of nested counters with values
from 1 to 10 and from 1 to 900 results in a number of data entries equal to 9000. Using this configuration the
component takes more than 1 day to process the data if running on a computer with clock speed 2 GHz.
If namespaces are used in the XML file, the namespace specification attribute cannot be edited and all the child
nodes have the same namespace as the parent node by default. In the old versions of the component, another
behavior took place, therefore when you open the old version's configuration, the component asks to update the
configuration.
Problem description
Solution
The component does not generate any output file. Status

Monitor shows the following error message:
Input data contains no information for replacing some

RRT used to set some node or attribute value with the
"Obligatory RRT has not been replaced (string name)" All RRTs must be replaced option being checked on.
There must be data for replacing this RRT in
, where name is some RRT used in configuration.
configuration. If there is no data to replace it, this RRT
must not be used in configuration or must be used
1458
Problem description
Solution
without checking the All RRTs must be replaced
option.
The component RRTs providing you with the input file

information, for example, ~XMR::FileName1~, are
not replaced in the output XML file. Status Monitor
"Internal XML Generator RRTs (File name, File
extension, File path or File content) are not replaced"
.
There may be no input file for the component. In

particular, there may be eConnector component; for
example, Send to Folder eConnector, with pass through
option turned off in the workflow process before XML
Generator component. In this case the component has no
input file and, therefore, no data for the replacement of
those RRTs.
RRTs from other components are not visible in

the "Available RRTs" window for XML Generator
component.
Most probably, the component generating RRTs is

not a blocking component (other components will
be configured through it) and you are not using Data
Interchange Filter in your configuration. Insert the Data
Interchange Filter in your configuration before the
component generating RRTs. Configure the remaining
components through the Data Interchange Filter.
RRTs from other components used in configuration have

not been replaced by real data in the output XML file.
Most probably, RRTs were not determined in the

"Available RRTs" window for XML Generator
component because they were not visible. Please see the
item above for solution.
Multiplying root element doesn't work.
Multiplying root element will result in creating an

invalid XML document, since an XML document must
contain one and only one root element. Don't try to
multiply the root element, it will not work anyway.
This behaviour will be fixed in a future version of the
component.
The component doesn't process attribute or node values

preset in the template.
The component does not process the value of a node or

an attribute (for example, doesn't replace counters or
RRTs) if it is identical to the value from the template,
that is, if you enter the same value in the configuration
dialog or you don't change the value at all, it will not be
processed by the component. A workaround is to add
space character to the beginning or the end of a preset
value. In this case, the component will process the value
and the space will be trimmed. The problem will be fixed
in a future version of the component.
XML Importer Help

Welcome to the XML Importer component
XML Importer is a process component that is design for extracting data from XML documents by using the XPath
query language. XPath is a powerful tool for extracting nodes and attributes from an XML document. The data
extracted from the input files is then passed to the subsequent components in the process via RRTs or is sent to the
workflow as a new file.
You can use a built-in XPath Designer, which facilitates creation of an XPath query and allows you to test it on a
selected file.
1459
Getting started
Feature highlights
XPath Designer allows you to load an XML file and test an XPath query on it.
Namespaces support.
Pass queries results to the subsequent components in a workflow via RRTs.
Create files from the data obtained by executing an XPath query on an XML file and pass them into the workflow.
Attach existing files to a workflow.
Using the XML Importer component

For using this component, the basic knowledge of the XPath language is required. Please refer to XPath Reference.
Three examples of component usage follow:
Sending invoice information

Transformation of XML file
Getting files' information from XML file
How to send invoice information

Consider an XML file that contains information from an invoice.
<?xml version="1.0" encoding="iso 8859 1" ?>
<Invoice>
<Number>13576</Number>
<Vendor>IT Books</Vendor>
<Date>12-10-2009</Date>
<General>
<Item>
<Name>Beginning XML</Name>
<Price>25.5</Price>
</Item>
<Item>
<Name>XML Step by Step</Name>
<Price>30</Price>
</Item>
</General>
<Total>55.5</Total>
</Invoice>
You may want to send information about the invoice total sum to a manager.
1. Design a workflow with AutoCapture, XML Importer and Send to Mail Recipient.
2. On the Fields tab of the XML Importer configuration, add two search fields.
1. Number with corresponding XPath query: //Number
2. Total with corresponding XPath query: //Total
3. In the Send to Mail Recipient configuration write the following text in the message field.
The total sum for Invoice ~XIM::%Number%~ is ~XIM::%Total%~.
4. Run the process.
5. Send the XML file to the process by AutoCapture client.
The following message will be sent: "The total sum for Invoice 13576 is 55.5."
How to transform an XML file
Consider an XML file that contains information about books: their titles and publishers.
1460

<Books>
<Book>
<Title>Beginning XML</Title>
<Publisher>Wrox</Publisher>
</Book>
<Book>
<Title>XML Step by Step</Title>
<Publisher>MSPress</Publisher>
</Book>
<Book>
<Title>Professional XML</Title>
</Book>
<Book>
<Title>Developing XML solutions</Title>
</Book>
</Books>
You may want to create an XML file with another structure that should contain data about publishers and the books
published by them.
1. Design a workflow with AutoCapture, XML Importer and XML Generator components.
2. On the Fields tab of the XML Importer configuration, add two search fields.
1. Wrox_books with corresponding XPath query: //Publisher[.= "Wrox"]/parent::node()/Title
2. MSPress_books with corresponding XPath query: //Publisher[.= "MSPress"]/parent::node()/Title
The following RRTs will be built:
~XIM::Wrox_books%~ is replaced by "Beginning XML".
~XIM::Wrox_books_1%~ is replaced by "Beginning XML".
~XIM::Wrox_books_2%~ is replaced by "Professional XML".
~XIM::MSPress_books%~ is replaced by "XML Step by Step".
~XIM::MSPress_books_1%~ is replaced by "XML Step by Step".
~XIM::MSPress_books_2%~ is replaced by "Developing XML solutions".
3. In XML Generator configuration, use the following template and use RRTs from XML Importer in the node values
of this template.
<Publishers>
<Publisher Name="Name1">
<Book>Title</Book>
<Book>Title</Book>
</Publisher>
</Publishers>
4. Run the process.
The following XML file will be created:
<Publishers>
<Publisher Name="Wrox">
<Book>Beginning XML</Book>
1461
<Book>Professional XML</Book>
</Publisher>
<Publisher Name="MSPress">
<Book>XML Step by Step</Book>
<Book>Developing XML solutions</Book>
</Publisher>
</Publishers>
How to get information about a file from XML
Consider an XML file that contains data about the books with their titles and publishers. This file also contains the
Base64-encoded image of some book and the reference to the annotation of another book.
<Books>
<Book>
<Title>Beginning XML</Title>
<Image>/9j/4QDmRXhpZgAASUkqAAgAAAAFABIBAwABAAAAAQAAADEBAgAcAAAASgAAADIBAgAUAAAA
ZgAAABMCAwABAAAAAQAAAGmHBAABAAAAegAAAAAAAABBQ0QgU3lzdGVtcyBEaWdpdGFsIElt
YWdpbmcAMjAxMDowMzoxMiAxMzowOToyOQAFAACQBwAEAAAAMDIyMJCSAgAEAAAAMjkyAAKg
BAABAAAADAAAAAOgBAABAAAADQAAAAWgBAABAAAAvAAAAAAAAAACAAEAAgAEAAAAUjk4AAIA
BwAEAAAAMDEwMAAAAAC8KRR8/8AAEQgADQAMAwEhAAIRAQMRAf/bAIQAAwICAgIBAwICAgMD
AwMEBwQEBAQECQYGBQcKCQsLCgkKCgwNEQ4MDBAMCgoPFA8QERITExMLDhUWFRIWERITEgEE
BQUGBQYNBwcNGxIPEhsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsb
GxsbGxsbGxsb/8QAWgABAQEAAAAAAAAAAAAAAAAAAwYIEAABBAICAwADAAAAAAAAAAABAgME
BQYRByEIEhMAFBUBAQAAAAAAAAAAAAAAAAAAAAARAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEA
AhEDEQA/ANZeVHk+/wCP2bYHHWzDj1tlYGwvZljKabH8lpxqPJSw2pf0efQqZHfCUJHshpwA
k7AvuRsXzu6zhmZjPNOb4rDEUNmFRY3X2Mdawte3C7IiOq9j0NBQSAlPWySQe44e47ybkGfy
RkVVY2M66oXsdlRX7iSYaoD4AdY/X9/iAr59kICux30Px0cVYbS43VYxXuZNCg4/XsVUNmvy
ifFQGGkBKAoJe2tQToe6ypWgkb0BoP/Z
</Image>
</Book>
<Book>
<Title>XML Step by Step</Title>
<Annotation>\\srv\Annotations\annot1.txt</Annotation>
</Book>
<Book>
<Title>Professional XML</Title>
</Book>
<Book>
<Title>Developing XML solutions</Title>
</Book>
</Books>
You may want to send the image and the annotation to a folder.
1. Design a workflow with AutoCapture, XML Importer and Send to Folder components.
2. On the Fields tab of the XML Importer configuration, add the search field FilePath with corresponding XPath
query: *//Annotation.
3. On the Files tab, add the following items:
FileName = Image.jpg, Content Type = Base64, File Content = *//Image

Content Type = File Path, File Content = ~XIM::%FilePath%~
1462
4. Configure other components in the workflow.

5. Run the process.
The following two files will be sent to the desired folder:
Image.jpgThe image that was read from the XML file's node.
annot1.txtThe annotation file found by the specified path that was retrieved from the XML file's node.
Configuring the XML Importer component

Activate the component in this window.
Option
Activate
Description
Use this combo box to activate the XML Importer
component. You can use one of the following
alternatives:
Delete original documents
Select Yes to enable the component.

Select No to disable the component. In this case the
component won't perform any actions during files
processing.
Enter a custom value. If the entered value is equal
to FALSE, NO, OFF or 0 (case-insensitive), then
all the settings in the configuration window become
disabled. Otherwise, the settings are enabled. You
can use RRT from other components in this combo
box. If this value is evaluated as TRUE, YES, ON or
1(case-insensitive) at run time, then the component
takes part in the workflow. If this value is evaluated
as FALSE, NO, OFF, or 0 (case-insensitive) at run
time, it does not perform any actions during file
processing. All other values at run time will be
regarded as invalid and the files will be rejected.
If this check box is selected, the original XML

document(s) will be deleted and the component will
pass only the RRTs and/or added files to the subsequent
components. Otherwise, the original XML document(s)
will be passed to the subsequent components.
Tab
Description
Fields tab
This tab contains the list of search fields and the controls
Files tab
On this tab you can specify additional files that will be

created or loaded during the process and passed into the
workflow along with the input document.
Fields tab
This tab contains the list of search fields and the controls for managing this list.
Using XPath query language you can extract certain information from an XML document and assign it to a named
field. The field is passes to the subsequent components in the process as an RRT.
1463
Option
Description
Search Fields
This table displays the list of the search fields that will
be used for building RRTs. Each item of the list contains
the name of the field, the flag indicating whether the
field is required and the text of the XPath query used to
retrieve information for replacement.
Add
Click this button to add a new search field to the list.

This button opens the Add New Field dialog box.
Edit
Select a search field and click this button to edit the

selected search field. This button opens the Edit Field
dialog box.
Remove
Select a search field and click this button to remove the

selected search field from the list.
Up
Click this button to move the item up.
Down
Click this button to move the item down.
Add New/Edit Field dialog box

Use this dialog box to specify a new field.
The name of the field will be used in forming the RRT name. The value of the field is obtained from the XML
document by using a specified XPath query and then passed to the subsequent components via RRT.
Option
Field name
Description
Enter the name of the field.
Note: RRTs should not be used in the Field
name text box, since the entered name is
used for building RRTs for the subsequent
components.
Is required
Select this field if you want the component to reject the

document if the field takes an empty value. When this
option is not selected and the XPath query returns an
empty, the component will simply replace the RRT with
an empty value and give a warning message.
XPath settings
This group of settings allows you to specify the

parameters of the XPath query used for retrieval of the
information that will replace RRTs for this field.
Namespace prefix
If namespaces are used in the XML file and you are

going to create an XPath query to receive an element
or attribute belonging to a particular namespace, you
should specify the namespace prefix in this text box.
For example, if your XML file contains the following
specification: xmlns:bk='urn:loc.gov:books'
and you are going to use an XPath query //bk:title
that refers to the <bk:title> element, you should
enter bk in this text box.
Namespace URI

should specify the namespace URI in this text box.
1464
Option
Description
enter urn:loc.gov:books in this text box.
XPath query
Enter the XPath query that will be executed for each

input document. You can enter the query text manually
or click the Design button to design the query in the
XPath Designer dialog box.
Design
Click this button to design an XPath query in the XPath

Designer dialog box.
Files tab
On this tab you can specify additional files that will be created or loaded during the process and passed into the
workflow along with the input document.
The content of an additional file can be provided by extracting data from the input XML file using an XPath query or
alternatively you can specify the path to the file to be loaded.
Option
Description
Files
This table displays the information about the files that

will be sent into the process. The name of the file is not
displayed if the file is an existing local file.
Add

button opens the Add File dialog box.
Edit
Select an item and click this button to edit the selected

item. This button opens the Edit File dialog box.
Remove
Select an item and click this button to remove the

Note: The order of files in the list does not matter. The component uploads the files marked required first.
Add/Edit File dialog box
This dialog box allows adding or editing an item containing file information.
Option
Description
File name
Specify the file name. You can use RRT in this text
box, in particular the RRT provided from XPath queries
configured on the Fields tab. This text box is enabled
only if the Base64 content type is selected. In this case, it
is mandatory to fill out this text box.
Content type
Specify the type of content to determine how the file

information will be received. You can select one of the
two ways:
Base64 in this case the component will read the

Base64 encoded content from a node or attribute of
the input XML file.
File Path in this case the component will get the file
located at the specified path.
1465
Option
Is required
Description
If this check box is selected, the component will require
the file to be loaded:
File content
For Base64 content type, this means that the XPath

query should return a non-empty result. If the query
does not return any value at run time or returns an
empty value, an error message will appear at run time
and the component will reject the document. If this
check box is not selected and some query returns an
empty value, the component will generate an empty
file and a warning message will appear at run time.
For File Path content type, this means that the file
should exist in the specified path. If there is no file
located in the specified path, an error message will
appear at run time, and the component will reject the
document.
Specify information needed by the system to load a file

at run time. The form of this information depends on the
Content type value:
For Base64 content type, specify the XPath query

that will retrieve Base64 encoded content from a
node or attribute of the input XML file. For example:
You can click the Design button to design the query

in the XPath Designer dialog box.
For File Path content type, specify the full path of
the file that will be loaded at run time. This path may
consist of several RRTs and strings, in particular the
RRT provided from XPath queries configured on the
Fields tab may be used. For example:
Design
*//Title[.='Beginning XML']/../Text
*//KnowledgeDocument/@Content
\\Srv01\~XIM::%publisher%~\~XIM::
%Author info%~
~XIM::%FilePath%~
Click this button to design an XPath query in the XPath

Designer dialog box. This button is enabled only if the
Base64 content type is selected.
Note:
All the files that the component passes to the subsequent components should have different names. If the
component tries to create or upload a file, and another file with the same name has been already created/
uploaded or an original file with such name is passed to the subsequent component, then the component
behavior is as follows:
For required fileThe component gives an error message and the processed document is rejected.
For unrequired fileThe component gives a warning message and the file is not created/uploaded.
If the Base64 content type is used and the query returns non-empty value that is not Base64 encoded, then the
component behavior is as follows:
For required fileThe component gives an error message and the processed document is rejected.
1466
For unrequired fileThe component gives a warning message and the file is not created/uploaded.
The order of the files in the Files tab does not matter. The component will first upload the required files, then
unrequired files.
XPath Designer
XPath Designer allows you to test an XPath expression against a selected XML file.
The result of the query evaluation is displayed in the table bottom of the table.
Option
Sample XML
Description
Select an XML file by clicking
. The file will be
displayed in the area below the field.
Note: The component does not open too big
XML files in XPath Designer. The limit is
80000 symbols.
Field/File name
Specify the name of the field that will be used for RRT
generation or the name of the file that will be created
using the query result.
Note: RRTs should not be used in the Field
name text box, since the entered name is
used for building RRTs for the subsequent
components.
Namespace prefix

should specify the namespace prefix in this text box.
enter bk in this text box.
Namespace URI

should specify the namespace URI in this text box.
enter urn:loc.gov:books in this text box.
XPath query
Enter an XPath query in this field. For example, the

expression "book[@type="Fiction"]" refers to the
<book> elements whose "type" attribute is set to
"Fiction". See more examples of the XPath queries in the
description of the component usage.
Test
Click this button to test the XPath query. The component

will execute the XPath query on the selected XML file
and display the result set in the Result values table.
Result values
This table displays the results of the XPath query

execution. The XPath query result can be either the
search fields, which will be used for building RRTs
1467
Option
Description
(when this dialog box is opened from the Add New/
Edit Search Field dialog box), or the files passed to
the subsequent components in the workflow (when this
dialog box is opened from the Add/Edit File dialog
box).
If this dialog box is used for getting search fields, and
the XPath query returns several results, the component
creates indexed RRTs for the querys result set and one
unindexed RRT for the first value. For example, if an
XPath query returns a result set containing three values
of Invoice Number, the following four RRTs will be
created:
~XIM::%Invoice Number%~
~XIM::%Invoice Number_1%~ (contains the
same value as the first unindexed RRT above)
~XIM::%Invoice Number_2%~
~XIM::%Invoice Number_3%~
For a single output, unindexed RRT will be created:

~XIM::%Invoice Number%~.
If this dialog box is used for getting files, and the XPath
query returns several results, several files will be sent
to the subsequent components in workflow. The index
will be added to the second and the next file names. For
example, if you specify the file name as Image.tif, and
the XPath query returns 2 results, the following 2 files
will be sent to the subsequent components:
Image.tif
Image_1.tif
Note: If the result value is too long to be
displayed in the Result values table, click on it
to see the whole value in a pop-up window.
XML Importer component RRTs

Component RRT ID
The RRT ID for this component is XIM.
This component supports the following RTN value:
Name
Description
File Count
Number of loaded files.

This component supports the following FRTN values:
1468
Name
Description
%Field%
(for example, ~XIM::%Invoice Number%)
%Field_Index%
(for example, ~XIM::%Invoice Number_1%)
%Field Count%
The first result of the query. Field is replaced by the

name of the search field.
A particular result of the query. Field is replaced by the
name of the search field. The #Index# part is replaced by
the index number of the query result.
The number of found values for the search field. Field is
replaced by the name of the search field.
For example, if an XPath query returns the result set containing three values of Invoice Number, the following RRTs
will be created:
~XIM::%Invoice
~XIM::%Invoice
~XIM::%Invoice
~XIM::%Invoice
Number%~
Number_1%~ (contains the same value as the first unindexed RRT above)
Number_2%~
Number_3%~
In this case, ~XIM::%Invoice Number Count%~ is replaced by 3.

For a single output, the unindexed RRT will be created: ~XIM::%Invoice Number%~
For using this component, the basic knowledge of the XPath language is required. Please refer to XPath Reference
in the MSDN Library.
If the component receives several files on input, it will process the first file that has correct XML structure.
The component does not open too big XML files in XPath Designer. The limit is 80000 symbols.
1469
Sunset Components
Basic Image Management
Welcome to the Basic Image Management component
This component allows you to clean up black and white multi-page images. It also lets you split a document into
multiple pages and provides barcode recognition. You can combine these functions based on your business need.
Basic Image Management component uses LeadTools Technologies as the core engine for image file handling and
barcode detection.
Getting started
Feature highlights
This component provides:
Quality improvement of black and white TIFF images by using deskewing and despeckling.
Basic Image Management component can be used to read eight types of barcodes.
Provide coordinates to specify a barcode search zone.
Split an image in either of two ways:
1. Specifying a fixed number of pages that the image should be split into
2. Instructing the component to split the document when a barcode matches a specific value or a pattern.
The values read from the barcode can be used as parameters in subsequent components in the configuration, they can
also be mapped into Fields that automatically will be used by Capture (store) or Process (filter) components that are
able to use this field information.
This component is commonly used for reading barcodes in black and white TIFF images generated from a scanning
device with at least 200 dpi resolution. Depending on the Scanner quality, and the size and type of the barcode being
read, you may need to generate higher quality images in order for the barcodes to be read properly.
If you want to setup your process such that Barcode values are used by other components, configure this component
through a blocking component, such as Digital Sender, MFP, POP3 email. If you plan to use this component with a
non blocking Capture (source) component, place a Data Interchange Process (filter) component before Basic Image
Management component.
In scenarios where barcodes are not being read, or they are only used for splitting pages, the component does not have
to be configured through a blocking component.
Using the Basic Image Management component
This component is used as part of business processes that rely on barcode coversheets or barcode information inside a
document, such as a barcode that represents the invoice number for an order. This component can be used to read the
values of a barcode and then store such information together with the document in one of the Document management
systems supported by the system.
Such information can also be used to dynamically set other values in the configuration. For example, if the invoice is
being sent to a Folder Store component, the final file could be renamed using the invoice number as part of the new
name.
This component is commonly used where the quality of the final image is essential. Use deskewing and despeckling
functions to better the quality of the scanned document.
If you have a process that receives an image file containing several documents inside with equal number of pages, and
these files need to be stored separately, you can use the split function on specific number of pages to implement batch
processing and obtain more efficient results.
1470
Configuring Basic Image Management

Image Processing tab
Check the image processing box to activate the clean up and splitting functions, and to allow the configuration to be
changed.
Option
Description
Image Processing Tab
Select this check box to activate the clean up and

splitting functions, and to allow the configuration to be
changed.
Deskew
Select this check box to deskew the image.
Despeckle
Select this check box to despeckle the image.
Split Type
Split IntoThis option splits the document up into

the specified number of pages that you enter in the
edit box.
Split on Barcode ValueCheck this to split the
document every time it finds the barcode value
specified in the edit box. The barcode value can
contain the wildcards * to match any string of
characters and ? to match any single character.
For example, if * is entered in the edit box, then the
document will split when it finds any barcode. If
1000? is specified then the document will split if the
barcode value is starts with 1000, for example 10002
or 10003.
Keep Barcode PageIf you are splitting based
on the barcode, you can choose either to keep the
barcode page or to discard it.
Pre separatorSelect this check box when you are
using the barcode page as a separator, and you want
the barcode to serve as a separator at the beginning of
the document. If this box is cleared, the component
will assume that the barcode separator is the last page
of the split document and will start a new file after it.
Barcode tab
Enter the Barcode attributes in this tab.
Option
Description
Activate
Check the activate box to enable the barcode processing

function, and to allow the configuration to be changed.
Barcode Type
If you know the exact type of barcode that are going to

be read from the image you can select it here. If you are
not sure, select All linear and the component will read
the barcode using any of the supported barcode types.
The supported barcode types are:
Codabar
1471
Option
Description
Max Barcode
Code 128: Very high density alphanumeric barcode

with 106 different printed barcode patterns.
Code 3 of 9 (Code 39): Alpha numeric barcode,
simpler than Code 128.
EAN 13: European Article Numbering consisting of
13 numbers.
EAN 8: European Article Numbering consisting of 8
numbers.
Interleaved 2 of 5: Numeric only barcode used for
interleaving pairs of numbers in a high density
barcode format.
UPC Version A: Universal Product Code consisting
of 12 numbers
UPC Version E: Universal Product Code consisting
of 8 numbers.
You can specify a maximum number of barcodes that the

component should try to read from a page. If you set this
value to 0, the engine will look for barcodes until the end
of the page.
Specifying a maximum number of barcodes can increase
performance since the component will stop searching the
page for barcode once it has read the maximum number
of barcodes specified.
Advance Read Options
Advance read options are included to further reading

capabilities. Options that can be adjusted are:
Maximum length of a barcodeEnter the maximum
character length of the bar code to be read.
Minimum length of a barcodeEnter the minimum
character length of the bar code to be read.
Number of line of white space above and below the
barcode symbolEnter the number of horizontal
1 pixel lines of white space that should be above and
below the barcode. This option is useful in cases when
the barcode is blurred and avoids a situation where a
single barcode is read as two barcodes.
Enter the number of horizontal 1 pixel lines that will be
skipped when reading a barcode. This option reduces the
time spent reading a barcode. By reducing the number
pixels to skip, will increase accuracy but will take more
time.
Return check digitIf the barcode contains a check
digit, selecting this option will return the check digit of
the barcode that is read.
Error check digitIf the barcode contains a check
digit, selecting this option will not return the check digit
of the barcode that is read.
1472
Option
Description
Search Zone
Restrict the image search area manually by specifying

the coordinates either in inches or millimeters. The
syntax for this as it appears in the edit box is: top, left,
right, bottom where :
Top: Distance from the upper side of the page to the

beginning of the search area.
Left: Distance from the left side of the page to the
Right: Distance from the left side of the page to the
end of the search area.
Bottom: Distance from the left side of the page to the
The search zone can also be specified by graphically

selecting the zone from a sample image file. To do this
click the browse button (...) next to the Search Zone edit
box and select a sample image file from where you can
identify the search zone, and click Open. You will be
presented with a preview of the first page of the image.
Move the mouse to the preview area, note that the cursor
will change to a cross sign, click on the image and drag
the cursor to select a square section of the image and
click Ok. This is the area where the component will
search for barcodes. You can change the file used for
previewing by clicking on Open and selecting a different
image.
Field Values
Click Add, to provide the field name specifying the

barcode value that should be associated with this field.
Click the browse button (...) next to the Barcode value
box and provide the page number and barcode value of
the barcode that contains the information that should be
assigned to this field.
You can also specify the barcode value directly by
using a specific syntax. For details about the syntax and
combination of values that can be used when assigning
field values, refer to Component RRTs page.
Component RRTs
RRT ID
The RRT ID of this component is L1B.
Usage notes
If barcode reading is activated, the values for single barcodes in different pages can be used to dynamically configure
other components in the configuration. By using different variations in referencing the page number and location
where the barcode is, you can not only refer to a single value but to the concatenation or several values or even all the
barcodes read for a document.
1473
The syntax used to refer barcode values that were read from the image file is as follows:
~L1B::PageNumber,BarcodePosition~
Where PageNumber is the image page where the barcode is located and BarcodePosition is the position of the
barcode on the page counting from left to right and from top to bottom.
There are some special characters that can be used instead of a specific PageNumber or BarcodePosition,
these are:
*Any Page Number or Barcode Position.

-1Last Page or Barcode Position.
So for example the possible combinations are:

RRT Scheme
Description
~L1B::*,BarcodePosition~

~L1B::PageNumber,*~

file.
~L1B::-1,-1~

~L1B::-1, BarcodePosition~

~L1B::*,*~

Remember: If you are using splitting on barcode, the term last page refers to the last page of the image file
after it has been split.
Problem
Solution
The Basic Image Management component cannot read

one of the supported barcode types.
barcode is located. Using the image that contains the
barcode as a sample, change the search zone so it
includes the location where the barcode appears. If you
are not sure if this locations is always going to be the
same for all images then do not use a search region, and
the component will try to find the barcode in the entire
page.
The status monitor shows that the barcodes are being

read, but the barcode values references are not being
replaced.
Your Capture (source) component is not a blocking

component and you are not using Data Interchange
Process (Filter) component in your configuration. Insert
the data interchange component in your configuration
before the Basic Image Management component, and
configure the remaining components through the Data
Interchange component.

The Basic Image Management component can only receive 1-bit (Black and White) TIFF images.
1474
FileMagic
Welcome to the FileMagic component
Use the FileMagic eConnector and FileMagic route components to process and store documents into the Westbrook
FileMagic Document Management System. FileMagic users can efficiently store content from a variety of sources
into a database. Once the content is captured, it becomes available for retrieval and collaboration across the network
within the organization.
Now you can design and implement workflow that capture electronic documents from a variety of sources such
as MFP devices, network/local folders, PC desktop, POP3 email servers to manage and store your documents into
FileMagic.
The only difference between FileMagic eConnector and FileMagic route component is that the eConnector
component provides a document pass-through option. This option, when selected, passes the document to the next
The FileMagic component supports FileMagic version 2.2 with Service Pack 5.
Getting started
Feature highlights
The FileMagic eConnector and route components support the following FileMagic features:
Automate document routing into FileMagic document management system.

Add metadata to documents for indexing.
Using the FileMagic component

Using FileMagic component:
Scan documents from a FTP site directly into FileMagic: Design a workflow process by selecting FTP site that has
a series of files to be processed. You can configure the FileMagic component to assign document fields, depending
on the Document Type that was selected. The document with the set attributes is routed directly into FileMagic.
FileMagic: Design a workflow process by selecting Poll Directory capture component. From the component tray,
select the desired process components and select the FileMagic route component for storing the scanned document
into FileMagic. You can configure the FileMagic component to assign document fields, depending on which
Document Type was selected. With the Server running, the walk-up MFP user (with or without authentication),
enters a pre-configured function key on the control panel of the MFP device, the document along with the set
attributes is routed directly into FileMagic.
Configuring the File Magic component

General tab
Configure the FileMagic options on this tab.
Option
Description
User Name
Enter a valid user name. This user name along with the
associated password is used to authenticate the user into
FileMagic.
Password
Enter a valid password.
Database
Select the database to which to store documents.
1475
Document tab
Configure document options on this tab.
Option
Description
Document Type
Select from the available document types that you

would like to associate to the document you are storing.
Document Types define the nature of the contents
of a document, including all the fields used to index
documents of this type.
For example a Medical Form has the name of the patient
and the doctor. The patient name and the doctor name
fields would be associated with that document type.
The fields are used for indexing the documents. In other
words, depending on the document type you choose you
have different fields associated to the document.
Folder
Select the folder that you would like to store the

document into.
If the folder does not exist, the files are stored in the root
of the database. With this component, dynamic folders
cannot be created.
Description
Enter a description of the original document.
Fields tab
Configure the field options on this tab.
Option
Description
Add
You can create field values that get stored with the
document in FileMagic.
Click this button to open the Add a Property dialog
box. In the Add a Property dialog box, select the
properties that you want to add to a file. These properties
are subject to change depending on the document
type specified by the Document Type option on the
Document tab. Each document type has its own specific
set of fields.
Modify
Click this button to modify the field value attributes.
Remove
Click this button to remove a field value.
FileMagic Component RRTs

Component RRT ID
The RRT ID for this component is FMG.
The following table describes the reserved RTN value for this component:
1476
Name
Description
ID
The unique identifier for the stored document, which can

be used by the eConnector in proceeding components.
Example: Configure a process with the FileMagic eConnector and the Send to Database Route component. When the
Send to Database component is configured with the appropriate table, specify a field with the value of ~FMG::ID~.
When the documents are successfully stored into FileMagic and passed to the Send To Database component, and ID
entry is added to the database.
There are no FRTNs for this component.
Folder Store
Welcome to Folder Store
Folder Store component is a Route component that allows files to be copied into any local or network directory. Using
directories is one of the fastest methods for implementing a document storage system as, storing files into flat folders
requires no database, no application, and lower cost of ownership. Using Folder Store you can create business rules
for folder location, security access, and file naming of scanned imaged and processed file.
This component is also capable of checking security access level of the user prior to storing documents into folders.
Using the check security feature, users scanning document into folder destination can only store into the destination
directory if proper access level is provided by the administrator. Using this feature an organization can implement a
secured storage location that only accepts files based on security settings.
If you enable the Check User Security option, you need to have Active Directory Services with a minimum of
Windows NT 2000 4.0 and Service Pack 3 and later.
Getting started
Feature highlights
Create dynamic folder names and locations.

Option to rename the file, based on document index information, field values, or field value references.
Option to Check User Security to check user level security against the destination folder location. Only accept
users with write permission to store files into destination location.
All types of files including images can be processed through this component.
Folder store is fully integrated with other components such as Barcode, Form Recognition, OCR, PDF, etc. For
example, a barcode value can be used as part of destination folder name to create dynamic destination folder based on
barcode values on the document.
1477
Using Folder Store

A list of most common usage scenarios are provided below:
A very common usage scenario is where a user logs into a device, scans a document and the document is placed in
user's directory on a shared network drive.
Use this component to store information into a folder where another process will be reading the information for
processing.
Configuring the Folder Store component

Folder Store options
Use the options in the Folder Store Configurations to define how documents are stored are stored to a folder.
Option
Description
Folder path
Enter the destination folder path where files are copied.

The server must have write access to this folder. The
input device can dynamically set the folder path.
Select this check box to overwrites any file that has the
same name as a routed file.
Rename file
Select this box to rename the output file based on the

Schema option.
Schema
evaluate the schema at run time.
If the Rename file check box is cleared, the default
schema name is:
~FLD::FileName~_~FLD::Counter~~FLD::FileExt~
For example, if the input file name is File.tif then
the output file name will be File_1.tif when the file
count is 1.
Check user security
Select the Check user security check box to enable

the server to check for the write permission on the
destination folder for the user specified in the User
name box.
Select this check box to have the system confirm that
the user or sender security level includes write access.
This relies on a lookup in Active Directory Services to
verify that the user has security rights to copy files to the
designated folder.
Tip: To allow processes to write to a
shared network location, use the AutoStore
Service Manager to specify a domain name
(domain\username) and password with write
permission to the network share. You can
use group permissions to provide access for
multiple users.
1478
Option
Description
Username
Enter the user name for the directory. The most common
usage includes use of RRT variables to evaluate this
value at run time.
Folder Store component RRTs

Component RRT ID
The RRT ID for this component is FLD.
Name
Description
FileName
Counter

FileExt
The RRT string ~FLD::FileName~~FLD::Counter~ is replaced with the value Document5 if the original
file name was Document and there were up to 4 (Document1 to Document4) files already within the destination
folder path.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
1479
SSRTN
Description
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

The RRT string ~FLD::%Y~-~FLD::%m~ will be replaced by 2003-9.
Problem Description
Solution
Access is denied to a directory
User does not have appropriate access rights to the

directory. Check with the administrator to grant you the
proper rights.
Path not found message
Make sure the username used for mapping drives is the

same as the username that runs the service. Run Service
Manager in Control Panel to view the user name that is
logged into Windows. Confirm that this is the same user
that mapped the drives, as mapped drives are user based.

We recommend to use the ~FLD::Counter~ RRT in the schema name definition rather than %c.
FTP Store
Welcome to FTP Store
This component is a destination component that provides you with the mechanism for storing files that are fed from a
source component to the FTP site for storage. Additional control over the FTP site transmission is provided through
support for secured FTP sites as well as bandwidth flow-control.
You can design your process according to your business process, such that a client (anonymous or specific) may then
open an FTP session to this server to access documents as required by business needs or processes.
Getting started
Feature highlights
Active flow control

Secured FTP site access
Supports dynamic file renaming and storage
Using the FTP Store component

An enterprise where PDF documents from several sources need to be placed on an FTP server. These documents
may then be processed for printing, or sending out as email.
1480
Connectivity of remote offices to central office can easily be implemented using FTP component. Scanners from
all remote sites can easily be connected to central site using a secured FTP protocol.
feature of FTP component. Bandwidth control lowers the impact of implementing distributed scanning on
Configuring the FTP Store component

FTP Store options
Configure attributes for the FTP site on this tab.
Set the attributes of the FTP site here.
Option
Description
Server name
Specify the IP address or the server name of the FTP site.

You can also specify the ftp site as ftp://companysite.com.
User name
Specify the user name of the client that will have access
right to the FTP site.
If you do not specify the user name, by default the access
permission will be set to anonymous.
User password
Specify the password that is associated with the user

name.
Destination Folder Path
You can specify the folder where the documents will be

stored on the FTP server.
If you specify a new folder in the dialog box, a new
folder with the same name is created on the FTP server.
However, if you do not specify a path or folder name, the
data gets stored on the root directory of the FTP server.
Overwrite Destination File
Check this box if you want the newly created files on the
FTP site to get overwritten on the existing files of the
same name on the FTP site.
If you do not check this option, the file will
automatically be appended with a number that is
incremented each time a newer version of the file is to be
stored on the FTP site.
Rename File

renamed based on the Schema settings.
Schema
Enter the schema name for the output file. You can use
Runtime Replacement Tags (RRTs) to dynamically set
the value of the schema at run time.
Advanced Settings tab

Options on this tab optimize the flow control settings.
Option
Activate Flow Control
Description
1481
Option
Description
Transfer Rate in MillisecondsUse this knob to

set your desired transfer intervals in Milliseconds.
The longer the interval the slower the transmission
rate.
Buffer Size in BytesUse this knob to set the size
of each transmitted buffer. The larger the buffer size
the higher the transmission rate and the larger impact
on the bandwidth.
The FTP Store component provides this method to flow

control the speed at which the data is transmitted. The
purpose of the flow-control option is to provide means
to manage the impact of FTP transmission may have on
the transmission bandwidth from remote sites. The flow
control knobs allow you to control the size of the buffer
and the transmission interval of each buffer. Additional
control is provided to test the flow control speed and
provide an easy to use method to check the transmission
speed.
Run Test
Run Test Test will be conducted against your FTP

site. Make sure you have specified correct FTP site,
user name and password. The tests are conducted
using 100Kbytes buffers and at the end of each
test cycle the results are reported in 100 Kbytes/
X Seconds. Where X is the number of seconds it
takes to send 100 Kbytes. Normal B/W documents
are between 25 to 50 Kbytes. The size of images
could vary based on type of scanner settings and
you should observe your scanner setting parameters.
Please note that you must have write access to
conduct FTP testing against a site.
Stop Click this button to terminate test buffer
Note:
To use the test feature the user must have access
to the FTP site from the workstation. This
feature establishes connection to the FTP site
and transmits dummy data to the FTP site to
test transmission bandwidth.
FTP Store component RRTs

Component RRT ID
The RRT ID for FTP Store component is FTP.
The following table describes the reserved RTN values for Schema option of this component.
Name
FileName
Description
1482
Name
Description
Counter

FileExt
The RRTs ~FTP::FileName~~FTP::Counter~ are replaced with the string Document5 if the original file
name was Document and there were up to four (Document1 to Document4) files already in the destination folder.
SSRTN
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
%y
%Y

~FTP::%Y~-~FTP::%m~ is replaced by 2004-10.
1483
Problem Description
Access denied message
Solution
Check username/password to make sure it is valid.

Check to make sure there are no firewalls

iManage
Welcome to the iManage (6.x) component
iManage DeskSite is an Enterprise Document Management System that can manage repositories of millions of
documents for thousands of users and provides searching, document check in/out, versioning, document profiling,
complex security features and more. For complete information on all the features, refer to the Manage DeskSite
documentation or http://www.imanage.com.
The iManage component allows organizations to further take advantage of their iManage Systems, by sending
documents directly from different sources such as Digital Senders, Multi-functional devices, Scanners or a POP3
Email account into iManage, offering enough flexibility to layout this process in a manner that adjusts to the business
rules of the organization.
Getting started
Feature highlights
The iManage component allows you to store a document and all the profile information associated with it, such as
Name, Description, Default Security, Type, Class, Author, Operator, and custom profile fields, such as Client and
Matter, that are particular to the iManage implementation.
Features for this product include the following:
Store documents and standard and profile information.

This component will also allow you to specify users and groups that will have access to the document, as well as
the level of access.
Import any kind of document into iManage, based on valid Type and Class associations for the documents.
Using the iManage component

Use the iManage component to extend the capabilities of an iManage system and provide users with alternate means
to store documents. The iManage component, when used in combination with other Capture (source) and Process
(filter) components allows an organization to implement very complex workflows, either involving interactive
participation of the users or unattended environment.
Use this component to categorize documents using index data that was obtained from barcode cover sheets, or
indexing stations using OneStep, or from multifunctional devices that support indexing.
Use POP3 Email Capture component with iManage Route component in a workflow scenario where users
email documents to a general-purpose Public folder in iManage. Assume the business process is that we are only
interested in knowing who sent the document along with a brief description of the document. The following
1. A user writes an email using his/her iManage User Name in the subject field, and a brief description of the
document in the email body.
2. The user then attaches a document to send to iManage.
3. After the email is prepared the user sends the email to an address defined through the POP3 email component.
1484
4. POP3 captures the email and proceeds to detach the document and create Runtime Replacement tags based on the
email headers that can be used by iManage.
5. The system routes the document to iManage component.
The administrator has configured iManage with fixed values for each one of the required parameters, except for
the Author field and Document Description. Instead of using a fixed values, the administrator uses Runtime
Replacement Tags (RRTs) from the POP3 component, ~POP::To~ (representing the To field of the email
received) has been assigned to the Author and ~POP::Body~ (representing the message body of the email) has
been assigned to the Description.
This example demonstrates how Routing documents to iManage using POP3 Email works.
Configuring the iManage component
General tab
This tab allows you to configure the parameters for connecting to the iManage library where the documents will be
stored.
Option
Description
Server
Enter the iManage DeskSite server name or host IP

address.
Database
Enter the iManage database name.
User Name
Enter the iManage user name. The user name must have
permissions to create documents and publish them in the
specified database/server.
Operator
Enter the operator of the document. This user has read/

write access, and can set the document's access rights.
Author
Enter the author of the document. This user has

maximum security rights, and is the Novelle owner of
the document.
Document tab
In this Tab you can configure the generic profile information for the documents that will be stored in iManage.
Option
Description
Name
Enter the short name for the document. The short name
can be up to 16 characters long.
Description
Enter a text description of the document. This field can

contain up to 254 characters.
Default Security
This is the general security settings for this folder. There

are 3 possible default security settings:
When the default security setting is set to PUBLIC,

all users with access to the library will be able
to view and edit the document and its profile
information except those users and groups of users
that are specifically denied access on the Security
tab.
When the default security setting is set to PRIVATE,
users do not have access to the document except for
the author and operator named on the General tab as
1485
Option
Description
File
well as users and groups to whom you specifically

grant access on the Security tab.
When the default security setting is set to VIEW,
all users have read-only access to the document
except for the Author and Operator named on the
General tab as well as those users and groups
granted full access, read-write access, or no access on
the Security tab.
In this section, enter the file attributes. The file type is

normally based on the application that was used to create
the file. Document class defines the default settings for
the document.
Click on Add to enter the extension of the file and

the document type and class that will be associated
with it.
To modify or remove an extension, type, or class
association after it had been added, select the
respective item from the list and click Modify or
Remove.
For example if the process is receiving scanned

images (TIFF or PDF format) from a multifunctional
device,click Add to create two entries. One entry for
documents with the extension .tif and another entry
for documents with the extension .pdf. You can also
accomplish this by dynamically setting these values at
run time with scripts or by using a combination of the
different Runtime Replacement Tags provided by other
components.
Field Values tab
In this tab, specify names and values that identify the custom fields that you want to associate to stored documents.
Option
Add
Description
Click on Add to enter the name of the custom category
in the Name box and the value for it in the Value box.
When entering the name of the custom field take into
account that this must be the internal name that iManage
uses to refer to this field, which can be Custom1 to
Custom30.
If you are entering values for custom fields Custom1
and Custom29, you must provide valid values that
come from the Custom1 and Custom29 lookups, these
fields also have a subcategory associated to them. For
Custom1 the subcategory is Custom2 and for Custom29
the subcategory is Custom30. For the subcategory
fields, you must provide valid values from the Custom2
and Custom30 lookups associated to the Custom2 and
Custom30 fields. Keep in mind that if you are entering
values for custom fields Custom2 and Custom30,
you must provide valid values for fields Custom1 and
Custom29 respectively.
1486
Option
Description
If you are entering values for custom fields Custom3 to
Custom12 you must provide valid values that come from
the Custom3 to Custom14 lookups.
In general you must ensure that valid values are provided
for all fields that are required to be filled in, based on the
Class that will be associated with the document. Failure
to do so will cause the document to be rejected since all
the required fields were not found.
As with other parameters in the configuration, you can
enter a combination of fixed and Runtime Replacement
Tags on the Field Values tab, or for more complex
workflows scripting can be used to populate these values
at run time.
Modify
Select the field value that you would like to modify and
click Modify.
Remove
Select the User/Group that you would like to remove and

click Remove.
iManage Runtime Replacement Tags (RRTs)

This component does not generate Runtime Replacement Tags, however all the parameters can contain RRT
strings. For example, when POP3Email is the capture (source) component, the "Author" parameter can be set to
~POP::To~, which represents the "To" field of the email received .
Set the "Description" parameter to ~POP::Body~, to represent that the message body of the email has been assigned
to the Description. In this example, we have a document in iManage and we know who sent it and what it the subject
of the email is.
No information is available.
The iManage component does not support version handling. Any document added will be added as new
documents. The user can add a new version of the document afterwards by using any other iManage interface that
has versioning features.
The Subclass category cannot be specified through the iManage component, do not try to set it through the Field
Values tab since this is not considered a custom category.
Kyocera MFP
Welcome to the Kyocera MFP component
The Kyocera capture component extends the capabilities of Kyocera multi-functional devices to additional document
capture and processing choices as well as routing and storage into a variety of Document Management Systems.
Design your process to capture documents from network-based Kyocera Multi-functional Devices and process the
content by using best of breed plug-in technologies for OCR, Form Recognition, etc. , and finally route to storage
and archival in to your DMS of choice such as Microsoft SharePoint Portal, Hummingbird, Documentum,
iManage, TRIM, FileNet and many others.
This component supports various Kyocera MFP devices.
1487
Getting started
Feature highlights
The Kyocera component extends the capabilities of Kyocera 3035/4035/5035 devices by providing the following
features:
Create and manage Groups of devices.

Create and manage multi-levels of Menus for groups of devices.
Create and manage Forms that enables capture of meta-data.
Configure Scan Setting parameters to match with desired content input to the device.
Dynamically customize form fields by using VB Scripts.
Device configuration
Configuring from the device panel
To configure the device after the firmware has been installed, the following steps must be completed:
1. Press the "Default Setting/Counter" button on the device.
2. Select "Scanner default" on the display screen.
3. Enter the password. The default password for Kyocera 3035 MFP is 3000; for Kyocera 4035 MFP is 4000 and for
Kyocera 5035 MFP is 5000.
4. Select "System Basic" on the display screen
1488
5.
6.
7.
8.
Press the down arrow key on the display until you see "KYOCapture".
Press "Change " on the display.
Select "On" and enter the IP address and port number (37169 is default) of the AutoStore server.
Once you have configured everything, press "Close" on all the screens until you return back to the main screen.
Configuring from the embedded web server
Obtain the device IP Address.

Open internet explorer and browse to http://<Device IP Address>.
From the left hand menu select System Basic Settings.
Click the Enterprise Mode link.
Under KYOCapture powered by AutoStore, click on Enable and enter the IP address and port number (37169 is
default) of the AutoStore server.
Click on the Registration button to submit the changes.
Scanning a document
Follow the steps in this procedure to scan a document from the Kyocera MFP console.
1. Press Scanner button on the Kyocera MFP device. The LCD display changes to Select scanner.
1489
1490
2. Click KYOcapture soft key. This initiates a connection to the Server.

If the Server is not accessible or the service has not been started, a "Communication Error message is
displayed on the Kyocera MFP Control Panel LCD. Note that if the Kyocera device is configured to work with
Authentication Server, the device initiates connection to the Authentication Server prior to connecting to the
server. If this communication fails, a "Communication Error" message is displayed on the device Control Panel
LCD.
3. At this point the Kyocera control panel displays a list of menus and forms.
A menu is an organizational unit, used to group other menus and forms. Menus do not have any fields associated
to them, and cannot be used for scanning.
1491
4. Select a form by navigating through menus.
When menu is pressed, a list of submenus (if any) and forms will appear.
5. Select the desired form and enter meta-data, as each field appears on the control panel LCD.
The following image shows a form with a field type of "String List".
1492
6. After you are finished entering data into the form, or if there are no form fields to populate, press the Start button
to begin scanning a document.
Supported devices
Kyocera MFP (3035/4035/5035)

Scanner Firmware: KM-3035 Ver2.64.0
Network Firmware: NS-30 Ver1.3.00
1493
Using the Kyocera MFP component

Use the Kyocera MFP capture component in conjunction with process and route components to design your
workflow. The workflow can be designed to accomplish very simple tasks such as sending a scanned document to
a folder to more complex tasks such as, cleaning and performing OCR on the image and routing the document to
multiple Document Management Systems (DMS).
Create a workflow process that takes input from multifunctional devices by using the Kyocera capture component.
If your workflow requires conversion of the scanned documents to a searchable PDF format and stored into an
MSQL server database, simply insert the OCR Process component to your workflow process. The component will
OCR the image into a searchable PDF before storing it. Finally, insert the Send to Database Route component to
store the document into MSQL through ODBC.
Configure the Kyocera component to create Menus and Forms that will be displayed on the MFP device Control
Panel Touch Screen LCD. For each form that you create, specify the configuration parameters associated with that
form.
Create a workflow process that reads Barcode images scanned from a Kyocera multifunctional device, indexes
the images and stores the images into Microsoft SharePoint Portal Server as well and Documentum DMS. In this
scenario, design your process with the Kyocera capture component, followed by PDF417 Process component
and the Multi-Router Route component. Multi Router component allows routing and storage into multiple Route
components. In this example, configure the Microsoft SharePoint Server component as well as the Documentum
component through the Multi-Router component.
Configure the Kyocera component to create Menus and Forms that will be displayed on the MFD Control
Panel Touch Screen LCD. Create 2 forms where if form1 is selected from the MFD control panel, documents
will be routed to Microsoft SharePoint Portal Server and if form2 is selected, the documents will be routed to
Documentum DMS.
When creating a process workflow, you can include as many Process components as are necessary for your
application. The nature of the workflow process that you are designing dictates the order of the Process
components used in your process.
Configuring the Kyocera MFP component

MFP Menu tab
The MFP Menu tab consists of a single graphical display of all MFP device groups, menus, forms, and fields. Each
of these entities can be managed directly from this tab using the side buttons available on this tab.
The MFP Menu tab contains Common MFP Group entry presented on the top of the list of the menus display. The
Common MFP Group, unlike other MFP groups, does not take any device members. By default, any MFP that is not
a member of other MFP groups is considered a member of this group. Use the Common MFP Group to create the
default menus/forms definitions appearing on your most common MFP devices.
Option
Add Group
Description
Use the Add Group button on the MFP Menu tab to
create additional MFP groups. MFP devices that are
members of a group have a menu structure that is
independent of the Common MFP Group.
When you click the Add Group button on the MFP Menu
tab, the MFP Group dialog box appears. The MFP Group
dialog box contains the following elements:
Group NameThis name is a string value that

describes the group. It does not appear on the MFP,
but is used as a logical group name.
Group DevicesThis area of the dialog box lists
the member-MFP host names or IP addresses. To add
devices, enter the IP address of the MFP. An MFP
that is added to this group no longer has the same
menu structure as the Common MFP Group. MFPs
1494
Option
Description
that are removed from this group inherit the menus
from the Common MFP Group.
Add Menu
Test Address: Click on this button to confirm IP

connectivity to the device.
Remove: Select a device entry and press Remove
to remove a device from the list.
Add a menu to create a hierarchy. The menu items are

simply an entry within a tree hierarchy.
MFP Menu NameThe name of the menu item.
Edit
Click this button to edit properties for a selected group,

menu, or form.
Remove
Click this button to remove a select group, menu, or

form.
Add group
Use the Add Group button on the MFP Menu tab to create additional MFP groups. MFP devices that are members of
a group have a menu structure that is independent of the Common MFP Group.
When you click the Add Group button on the MFP Menu tab, the MFP Group dialog box appears. The MFP
Group dialog box contains the following elements:
Option
Description
Group Name
This name is a string value that describes the group.

It does not appear on the MFP, but is used as a logical
group name.
Group Devices
This area of the dialog box lists the member-MFP host

names or IP addresses. To add devices, enter the IP
address of the MFP. An MFP that is added to this group
no longer has the same menu structure as the Common
MFP Group. MFPs that are removed from this group
inherit the menus from the Common MFP Group.
Test AddressClick on this button to confirm IP

connectivity to the device.
RemoveSelect a device entry and press Remove
to remove a device from the list.
Add menu
Add a menu to create a hierarchy. The menu items are simply an entry within a tree hierarchy.
Option
MFP Menu Name
Description
The name of the menu item.
Add Form
Add a form to capture index data for the scan job. To add a form click the Add Form button and configure options on
the following tabs to specify the form attributes:
General Tab
Components Tab
1495
General tab
Field name
Description
Form Name
The name of the form you want to be displayed as a

button name on the MFP.
Scanning Mode
File Format
Resolution
OCR
Photo
Text
TIFF
PDF
200 DPI
300 DPI
400 DPI
600 DPI
Color Type
Only Black and White is supported at this time.
Multiscan
Check this box if the document you are scanning is

comprised of multiple pages and you want to scan the
entire document as one scan job. Note that this option
does not provide the capability to switch input feeder
between Flat-Bed and Automatic Document Feeder for
a job. With Flat-Bed multi-scan, you may scan multiple
documents of same or different sizes. With Automatic
Document Feeder multi-scan, you can scan different
sized, and large number of documents.
Script
Use VB scripts to dynamically customize the Form

Fields. For example, you can write a VB script to
dictate the behavior of the form based on the user that
is authenticated to the device. You can also write a VB
script to initialize a set of fields and related attributes
and/or to validate user-entered data. Note that if you VB
script does not compile properly, the form will function
as if no script was configured at all. However, the Status
Monitor logs the script error event.
Form Fields

you have added the first row you can tab through to get
field Name, Comment, and Type. The field attributes
are:
Field NameField label name is a string type

and can be any alphanumeric characters. Use of
special characters (~, !, @, , $, %, etc.) are not
recommended.
1496
Field name
Description

within the MFP.
Required Click in the checkbox if the field you
are adding is mandatory.
Type
String: Alphanumeric field

Password: Alphanumeric field
String List: Keyword list of values
Integer: Integer values
Float: Floating numbers
Date: Date values
For each field type, you can further set the field
attributes by selecting the Properties button on the right
most column on each entry.
Components tab
This tab displays a numbered list of all components in the process along with their description and type. The
configuration button appears as the last column of each row with appearing on it. Click on the configuration
button to set the component configuration attributes.
VB scripting
Events
Initialize(UserName, EmailAddress)
InitializeField(FieldName, FieldValue)
ValidateField(FieldName, FieldValue)
Initialize(UserName, EmailAddress)
Arguments
UserName
The logged on users username
EmailAddress
The logged on users email Address
Remarks
You can use this event to determine the current logged on user and perform any needed initializations
Example
Dim g_UserName
Dim g_EmailAddress
Sub Initialize(UserName, EmailAddress)
Write custom code to keep the logged on username information for later use
1497
g_UserName = UserName
g_EmailAddress = EmailAddress
End Sub
InitializeField(FieldName, FieldValue)
This event occurs prior to when a field on a form is displayed.
Arguments
FieldName
The name of the field
FieldValue
The value of the field
Remarks
You can use this event to provide a field value
Example
Function InitializeField(FieldName, FieldValue)
If (FieldName = Path) Then
InitializeField = LookupHomeDirectory(g_UserName)
End If
End Function
ValidateField(FieldName, FieldValue)
Arguments
FieldName
The name of the field that requires validation
FieldValue
The value of the field that requires validation.
Remarks
Example
Function ValidateField (FieldName, FieldValue)
ValidateField =
Write custom validation to check that the user is attempting to enter a value for the Amount field that is less then
100.
ValidateField = Amount cannot be greater than 100.
End If
1498
End If
End Function
Sample script
Dim emailAddress
Dim userName
' The form has 2 fields Field1 and Field2. Field1 type is string.
' Field2 type is StringList.
' save UserName and EmailAddress for later reference
function Initialize(UserName, EmailAddress)
userName = Name
emailAddress = Email
end function
function InitializeField(fieldName, fieldValue)
'custom initialization for user with a name equal "Name1"
if fieldName = "Field2" and userName = "Name1" then
InitializeField = "Selection1, Selection2, Selection3"
exit function
end if
'custom initialization for user with aname equal "Name2"
if fieldName = "Field2" and userName = "Name2" then
InitializeField = "Selection3, Selection4, Selection5"
exit function
end if
'do nothing
InitializeField = ""
end function
function ValidateField(fieldName, fieldValue)
'custom validation
ifemailAddress = "useraddress@nsius.com" and fieldName = "Field1" then
if (fieldValue != "TestValue")
'Displays"Invalid Value" on scanner Panel
ValidateField = "Invalid Value"
exit function
endif
'do Nothing
ValidateField = ""
end function
Preferences tab
Use this tab to control the Kyocera MFP internal attributes for storing, forwarding, and routing MFP messages.
Option
Description
Home Directory
Specify the root directory where the server creates all

temporary directories and files necessary for controlling
the MFP related traffic. The server must have proper
permission to write to that directory.
Port Number
The TCP/IP port number used by the server to

communicate the group, form, and menu updates to the
Kyocera device. The server listens on this port number to
receive requests from all the Kyocera devices.
1499
Option
Description
The same port number must be configured on the
Kyocera MFP device.
Time out
A device connecting to the server establishes a session

with the server, collecting menu, form, and group
updates. If there is no ongoing communication between
the MFP device and the server, the device will close the
connection due to inactivity.
Enter the session time out value here. By default, after
2 minutes of inactivity the device will close the session
with the server.
Keep

files (send to folder/application files) are stored into
Files directory when the server successfully
Keep in mind, if this is turned on, a copy of every
file that has been routed successfully is saved on
this directory. Make sure that proper disk storage is
allocated for this directory.
Rejected filesThe Rejected Files directory is used
for storing any files that failed to store into the final
destination location. The failure could be due to any
number of reasons and it must be researched through
searching the application log file entries. Typically,
it is beneficial to have a secondary process that takes
this directory as an input and routes messages out to
The server must have sufficient permissions to access
this directory.
Kyocera MFP component RRTs

Component RRT ID
The RRT ID for this component is KMC.
Name
Description
PageCount
Number of pages received. This applies to TIFF images

only.
Format
File format values:
FileSize
PDF
TIFF
Received file size.
1500
Name
Description
IP
IP address of the MFP device.
MainMenu
Top level menu item name.
SubMenu
Sub Menu Path.
HostName
If available, it is the hostname of the MFP, if not it is the

IP Address.
SenderName
Name of the authenticated user.
SenderAddress
Email address of the authenticated user.
The RRT scheme ~KMC::PageCount~ is replaced with the value 10, for a ten page TIFF document.
The RRT scheme ~KMC::Format~ is replaced with string "PDF", if the file sent by MFP is a PDF file.

This component does support FRTNs and replacement of field names generated from the MFP devices. The
~ACC::%Client ID%~ is replaced by Company if the user types in Company for the field name called
Client ID.
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
%H
%I
%j
%m
%M
%p
%S
%U

day of week (0053)
%w
%W

day of week (0053)
1501
Name
Description
%y
%Y
Problem Description
Status Monitor displays error.
Solution
This event may occur due to several reasons:
The Kyocera device displays an error message on the

control panel LCD.
The evaluation license key has expired.

The maximum number of concurrent licenses has
been exceeded
This event may occur due to several reasons:
The evaluation license key has expired.

The maximum number of concurrent licenses has
been exceeded
The device is unable to connect to the Authentication
server (if the device is configured to work with
Authentication server).
The device is unable to connect to the server.
Server rejecting jobs.
Form Button names cannot contain " / " character.
Server fails to start.
The folders paths that appear under the Preferences

tab must all exist. The server attempts to create these
folders, but if not successful or if the folder is deleted
prior to starting the server, then the server will not start
properly. Solution: Make sure the folders on Preferences
tab exist and the service user id has full access to them.
An MFP device can only appear in one device group.

A form name can be up to 25 characters long.
Use of " / " is illegal in the Form Button name.
PDF 417 Barcode

Welcome to the PDF 417 Barcode component
The PDF 417 Barcode component is used to read 2D barcodes from images. After a barcode is read, the barcode
information can be used by other components within the process. Use the PDF 417 barcodes when there is a large
number of data fields that need to be captured within a process.
Refero is a Notable Solutions Web Server application that has the capability of generating PDF 417 2D barcodes.
Refero application has the capability of producing indexing forms linked to ODBC database, Microsoft SharePoint
Portal Server, or iManage document management system.
PDF 417 Barcode uses LeadTools Technologies as the core engine for barcode detection and images handling.
1502
Getting started
Feature highlights
PDF 417 Barcode is used to read 2-Dimensional barcodes of type PDF 417. This is a multi-row barcode capable of
encoding several hundred characters.
The values read from the barcode can be used as parameters by subsequent components in the configuration. These
values can also be mapped into Fields that automatically will be used by Route (store) or Process (filter) components
that are able to use this field information.
The component allows splitting of image by instructing the component to split the document when a barcode matches
a specific value or a pattern.
This component is commonly used for reading barcodes in black and white TIFF images generated from a scanning
device with at least 200 dpi (dots per inch). Depending on the Scanner quality, and the size and type of the barcode
being read, you may need to generate higher quality images in order for the barcodes to be read properly.
If you want to setup your process such that Barcode values are used by other components, configure this component
through a blocking component, such as Digital Sender, MFP and POP3 email. If you plan to use this component with
a non blocking Capture (source) component, place a Data Interchange Process (filter) component before PDF417
Barcode component.
Using the PDF 417 Barcode component
This component is used as part of business processes that rely on barcode coversheets or barcode information inside a
document, such as a barcode that represents the invoice number in an invoice document.
PDF Barcode component can be used to read the values of a barcode and then store such information together with
the document in one of the Document management systems supported by the system.
Such information can also be used to dynamically set other values in the configuration. For example, if the invoice is
being sent to a Folder Store component, the final file could be renamed using the invoice number as part of the new
name.
Configuring the PDF 417 Barcode component
General tab
Configure the basic features for this component
Option
Description
Activate
Select this check box to enable the barcode processing

function. Clear this checkbox disable this component
based on input or routing slip.
Max Barcode
You can specify a maximum number of barcodes that

this component should try to read from a page.
Set Max Barcode to 0 when to look for barcodes until
the end of the page.
Specifying a maximum number of barcodes can increase
performance since the component will stop searching the
page for barcode once it has read the maximum number
of barcodes specified.
Search Zone
Restrict the image search area manually by specifying

the coordinates either in inches or millimeters. The
syntax for this as it appears in the edit box is: top, left,
right, bottom where :
TopDistance from the upper side of the page to the
1503
Option
Description
LeftDistance from the left side of the page to the
RightDistance from the left side of the page to the
BottomDistance from the left side of the page to the
The search zone can also be specified by graphically
selecting the zone from a sample image file. To do this
click on the ... next to the Search Zone edit box and
select a sample image file from where you can identify
the search zone, and click Open. You will be presented
with a preview of the first page of the image. Move
the mouse to the preview area, note that the cursor will
change to a cross sign, click on the image and drag
the cursor to select a square section of the image and
click OK. This is the area where the component will
search for barcodes. You can change the file used for
previewing by clicking on Open and selecting a different
image.
Page Split
Split on Barcode Value: Check this to split the

document every time it finds the barcode value specified
in the edit box. The barcode value can contain characters
such as * and ?.
For example, if * is entered in the edit box, the
document will split when it finds any barcode. If 1000?
is specified then the document will split if the barcode
value is 10002 or 10003 for example. By definition the
following wild card characters can be used:
* for any number of characters

? for any single character
Keep Barcode PageIf you are splitting based on the

barcode, you can choose to either keep the barcode page
or discard it. You can only discard barcode pages when
Pre-separator is not used.
Pre separatorCheck this box when you are using the
barcode page as a separator, and you want the barcode
to serve as a separator at the beginning of the document.
If this box is not checked, the component will assume
that the barcode separator is the last page of the split
document and will start a new file after it.
Barcode Data
Use Refero XML SchemaIf the PDF 417 barcode

used in the process is being generated from the Refero
Application. The user can instruct the component to
automatically extract individual fields information from
the barcode. The barcode will still be available as a
whole, and references to individual fields contained in it
can be used.
1504
Field Values tab

On this tab you can delete fields entries from the list of field values.
Option
Description
Insert
Click this button to enter the field name and the barcode
value that is associated with this field. Click the browse
button (...) next to the Barcode value box to provide the
Page Number and Barcode Number of the barcode that
contains the information that should be assigned to this
field.
You can also use RRT strings to dynamically specify the
barcode value at run time.
Delete
Click this button to remove selected entries from the

Field Value list.
PDF 417 component RRTs

The values for single barcodes read in different pages can be used to dynamically configure other components in
the configuration. By using different variations in referencing the page number and location where the barcode is,
you can not only refer to a single value but to the concatenation or several values or even all the barcodes read for a
document.
Component RRT ID
The RRT ID for this component is L2B.
Syntax
The syntax used to refer barcode values that were read from the PDF 417 Barcode file is as follows:
~L2B::PageNumber,BarcodePosition~
Where PageNumber is the image page where the barcode is located and BarcodePositionis the position of the
barcode on the page counting from left to right and from top to bottom.
There are some special characters that can be used instead of a specific PageNumber or BarcodePosition, these are:
* specifies any page number or barcode position.

-1 specifies the last page or barcode position.
The following table shows examples of possible combinations:

~L2B::*,BarcodePosition~

~L2B::PageNumber,*~

file.
~L2B::-1,-1~

~L2B::-1,BarcodePosition~

~L2B::*,*~

1505
If you are using splitting on barcode, the term last page refers to the last page of the image file after it has been
split.
Refero is a Notable Solutions product offering. If you are using barcodes generated by the Refero application, you can
reference individual fields with the following syntax:
~L2B::PageNumber,BarcodePosition,FieldName~
For example, the RRT string ~L2B::-1,1,InvoiceNumber~ will return the value for the InvoiceNumber
field in the first barcode on the last page of the document. Note that the special character * cannot be used for the
PageNumber or BarcodePosition when you specify a field name in this manner.
Problem
Solution
PDF 417 Barcode cannot read one of the supported

barcode types.
barcode is located. Using the image that contains the
barcode as a sample, change the search zone so it
includes the location where the barcode appears. If you
are not sure if this location is always going to be the
same for all images, then do not use a search region, and
the component will try to find the barcode in the entire
page.
The status monitor shows that the barcodes are being

read but the barcode values references are not being
replaced.
Your Capture (source) component is not a blocking

component (other components will be configured
through it) and you are not using Data Interchange
Filter in your configuration. Insert the data interchange
process (filter) component in your configuration before
the PDF 417 Barcode component, and configure the
remaining components through the Data Interchange
Process (Filter) component.

The splitting functionality is only available when reading multi-page TIFF images.
The complete list of supported file formats by the PDF 417 Barcode component is as follows:
JPEG Formats

JPEG 2000 Format. This file format contains image data and extra information about the contents and
GIF Formats
CompuServe GIF
TIFF Formats
Tagged Image File Format, with no compression and with RGB color space and 8-bit grayscale
Tagged Image File, with no compression and with CMYK color space
Tagged Image File, with no compression and with YCbCr color space
Tagged Image File with PackBits Compression and RGB color space
Tagged Image File with PackBits Compression and CMYK color space
Tagged Image File with PackBits Compression and color YCbCr space
1506

Tagged Image File with a vector image saved as a DXF
Tagged Image File with JPEG 2000 Compression. This file format contains only a stream of image data.
Tagged Image File with Wavelet CMP Compression
BMP Formats
Windows BMP, with no compression

Windows BMP, with RLE compression
Wireless Bitmap fileType 0
WMF and EMF Formats
Windows Meta File

Windows Enhanced MetaFil
Exif Formats
Exif file containing a TIFF image, with no compression and with RGB color space
Exif file containing a TIFF image, with no compression and with YCbCr color space
1-Bit FAX Formats
TIFF, compressed using CCITT

TIFF, compressed using CCITT, group 3, 1 dimension
TIFF, compressed using CCITT, group 3, 2 dimensions
TIFF, compressed using CCITT, group 4
Raw FAX, compressed using CCITT group 3, 1 dimension
Raw FAX, compressed using CCITT group 3, 2 dimensions
Raw FAX, compressed using CCITT group 4
IOCA, compressed using CCITT group 3, 1 dimension
IOCA, compressed using CCITT group 3, 2 dimensions
IOCA, compressed using CCITT group 4
IOCA, compressed using IBM MMR, with the MO:DCA wrapper
IOCA, uncompressed, with the MO:DCA wrapper
Other 1-Bit Formats
MacPaint
Portable BitmapASCII File
Portable BitmapBinary File
XBitmap File
Microsoft Paint
1507
Poll Directory
Welcome to the Poll Directory component
Poll Directory is a Capture component that lets you batch load files into your applications. Using the Poll directory
module, you can import documents of any format, from any shared network drive, process the content, and store them
into its supported document and database management system.
The Poll Directory component is designed to poll an input directory for files and then move all files from that
directory to a designated working directory to introduce them into a process.
You can poll the Inbox directory for all files or narrow your poll to a specific file type. Use wild-card strings to match
certain file extensions or file names. For example, C:\AutoStore\Sample\Inbox\*.tif reads all files with
the .tif file extension into a process. The Poll Directory component moves the specified files from the inbox directory
to the specified working directory to introduce them into the process.
Getting started
Feature highlights
The following lists the major features of this component:
Accepts any type of input file.

Moves files into a specified working directory
Can be a source component for any Process or Route component
Using the Poll Directory component

The following are ways that Poll Directory component may be used in a process:
Record migration between Document Management systems can be implemented by exporting files into directory
and importing the files using Poll Directory.
Import scanned images from CD's into your back-end Document Management applications using Poll directory.
Read Fax tiff images using Poll Directory component, review them and route them into back-end applications.
Poll Directory is the ideal component to connect your Fax servers into back-end applications.
Administrators can automatically capture documents from shared network drives as they are related to projects
without any change in the day to day process by the users. Users can simply continue to capture documents into
the shared network drive, while in the background, the process captures them into a Document Management
system.
Make the Success or Failure directory of one process feed into the inbox of the next process and use another
process to read the images. For example, the first process has a digital sender source component with the Success
directory of C:\Process 1\SuccessDir. The next process in the chain uses a poll directory component
and sets its inbox directory to C:\Process 1\SuccessDir. Notice that with this scenario, the files placed in
Process 2 are the same files that were placed in Process 1 (the same files were fed to both processes in this chain).
Use this technique if the same files must be routed to different destinations.
Configuring the Poll Directory component

Specify the input and working directories for this component in the configuration options.
Option
Input Directory
Description
You can poll the input directory for all files or narrow
your poll to a specific file type. Use wild-card strings to
match certain file extensions or file names.
For example, C:\AutoStore\Sample\Inbox
\*.tif reads all files with the .tif file extension into
your process.
1508
Option
Description
You can also limit your file-matching parameter to a
directory name and then read all files using a wildcard
(*.*) to the process. The poll directory reads files to a
process one file at a time until the input directory has no
more matching files.
Working Directory
The usage of this directory is to remove documents

from the input directory so that the document will not be
picked up again. All documents in the input directory
are processed. Therefore, when you remove a document
and place it into the working directory, it prevents the
infinite processing of the same document.
Note: Files will remain in the working
directory and are not removed automatically.
If you want to remove the files from the
working directory, place a File Options process
component in your process and configure it to
remove the files
Poll Directory component RRTs

Problem Description
Errors in the log while accessing the Input directory.
Solution
Check the user permission and make sure the User ID

has access to the Input and the Working directory.
Check the path name for the Input and make sure the
Input folder is available to the server.
Make sure service has full control over the path
(including write and delete permissions) for Input and
Working directories.
The poll directory reads one file at a time. For example, if your Inbox directory contains 200 files that match your
polling criteria, the poll directory will introduce 200 separate files into your process.
There can only be one poll directory component in each process.
The poll directory component must appear at the beginning of each process.
Ricoh MFP
Welcome to Ricoh MFP component
Ricoh MFP component allows direct integration of Ricoh device panel with the server. This component provides key
functionality such as:
Device level authentication including Windows NT, Active Directory, and NetWare authentication
Multi-Layer menu definition that allows ease of use and quick indexing
Centralized meta-data form definition providing full centralized control over the indexing forms
Device groupings allow devices to be divided into functional or organizational groups.
1509
Integrated with LDAP email
Ricoh MFP integration utilizes the latest in Java SDK/J technology and is designed to provide enterprise level
functionality.
This component supports various Ricoh MFP devices.
Feature highlights
Ability to create device groups and corresponding group-specific workflows.

Ability to create control panel multi-level menu hierarchy.
Supports multiple field types including String, String list, Boolean, Date/time.
Customize the forms using scripts.
Validate form field values using VB scripts.
Centrally control all device scan setting parameters.
Supports multi-scan setting to allow multi-part document batch scanning.
Support for user authentication and LDAP user email setting.
Support for Duplex and Color Scanning.
Using the Ricoh MFP component

Use this component to capture documents from the Ricoh MFP device and process into a workflow.
This component allows the Ricoh devices with SDK/J capability to integrate directly with the application.
Additionally use the scripting capability provided by this component to create dynamic forms and fields that are
connected with your applications. Validation of form fields can also be done directly against the back-end application
databases providing the user with a quality control indexing station directly on top of the Ricoh MFP devices.
This component provides a rich set of form fields to allow the user to capture String, String list, Date and Boolean
field values. Creation of forms using these devices are now very simple and easy to manage since all devices are
centrally controlled from the AutoStore server.
This implementation is truly an enterprise solution that can provide device grouping, scan setting control from a
single location (no need to login to every device), centralized indexing form management, as well as support for
Server Farms and load balancing for larger deployment of devices. This component allows your devices to access a
rich set of workflows and reach the document capture efficiency beyond any other product in the marketplace.
Installing the Ricoh MSP component on the device
How to Install the JavaTM Platform
1. Make sure that the Main Power of the Ricoh Device is turned OFF.
2. Insert SD card into available slot. Power ON the Ricoh Device.
3. Press the User Tools > Counter > Inquiry button on the Ricoh Device control panel.
The User Tools/Counter/Inquiry function menu is displayed on the Display panel.
4. Press the Extended Features button.
This displays the initial SDK/J application management screen.
6. Select the Install tab.
This displays the Extended Feature Settings screen with Install target list of SDK application on the Ricoh
Device Display panel.
7. Select an appropriate SD Card Slot (where the SD card was inserted).
8. Select the key of JavaTM Platform first.
Remember: Only one key can be selected at a time.
1510
This displays the Extended Feature Installation. Select method to install or run screen on top of Extended
Feature Settings screen.
9. Specify the Run from SD Card Slot <> method to start installing JavaTM Platform, and press OK.
This pops up the Target to Allocate Extended Feature screen.
10. Allocate a Key to display JavaTM Platform User Interface: press the hard Function Key, for example Scanner
key.
11. Press OK.
This displays the Extended Feature Information screen.
12. Select OK to start the installation.
This displays Installing the Extended Feature, showing that the installation process is being performed.
13. When installation has completed, select Exit on the Completed Extended Feature installation screen.
14. Press Exit on the Extended Feature Settings screen.
15. Press Exit on the User Tools > Counter > Inquiry function menu.
16. After installation has been completed, press the Power Operations switch on the upper right corner of the Ricoh
Device Control Panel.
The ON indicator begins blinking.
Warning: The user should NOT turn off the main power switch while the ON indicator is blinking.
Doing so may damage the device hard drive.
17. Turn OFF the Main Power Switch after the power Operations ON indicator stops blinking.
How to Install the JavaTM SVR Platform
1. Make sure that the Main Power of the Ricoh Device is turned OFF.
3. Press the User Tools > Counter > Inquiry button on the Ricoh Device control panel.
The User Tools/Counter/Inquiry function menu is displayed on the Display panel.
This displays the initial SDK/J application management screen.
6. Select the Install tab.
This displays the Extended Feature Settings screen with Install target list of SDK application on the Ricoh
Device Display panel.
7. Select an appropriate SD Card Slot (where the SD card was inserted).
8. Select the key of JavaTM SVR Platform.
Remember: Only one key can be selected at a time.
This displays the Extended Feature Installation. Select method to install or run screen on top of Extended
Feature Settings screen.
9. Specify the Run from SD Card Slot <> method to start installing JavaTM SVR Platform, and press OK.
This pops up the Target to Allocate Extended Feature screen.
10. Allocate a Key to display JavaTM SVR Platform User Interface: press the hard Function Key, for example
Scanner key.
11. Press OK.
This displays the Extended Feature Information screen.
12. Select OK to start the installation.
This displays Installing the Extended Feature, showing that the installation process is being performed.
13. When installation has completed, select Exit on the Completed Extended Feature installation screen.
14. Press Exit on the Extended Feature Settings screen.
15. Press Exit on the User Tools > Counter > Inquiry function menu.
1511
16. After installation has been completed, press the Power Operations switch on the upper right corner of the Ricoh
Device Control Panel.
The ON indicator begins blinking.
Warning: The user should NOT turn off the main power switch while the ON indicator is blinking.
Doing so may damage the device hard drive.
17. Turn OFF the Main Power Switch after the power Operations ON indicator stops blinking.
How to Install AutoStoreXlet
1. Insert SD card into SD Card Writer
2. Connect SD Card Writer to the machine where the AutoStore is installed
3. Copy the 33956096 folder from the server_installation_directory\Distributables\Ricoh
MFP\33956096 directory and paste it into \\SDK\DSDK\DIST directory on the SD card.
4. Make sure that the Main Power switch on the Ricoh device is turned OFF.
6. Press the Scanner function key on the Ricoh device control panel.
7. Select JavaTM Platform
8. On the Application Manager screen select Login.
9. Select the Install tab to display the list of available applications.
10. Scroll down to the AutoStoreXlet and select it.
11. Specify Destination screen will be displayed on top of the Application Manager screen.
12. Select Hard disk and select OK
13. Extended feature info screen will come up. Set up the Auto Start feature by selecting the Yes and OK buttons.
14. Select OK on the installation complete screen.
Note that if Auto Start option was not selected, then the AutoStoreXlet can be started from the Start/Stop tab.
How to Install AutoStoreServlet
1. Obtain the IP address for the Ricoh device.
a) Press User Tools > Counter > Inquiry button on the Ricoh Device control panel.
This displays the User Tools > Counter > Inquiry function menu on the device control panel.
b) Press System Settings, then select the Interface Settings tab.
c) You can print out all the Interface Settings or select and bring up on the screen a particular setting.
2. Open Internet Explorer and browse to http://<Ricoh Device IP>:8080 to run the DSDK Server Installer web
application.
3. Click the Install tab.
4. Under Install Application on local hard disk, browse to the server_installation_directory\Distributables\Ricoh
MFP\33956096.zip.
5. Under Install Application on local hard disk, select Install.
6. Review the content of the displayed information about the web application that is getting installed, and then Click
OK.
7. After the Installation finishes open the Application List.
The Application List will indicate that AutoStoreSerlvet web application has been installed.
How to use the Ricoh MFP component
1. Press the Scanner function key on the Ricoh Device Control Panel.
2. Select JavaTM Platform.
3. Select AS to display the configured AutoStore menu items.
1512
How to configure AutoStoreXlet

Perform this procedure after the AutoStore server has been configured and started.
1. Browse to http://device_IP_address:8080/XletSettings/AutoStore> to display the Ricoh Workflow Settings
embedded web page.
2. Type in the IP Address of AutoStore server, the Port Number (8085 is default port), and click Apply.
This displays the Xlet Configuration is Updated message.
Uninstall the Ricoh MFP component
Perform uninstall in case of an update to AutoStoreXlet or AutoStoreServlet prior to re-installation.
How to uninstall AutoStoreXlet
1.
2.
3.
4.
5.
6.
7.
8.
9.
Press the Scanner function key on the Ricoh Device control panel.
Select JavaTM Platform.
Press on the Menu button.
On the Application Manager screen select Login.
Select the Start/Stop tab to display the active applications.
Select the AutoStoreXlet application.
Press the Execute button to stop the AutoStoreXlet.
Select the Uninstall tab to display the installed applications.
Scroll down to the AutoStoreXlet and select it.
This displays the Extended feature info screen.
10. Press OK to uninstall
11. Press the OK to complete the uninstallation.
Uninstall AutoStoreServlet
1. Open Internet Explorer and browse to http://Ricoh_device_IP:8080 to run the DSDK Server Installer web
application.
2. Click the Detail link next to the AutoStoreServlet.
3. Click the Uninstall button.
4. Click Yes to confirm the uninstall.
Supported devices
The following table lists the devices that work with Ricoh component. Please consult Ricoh Supported Devices
(http://ricoh.nsiautostore.com/sales-support/supported-devices/) for current information about supported devices.
1513
Configuring the Ricoh MFP component

Menu tab
Use this tab to add, edit, or remove groups, menus, forms, and actions.
Option
Description
Add
Group
Menu
Form
Edit
Select the group, menu or form that you want to update

and click on Edit.
Remove
Select the group, menu or form that you want to delete

and click on Remove.
Group
Use groups to create separate menus and forms for different groups of users
Configure the following options for a group.
Option
Description
Name

name does not appear on the desktop and it is used
strictly as logical group name. This component is
equipped with a default group called Common Group.
You may add menus and forms to the Common Group.
Root Menu Title

device display.
1514
Option
Description
Select this check box to apply authentication settings to

the group.
Member Name
Click Add to enter either a valid Ricoh MFP IP address.

Click Ping Address to check the validity of the IP
address. Click Remove to delete an MFP device.
Menu
Add a menu to create a hierarchy. A menu hierarchy guides desktop users to select a workflow.
Option
Description
Menu
Enter the name of the menu.
Form
Add a form when your workflow requires capture of index data.
To add a form, configure options on the following 2 tabs:
General tab
Components tab
General tab
Option
Description
Form Name
The name of the form to be displayed on the Ricoh MFP.
Script File
Enter the VB Script name for validating the index data

on the devices.
Run Script on form load
If this option is checked, the provided script file will be

executed on the server prior to loading the form on the
MFP device.
Combine generated TIFF files into a multi-page TIFF Select whether you want to capture scanned image as:
file
Single page document
Multi-page document
Scan Setting
Feed Types
ManualUse this value to scan from the flatbed

screen.
ADFUse the Automatic Document Feeder to
scan the document.
SADFProvide a selection to the user to select
between the flatbed scanner window or the ADF
to scan the document.
ResolutionSelect the desired scanning resolution.
CompressionDescribes the file compression
mechanism to be used for scanning the documents
into digital format. Select the desired compression
mechanism.
ColorThe choices are:
Color
Black and White
1515
Option
Description
Scan TypeAllows you to select from a list of

proper documents:
Form Fields
Textselect this when your documents are text

only.
MixedSelect this setting when your documents
contain a mix of graphics, photos and text.
OCRSelect this when you are looking for your
documents to be OCR'ed into text.
Photoprovides photo quality scanning based
on the scanner settings.
Multiple ScanAllows for scanning job to be
performed in multiple parts. This setting should be
used when you have a mix of pages that may not all
feed through the ADF.
Duplex ScanIf supported by the device hardware,
check this box to scan the back side of the document
in normal position.


be any alphanumeric characters. Use of special
characters (~, &, <, >,%, ", /, \, :, ?, | ) are not
recommended.
Boolean
Date/Time
String
String list
Required checkboxCheck this box if the field is
within the MFP.
CheckboxIf checked, the provided script file will
be executed on the server once the field value has
changed on the MFP device.
Properties button on the rightmost column on each
entry.
Components tab
button to set their configuration attributes. The configuration button () appears at the last column within each row.
Select a component by clicking the leftmost column next to each component and configure the component for this
form by clicking on the configure button (rightmost column on each row).
1516
Fields
Boolean field
Option
Description
Default value
The default value can be set to True or False.
True value
Set the value for a true condition.
False value
Set the value for the false condition.
Visible
Enabled

DateTime field
A Date/Time field allows users to enter dates and times in a form.
Select the mode for the Date field. There are 3 available modes:
DateWith this mode only the day, month and year of the date can be specified.
TimeWith this mode only the hour, minutes and seconds of the date can be specified.
Date and TimeAll parts of the date can be specified.
FormatSpecify the desired format for this field. A valid format is composed of the following pattern letters.
Letter
Date or Time
Presentation
Example
Era designator
Text
AD
Year
Year
1996; 96
Month in year
Month
July; Jul; 07
Week in year
Number
27
Week in month
Number
Day in year
Number
189
Day in month
Number
10
Day of week in month
Number
Day in week
Text
Tuesday: Tue
AM/PM marker
Text
PM
Hour in day (0-23)
Number
Hour in day (1-24)
Number
24
Hour in am/pm (0-11)
Number
Hour in am/pm (1-12)
Number
12
Minute in hour
Number
30
Second in minute
Number
55
Millisecond
Number
978
Time zone
General time zone
Pacific Standard Time;

PST; GMT-08:00
1517
Letter
Z
Date or Time
Time zone
Presentation
Example
RFC 822 time zone
-0800
Letters that are not quoted, from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the
components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents
a single quote. All other characters are not interpreted; they're simply copied into display date. Please refer to the
examples below.
Pattern letters are usually repeated, as their number determines the exact final display, depending on the type of
presentation we have:
TextIf the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is
used if available.
NumberThe number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded
to this amount
YearIf the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a
number.
MonthIf the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted
as a number.
General time zoneTime zones are interpreted as text if they have names. For time zones representing a GMT
offset value, the following syntax is used:
GMTOffsetTimeZone:
GMT Sign Hours : Minutes

Sign: one of + or Hours: Digit or Digit Digit
Hours must be between 0 and 23

Minutes: Digit Digit
Minutes must be between 00 and 59.

Digit: one of 0 1 2 3 4 5 6 7 8 9
RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:
RFC822TimeZone: Sign TwoDigitHours Minutes
TwoDigitHours: Digit Digit
TwoDigitHours must be between 00 and 23.
Examples
The following examples show how date and time patterns are interpreted if the device is set to English. The given date
and time are 2001-07-04 12:08:56 local time in the U.S. PCT zone.
Date & Time Pattern
Result
yyyy.MM.dd G 'at' HH:mm:ss z
2001.07.04 AD at 12:08:56 PDT
EEE, MMM d, ''yy
Wed, Jul 4, '01
h:mm a
12:08 PM
hh 'o''clock' a, zzzz
12 o'clock PM, Pacific Daylight Time
K:mm a, z
0:08 PM, PDT
"yyyyy.MMMMM.dd GGG hh:mm aaa"
02001.July.04 AD 12:08 PM
"EEE, d MMM yyyy HH:mm:ss Z"
Wed, 4 Jul 2001 12:08:56 -0700
"yyMMddHHmmssZ"
010704120856-0700
1518
Date/Time formats
Format: Specify the desired format for this field. A valid format is composed of the following pattern letters. Note
that all lower case and upper case characters not mentioned in the table below are reserved.
Description
%a
abbreviated weekday name
%A
full weekday name
%b
abbreviated month name
%B
full month name
%C
century number
%d
the day of the month ( 00 .. 31 )
%e
the day of the month ( 0 .. 31 )
%H
hour ( 00 .. 23 )
%I
hour ( 01 .. 12 )
%j
day of the year ( 000 .. 366 )
%k
hour ( 0 .. 23 )
%l
hour ( 1 .. 12 )
%m
month ( 01 .. 12 )
%M
minute ( 00 .. 59 )
%n
a newline character
%p
PM or AM
%P
pm or am
%S
second ( 00 .. 59 )
%s

00:00:00 UTC)
%t
a tab character
%U, %W, %V
the week number
%u
the day of the week ( 1 .. 7, 1 = SUN )
%y
year without the century ( 00 .. 99 )
%Y
year including the century ( ex. 1979 )
%%
String field
A string field allows users to a string of text.
Field Name
Description
Default value
Type the default value for the string.
Maximum characters
Type the maximum number of characters allowed for the

string.
1519
Field Name
Description
Visible
Enabled

Obscured Entry
Select this check box to obscure the user entry replacing

characters entered by the user with asterisks (*).
String List field

A string list field allows users to select from items in a list.
Option
Description
Add
Add values to the string list.You can also click the N

button at the top of the first column, or press the Tab key
to tab through the last row in the list.
Remove
Remove a selected value from the string list.
Import
Select to import values from a file. The file must be a

CSV file.
Export
Select to export values to a file.The file must be a

CSV file with each row containing a label and value
(label,value).

entries.
Visible
Enabled

Preferences tab
On this tab, set the location where the server stores the program files for the job that is processing.
Option
Description
Home Directory

Port Number
Enter the port number used by the MFP to communicate

with the Server. The device must be configured to use
the same port number to communicate with the server.
If the device is having problems communicating with
the server check the port settings on the server to make
sure they match the device port number. Also make sure
there are no firewall equipment blocking the specified
port.
Note that the device settings are modified by going to the
Internet browser and accessing the device configuration
settings screen on the device.
1520
Option
Description

between the server and the MFP device over an SSL
secure channel.
Keep
The Keep settings allow the workflow to keep the

Processed files (when checkbox is selected) in the
specified directory upon completion of successful
routing. If you turn this attribute on, all files are stored
into the Processed Files directory at the time when the
service successfully completes writing them into the
destination location. Keep in mind that if this is option
successfully is saved in the "Processed Files" directory.
Make sure that proper disk storage is allocated for this
directory.
The Keep settings allow the workflow to keep the
captured files into the Rejected Files directory. Rejected
Files directory is used for storing any files that failed
to store into the final destination location. The failure
could be due to any number of reasons and it must be
researched through searching the server application
log file entries. Typically, it is beneficial to have a
secondary process that takes this directory as an input
and routes messages out to system administrator and
warns them of failure. It is important to note that
the service must have sufficient rights to access this
directory.
Authentication tab
Set up authentication attributes in this tab. The authentication server runs on the Ricoh MFP component of the
workflow server.
Option
Authentication Type
Description
The supported authentication types are:
Windows
Choose this option to use Windows NTLM

authentication.
Active Directory
NoneThe device does not require the user to

feature.
Windows authentication
Active Directory authentication
Netware authentication
Choose this option to use Windows Active Directory for

user name and password settings.

name.
1521
Option
Description
Netware
Choose this option to use NetWare authentication. This

will prompt the user for the NDS context and tree.

tree name.
displayed.
Logout Timer
Specifies the number of seconds of inactivity that will

cause the logged on user to be automatically logged out.
LDAP tab
The Ricoh MFP has been integrated with ADSI (Active Directory Service Interface). With ADSI, Microsoft is able to
offer a COM-component for access to various directory services. ADSI is a component of Windows 2000.
The structure of a directory service is hierarchic and it can be seen as a directory tree: there is a root where you can
start from to other entries. The root can contain containers (knots) and leaves. Containers themselves can contain
other entries while leaves mark the end of a branch in a directory tree. Every entry in this directory describes an object
and has specific attributes. Conceptually the root is the topmost entry in a LDAP hierarchy. This can be illustrated
with the Windows file system: the C: drive is the root, the directories/folders are the containers and the files are the
leaves.
The LDAP standard requires that all LDAP directories maintain a special entry, called the Root DS Entry, or Root
DSE. This entry provides a set of standard operational attributes that the user can read to find out fundamental
characteristics of the directory and the server. The Root DSE can also provide any number of vendor-specific
attributes.
One of the standard operational attributes is defaultNamingContext. This attribute contains the distinguished name
(DN) of the root of the directory. In Windows 2000, this is the DN of the Domain container at the root of the current
tree. By reading the defaultNamingContext attribute from the Root DSE, you can discover what domain you are
logged in to at run time. When you press the Test button, the domain you are logged into is displayed.
Note that when the root is left blank, and you press the Test button, the results may differ from when you actually run
the server with Ricoh MFP component (equipped with Authentication). A blank root uses the default value, which
is retrieved from the account that you are logged into the machine as. However, when you run the server, you are
logged in as LocalSystem (or whichever user name you specify on the Service tab), possibly yielding different results.
For this reason, it is highly recommended that you either supply the root or login to the service with a user name/
password different than LocalSystem.
Configure options on this tab to set the LDAP attributes.
Option
Description
LDAP ServerEnter the LDAP server you want to
search the authenticated user against.
Root DirectoryEnter the root search directory you
want to begin searching against . If this field is left
blank, the search starts at the LDAP default directory.
1522
Option
Description
Click Find Root to locate the default root of the LDAP
server.
Credentials

AnonymousCheck this box if you want to log in to
LDAP server as anonymous user without providing user
name and password.
Username/passwordEnter the username/password to
access the LDAP server.

Active DirectoryWith Windows Active

Directory authentication method, the username is
matched against "samAccountName" field, the Get
Email From is matched against "mail" field, and
the Get Display Name From is matched against
"displayName" field.
eDirectoryWith Netware authentication method
against "uID" field, Get Email From matched against
"mail" field, and Get Display Name matched against
"cn" field.
multiple types of Authentication. To customize the
values that you can define for the following:

Get Email From
Click Reset to blank out the above field values.

Test
To test the settings, click the Test button and enter a user
name as it will be entered on the MFP. This verifies that
an email address and display name can be found for the
user on the LDAP server.
Ricoh MFP component RRTs

Component RRT ID
The RRT ID for this component is RCH.
1523
Name
Description
UserName
The logged on user name of the authenticated user that is

submitting document(s) is returned. If authentication is
set to "none", this will return blank.
Email
The email of the user.
IPAddress
HostName
PageCount
Number of pages received.
Format
Valid file format is: Tiff
FileSize
Received file size.
Domain
The authenticated users domain name if Authentication

DisplayName
The authenticated users display name if Authentication


The RRT string ~RCH::%Client ID%~ is replaced by Company if the user types in Company for the field
Name
Description
%a
%A
Full weekday name
%b
%B
Full month name
%d
Day of month as decimal number (01 31)
%H
Hour in 24-hour format (00 23)
%I
Hour in 12-hour format (01 12)
%j
Day of year as decimal number (001 366)
%m
Month as decimal number (01 12)
%M
Minute as decimal number (00 59)
%p
%S
Second as decimal number (00 59)
%U

day of week (00 53)
%w
Weekday as decimal number (0 6; Sunday is 0)
1524
Name
Description
%W

day of week (00 53)
%y
Year without century, as decimal number (00 99)
%Y
VB Scripting
Events
FieldChanged event
This event occurs when a field value on the form has changed.
FieldChanged ( Form , FieldName , FieldValue )
Argument
Description
Form
The form object.
FieldName
FieldValue
Remarks
Sub FieldChanged(Form, FieldName, FieldValue)
If (FieldName = UserName) Then
Form.SetFieldValue Path, LookupHomeDirectory(FieldValue)
End If
End Sub
FormLoad event
FormLoad ( Form )
Argument
Form
Description
Remarks
Example
Sub FormLoad(Form)
'Write custom code to lookup the authenticated user's home directory.
End Sub
1525
FieldValidating event
FieldValidating ( FieldName , FieldValue )
Argument
Description
FieldName

validation.
FieldValue

validation.
Remarks
Example
Function FieldValidating(FieldName, FieldValue)
FieldValidating =
Write custom validation to check that the user is attempting
'to enter a value for the Amount field that is less then 100.
FieldValidating = Amount cannot be greater than 100.
End If
End If
End Function
Form object
Form Object properties
Property
Description
UserName
Returns the account name of an

authenticated user.
EMailAddress
Returns the email address of an

authenticated user.
Remarks
These properties are only available if authentication has been enabled for the device.
Methods
string GetFieldValue ( property FieldName )
Argument
FieldName
Description
1526
Return Value
This method returns a string expression representing the value of the field.
SetFieldValue ( FieldName , FieldValue )
Argument
Description
FieldName
FieldValue
SetScanAttributes method
SetScanAttributes ( ScanCompression , ScanColor , ScanType , ScanResolution , FeedType )
Argument
ScanCompression
ScanColor
ScanType
ScanResolution
FeedType
Value
Setting
Compression type MH
Compression type MR
Compression type MMR
Compression type JPEG
Black and White
Color
Text
Photo
Mixed
OCR
100
100 DPI
200
200 DPI
300
300 DPI
400
400 DPI
600
600 DPI
Manual
ADF
SADF
UpdateListField method
UpdateListField ( FieldName , Required , List , Value )
Argument
Description
FieldName
Required

1527
Argument
Description
List
A comma separated list of list

choices. To support a choice where
the Label and Value is different,
use Label1=Value1 syntax for each
comma separated entry.
Value
Remarks
UpdateStringField method
UpdateStringField ( FieldName , MaxLength , Required , Value )
Argument
Description
FieldName
MaxLength
The maximum number of characters

that can be typed in the field.
Required

Value

UpdateBooleanField method
UpdateBooleanField ( FieldName , TrueValueName , FalseValueName , Required , Value )
Argument
Description
FieldName
TrueValueName
A string value representing the true

value.
FalseValueName
A string value representing the false

value.
Required

Value

UpdateDateField method
UpdateDateField ( FieldName , Format , Required , Value )
Argument
FieldName
Description
1528
Argument
Description
Format
The output format of the date field.

Refer to the documentation.
Required

Value
Remarks
/
\
:
?
"
<
>
|
Use of the following characters is illegal within the menu, form or group:
&
<
>
Ricoh MFP component fails when the configuration has been updated. This occurs under the following scenario:
You have scanned a document while the Form remains open on the Ricoh device touch screen, and you stop
the workflow process to update the Form Properties (the Form view remains the same) and reran the workflow
process. The process fails the first time as it takes time for Form updates to take place.
This issue will not happen the next time as the update has fully been completed.
1529
Appendices
Appendix 1. Runtime Replacement Tags
When your process requires assignment of attributes that depend on the data or the sequence of processing, you can
use Runtime Replacement Tag (RRT) strings to assign component attributes. The RRT strings interpret your input
string and extract dynamic data from your process data stream, then use it to set your process attributes. This powerful
feature allows you to set component attributes using dynamic variables
What are RRTs?

A Runtime Replacement Tag (RRT) is a tag that can be placed in a configuration file for replacement by metadata
values at run time. When components are executed within the application at run time, each component is responsible
for searching all items within the configuration memory structure and replacing RRTs with actual metadata values.
Tip: RRTs were formerly called Field Value References, or FVRs.
How do RRTs work?

When you create a process that consists of a series of components, the components are executed in order from left to
right (Capture to Route). Each component, prior to its termination, searches all configuration entries and replaces all
its own RRTs with actual metadata values. As an example, the XML Knowledge Package Loader component will
search for RRTs starting with ~ASX:: and replaces them with actual metadata values.
The order of execution of components within a process is significant. Due to the component execution order (Capture
to Route), RRTs owned by components that appear later in a process cannot be placed within components that appear
earlier in a process. As an example, placement of Send to Folder component RRTs within a Capture component such
as Multi-Poll is invalid and will not be replaced at run time.
RRT naming convention

A Runtime Replacement Tag (RRT) has three components consisting of the three-character RRT identifier, the
separator (::), and the RRT name. These are all contained between two tilde (~) markers.
The figure below provides you with an illustration of the RRT definition. Each part of the RRT is designed to create a
standard field tag replacement that can be expanded to all components designed and developed within the component
framework.
1530
Important: RRTs are case sensitive and cannot have any space characters between segments. Be careful to
use the exact combination of lower and upper case characters specified by an RRT definition.
The table below provides details on each segment of the RRT:
Segment Name
Description
Markers
The tilde character (~) used to mark the beginning and

the ending of each RRT. You cannot use the ~ character
anywhere else within other parts of an RRT. Including
the ~ as the value of a special field is not supported.
RRT ID
Three characters that identify the component owning

the RRT and responsible for replacing the tags with the
actual values.
Separators
Double colon characters (::) are used to separate

the Component RRT ID from the actual Replacement
Tag Name. The double colon is reserved and cannot
be used anywhere else within other parts of an RRT.
The following example would not be permitted as
it repeats the :: within the Replacement Tag Name
~MYC::Invoice::Number~.
Replacement Tag Name
The Replacement Tag Name or RTN can be the name of

the metadata collected from a content source (such as a
device) or a metadata generated by the component (for
example, an XML data field). The following types of
RTN are currently supported:
Reserved (RRTN)
Each component is
allowed to create and
maintain a set of reserved
RTN or RRTN. Within
the boundaries of each
component reserved names
have special meaning.
1531
Segment Name
Description
Each component defines a
list of RRTNs.
Field (FRTN)
Some components that

support field names allow
the fields to be referenced
using the special enclosure
character: %. An example
of a field name used
within an RRT is:
~MYC::%Invoice
Number%~
This example allows
replacement for a
field called Invoice
Number within the
MYC component with the
value of the field Invoice
Number.
Special Sets (SSRTN) These are special set of

characters providing you
with useful information on
the job such as document
date, document time, etc.
Important: Not
all components
support the
SSRTN values.
Look in
documentation for
a component to
find if it supports
SSRTNs.
1532

Guia de Administrador de NSiAutoStore6 - English

Uploaded by

Copyright:

Available Formats

You might also like

Guia de Administrador de NSiAutoStore6 - English

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Guia de Administrador de NSiAutoStore6 - English

Uploaded by

Copyright:

Available Formats

Administrator Guide

NSi AutoStoreTM 6.0

Notable Solutions, Inc.

AutoStore Process Designer................................................................................................................................. 9

AutoStore Components........................................................................................ 138

Welcome to the Barcode component....................................................................................................179

Welcome to the HP MFP/Digital Sender (OXPd) component.............................................................526

Welcome to OpenForms 360................................................................................................................873

Welcome to the SharePoint 2007 component.................................................................................... 1158

Basic Image Management.............................................................................................................................. 1470

Kyocera MFP.................................................................................................................................................. 1487

Capture is the initial part of a workflow, where a

Process is the intermediate part of the workflow

Route is the final part of the workflow process where

Copyright 2014 Notable Solutions, Inc.

Understanding AutoStore Process Designer

Displays icons for registered

Provides a command interface that

This tab displays the name of the

Components are are the building

Copyright 2014 Notable Solutions, Inc.

This tab displays the name of a

The process viewer provides a visual

AutoStore Process Designer features

The ability to display attributes of a workflow process.

Using AutoStore Process Designer

Copyright 2014 Notable Solutions, Inc.

Select this check box to back up the previously saved

Display properties dialog on task creation

Select this check box to open the task properties dialog

Specifies the location for AutoStore configuration

Copyright 2014 Notable Solutions, Inc.

Specifies the default location when opening or saving

Apply only on application startup

Select this check box to use the Default directory

Specifies to use Blue, Black, or Silver as the color

Specifies to locate the task tab on the bottom, right, left,

Show capture icon

. Clear this check box to

only show the task name without the icon:

Task Properties dialog box

NameThe name for the process.

Perform this task

In the Every box, enter the frequency of execution for

If this task fails

Select the Retry check box if you want the service

Copyright 2014 Notable Solutions, Inc.

Administrator Alerts tab

Select this check box to enable alerts to be sent to an

Enter the name or IP address of the SMTP server.

Enter the SMTP server port.

This server requires an encrypted connection (SSL)

Select this check box to enable Secure Sockets Layer

Enter the user name to connect to the SMTP server.

Enter the password for the user name.

Enter the return email address that will be specified in

Enter the email address that will be receive the alert.

Click this button to test the logon credentials for the

Schedule the task to run in a designated time slot by