OpenText Imaging Enterprise Scan 16.0 - User and Administration Guide English (CLES160000-UGD-En-1)
OpenText Imaging Enterprise Scan 16.0 - User and Administration Guide English (CLES160000-UGD-En-1)
OpenText Imaging Enterprise Scan 16.0 - User and Administration Guide English (CLES160000-UGD-En-1)
CLES160000-UGD-EN-1
OpenText™ Imaging Enterprise Scan
User and Administration Guide
CLES160000-UGD-EN-1
Rev.: 24. Mar. 2016
This documentation has been created for software version 16.0.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text SA
Tel: 35 2 264566 1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: http://support.opentext.com
For more information, visit https://www.opentext.com
Copyright © 2016 Open Text SA or Open Text ULC (in Canada). All Rights Reserved.
Trademarks owned by Open Text SA or Open Text ULC (in Canada).
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
PRE Introduction ix
i What is OpenText Imaging Enterprise Scan? ..................................... ix
ii About this documentation ................................................................. xi
iii Respect for legal guidelines ............................................................. xii
3 Scanning .................................................................................. 23
3.1 Scanning documents ....................................................................... 23
3.2 Scanning from external storage ........................................................ 24
3.3 Scanning from fax ........................................................................... 25
3.4 Dual stream scanning ...................................................................... 26
Introduction
i What is OpenText Imaging Enterprise Scan?
OpenText Imaging Enterprise Scan (Enterprise Scan) is the solution for mass
scanning and indexing of documents at one or more scan stations. With Enterprise
Scan, workflows can be implemented from receipt by post, through scanning and
linking to the leading application, and then through to archiving. After scanning, the
pages can be checked carefully, straightened, and cleaned up. Several functions are
available to improve contrast and legibility. Enterprise Scan also provides support
for sorting and archiving.
This is the most frequently used scenario. Enterprise Scan either directs a
scanner to acquire images or retrieves them from another input source. After
processing, the documents and the index data are passed to a Document
Pipeline, which in turn transfers them to the target system. Since Document
Pipeline runs asynchronously to Enterprise Scan, the Enterprise Scan
operator can continue scanning even as the document is being transferred.
In this scenario, Enterprise Scan is one of several sources for Capture Center
to receive images from. Similar to Document Pipeline in the Enterprise Scan
with Document Pipeline scenario (see example 1 Example 1, “Enterprise
Scan with Document Pipeline” on page ix), Capture Center separates image
processing and data transfer to the target system from the scanning
operation. In addition, Capture Center allows for intelligent document
Capture Center typically runs on a separate server and receives input from
multiple Enterprise Scan workstations.
In this scenario, Enterprise Scan stores the scanned documents directly into
Content Server without using Document Pipeline. This is a convenient setup
for lower volume scenarios.
In this scenario, Enterprise Scan is invoked from Content Server. The user
starts Enterprise Scan from its Content Server Web client. This is a low
volume scanning scenario.
This scenario can be used if one employee scans the images while other
employees do the indexing. It can also be useful if scanning is delegated to
an external service bureau.
There might be overlap between the different user groups because one task might be
carried out by one target group or the other.
This part deals with the basic tasks of a scan operator. As these tasks contain
company-specific elements, for example profile names, this manual cannot provide
exact step-by-step instructions, but rather a more general view. In most of the cases
the scan administrator prepares an additional checklist for the scan operators that
describes the company-specific parts for the scan operators. For more information,
see “Using a template for scan operator checklists“ on page 247.
Before you can start scanning paper pages, you must first sort them according to the
configured profiles, based on contents and paper quality. You can sort documents in
the following ways:
• Sort the documents according to the contents (for example invoices), because the
documents will be dealt with differently in terms of their technical processing,
workflows, storage durations, and access rights.
• Sort the documents according to their legibility (for example bad, medium, good),
because legibility can be improved automatically if you choose the right profile.
In most cases, the documents are separated by barcodes or patch codes. But in some
cases it is necessary to insert separator pages between the individual documents. The
documents are separated during scanning and the blank pages are removed
automatically during postprocessing.
You must start the scanner before you start Enterprise Scan. How to start your
scanner is described in the scanner documentation. Refer to the Release Notes for
supported scanners.
Notes
• If you start Enterprise Scan for the first time you have to confirm that
Enterprise Scan is allowed to communicate to private and/or public
networks.
• The default port used by Enterprise Scan is 11989. If this port is not available
Enterprise Scan automatically chooses the next available port in a range
within the next 500 ports.
• The default port used by Enterprise Scan started by Scan&Index from
Content Server is 11990. If this port is not available Enterprise Scan
automatically chooses the next available port in a range within the next 500
ports.
• If you start Enterprise Scan directly from Content Server, some advanced
functions like configuring subprofiles will not be available.
Note: Pages that are scanned but not archived are saved locally on your
computer.
User interface Enterprise Scan user interface comprises several distinguishable areas, as shown in
Figure 2-1.
(1) Toolbars
You can find a list of the available toolbars in “Menus and icons“ on page 239.
To customize the toolbars, see “Customizing toolbars” on page 51.
(2) Views
You can open different frames, which are also known as Views in the program
window. The following views are available:
To scan documents:
1. In the Profiles toolbar, select the appropriate profile from the list.
Select the Batch from the list or enter a name for a new batch. This new
batch is created during scanning. The scanned pages are assigned to the
selected batch.
• If Folder Creation or Assignment by User was defined for the selected
profile, the Select Folder dialog box opens.
Select the Folder from the list or enter a name for a new folder. This new
folder is created during scanning. The scanned pages are assigned to the
selected folder.
If you click Cancel in the Select <Name> dialog box, the complete scan
operation is cancelled, not only the selection.
3. Optional You can rescan pages, for example if they have not been scanned
correctly.
a. To replace existing pages, select the pages, and then click File > Rescan >
Scan and replace.
b. To insert pages, select the page to the right of where you want to insert the
new page, and then click File > Rescan > Scan and insert.
A dialog box opens, according to the selected input sub profile. If you have the
appropriate permission, you can temporarily change the input device settings.
For example, if you have scanned a document with 100 dpi, you can rescan it
with 300 dpi, a second time.
If you do not have permission to change the input device settings, you can only
rescan with the same settings as were used in the initial scan. For example, if the
problem was a paper jam or a problem with the physical scanner, you would
not need to change the settings.
The following areas are available on the Scan from External Storage dialog box:
External Storage
Lists storage types that have been registered in the Profile Configuration dialog
box. When no external storage is configured, you do not get a message because
the list is empty.
Groups of documents
Displays the Group name and the Number of documents in the group.
The following areas are available on the Scan from Microsoft Exchange dialog box:
Received faxes
Shows the Fax line, ID, Number, Sender, and Received attributes of all received
faxes.
Preview
Displays a preview of the pages using the page scroll tool if Enable preview is
selected.
1. In the Received faxes area, select one or more of the faxes that you want to scan.
2. Click Scan.
Important
• When archiving, Enterprise Scan exports the source color data, not the
processed monochrome image data.
• Do not use image manipulation functions, for example rotation or de-
speckle. These types of effects are only displayed on the monochrome
image. The archived image remains unchanged.
The following types of dual stream scanning are available in Enterprise Scan:
Software emulation
Enterprise Scan internally extracts the monochrome image from the scanned
color image to create two streams. For more information, see “Configuring
input“ on page 63.
After scanning the paper documents, you must check the documents in Enterprise
Scan for completeness, order, and legibility.
Due to the very high quality of modern scanners and to well-prepared profile
management by the Enterprise Scan administrator, manual postprocessing steps are
rarely necessary. Most of the postprocessing is performed automatically during
scanning. For more information, see “Configuring processing“ on page 85.
The following table lists and describes problems that may occur and must be solved
manually:
If the postprocessing will be done by another person, you can mark documents that
require further corrections. For more information, see “Marking documents for
further processing” on page 40.
Select one or more Click the document in the Documents view. Select multiple
documents documents with the CTRL key.
Select one or more Use one of the following methods to select one or more pages:
pages • Select the pages in the Thumbnails view using the SHIFT and
CTRL keys.
• Draw a frame in the Thumbnails view.
• Select a single page in the Thumbnails view and expand the
selection with the arrow keys.
Select all pages Use Edit > Select All to select all pages in the document stack.
Invert selection If you want to select nearly all pages in the document stack with
several exceptions, you can select the exceptions first and then invert
the selection with Edit > Invert Selection.
Select marked If one of your colleagues already marked the pages that need post
pages processing, you can select the marked pages with Edit > Select
Marked Pages. For more information, see “Marking documents for
further processing” on page 40.
4.2.2 Zooming
You have several possibilities to zoom pages.
To zoom pages:
1. Select a page.
2. Use the zooming icons in the main toolbar or in the View menu. For more
information, see “View menu” on page 241.
You can also use + to enlarge and - to shrink the page. These work the same way
in the Page, Document, and Thumbnails view. In the Indexing view, press
ALT together with them to achieve the same effect.
3. To fit the page to window, height, or width, right-click in the View view, and
click Scale, and then choose Fit Window, Fit Height, or Fit Width.
4. To scale every new displayed page to the size specified when lock was set,
right-click, and then click Scale > Scale Lock.
Note: When archiving, Enterprise Scan exports the source color data, not the
processed monochrome image data.
Tips
• If Emulate dual stream mode is enabled, the View view displays a
monochrome image of the color image that was originally scanned.
• If a PDF file cannot be rendered it displays the Adobe Reader logo.
• In the View view, right-click the first page, and then click View PDF.
The PDF Viewer opens and displays the first page of the PDF document.
Navigating through the pages of the PDF file is possible using the spin box.
Changes of the dialog box size and location persist for the current session only.
After restarting Enterprise Scan the default values are used again.
To switch back to the PDF replacement view, close the PDF Viewer.
• Keep CTRL pressed, and then use the arrows of the numeric keypad.
• Double-click the header bar of the View view or drag the View view from its
location.
Tips
• You can enlarge the floating View pane by resizing its window.
• You can drag the floating View pane to relocate it inside or outside of the
Enterprise Scan window. For example, you could drag the floating View
pane to a second monitor to have a larger display
• You can perform the same actions in the floating View pane as in the View
view.
• The page you select in the Thumbnails view is displayed in the floating
View pane.
• When you drag the floating View pane inside the Enterprise Scan window,
docking icons are displayed on the margins and in the middle of the
window. If you drag the floating View pane to one of these icons, it is
docked at this location.
• When you close the docked View view or the floating View pane using the
close button in the title bar, the original size is restored if you open the
View view again using the View menu.
• When you close the docked View view or the floating View pane using the
View menu, the window settings are lost. Opening the View view again
uses the default window settings.
• The default window size is 300 x 300 pixels. It is displayed if the View view
is displayed for the first time as dragged window, auto-hide window or as
floating window by double clicking the window title bar.
• In following situations when the View view is closed Enterprise Scan will
use the default window settings:
• Shutting down Enterprise Scan.
• Switching to another profile or subprofile.
• Changing a subprofile.
• The View view window settings of different profiles are preserved for each
profile.
• Double-click the header bar of the floating view pane or drag it back into the
Enterprise Scan window.
• Click Archive Group to archive all documents that belong to the selected
group. Archive Group is only visible if Filter by Group is selected.
If you have modified the static batch or static folder entries in the Workstation
Options the Tree view must be updated.
Note: Using these actions the current batch and folder nodes state
(expanded/collapsed) is not preserved.
Note: Using these actions the current batch and folder nodes state
(expanded/collapsed) is preserved.
To rotate pages:
1. Select each page you want to rotate in the Thumbnails, Documents, or View
view.
2. Right-click, and click Rotation, and then choose Rotate 180°, Rotate Left, or
Rotate Right. For more information, see “Page menu” on page 242.
1. In the Thumbnails view, select a page you want to copy in the Thumbnails
view.
2. To copy the page, press CTRL + C or select Edit > Copy from the menu.
Note: If you select more than one page, only the first page of the selection
is copied to the clipboard.
3. Open the image editing application you want to paste the page into.
Note: You cannot copy pages from Enterprise Scan and paste them into
the file system, for example in Windows Explorer. Use the Export function
instead.
4. Navigate to the location where you want to insert the page.
5. To paste the page, press CTRL + V.
The page is pasted into the application as a bitmap.
1. In the file system, for example in Windows Explorer, select each image file you
want to import to Enterprise Scan.
2. In the Thumbnails view, drag the selected files to the position where you want
to insert them.
Tip: You can also import a complete folder of image files. All files in the folder
are added to the document as new pages.
3. In Enterprise Scan, paste the image using CTRL + V or by selecting Edit > Paste
from the menu.
The image is added in the Thumbnails view as a new page after the selected
page.
Notes
• You cannot copy image files from the file system and past them into
Enterprise Scan.
• You cannot copy more than one image at a time using Enterprise Scan.
Tips
If the complete document is scanned in the incorrect order, you can reverse the order
of the pages.
2. Right-click the document, and then click Document Operation > Reverse.
It is important to check the documents after automatic separation to make sure that
the documents have been separated correctly. Following problems may occur:
To separate documents:
1. Select the page that should be the first page of the new document.
2. Right-click the document, and then click Separate > Separate before
Selection.
A new document is created, beginning with the selected page. It has a row of its
own in the Documents and Thumbnails view and its own document header.
The index information is empty. The original document keeps the original index
information.
To keep the original index information in the new document, the REG_SZ
HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM
\DocumentIndex\B:InheritIndexForSeparation registry key must be set to
“True”.
• If a separation condition has been mistakenly applied, the document is divided
into two separate documents. The documents then have to be joined.
To join documents:
Note: If you only select one document it will connect itself to the next
document in the view.
To merge documents:
Important
This scanning software allows you to delete pages. However, there are
conditions of which you should be aware. To ensure that the archiving of
documents is complete and comprehensive, you must archive electronic
images of all documents with all their pages in such a way that the
documents can be retrieved rapidly. In this way, you also ensure compliance
with local legal requirements. You must also store documents for the time
period required by commercial or industrial authorities in your area.
To delete page(s):
Tip: If you do not want to delete immediately, use the Delete Marker in
the Page menu to mark pages intended for deletion. When you decide to
permanently delete the marked pages, select them and press Ctrl+D or
choose Delete Marked in the Page menu. A dialog box asks you to
confirm the deletion.
For details on working with markers, see “Marking documents for further
processing” on page 40. The corresponding toolbar icons are listed in
“Page menu” on page 242.
In most cases, the classification into document groups and the assignment to batches
and folders is performed automatically during scanning. If no parameters for
classification into groups, or assignment to batches, and folders have been
configured, Enterprise Scan stores the documents in the default group, batch and
folder <none>.
If the automatic document classification or assignment failed, you can change the
name of the group, batch, or folder manually:
1. In the Thumbnails view, select each document you want to move to another
group, batch, or folder.
2. In the Properties view, enter the name of the group, batch, or folder or select the
name from the list.
Note: You can define static groups, batches, and folders for your
workstation. For more information, see “Configuring document groups,
batches and folders” on page 190. These static subdivisions are displayed
in the list in the Properties view.
1. Select the document that contains the index you want to change.
Note: Whether the index can be modified depends on the options set in
the Document Index tab. For more information, see “Configuring the
document index” on page 189.
However, if the legibility is still poor, you can increase the color depth to the same
value for all pages of a document.
If there are still legibility problems, contact an experienced scan operator or your
administrator to use advanced filter methods. For more information, see
“Configuring page processing” on page 86.
Bookmark Marker Insert this marker if you want to label for example the last
page you corrected before lunch break.
Delete Marker Insert this marker if there are pages that should be deleted.
These pages can be deleted afterwards either manually (for
more information, see “Selecting marked pages”
on page 40) or automatically (for more information, see
“Configuring deletion of marked pages” on page 162).
Quality Marker Insert this marker if you have legibility problems with a
specific page and your administrator needs to solve this
problem.
Tip: If the Page toolbar is not displayed add it using View > Page Toolbar.
If the page has already been marked, the marker is removed. For keyboard
shortcuts and additional icons for navigation between markers, see “Menus and
icons“ on page 239.
Note: The Custom marker option is only used for project specific
solutions where the markers have been defined, for example by a plug-in.
3. Click OK.
To send files:
3. In the Advanced Settings dialog box, enter the output settings. For more
information, see “Defining advanced settings for archiving” on page 179.
4. Click OK.
A new email message appears with the pages attached.
To print documents:
You can specify some print configuration settings in the Configure Printing dialog
box.
All documents
Prints all documents in the document stack.
Selected documents
Prints only selected documents.
Selected pages
Prints all selected pages of the current document.
Orientation
Select Portrait or Landscape orientation for the printed document.
Paper
Select the paper size from the list.
6. Click OK.
You can import documents of all supported image formats and PDF files from the
file system in following ways:
Note: The language of the Open dialog box depends on the installed operating
system and may differ from the Enterprise Scan language.
You can export the documents in the document stack either to the file system or to
external storage.
After all documents have been exported, the document stack is empty.
After the documents are scanned and processed you can start indexing and
archiving.
Indexing fields You add indexing values in the indexing fields of the Indexing view. The following
properties provides general information about indexing fields.
•
Mandatory fields are marked with .
• Indexing fields that are highlighted in light blue color contain values valid for all
documents. They are persistent when archiving but they are lost if the profile or
subprofile is changed or if Enterprise Scan is shut down.
• Indexing fields that are not highlighted contain values valid for the particular
document. They are persistent, that means they do not change even if a different
document is selected in the stack or if Enterprise Scan is shut down.
• If you select more than one document from the stack (multi-selection), the
indexing fields that contain different values are highlighted in salmon color.
They display the value of the last selected document. When you navigate
through the indexing fields, your actions have the following results:
Navigating by mouse
You move from one indexing field to another. You can change the value by
editing the field. This affects all selected documents.
Index Item view The Index Item view shows information for indexing enlarged. This part is
highlighted in the View view in a defined color so that the area can be seen in the
context of the whole page. The default value is red.
Note: You can move the indexing items, which are indicated as highlighted
areas in the Indexing view as shown in the following table:
2. Read the property, for example the customer name in the Index Item view, and
then enter it in the corresponding field in the Indexing view.
Notes
•
If the entered values are not correct, the icon and an error message
appears behind the index field.
• This correctness check allows you to go on to another indexing field and
correct the error later. However, you will not be able to archive the
document before correcting the error.
Tips
• To archive all documents in the document stack, press F2. When the
documents have been archived, the document stack is empty.
• You can cancel the archiving operation by clicking Stop. In this case
the documents that have already been archived are handed over to the
leading application and the other documents stay in the document
stack of Enterprise Scan.
Output device
Current archiving profile
Archive mode
Current archive mode
Name
Name of the external storage. Only used for external storage output devices,
instead of Archive Mode.
Tip: To skip the archive confirmation dialog box, see “Configuring general
workstation options” on page 188.
You can specify the settings of Enterprise Scan to fit your needs, adjust the options
of the program, and change the display for different views.
To customize toolbars:
1. Point to the toolbar you want to customize, right-click, and then click
Customize.
2. To add a button to the toolbar, select the button you want to add in the
Available toolbar buttons list, and then click Add.
3. To remove a button from the toolbar, select the button you want to remove in
the Current toolbar buttons list, and then click Remove.
2. Choose the Category and the Command you want to create a keyboard shortcut
for.
3. Click in the text field and press the corresponding key(s) on the keyboard. The
new shortcut is created and added to the text field.
2. In the Configure User Options dialog box, define the settings, and then click
OK.
Language
Choose the language in which you want to work with Enterprise Scan. You
can only select languages for which language components have been
installed.
Note: After specifying the language, you must restart Enterprise Scan.
Units
Choose the units of measurement in which you want to work with
Enterprise Scan. If you select System, the regional settings of the operating
system will be used.
Log Level
Choose the log level. Normally, Default is set. For troubleshooting
purposes, set the log level to Extended.
Thumbnails Wrapping
Select this check box to group the pages of a document under a headline
showing the document number. The pages under a document are wrapped
according to the size of the Thumbnails view.
Thumbnail size
Define the thumbnail size in the Maximum width and Maximum height
fields.
Displayed documents
Choose between Show all documents and Show selected document.
You can configure the size of icons in the Thumbnails view by changing Windows
system settings.
3. Click Advanced.
4. In the Advanced Appearance dialog box, select Icon Spacing from the Item
list, and then enter a value in the Size box.
5. Click OK.
• Input: Specify the source of the data. For more information, see “Configuring
input“ on page 63.
• Processing: In order to attain optimum scanning quality for different types of
original documents, you can configure individual processing settings for each of
them.
You can specify the rules by which scanned pages are separated into documents,
batches, and folders and define how the pages are classified into groups during
scanning. For more information, see “Configuring processing“ on page 85.
• Archiving: Documents can be archived in different ways. They can be archived
through the Document Pipeline into Archive Center, through Capture Center, or
directly into a leading software system or to external storage. You can define the
archiving method in the profile. For more information, see “Configuring
indexing and archiving“ on page 127.
Tip: In most cases, you should distinguish scanning or input scenarios from
archiving scenarios. Pages can be scanned and processed in the same way, but
the resulting documents are archived in different ways. You should create a
profile for each scanning scenario and one for each archiving scenario. Then
you can add and configure the required subprofiles. A scanning or input
scenario usually needs an Input subprofile and a Processing subprofile. An
archiving scenario needs an Archiving subprofile.
9.1 Preparations
The profiles for Enterprise Scan are defined in coordination with OpenText Global
Technical Services. Before you can define these profiles, you have to analyze the
company requirements:
Most profiles are defined during initial configuration of Enterprise Scan, but it is
also possible to extend and modify the profiles if your requirements change.
To create a profile:
Notes
•
You cannot delete the active profile, which is marked with .
• When you delete a profile, referenced subprofiles are not deleted. They
remain in the corresponding subprofile lists, so that you can use them
for other profiles.
2. In the Profile Manager dialog box, click Create to create a new profile.
3. In the Profile Creation dialog box, enter a profile name, and then click Next.
Tips
• Use a name that is as descriptive as possible.
• You can use an existing profile as a template to create a similar profile.
To do so, select the Copy from check box, and then choose the
respective profile.
5. In the Subprofile Creation dialog box, enter an subprofile name, and then click
Next.
Tips
• Use a name that is as descriptive as possible.
• You can use an existing subprofile as a template to create a similar
subprofile. To do so, select the Copy from check box, and then choose
the respective subprofile.
6. Define the detailed configuration of the Input subprofile, and then click Finish.
For more information, see “Configuring input“ on page 63.
7. Click Next.
8. In the Profile Creation dialog box, click Create to create a new Processing
subprofile.
9. In the Subprofile Creation dialog box, enter a subprofile name, and then click
Next.
Tips
• Use a name that is as descriptive as possible.
• You can use an existing subprofile as a template to create a similar
subprofile. To do so, select the Copy from check box, and then choose
the respective subprofile.
10. Define the detailed configuration of the Processing subprofile, and then click
Finish. For more information, see “Configuring processing“ on page 85.
11. Click Next.
12. In the Profile Creation dialog box, click Create to create a new Archiving
subprofile.
13. In the Subprofile Creation dialog box, enter a subprofile name, and then click
Next.
Tips
• Use a name that is as descriptive as possible.
• You can use an existing subprofile as a template to create a similar
subprofile. To do so, select the Copy from check box, and then choose
the respective subprofile.
14. Define the detailed configuration of the Archiving subprofile, and then click
Finish. For more information, see “Configuring indexing and archiving“
on page 127.
15. Click OK to complete the profile configuration.
Tip: The selected subprofiles are listed in the Page flow field.
16. Validate the profil. For more information, see “Validating profiles”
on page 61.
1. Open a profile:
Create
Based on the tab Input, Processing, or Archiving, the Create button opens
the corresponding Subprofile Creation Wizard, where you can create a
new subprofile.
Modify
Select the subprofile you want to change. The functionality available here
depends on the tab you have open:
Input tab
Click Modify to change the input source. Select the correct input source
from the Scanners list in the Configure Input subprofile dialog box.
For more information, see “Configuring input“ on page 63.
To configure the parameters for the selected input source, click
Configure.
Processing and Archiving tab
Click Modify to change the settings and parameters of the selected
subprofile for Processing, and Archiving. For more information, see
“Configuring processing“ on page 85 and “Configuring indexing and
archiving“ on page 127.
Rename
Select the subprofile whose name you want to change, click Rename, and
then enter a new name for the subprofile.
Delete
Select the subprofile you want to remove, and then click Delete.
Notes
•
You cannot delete the active profile, which is marked with .
• You cannot delete a subprofile which is being used by a profile.
Configure
Change the settings of the currently selected input device. It is only
available for the Input subprofile.
2. In the Profile Manager dialog box, select a profile, click Modify, and then click
Validate.
The Validation Result dialog box shows if the combination of subprofiles used
is valid. Comments beneath each subprofile offer hints for solving various
profile configuration problems.
For example, in the Processing subprofile, you cannot use Separate by Barcode
unless Barcode recognition is enabled first.
• Click Profile > Switch to, and then select the profile you want to use.
When you are regularly working with several profiles create Enterprise Scan
shortcuts on your desktop referring to different profiles. Thus you can work with the
preselected profile without switching profiles.
• Create a shortcut for Enterprise Scan on the desktop, right-click it, select
Properties, and then enter <Path to the Enterprise Scan installation>
\EnterpriseScan.exe -p<profile name> in the Target field.
As input media, you can choose between ISIS scanners, Kofax certified scanners,
External Storage, File Import, File Input, Lotus Notes, or Microsoft Exchange.
To configure input:
2. In the Profile Manager dialog box, select the profile you want to configure, and
then click Modify.
3. In the Configure Profile dialog box, click the Input tab, select the subprofile,
and then click Modify.
4. In the Configure Input Subprofil dialog box, define the settings, and then click
OK.
Scanners
Select the input device for electronic pages to be scanned. Click Configure
to set the options for your scanning operation.
Note: If you select File Import as the input device, Configure is not
available.
Options
Note: If you select an ISIS scanner as the input device, this check
box is not available.
Note: The fields that are active in this dialog box vary depending on the input
source you have selected.
Format Checker If Check input file format was activated in the Input subprofile and some scanned
Result documents do not fulfill the defined requirements, the Format Checker Result
dialog box opens.
Check if the listed pages are sorted into the right group and if you have selected the
right profile.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. Select the Check input file format check box, and then click Properties.
3. In the Configure Format Checker dialog box, define the settings, and then click
OK.
Check
Enter the minimum size in inches for X and Y values of the document
pages.
• Multipage tags searches for tags with multiple pages in the file, that is
tags that are significant for a TIFF file with multiple pages.
Fix
Exporting to external storage creates the following folder structure on the file
system:
<configured folder>\<group name>\<serial number>\, for example C:
\extstorage\MyGroup\00000002.00000000\.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. In the Configure Input Subprofile dialog box, select External Storage, and then
click Configure.
3. In the Configure External Storage dialog box, define the settings, and then click
OK.
Edit
Edits the path specification for the external storage.
Remove
Deletes the external storage location.
Delete images
Deletes the data in the directory after scanning.
• Select the Delete Group Folder check box to delete the <group name>
folder after scanning.
• Clear the Delete Group Folder check box to delete only the files and
folders contained in the <group name> folder. The empty <group name>
folder will remain on the file system.
Importing PDF You can import PDF files from the file system in two ways:
files
• Rendering PDF files to bitmap. Each page of the PDF file is converted to a bitmap
and handled downstream in the same way as the pages of a document would
have been scanned in the first place.
• Passing the original PDF through. Each PDF file is passed though Enterprise
Scan without being touched at all. For more information, see Transparent
passthrough for PDF on page 64.
Warning
The scanned documents are not locked. This means that this input source
cannot be used for scenarios where concurrent users are scanning from the
same network file share because there is a high risk that they import the same
document more than once.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. In the Configure Input Subprofile dialog box, select File Input, and then click
Configure.
3. In the Configure File Input dialog box, define the settings, and then click OK.
Scan Options
Warning
You will lose original data if the original image is in the wrong
format or if the processing subprofile indicates an error because it
cannot handle the current color depth of the scanned page. In
these cases a message is displayed and the original files on the
disk are then deleted without warning irrespective from the
success or failure of scanning.
Note: The subdirectories are not empty if they contain any files,
for example thumbs.db, or desktop.ini. These files are only
visible to the Windows user selecting the Show hidden files,
folders, and drives setting in the Folder Options.
In case a subdirectory deletion failed, see the log file.
For more information about log files, see “Enterprise Scan log
files” on page 225.
Document Options
File Selection
Image files
Selects only image files.
All files
Selects all files.
Note: The language of the Open dialog box where you select the files depends
on the installed operating system and may differ from the Enterprise Scan
language.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. In the Configure Input Subprofile dialog box, select File Import, and then click
OK.
Note: Each ISIS driver supports one or more scanners. Install the relevant
driver only.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. In the Configure Input Subprofile dialog box, select your scanner, and then
click Configure.
3. In the Configure ISIS Scanner dialog box, click the tab you want to change,
define the settings, and then click OK.
Common rules, valid for all fields in the Configure ISIS Scanner dialog box
• Your changes are immediately validated for all controls except edit
boxes. For edit boxes, the value is checked when the focus is moved to
another box.
• There can be dependencies between scanning parameters. This means
that if you change one value, other values may automatically change to
make the whole configuration valid. Also, the available options for a
parameter may be limited by the current value of other parameters. For
example, you can select Compression only if 1bit B&W color depth is
selected.
• Default resets the fields on the active tab only.
Standard tabs
The Page and Image tabs set the parameters for the paper format and image
quality options. For more information, see “Configuring Page settings for
ISIS scanners” on page 70 and “Configuring Image settings for ISIS
scanners” on page 72.
Optional tabs
The Advanced and Endorser tabs as well as special tabs for some scanners
may also appear. These tabs are only available if the driver supports at least
one of the corresponding parameters. For more information, see
“Configuring Advanced settings for ISIS scanners” on page 74,
“Configuring Endorser settings for ISIS scanners” on page 75,
“Configuring Driver settings for ISIS scanners” on page 79, “Configuring
All Settings for ISIS scanners” on page 79, “Configuring Kodak special
tab” on page 80 and “Configuring Fujitsu IPC tab” on page 80.
Note: The options available depend on the functions supported by the scanner
you are using.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Page tab, define the
settings, and then click OK.
Paper Source
Flatbed
Scans each page individually from the Flatbed scanner.
Automatic
Scans pages automatically, that is if there is a stack of paper pages in the
feeder, they will all be scanned as single-sided. If there is no paper
stack, one image from the flatbed scanner will be scanned.
Timeout
Sets the length of time in seconds that the scanner can wait for
another document without interrupting the scanning operation.
The feeder timeout parameter should be set in scenarios where the
scanner itself does not implement any timeout threshold. That is for
scenarios with “manual feed” or for any related types of scanning
where sheets are not fed continuously but need a certain break to
insert the next sheet.
Double-sided scanning
Specifies if you want to scan both sides of a document.
Selected Device
Select the scanner id from the list if you have multiple scanners
attached to the computer.
None
The dual stream is disabled. Default setting.
Emulated by software
The dual stream is similar to the Emulate dual stream mode option for
non-ISIS input devices in the Configure Input dialog box. For more
information, see “Configuring input“ on page 63.
Hardware
The dual stream is provided by the scanner.
Page
Paper Size
Specifies the settings for Page format, Orientation, Width, Height, Left
and Top offset.
Advanced
Set Border detection to On to recognize page borders and to determine
the Page format. This check box can be selected only if the scanner
supports this function.
Select the Deskew check box to deskew the page. With some scanners,
this check box can be selected only if Border detection is set to On.
Enter a size in Overscan to enlarge the scanning area by the specified
size. You can, for example, select A4 size with a 5 mm safety margin.
Note: The options available depend on the functions supported by the scanner
you are using.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Image tab, define the
settings, and then click OK.
Image Format
Color depth
Color depth options depend on the color settings that are supported by
the selected scanner.
Resolution
Sets the resolution. The higher the selected resolution, the better the
result. However, at high resolutions, scanning takes longer and requires
more storage space. Since this setting depends on the quality of pages
that are to be scanned, you must test the settings to find which one
provides the best results. OpenText recommends that you use 300 dpi
for black and white scanning and 150 dpi for color or grayscale
scanning.
Brightness
The greater the percentage value you select, the lighter the electronic page
will appear. If Automatic is selected, the optimized setting for the scanner is
used, but only if the scanner supports this function.
Contrast
Sets the contrast. The greater the percentage value you select, the higher the
contrast in the electronic page.
Advanced
Dithering
Switches the dithering mode and can turn dithering off. Dithering
improves the quality of pictures in 1-bit monochromatic mode but may
damage text or barcodes.
Compression
Sets the type of compression used when images are transferred from the
scanner to the application. For fast scanners, this may influence the
speed of the whole scanning process. The most suitable compression
setting depends on the overall profile configuration.
Note: The options available depend on the functions supported by the scanner
you are using.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Advanced tab, define the
settings, and then click OK.
Emphasis
Enhances the image.
White level follower
Compensates for a non-white background.
Invert image
Inverts the color of each pixel in the image.
Outline extraction
Makes edges black while leaving monochrome areas white.
Mixed scan
Optimizes scanning for pages containing both images and text.
Error Handling: Prompt scanner internal error during scanning
When an internal error occurs inside the scanner during scanning, Enterprise
Scan will display an error message along with the error code. Select this check
box to enable these error messages. By default, the check box is selected.
If you clear this check box, the user will not be notified of an internal error inside
the scanner during scanning. Scanning will be aborted silently.
Example: The following screenshot shows an error message when a paper jam has
occurred in the scanner feeder.
You can enable a retry option for any scanner error during scanning by creating a
registry entry.
2. Add the error codes for which you want to enable a retry option.
In the example above, to enable a retry option in case of paper jam, enter the
value -4426 for S:ErrorCodes. If you want retry option for multiple errors,
separate the error codes by a semicolon.
Example: The following screenshot shows the paper jam error message with the error code
added in the registry.
To continue scanning, clear the paper jam, and then click Retry. To abort the scanning
operation, click Cancel.
For all errors whose error code is not added in the registry, only the OK option will
be available in the error message.
• Scanner with hardware imprinter: Using a printer unit of the scanner to print
some text on the sheets being scanned. For more information, see “Configuring
Endorser settings for ISIS scanners” on page 75.
• Scanner with software endorser: Using the endorser functionality of the scanner
driver to add some overlay text to the image before sending it to the scanning
application. For more information, see “Configuring Endorser settings for ISIS
scanners” on page 75 and “Configuring Driver settings for ISIS scanners”
on page 79.
• Enterprise Scan performing software imprinting: Adding overlay text as
configured in the processing subprofile. For more information, see “Configuring
software imprinter” on page 108.
In the Endorser tab, you specify the stamp settings for your ISIS scanner.
Note: The options available depend on the functions supported by the scanner
you are using.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Endorser tab, define the
settings, and then click OK.
Mode
Specifies how the stamp is printed.
Disabled
No stamp is printed.
Manual
No stamp is printed during scanning. However, you can enter a stamp
identification manually by using the Properties view. You can use the
manual setting for pages that have already been time stamped.
Automatic
Prints the stamp automatically on every scanned page.
Automatic Counter
This counter increases by 1 after every page that is scanned. To change the
value used for the next page, enter the value into the field.
Endorser string
Defines the printed appearance of the endorser.
Tips
• You can use the scanner specifier apart from the Enterprise
Scan specifier.
• The performance will not be reduced even in case of using the
dynamic specifier.
• The Enterprise Scan specifier will take more priority if you use
it together with the scanner specifier.
• Type: Static
• Interpretation: Computer Name
• Performance: Unaffected
%C
• Type: Static
• Interpretation: Computer Name
• Performance: Unaffected
%d
• Type: Static
• Interpretation: The current date.
• Performance: Unaffected
%D
• Type: Static
• Interpretation: The current date.
• Performance: Unaffected
%n
• Type: Dynamic
• Interpretation: Counter of pages.
• Performance: Reduced
%N
• Type: Dynamic
• Interpretation: Counter of pages.
• Performance: Reduced
%P
• Type: Static
• Interpretation: Use driver endorser string settings.
• Performance: Unaffected - depending on driver settings.
Notes
• You cannot combine this format specifier with any other format
specifiers.
• %P has the same function as an empty string.
%t
• Type: Dynamic
• Interpretation: The current time.
• Performance: Reduced because also seconds will be evaluated.
%T
• Type: Dynamic
• Interpretation: The current time.
• Performance: Unaffected but not accurate.
%u
• Type: Static
• Interpretation: The current user name.
• Performance: Unaffected
%U
• Type: Static
• Interpretation: The current user name.
• Performance: Unaffected
Position
Specifies the position of the stamp on the page relative to the margins.
Note: This tab is visible for administrators only. Users with the appropriate
permission can display the tab by simultaneously pressing the SHIFT key while
opening ISIS configuration. To change permissions, see “Changing
permissions“ on page 197.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Driver tab, define the
settings, and then click OK.
Driver Settings
Defines the settings for the selected driver by entering the device name in
the Select Device field and choosing the properties to be ignored in the
Property not used list.
ScannerID
Select the ScannerID in the list.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the All Settings tab, define the
settings, and then click OK.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Kodak special tab, define
the settings, and then click OK.
Manual feed
Controls the automatic feeder. If enabled, the user must press a button on
the scanner before each page.
Skew stop
Stops the scanning when a skewed sheet of paper is detected.
Adaptive thresholding
Adapts the threshold to optimize scanning.
Invert image
Inverts the color of each pixel in the image.
1. Go to the scanner you want to configure. For more information, see “To
configure ISIS scanners:“ on page 69.
2. In the Configure ISIS Scanner dialog box, click the Fujitsu IPC tab, define the
settings, and then click OK.
Threshold
Increases the accuracy of low-contrast documents.
Gradation
Specifies the gamma correction in Auto I mode.
Smoothing
Adjusts character edges to improve Optical Character Recognition (OCR).
Variance rate
Adjusts the level of gray at which the pixel is regarded as being black or
white. It enables the automatic brightness option.
Installed Kofax certified scanners are listed in the Scanners list of the Input
subprofile. They are marked with a purple icon.
Initialization of the Kofax certified scanner driver is started automatically when you
start scanning or configuring the scanner for the first time. A dialog box showing the
initialization progress opens. If the driver supports VirtualReScan (VRS), the VRS
icon appears in the Windows taskbar.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. In the Configure Input Subprofile dialog box, select your Kofax certified
scanner, and then click Configure.
Tip: Instead of using a Kofax certified scanner you can also select a Kofax-
VRS Scanner. This generic scanner can be assigned a physical scanner
using the Kofax scanner configuration tool. The generic scanner also uses
the ISIS configuration dialog.
3. In the Configure ISIS Scanner dialog box, click the tab you want to change,
define the settings, and then click OK.
For a description of the values, refer to the Kofax documentation.
To configure VirtualReScan:
• Right-click the VRS icon in the taskbar, and then select Preview or click
Advanced in the Scanner Properties dialog box.
The language of the Scanner Properties dialog box depends on the installed
scanner driver and may differ from the Enterprise Scan language.
The VRS settings are independent from the scanner's settings. They are not
handled by Enterprise Scan but by the VRS engine. For more information on
VRS settings, refer to the VRS documentation.
Notes
• The VRS profile selected in Enterprise Scan must be available on the scan
computer. If you download the configuration to another computer with VRS
you must install the VRS profile on this computer too because it is not part of
the Enterprise Scan configuration. If the requested VRS profile is not
available on the computer a default configuration is used by VRS.
• Switching the profile in the context menu of the VRS notification does not
apply to Enterprise Scan. Whenever you start a scan the configuration is
updated by Enterprise Scan, that is the VRS profile is explicitly set to the
Enterprise Scan input profile settings. If you want to use different VRS
profiles in Enterprise Scan you must create corresponding input subprofiles
in Enterprise Scan and use them to switch to another VRS profile.
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. Select Lotus Notes in the Configure Input Subprofile dialog box, and then
click Configure.
3. In the Lotus Notes Properties dialog box, define where the faxes will arrive:
1. Go to the profile you want to configure. For more information, see “Configuring
input“ on page 63.
2. Select Microsoft Exchange in the Configure Input Subprofile dialog box, and
then click Configure.
3. In the Microsoft Exchange Properties dialog box, define where the faxes will
arrive:
Folders
If you want to change the default names, enter new names for the folders in
the Input, Error, and Deleted boxes. When Enterprise Scan retrieves new
fax messages, these three folders are automatically created in the Folders
folder of your mailbox directory, if they have not already been created.
Configuring processing
To configure processing:
2. In the Profile Manager dialog box, select the profile you want to configure, and
then click Modify.
3. In the Configure Profile dialog box, click the Processing tab, select the
subprofile, and then click Modify.
The Configure Processing Subprofile dialog box is divided into the following
parts:
Page Processing
Page processing improves the legibility of the document. Usually, page
processing is performed automatically during the scanning operation.
However, it might be necessary to improve the document quality manually.
For more information, see “Configuring page processing” on page 86.
Document Creation
During mass scanning, the beginning of a new document must be detected
automatically. This can be done in various ways: From a barcode, blank
pages, the page number, or blank pages.
For more information, see “Separating documents (document creation)”
on page 110.
Document Processing
If you are using blank pages to detect the end of a document, the obsolete
blank pages can be removed automatically during scanning.
For more information, see “Removing blank pages” on page 120.
The scripting extension enables you to configure document processing,
using a script.
For more information, see “Scripting extension” on page 120.
Document Classification
During mass scanning, the documents can be separated automatically into
document groups. This can be done using a barcode, default group or patch
code.
For more information, see “Configuring document classification”
on page 121.
4. Add the operation you want to use to the Flow list, and then click Configure.
For more information, see the appropriate section in “Configuring processing“
on page 85.
5. Click OK.
2D Barcode Recognition
Use to separate documents, assign documents to a batch or a folder, or classify
documents by 2D barcode. For more information, see “Configuring 2D barcode
recognition” on page 88.
Barcode Recognition
Use to separate documents, assign documents to a batch or a folder, or classify
documents by barcode. For more information, see “Configuring barcode
recognition” on page 91.
Black Border
Use when you are using the deskew or crop function. Works only with black
and white images. For more information, see “Configuring black border”
on page 95.
works only with color images. For more information, see “Configuring content
extractor with preview (manual processing only)” on page 98.
Note: OCR is only available in the Operations list if the deprecated OCR
feature is installed separately.
DPI Resampling
Use to change the resolution of an image, for example when pages are noisy and
Barcode or Patch Code Recognition is used. For more information, see
“Configuring DPI resampling” on page 101.
Deskew
Use to deskew skewed images. Works only with black and white images. For
more information, see “Configuring deskew” on page 101.
Despeckle (B&W)
Use to correct dirty black/white pages. Works only with black and white images.
For more information, see “Configuring despeckle (B&W)” on page 103.
Landscape to Portrait
Use to rotate odd pages left and even pages right. If you have a duplex A3
scanner and are scanning A4 pages, you can speed up the scanning by rotating
the A4 pages to landscape. This function is able to correctly convert the scanned
landscapes to original portraits. For more information, see “Configuring
landscape to portrait” on page 104.
Patch Code Recognition
Use to separate or classify documents by Patch Code. For more information, see
“Configuring patch code recognition” on page 105.
Quality Indicator
Use to automatically check the image quality during scanning. If an image does
not meet the quality requirements, the page is marked with the Bad Quality
Marker. The scan operator can then search for the Bad Quality Marker and
manually correct the quality, if possible. This operation is only supported by
OpenText Capture Center. For more information, see “Configuring quality
indicator” on page 106.
Rotation
In mass scanning scenarios, it may not always be possible to scan the documents
in the correct orientation. This function rotates these pages automatically. For
more information, see “Configuring rotation” on page 107.
Smooth (Color)
Use to correct dirty color pages. Works only with color images. For more
information, see “Configuring smooth (color)” on page 107.
Software Imprinter
Use to imprint information on your scanned documents. For more information,
see “Configuring software imprinter” on page 108.
Notes
Barcode
2D Barcode
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add 2D Barcode Recognition to the flow list, and then click Configure.
Barcodes tab
Enterprise Scan supports the following types of 2D barcodes:
Pdf417
Data Matrix
QR
Recognize barcodes
Defines the barcodes that you want to search for.
Checksum
Examines the checksums of the recognized barcodes. For more information
on checksums, see “Questions about barcodes” on page 296.
Licence
Indicates the license for the 2D barcode recognition. If you select a 2D
barcode without having an appropriate license, a warning message is
displayed.
Configure tab
Barcode orientation
Defines the orientation of the 2D barcodes on your paper. Enterprise Scan
needs this information for correct reading of 2D barcodes. The following
values are possible:
Notes
• Barcode Recognition must be set in the flow preceding the document
separation, assignment, or classification.
• To distinguish simple barcodes from 2D barcodes, the term “barcode”
always indicates the simple barcode whereas the term “2D barcode” always
indicates the 2-dimensional barcode.
Barcode
2D Barcode
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Barcode Recognition to the flow list, and then click Configure.
3. Define the settings, and then click OK.
Barcodes tab
Tip: To select all barcodes, press SHIFT, and then select one of the
check boxes.
• 2/5 Datalogic
• 2/5 IATA
• 2/5 Industrial
• 2/5 Interleaved
• 2/5 Inverted
• 2/5 Matrix
• Code11 Matrix
• Code32
• Code39 Standard
• Code93
• Code128
• ABC-Codabar
• BCD
• Codabar
• EAN128
• EAN13
• EAN8
• JAN-13
• JAN-8
• MSI
• Plessey
• UPC Version A
• UPC Version E
Recognize barcodes
Select the barcodes that you want to search for.
Checksum
Uses the checksum function of the barcode: The checksum is read and
checked.
If the checkbox is selected, the checksum is checked.
For more information on checksums, see “Questions about barcodes”
on page 296.
Remove checksum
Defines the processing of the checksum after check.
If the checkbox is selected, the checksum sign is removed.
If the checkbox is not selected, the checksum sign remains in the barcode.
Regular expression
Defines a regular expression against which the index is checked.
Remove chars
Removes certain characters or strings from the index in accordance to the
rules entered in this box. For example, to remove the first four characters
enter 1-4. To remove the first and the fourth character enter 1,4.
More Info
Displays a technical specification of the selected barcode.
Configure tab
Recognition tab
You can change the settings to enhance recognition of the individual barcodes.
Comparison shift
Defines the maximum horizontal shift of the lines that are to be compared.
Increasing this value improves the recognition of oblique or less legible
barcodes.
Skip duplicates
Compares the identified barcodes. If two identical barcodes appear on a
page, then only one is considered.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Black Border to the flow list, and then click Configure.
This parameter is used to make border detection less sensitive to white dots
within the borders. White areas that are narrower than the specified value
are interpreted as part of the black border.
Note: Set Blank Page Detection in the flow preceding Blank Page Removal.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Blank Page Detection to the flow list, and then click Configure.
Tolerance
Specifies when the page is recognized as blank. The higher the value you
choose, the less spots the page may contain.
If you are unsure whether all pages you want to scan are in color, include
Conversion to xxx colors option in the flow. Conversion to xxx Colors must precede
Content Extractor.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Content Extractor (Color) to the flow list, and then click Configure.
Channel
When the image is in true colors, pixels possess three values that identify
the intensity of red, green, and blue color values. The algorithm takes only
one of these colors or channels into account.
When you select Luminosity, a calculated value from all of these colors will
be used in the algorithm, according to the level of human sensitivity to
these colors. Each pixel in the image is assigned a value that is taken from
the channel intensity, and the threshold is calculated. All pixels with a value
higher than this threshold result will be white.
Text color
Autodetect
Determines the color automatically.
Dark
Determines the color as dark.
Light
Determines the color as light.
Threshold
Global
One threshold is calculated for the whole image.
Adaptive
The image is split into squares, each with a specific threshold.
Global sampling
Determines how many pixels are taken into account. It overlays the
image with a system of grids. Global sampling determines the space
between the grids.
The higher the grids, the lower the resulting quality, but the faster the
performance.
Adaptive grids
Determines the size of these squares in pixels.
To suppress differences, the thresholds over pixels near borders are
continuous. In other words, there are no jumps between pixels in
adjacent squares.
Secondary pass
Additional function for the improvement of the image, in case some
problem areas appear after conversion. These areas are then reevaluated in
the second cycle.
You can set the threshold values for a manual conversion of images from color to
black and white. You then see the results of recent settings in a preview.
1. Click Page > Image Filter > Content Extractor with Preview.
The histogram shows the number of pixels for all intensities (0 to 255) for the
chosen channel. The representation of the number of pixels, which are vertical
lines in the histogram, is adjusted to fit this rectangle.
Channel
When the image is in true colors, all pixels possess three values that identify
the intensity of red, green, and blue color values.
The algorithm takes only one of these colors or channels into account.
When you choose Luminosity, a calculated value from all of these colors
will be used in the algorithm, according to the level of human sensitivity to
these colors.
A value is assigned to each pixel in the image, taken from the channel
intensity, and the threshold is calculated. Pixels with values higher than this
threshold result will be white.
Threshold
The threshold is the value that determines how the image will be converted.
All pixels with an intensity smaller than this threshold value are converted
to black, and all others to white.
You can set only one threshold at a time, according to the channel selected.
Conversion can be performed for one channel only. The default value is 100
for all channels.
Preview
A simplified preview of the image shows the potential result of the
conversion to black and white.
You can either configure color conversion in the Processing subprofile or configure
it manually through the Page menu.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Conversion to xxx Colors to the flow list, and then click Configure.
You can only configure Conversion to 2 Colors and Conversion to 256 Colors.
Dithering method
The best dithering method depends on the type of graphic, available colors
and whether the graphic is to be displayed or printed. Floyd-Steinberg is
always set as the default. For most graphics, this method produces a
satisfactory result. You need to test the various methods to determine which
best meets your requirements. For more information on dithering methods,
see “Using color reduction methods“ on page 271.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Conversion to Gray Scale to the flow list, and then click OK.
There are no configuration parameters for this function.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Crop Filter to the flow list, and then click Configure.
Mode
Specifies whether the background of the documents is white or black.
Alternatively, you can select Detect background color so that the color will
be recognized automatically. This is slightly slower and sometimes may
produce unwanted results. The background color is important because only
borders filled with background color will be cropped.
Reserve borders
Crops only borders that exceed this size.
You use DPI Resampling in cases where the pages are noisy and barcode or patch
code recognition is used. The probability of correct barcode or patch code
recognition on noised pages is higher if you select higher resolution values. The
pages are scanned in high resolution, barcodes are recognized, and then the
resolution is reduced. Pages with lower resolution need less space on Archive
Center.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add DPI Resampling to the flow list, and then click Configure.
3. Define the Resolution for X and Y, and then select the Resampling method you
want to use.
4. Click OK.
To configure deskew:
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
Algorithm Precision
Specifies sampling frequency. The higher this parameter, the better the
results of deskewing will be. However, setting a high value will lengthen
the run time.
Background color
Defines the background color. This color is used as a filling color to areas
that are new after deskewing is performed.
The following examples illustrate how to use the maximum angle and algorithm
precision settings.
To configure despeckle:
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Despeckle (B&W) to the flow list, and then click Configure.
Type
Specifies the type of speckles to be removed.
You can remove black speckles from a white background or white speckles
from a black background.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Landscape to Portrait to the flow list, and then click OK.
There are no configuration parameters.
To configure OCR:
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
Language
Select the language to be recognized. The following languages are
supported:
• English
• German
• French
• Spanish
• Italian
Recognition tab
You can change the settings to enhance recognition of the individual patch
codes.
For a description of the settings, see the Recognition tab of the Barcode
recognition. For more information, see Recognition tab on page 94.
Note: Set Patch Code Recognition in the flow preceding Document separation
or Classification.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Patch Code Recognition to the flow list, and then click Configure.
Patch Codes
Names of each patch code.
The highlighted code is shown in the Preview area.
Orientation
Specifies whether the code is to be read vertically or horizontally.
Recognition tab
You can change the settings to enhance recognition of the individual patch
codes.
For a description of the settings, see the Recognition tab of the Barcode
recognition. For more information, see Recognition tab on page 94.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Quality Indicator to the flow list, and then click Configure.
Contrast
The contrast checker verifies the density of color images.
Sensitivity
Specifies the contrast density of images. The lower you set the checker,
the lower contrast density will be accepted as correct in the scanned
image.
Algorithm Precision
Specifies the sampling frequency. The higher this parameter, the better
your contrast checking results will be. However, setting a high value
will lengthen run time.
Content Overflow
The content overflow checker verifies that no part of the page content, such
as text, appears outside the borders of the scanned image.
Ignore Objects
Specifies the maximum length and width of an object. Any parts of the
object that fall outside these parameters are cropped.
Character Compactness
The character compactness checker verifies that characters in the image are
not divided into too many parts, for example, very light copies.
Sensitivity
Specifies the acceptable division of characters in the image. The lower
you set the checker, the smaller distance between characters will be
accepted as correct in the scanned image.
Characters Height
Specifies the maximum, minimum and standard height of the
characters. The minimum value is 0, and the maximum value is 0.79
inches (20 mm).
To configure rotation:
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Rotation to the flow list, and then click Configure.
3. Select the appropriate rotation, and then click OK:
Left
The page is rotated 90 degrees to the left.
Right
The page is rotated 90 degrees to the right.
180°
The page is rotated 180 degrees.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Smooth (Color) to the flow list, and then click Configure.
3. Define the settings, and then click OK.
Method
Specifies the cleaning method. All methods reduce the noise (dirty pixels) of
the image and improve the quality.
• Min - Max
The Min-Max filter is a weaker variant of the Median filter. It does not
lose as much relevant data, but is able to remove some kinds of noise.
For this method, the size option is disabled.
• Median
The Median filter takes an array of 3x3 pixels into account. It sorts the
pixels by color and determines the pixel in the middle. The color value
of this pixel is then assigned to all pixels in the array. If the dirty area is
large, this filter may be unable to remove the noise.
For this method, the size option is disabled.
• Average
The Average filter computes the value of a pixel as an average of the
pixels in the surrounding area. The size of the considered area is
configured under Size.
Size
Specifies the area size for the Average method.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Software Imprinter to the flow list, and then click Configure.
3. Define the settings, and then click OK.
Settings tab
Template String
Defines the printed appearance of the imprint.
The imprint string may consist of:
%c
• Type: Static
• Interpretation: Computer Name
%d
• Type: Static
• Interpretation: The current date.
%n
• Type: Dynamic
• Interpretation: Counter of pages.
%t
• Type: Dynamic
• Interpretation: The current time.
%u
• Type: Static
• Interpretation: The current user name.
Automatic Counter
Current Value
Starts with the number of the page you enter and increases by 1 after
every page that is scanned.
Digits
Number of digits the string consists. For example, if you select Counter
Value and enter 4 it prints 0001, 0002 and so on. That is, empty
positions in the string will be filled with 0.
Counter Persistency
Scan
Sets the counter back to 0 every time you press Scan.
Session
Sets the counter back to 0 when you restart Enterprise Scan or switch to
another profile.
Global
Sets the counter never back to 0.
Position tab
Position
Specifies the position of the imprint on the page.
Alignment
Specifies the orientation of the page.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Separation by 2D Barcode to the flow list, and then click Configure.
Conditions
Barcode type
Separates the document only if the identified 2D barcode matches the
selected one.
Checksum is OK
Separates the document only if the checksum is analyzed as correct.
Options
For separation, you can use leading pages containing only the barcode. You
can delete these pages automatically during scanning, mark them for
manual deletion, or keep them.
The Separate by Filename function will also set the index of the document to the
barcode.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Separation by Barcode to the flow list, and then click Configure.
Conditions
Barcode type
Separates the document only if the identified barcode matches the
selected one.
Note: You can select one barcode or all barcodes. If you want only
a few barcodes to be used as separators, add Separate by barcode
to the processing flow as often as needed.
Checksum is OK
Separates the document only if the checksum is analyzed as correct.
Options
For separation, you can use leading pages containing only the barcode. You
can delete these pages automatically during scanning, mark them for
manual deletion, or keep them.
Note: Set Blank Page Detection in the flow preceding Separate by Blank Page.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Separation by Blank Page to the flow list, and then click Configure.
When certain third-party fax software packages are used to receive faxes, they may
save faxes with multiple pages in such a way that each fax page is imported into
Enterprise Scan as a separate one-page document. In such cases, the Separate by
Filename function creates one document for each fax file and separates the imported
fax pages into the relevant documents with multiple pages.
Set Separate by Filename in the flow and no further configuration is then needed.
Separate by Filename function will also set the index of the document to the file
name.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
3. Click OK.
The Separate by Nth Page function will set the index of the document to the file
name. However, this is only for the first document and not for the subsequent
documents.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Separation by Nth Page to the flow list, and then click Configure.
3. Enter the page after which a new document is to be created, and then click OK.
Note: Set Patch Code recognition in the flow preceding Separate by Patch
Code.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Separation by Patch Code to the flow list, and then click Configure.
3. In the Patch code type list, click the patch code, optionally select the Option,
and then click OK.
Note: Select the Delete page with recognized patch code check box if the
separation pages only contain the patch code, and if these pages should be
automatically deleted.
The configuration is identical for batches and folders, so the following sections apply
to batches and folders.
You can select following methods of batch and folder creation or assignment:
• 2D barcode
• barcode
• patch code
Alternatively, the user can directly select a batch or a folder to scan documents into,
before scanning is started. To configure this scenario, add Batch/folder creation or
assignment by user to the operation flow in the Processing subprofile.
Note: To use this function, make sure 2D Barcode Recognition is set in the
flow preceding Batch Creation or Assignment by 2D Barcode/Folder Creation
or Assignment by 2D Barcode.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
Batch/Folder
You have the following options:
Recognize barcodes
Select the 2D barcode that should be recognized, or select All, if you
want all 2D barcodes to be recognized. Each document with the selected
2D barcode(s) will be assigned to the batch or folder selected in this line.
Checksum
Assigns the document into the selected batch or folder only if the
checksum is valid.
Regular expression
Uses a regular expression for the assignment. The regular expression
must be consistent with the UNIX standard. For more information, see
“Working with regular expressions“ on page 273.
Remove
Deletes the selected line.
Tip: For an example, see “Separating documents by barcode and sorting into
groups using regular expressions“ on page 263.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Batch/folder Creation or Assignment by Barcode to the flow list, and then
click Configure.
3. Define the settings, and then click OK.
Recognize barcodes
Select the 2D barcode that should be recognized, or select All if you
want all 2D barcodes to be recognized. Each document with the selected
2D barcode(s) will be assigned to the batch or folder selected in this line.
Checksum
Assigns the document to the selected batch or folder only if the
checksum is valid.
Regular expression
Uses a regular expression for the assignment. The regular expression
must be consistent with the UNIX standard. For more information, see
“Working with regular expressions“ on page 273.
Remove
Deletes the selected line.
Set Patch Code Recognition in the flow preceding Batch Creation or Assignment by
Patch Code/Folder Creation or Assignment by Patch Code.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Batch/folder Creation or Assignment by Patch Code to the flow list, and
then click Configure.
Batch/Folder
You have the following options:
Remove
Deletes the selected line.
When you start scanning, the Select Batch or Select Folder dialog box opens. Select
a Batch or a Folder name from the list or enter a name for a new batch or a new
folder. This new batch or folder is created during scanning, and all scanned pages
are assigned to this batch or folder.
Tip: You can predefine the list of available batches and folders in the Static
Batches or Static Folders tab in Tools > Workstation Options.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Batch/folder Creation or Assignment by User to the flow list, and then
click OK. No further configuration is needed.
In order to use this function, Blank Page Detection must be set in the flow preceding
Remove Blank Pages.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Remove Blank Pages to the flow list, and then click Configure.
If you want to use 2D barcodes, simple barcodes, or OCR in your processing script,
make sure the respective plug-ins are properly configured in the page processing
flow.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Scripting Extension to the flow list, and then click Configure.
3. In the Configure Processing Extension Script dialog box, enter your script for
document processing. The scripting interface in the processing script looks
similar to the following:
Page attributes
var bc = PageAttributes.GetBarcode(index);
var bc2d = PageAttributes.Get2DBarcode(index);
• To access the OCR result:
PageAttributes.GetOcrText();
Separation
// separates only
//Separation.Separate(props);
// separates and deletes the current page
//Separation.Separate(props, Separation.Flags.DeletePage);
// separates and sets the delete-marker for the current page
Separation.Separate(props,
Separation.Flags.MarkPageForDelete);
4. Click Load, Save, and Compile to open, store, and test the scripts.
Use References to add a reference to third party libraries, see “Assigning third
party libraries” on page 155.
For details about scripting, see “Working with scripts for indexing and
archiving“ on page 251.
You can click Open Global Function Depot to display the Global Function
Depot, see “Global function depot” on page 260.
5. Click OK.
Using groups gives a better overview of scanned documents and simplifies your
work, especially when you archive into External Storage. Groups correspond with
directories in the file system, so only the desired group of documents can be selected
for further processing.
Alternatively, the user can directly select a batch or a folder to scan documents into,
before scanning is started. To configure this scenario, add Batch/folder creation or
assignment by user to the operation flow in the Processing subprofile.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Classification by 2D Barcode to the flow list, and then click Configure.
3. Define the settings, and then click OK.
Remove
Deletes the selected line.
Tip: For an example, see “Separating documents by barcode and sorting into
groups using regular expressions“ on page 263.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Classification by Barcode to the flow list, and then click Configure.
Group
Select a group name from the list, or enter a name for a new group to be
created during scanning.
Recognize barcodes
Select the 2D barcode that should be recognized, or select All if you
want all 2D barcodes to be recognized. Each document with the selected
2D barcode(s) will be classified into the group selected in this line.
Checksum
Assigns the document into the selected batch or folder only if the
checksum is valid.
Regular expression
Uses a regular expression for the assignment. The regular expression
must be consistent with the UNIX standard. For more information, see
“Working with regular expressions“ on page 273.
Remove
Deletes the selected line.
Move Up/Move Down
Changes the sequence in which the barcodes are checked during scanning.
Set Patch Code Recognition in the flow preceding Classification by Patch Code.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Classification by Patch Code to the flow list, and then click Configure.
3. Define the settings, and then click OK.
When you start scanning, the Select Group dialog box opens. Select a Group name
from the list or enter a name for a new group. This new group is created during
scanning, and all scanned pages are assigned to this group.
Tip: You can predefine the list of available groups in the Static Groups tab in
Tools > Workstation Options.
1. Go to the profile you want to configure. For more information, see “To
configure processing:“ on page 85.
2. Add Classification by User to the flow list, and then click OK. No further
configuration is needed.
In the Archiving subprofile, you can define where and how the scanned and
processed pages will be stored. The Archiving subprofile must be configured
according to the processing workflow and the leading application.
2. In the Profile Manager dialog box, select the profile you want to configure, and
then click Modify.
3. In the Configure Profile dialog box, click the Archiving tab, select the
subprofile, and then click Modify.
The Configure Archiving Subprofile dialog box is divided into the following
parts:
1. Configure the relevant Content Server objects, categories, and workflow maps
on Content Server. For more information, see OpenText Content Server Admin
Online Help - Content Server Administration (LLESWBA-H-AGD).
2. Create the archiving subprofile and configure it for Content Server. For more
information, see “Archiving documents on Content Server” on page 166.
The corresponding scenario names are Storing for subsequent entry and Storing
for subsequent assignment. The scenario names depend on the SAP product
version.
Late Archiving In the Late Archiving with Barcode scenario, paper documents are passed through the
with Barcode office and are not archived until all document-related work has been completed. If
documents are archived in this way, indexing by barcode, patch code or another
indexing method is used to join the documents to the corresponding business entries
in SAP. Documents are identified by a barcode or patch code on their first page.
Pre-Indexing With the Pre-Indexing scenario, you can store additional document properties with
the scanned document in Archive Center. A, for example TCP user, can use these
properties to retrieve the document.
3. Configure the OpenText TCP Document Pipelines with the archive mode
defined in OpenText Administration Client, and then select DMS doctype. For
more information, see “Configuring Server and Document Pipeline settings”
on page 209.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Init-Profile Script
tab, and then click Edit.
3. In the Configure Init-Profile Script dialog box, enter the script in the Script
field, and then click OK.
• Use Load, Save, and Compile to open, store, and test the script.
• Use References to add a reference to third party libraries. For more
information, see “Assigning third party libraries” on page 155.
• Use Open Global Function Depot to open the Global Function Depot,
where you can collect all your Enterprise Scan scripts. For more information,
see “Global function depot” on page 260.
You can find scripting example in the Scripting Examples > Init-Profile Script Examples
section in the Indexing and Scripting Guide in OpenText Developer Network (OTDN)
(https://knowledge.opentext.com/go/EnterpriseScan_OTDN).
To configure indexing:
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab.
In this dialog box you define the indexing fields for the archiving profile shown
in the heading.
• Click Add > New field to define own index fields. For more information, see
“Configuring custom index fields” on page 133.
• Click Add > Import from TCP to import the records from TCP Business
Object Layer. For more information, see “Importing records from TCP”
on page 134. The records must be defined in the OpenText TCP Modeler.
• Click Add > Import from Content Server to import the attributes from
Content Server. For more information, see “Importing Content Server
attributes” on page 137. The attributes must be defined in the Content
Server administration.
• Click Add > Import from Oracle to import the attributes from Oracle Web
Service. For more information, see “Importing Oracle Web Service
attributes” on page 144.
• Click Add > Import from SAP to import the attributes from SAP. For more
information, see “Configuring indexing for SAP” on page 148.
5. Click Field areas to define the area in the document where the scan operator
will find the required information for editing the selected indexing field. For
more information, see “Assigning zooming areas to indexing fields”
on page 157.
Tip: You can define the order of the index field with the arrow buttons.
6. If you have imported the index fields from Content Server, you can group the
fields in the indexing form according to the set names. To do this, select the
Group fields by sets check box. The set name is first part of the field name
separated by colons.
Note: If you have imported the index fields from TCP Business Object
Layer, you must clear this option.
7. Click OK.
The Indexing view opens with the specified index fields when the scan operator
selects this profile. For more information, see “Indexing and archiving
documents“ on page 47.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
Name
Name of the field.
Type
Select the field type.
Content Server
Only active if User type is selected. For more information, see “Indexing the
Content Server User attribute type” on page 144.
Display String
Name that is displayed in the index form.
Mandatory
Select this check box if the scan operator must complete this field.
Owner
Select Document or Global.
Document
The values in indexing fields with the Document owner are valid for
the particular document. They are persistent, which means they do not
change even if a different document is selected in the stack or if
Enterprise Scan is shut down.
Global
The values in indexing fields with the Global owner are valid for all
documents. They are persistent when archiving but they are lost if the
profile or subprofile are changed, or if Enterprise Scan is shut down.
Indexing fields of the Global type are highlighted in light blue in the
Indexing view and in the Indexing tab of the Configure Archiving
Subprofile dialog box.
More
Only activ for importing TCP relations. For more information, see
“Configuring TCP relations” on page 135.
5. Assign scripts to the index field. You can click tabs with the following scripts:
• Initialization script
• Selection script
• Validation script
• Update script
For more information, see “Scripts in the interactive phase” on page 251.
6. Click Load, Save, and Compile to open, store, and test the scripts.
You can click Open Global Function Depot to display the Global Function
Depot. For more information, see “Global function depot” on page 260.
7. Click OK.
Note: Prior to importing, the records must have been defined in OpenText TCP
Modeler.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab, and
then click Add > Import from TCP.
3. Sign in to TCP (for more information, see “Defining the sign in to TCP”
on page 211) to display the Import Record Types dialog box.
Note: Only one document type can be specified, whereas any number of
data object types can be imported. The document type will contain the
scanned document itself.
6. Click Import.
1. Import records from TCP. For more information, see “Importing records from
TCP” on page 134.
2. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
3. In the Configure Archiving Subprofile dialog box, click the Indexing tab.
4. Mark the indexing field you want to change, and then click Edit.
5. In the Configure Field dialog box, select the number of rows in the Count field
that are displayed initially in the Indexing view. The default value is 1.
6. For fields with multiple values imported from TCP, there is no upper limit for
the number of rows. If needed, configure the limit with the Maximum check
box.
7. Select Locked if you are using a single-value property, and you want to make
sure that the number of lines cannot be changed in the Indexing view.
8. In the Indexing view, add and remove rows for indexing attributes with
multiple values by clicking the plus icon and the minus icon .
Along with relations, the corresponding mapping properties are imported. This
creates duplicate entries in the list of Indexing fields in the Indexing tab of the
Configure Archiving Subprofile dialog box. The duplicates are shown in red.
Notes
• Relations with compound mapping properties are not supported.
• Relations where a key of the record to be created is inserted as a foreign key
in the related record are not supported. However, they are imported because
the software cannot always identify this scenario without knowing the
semantics of the data model. You must remove these fields manually in the
Configure Archiving subprofile. To do so, mark the indexing field, and then
click Remove.
1. Decide if the Indexing view will show the mapping properties or the relations,
and remove the unused field.
Alternatively, keep both fields so the scan operator can choose either to insert,
for example, the customer number, or select the customer from a list of
customer names.
2. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
• Specify the Fetchlimit, which is the maximum number of lines displayed for
this property type in the Indexing view.
Notes
• Enterprise Scan supports Unicode (UTF-8) strings for indexing values when
archiving through the Document Pipeline for Content Server. As a
prerequisite, Content Server must support UTF-8.
• The relevant system attributes defined by the Content Server instance are
automatically imported as well. If they are not needed, you can delete them.
• Enterprise Scan constructs a indexing form when Copy is used in the
Content Server web interface.
• The default value for an attribute defined in Content Server can contain
quote or double quote characters. The Enterprise Scan indexing module can
process theses default values and initializes the Indexing view accordingly.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab, and
then click Add > Import from Content Server.
3. Sign in to Content Server. For more information, see “Defining the sign in to
Content Server” on page 212.
4. In the Import Attributes dialog box, select the required folder, category, or
workflow, and then click Import.
To import the cascading attributes from Content Server, you must first define
Cascading Attributes in the Content Server Administration.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab, and
then click Add > Import from Content Server.
3. Sign in to Content Server. For more information, see “Defining the sign in to
Content Server” on page 212.
4. In the Import Attributes dialog box, the available Cascading Attributes profiles
are displayed. Select the required profile, and then click Import.
Notes
• The update script of such fields is automatically filled when importing
from Content Server. This update script can later be extended by user
scripts but it must not be deleted. Otherwise functionality is lost, for
example the dependency between fields.
• Fields must not be renamed after import.
Prerequisite The Records Management attributes to be imported must have the Show option
selected for Add Item Page. This needs to be configured in Content Server, see
OpenText Records Management - Administering Records Management (LLESRCM-H-
AGD). Enterprise Scan communicates with Content Server through web services.
Therefore, the Records Management web service needs to be installed and
configured for Content Server. For more information about supported versions, see
Release Notes for Content Server.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
Tips
• The Tree view in the Import Attributes dialog box is not relevant for
importing Records Management attributes.
• You can combine importing Records Management attributes with
importing Content Server attributes. For more information, see
“Importing Content Server attributes” on page 137.
5. Click Import to import all Records Management attributes that have the Add
Item Page property from Content Server.
Enterprise Scan supports importing the following Records Management
attributes:
• Record Date
• Status
• Status Date
• Received Date
• Mark Official
• Storage Medium
• Accession
• Subject
• Author or Originator
• Addressee(s)
Note: Enterprise Scan does not support importing the following Records
Management attributes:
• Record Type
• RSI
• Other Addressee(s)
• Update Cycle Period
• Originating Organization
6. Click OK.
In the Indexing view, the Classification field is displayed as a special field that
allows you to select the Records Management classification for the current
document.
Once the document is released from Enterprise Scan to Content Server through
the Document Pipeline for Content Server, the Records Management attributes
are written to the IXATTR file for further processing by the Document Pipeline
for Content Server module.
Note: You can only select RM:Classification that are defined in Content
Server.
Browse Classification
In the Classifications Tree, browse through the available Records
Management classifications and select the appropriate one.
My Favorites
In the Classifications Tree, select a classification from the Favorites list.
User Pick List
In the Classifications Tree, select a classification from the list of
classifications that are available to the user.
Group Pick List
In the Classifications Tree, select a classification from the list of
classifications that are available to the group.
1. Import attributes from Content Server. For more information, see “Importing
Content Server attributes” on page 137.
2. Configure the field parameters of each attribute. For more information, see
“Configuring custom index fields” on page 133.
3. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
6. In the Configure Field dialog box, enter the number of rows (Count) to be
displayed initially in the Indexing view for the attribute. The minimum value is
1.
Note: The initial number at Count corresponds with the “default” value
defined for the attribute with multiple rows in Content Server.
The default value for a attribute with multiple rows results from the
default value definition inside the corresponding category in Content
Server. Items with an index between “default” and “max” do not have a
default value because this value is not defined in Content Server.
8. In the Indexing view, you can add as many new rows as are defined in the
“max” parameter for the respective attribute in Content Server. Click the plus
icon near the appropriate indexing field. Use the minus icon to reduce
number of rows.
Note: An overflow of the “max” number can occur, when the number of
rows added in the Indexing view exceeds the maximum available count of
rows for a attribute with multiple rows defined in Content Server. The
scan operator should know the “max” number of rows to avoid this
problem.
Indexing attributes with multiple rows is supported for the following attribute
types:
Scripting
Selection, Validation, and Update scripts are triggered for every item in the array.
Initialization scripts are called just once.
The following methods or properties for field objects are available in the
Initialization, Selection, and Validation or Update scripts:
For details about scripting, see “Working with scripts for indexing and archiving“
on page 251.
Because a Set can include nested attributes with multiple rows, Enterprise Scan can
only import the first row of a Set with multiple rows. However, the feature with
multiple rows for each individual attribute in this first row of the set is fully
supported.
Limitations
Indexing of attributes with multiple rows is not supported for the following:
• Export script plug-ins. For more information, see “Scripts in the export
phase” on page 258.
• Document Pipeline for Content Server. For more information, see “Archiving
documents on Content Server using Document Pipeline” on page 171.
• Existing archiving subprofiles. In order to use this functionality for existing
subprofiles you must re-import the indexing fields from Content Server or
edit them manually in the Configure Field dialog box. To do so, clear the
Locked check box, and then set the appropriate values for Count and
Maximum.
• Date: Calendar Attribute
1. Click the User icon to the right of the text field to open the Select User dialog
box.
2. Select a search parameter, such as User Last Name, enter a search term in the
field, and then click Find.
The search is performed in the Content Server User Database.
3. Select the user from the listed results, and then click OK.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab, and
then click Add > Import from Oracle.
Tips
• To expand all nodes, click Expand All.
• To collapse all nodes, click Collapse All.
The bullet icon indicates a simple field that provides the following
information:
• The attribute name, for example billBackStatus, that is used as the label for
the indexing field in the Indexing view.
• The data type, for example String.
• If the field can be used for indexing one time or often: Single or Multiple.
The icon indicates a complex field that contains one or more simple or
complex fields that provides the following information:
• The attribute name, for example BillBack, that is used as the label for a
group of indexing fields in the Indexing tab.
• If the field can be used for indexing one time or often: Single or Multiple.
4. To use a field often for indexing, right-click the respective line, and then click
Input Count.
5. In the Count dialog box, enter the number of times you want the field to be
displayed in the Indexing view, and then click Ok.
6. Repeat Step 4 and Step 5 for all fields you want to use often for indexing.
7. Click Import.
All Oracle attributes (simple fields) are imported in the Indexing tab of the
Configure Archiving Subprofile dialog box, using the following mapping:
Name
Oracle:InvoiceInfo.<complex field name> (may be more than
one):<single field name>
Example: Oracle:InvoiceInfo.BillBack.tenant:tenantName
In case you have defined some fields to be displayed often in the Indexing
view, index numbers are added to the field name.
Example: Oracle:InvoiceInfo.attachment1:description
Oracle:InvoiceInfo.attachment2:description
Display string
<single field name>, used as label of the indexing field in the Indexing view.
Type
Data type, as indicated in the Oracle Attributes dialog box.
8. Remove the Oracle attributes you do not need from the Indexing fields.
9. To group the indexing fields by complex fields in the Indexing view, select the
Group fields by sets check box.
10. In the Indexing tab, select one line, and then click Edit to edit the script the
indexing fields.
The Configure Field dialog box opens. For more information, see “Configuring
custom index fields” on page 133.
Important
• Do not change the Name indexing field. The exact format is required
to display the fields in the Indexing view.
• The value of Count and Maximum must be 1, and the Locked check
box must be selected.
To specify that the field in the Indexing view must be completed before the
document can be archived, select the Mandatory check box.
In scripting, you can use the following field names:
Example:
Fields["Oracle:InvoiceInfo.Vendor:VendorID"] = "ID25555";
Fields["Oracle:InvoiceInfo.Vendor:VendorName"] = "Open Text";
Fields["Oracle:InvoiceInfo.Vendor:taxRate"] = "20%";
For a complex field that allows multiple occurrences in the Indexing view, you
can add the index numbers with the field name during scripting.
If you have chosen an Oracle field, for example Reason, to occur multiple times
in the Indexing view, you can reference the particular index numbers (1/2/3/…)
in scripts, like in the following example:
Example:
Oracle:InvoiceInfo.reason1.reasonCode
Oracle:InvoiceInfo.reason2.reasonCode
For details about scripting, see “Working with scripts for indexing and
archiving“ on page 251.
• The archive mode must be configured. For more information, see section 11
“Configuring scan stations” in OpenText Archive Center - Administration Guide
(AR-ACN).
1. Create templates using DocuLink for the IXATTR file and the COMMANDS file,
using the customer-specific table in SAP. These files control the indexing and
archiving process. For more information, see “Creating templates” on page 149.
2. Adapt the pipeline script scanr3.pl. For more information, see “Adapting
pipeline script” on page 150.
3. Configure indexing information in the Configure Field dialog box. For more
information, see “Configuring indexing information” on page 151.
4. Add a script in the Set Document Pipelines Attributes dialog box. For more
information, see “Adding a Document Pipeline attributes script” on page 152.
Creating In DocuLink customizing, you create templates for the IXATTR file and the COMMANDS
templates file. For more information, see section 10.3.1.1 “General” in OpenText DocuLink for
SAP Solutions - Customizing and Administration Guide (DC-CGD).
ATTRIBUTES ZDEMO1|DATUM|DD|19981111|
ATTRIBUTES ZDEMO1|LIEFERSCHEINNUMMER|NN|123456|
ATTRIBUTES ZDEMO1|BETRAG|CC|124444|
R3_CLIENT TOAV0|MANDT|CC|%s|ZDEMO1|
R3_SAP_OBJ TOAV0|SAP_OBJECT|CC|%s|ZDEMO1|
R3_AR_OBJ TOAV0|AR_OBJECT|CC|%s|ZDEMO1|
ARCHIVIDATTR TOAV0|ARCHIV_ID|CC|%s|ZDEMO1|
DOCIDATTR TOAV0|ARC_DOCID|CC|%s|ZDEMO1|
For details on automatic field entry, see section 9.4.4.3 “Automatic entry of
field values using DocuLink” in OpenText Document Pipelines - Overview and
Import Interfaces (AR-CDP).
Adapting After installing Document Pipeline for DocuLink (SCR3), the pipeline script file
pipeline script scanr3.pl is located in: %ProgramFiles%\OpenText\DocuLink Document Pipeline
<version>\scripts\perl\. The change you must perform tells the script that there
is no need to run additional custom scripts for the SCR3 scenario.
Configuring Configure the indexing information manually in the Configure Field dialog box.
indexing
information
To configure indexing information:
1. In the Indexing tab, select one line, and then click Edit.
The Configure Field dialog box opens. For more information, see “Configuring
custom index fields” on page 133.
The parameters you configure for SAP indexing are transferred into an entry in
the IXATTR file. This entry has the following syntax:
ATTRIBUTES <r3_table_name>|<column_name>|<col_type>|<value>|
<r3_table_name>
Name of the SAP table in which entries are to be made.
<column_name>
Name of the column in the SAP table <r3_table_name>.
<col_type>
Data type of the <value>. The following data types are used for SAP
indexing:
CC
Character strings
NN
Character strings comprising numbers only
D2
Standard date format DD.MM.[YY]YY. This is converted to database
format internally.
<value>
Value to be entered either in plain text or as a placeholder specifying the
value type (%s, %d, and so on).
For more information, see section 9.4.4 “IXATTR for SAP applications/
DocuLink” in OpenText Document Pipelines - Overview and Import Interfaces (AR-
CDP).
Important
Whenever the IXATTR file is modified in the Set Document Pipeline
Attributes script, the automatic creation of IXATTR with indexing
information does not take place. In this case, you have to generate the
entire contents for the IXATTR by script manually.
2. To get the desired syntax in the IXATTR file, define the indexing fields in the
Configure Field dialog box the following way:
Note: See also Example 12-2, “IXATTR file template” on page 149. The
ATTRIBUTES lines in the template can help to define the fields.
Name
The field name must be <r3_table_name>:<column_name>.
Important
The separator must be a colon. Otherwise indexing will fail.
Type
Your entries in the Type field in the Configure Field dialog result in values
for the <col_type> and <value> parameters in the IXATTR file, according to the
following table:
Adding a Configure the Document Pipeline attributes manually in the Set Document Pipeline
Document Attributes dialog box. For more information, see “Defining Document Pipeline
attributes” on page 162.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Set Document Pipeline Attributes to the Flow list, and then click
Configure.
4. Type the following script that will be evaluated for the COMMANDS file:
Note: See also Example 12-3, “COMMANDS file template” on page 150.
The template can help you to define the script.
Most entries in the COMMANDS file are passed directly by Enterprise Scan.
The entries are passed to the COMMANDS file by the Set Document Pipeline
Attributes script, and the link table information is transferred to the IXATTR file.
For a comprehensive description, see section 9.4.4.2 “Entries in SAP link tables”
in OpenText Document Pipelines - Overview and Import Interfaces (AR-CDP).
Examples - The following examples show the IXATTR and COMMANDS files
generated by Enterprise Scan with the indexing fields and the Set Document
Pipeline Attributes script, as described in the previous section:
NEWDOC
R3_CLIENT ZDEMO1|MANDT|CC|%s|
ATTRIBUTES ZDEMO1|KUNDENNUMMER|CC|1234567|
ATTRIBUTES ZDEMO1|RECHNUNGSNUMMER|CC|12345678|
ATTRIBUTES ZDEMO1|DATUM|D2|08.06.2009|
ATTRIBUTES ZDEMO1|LIEFERSCHEINNUMMER|NN|123456|
ATTRIBUTES ZDEMO1|BETRAG|CC|124444|
R3_CLIENT TOAV0|MANDT|CC|%s|ZDEMO1|
R3_SAP_OBJ TOAV0|SAP_OBJECT|CC|%s|ZDEMO1|
R3_AR_OBJ TOAV0|AR_OBJECT|CC|%s|ZDEMO1|
ARCHIVIDATTR TOAV0|ARCHIV_ID|CC|%s|ZDEMO1|
DOCIDATTR TOAV0|ARC_DOCID|CC|%s|ZDEMO1|
Note: For details on automatic field entry, see section 9.4.4.3 “Automatic
entry of field values using DocuLink” in OpenText Document Pipelines -
Overview and Import Interfaces (AR-CDP).
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
Name
ARCHIV_ID:SAP_OBJECT:AR_OBJECT:CLIENT:TABLENAME:FIELDNAME
Example: T5:LFA1:ZT5PDF01:800:ZARCHIVEALPLUS:CREATOR
Display string
<single field name>, used as label of the indexing field in the Indexing view.
Type
Data type, as indicated in the SAP Attributes dialog box.
5. To group the indexing fields by complex fields in the Indexing view, select the
Group fields by sets check box.
6. In the Indexing tab, select one line, and then click Edit to edit the script the
indexing fields.
The Configure Field dialog box opens. For more information, see “Configuring
custom index fields” on page 133.
Important
• Do not change the Name indexing field. The exact format is required
to display the fields in the Indexing view.
• The value of Count and Maximum must be 1, and the Locked check
box must be selected.
Example:
Fields["T5:LFA1:ZT5PDF01:800:ZARCHIVE_ALPLUS:PIECE"] = 1234;
For details about scripting, see “Working with scripts for indexing and
archiving“ on page 251.
Notes
• Only .NET assemblies are supported. For more information, see “Working
with scripts for indexing and archiving“ on page 251.
• If the referenced library is added with an absolute path, ensure that this path
is also valid on other computers that will use that configuration. If the library
is installed in the <Enterprise Scan Home>\bin directory you can add the
referenced library without path.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab.
3. Click References.
.NET You could have a .NET Framework permission problem because the network shares
Framework only get LocalIntranet permissions, by default.
permission
problem
The easiest workaround is to copy the required *.dll to the <InstallDir>/bin
directory of Enterprise Scan. Otherwise use the extended configuration of your
local .Net Framework to elevate permissions for selected file shares. To do so, use
CasPol.exe, for example.
• Use CasPol.exe to fully trust shares that you control and that you know are
safe. However, due to the CasPol syntax, the command to trust shares is not
immediately obvious. To trust everything on the \\FS01\Tools share, use the
CasPol.exe -m -ag 1.2 -url file://\\FS01/Tools/* FullTrust command.
Parameter explanation
-m
Modifies the computer level of the policy. This is needed because the
machine level is where all of the default policy lives.
-ag 1.2
Adds a code group under group 1.2. In the default policy, group 1.2 is the
LocalIntranet group, so the new code group that you are creating will
only be checked if the file comes from the intranet.
-url file://\\FS01/Tools/*
Sets the membership condition for the new code group as an
UrlMembership condition. It should match anything with a URL that starts
with file://FS01/Tools, meaning that any file on the \\FS01\Tools
share will match this code group.
FullTrust
Sets the permission to be granted to assemblies that match the code group.
Note: The rectangular area is automatically displayed in the Index Item view
when the input focus is in the corresponding index field in the Indexing view.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Indexing tab.
4. In the Configure Area Set dialog box, navigate to the document page represents
the documents that should be processed with this profile.
5. Click Add.
A rectangle is added to the page and a new row is added to the List of
rectangles.
6. Move the rectangle to the correct position and define the size.
7. Select the index field for which this area is valid in the list located in the
Indexing field column.
8. Click OK.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
• Use Load, Save, and Compile to open, store, and test the scripts.
• Use References to add a reference to third party libraries. For more
information, see “Assigning third party libraries” on page 155.
• You can share, export, and import global functions. For more information,
see “Sharing, exporting, and importing the configuration“ on page 199. If
you import global functions to a computer that already has global functions,
the imported functions will be appended to the existing functions.
1. Assume you have five documents with the following attributes on the stack:
Alternatively, click Archive All, and then click OK in the Archive Documents
dialog box.
The following Archiving details dialog box is displayed.
To configure archiving:
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. In the Operations area, click the appropriate operations, and then click Add.
4. Correct the order of the operation in the Flow field with Up and Down.
Notes
• The document processing operations must be performed before the
document export operations.
• There must be exactly one document export operation and it must be
the last operation in the flow.
5. Select the appropriate operation in the Flow area, and then click Configure to
define the properties of the operation:
Document processing
Document Export
Capture Center
Exports documents to the Capture Center for OCR. Renders, validates, and
archives documents through an interface. For more information, see
“Exporting to Capture Center” on page 163.
For details about scripting, see “Working with scripts for indexing and archiving“
on page 251.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
• Use Load, Save, and Compile to open, store, and test the script.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Delete Marked Pages to the Flow list, and then click Configure.
For details about scripting, see “Working with scripts for indexing and archiving“
on page 251.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Set Document Pipeline Attributes to the Flow list, and then click
Configure.
• Use Load, Save, and Compile to open, store, and test the script.
• Use References to add a reference to third party libraries. For more
information, see “Assigning third party libraries” on page 155.
• Use Open Global Function Depot to open the Global Function Depot,
where you can collect all your Enterprise Scan scripts. For more information,
see “Global function depot” on page 260.
Enterprise Scan uses an OCC Profile (OpenText Capture Center Profile) configured
on the Capture Center Server. If the profile does not exist, the export from Enterprise
Scan fails and displays a time out message. To avoid this, you must first configure
Capture Center and prepare it for importing documents. Afterwards, you can
proceed with the configuration in Enterprise Scan.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Capture Center to the Flow list, and then click Configure.
Server name
Server name of Capture Center.
Protocol
• net.tcp
• net.tcp secure
• http
• https
Port number
Port number of Capture Center.
Profile
Select the Capture Center profile from the list of configured profiles on
Capture Center Server.
You can edit the profile name if the configured profiles cannot be retrieved
from the selected Capture Center Server.
It is possible to assign the name of the profile dynamically: Use a pattern
like <BATCH>, <FOLDER>, or <fieldname>. On Capture Center Server, the
pattern will be replaced with the real value.
Note: Selecting Export loose pages you cannot use document index
fields. Only global fields are allowed. The global fields are exported as
batch fields. If a configuration includes document fields, an error is
reported and archiving is aborted.
Global fields are exported as new batch fields and, for document export without
option Export loose pages, in document as strings.
Note: For the export to batch fields, the Enterprise Scan data types are
converted to Capture Center data types. Information about unsupported fields
is added to log file. For loose pages export, an error message is still shown and
export is aborted.
Note: Capture Center field names must be XML compliant element names.
However, Enterprise Scan does not implement this restriction so that you can
configure indexing field names that are not valid in Capture Center and thus
the export to Capture Center will fail. Ensure that indexing field names match
the following regular expression:
<Indexing field name> = [_a-zA-Z][-_.0-9a-zA-Z]{0,99}
In regular configurations, the path to the shared folder has the following syntax:
\\<server name>\OpenTextCaptureCenterData\<profile name>
This folder is created and configured by Capture Center. If the folder does not exist,
the export from Enterprise Scan fails and displays an error message. To avoid this,
configure Capture Center first and prepare it for importing document. Afterwards,
proceed with the configuration in Enterprise Scan.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Capture Center (via shared folder) to the Flow list, and then click
Configure.
Server name
Server name of Capture Center.
Port number
Port number of Capture Center.
Custom directory
If the path does not match the syntax above, select the Custom directory
check box and enter the directory in the Directory field.
Note: Capture Center field names must be XML compliant element names.
However, Enterprise Scan does not implement this restriction so that you can
configure indexing field names that are not valid in Capture Center and thus
the export to Capture Center will fail. Ensure that indexing field names match
the following regular expression:
<Indexing field name> = [_a-zA-Z][-_.0-9a-zA-Z]{0,99}
Note: The Scan & Index function is only available for the Folder object type.
The function is not supported for other object types, for example Document,
Discussion, Project, Channel, and so on.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
a. For Root, define the target folder on Content Server where the documents
will be archived.
i. Select the Always prompt to select root folder before archiving check
box to open the Select Folder dialog box after pressing Archive where
you can select or accept the target folder on Content Server.
Tips
• After pressing Archive the Content Server Sign In dialog box
opens if you are not yet signed in to Content Server.
• For the first archiving the configured target folder is opened
in the Select Folder dialog box. Subsequent archiving opens
the Select Folder dialog box with the last selected target
folder but the configuration of the target folder remains
unchanged in Root.
• If you are using the Content Server workflow with the
Workflow only option the Select root folder before archiving
option is unavailable because the document is attached to the
workflow only and not archived.
ii. Click Browse, and then sign in to Content Server.
iii. In the Select Folder dialog box, select the target Content Server folder,
and then click OK.
Important
• All folders with at least READ permission are listed. Make
sure that the selected folder has sufficient rights for
archiving. Otherwise archiving will not be possible.
If you sign in as a user without administrator privileges,
•
Notes
• The archiving procedure will be aborted if the indexing field
values included in <> are not replaced with real values in the
indexing form.
• Some characters are not valid in a document name. Therefore,
ensure your selection in this dialog box does not generate
d. Select the Create new version if already exists check box to create a new
version of an existing document.
If the document does not exist, a new document will be created. If this
option is not selected and a document with the same name already exists,
the archiving will be aborted.
e. Select the Use strict mode for archival check box to stop archiving of
documents if the required attributes of the target folder in Content Server
are not provided.
Tip: If this setting is selected and Enterprise Scan stops the archiving
procedure you can import the attributes before archiving. For more
information, see “Importing Content Server attributes” on page 137.
Notes
• Use strict mode for archival only works for direct archiving to
Content Server.
• Only category attributes are supported.
• System node attributes, and workflow attributes are not supported.
5. In the Content Server Workflow tab, do the following to configure the Content
Server workflow:
6. Click OK.
You can also use the Searchable PDF Doctool to store scanned documents as
searchable PDF files in Content Server using Document Pipeline. For more
information, see “Searchable PDF Doctool“ on page 287.
Notes
• The Scan & Index function is only available for the Folder object type. The
function is not supported for other object types, for example Document,
Discussion, Project, Channel, and so on.
• Software and licenses for Rendition Server must be purchased separately.
Contact your OpenText sales representative for more information.
• For supported versions of Document Pipelines, Content Server and
Rendition Server, see Release Notes.
• When changing the Document Pipeline for Content Server configuration you
must restart the Spawner service to enable the new sign in session.
You can perform an additional check for the category version before the document
will be archived. To do so, set the variable VERIFYLLCATEGORYVERSION = 1 in the
%PROGRAMDATA%\OpenText\BASE Document Pipeline\config\setup
\DT_DOCTOLES.Setup file, and then restart the Spawner service. With the default
value VERIFYLLCATEGORYVERSION = 0 the document will be archived and then
reverted if the category version does not match. In case the Content Server user does
not have the delete permission, the document will not be reverted.
Prerequisite Document Pipeline for Content Server must be installed. For more information, see
section 6.4.4 “Installing Document Pipeline for Content Server” in OpenText Imaging
Enterprise Scan - Installation Guide (CLES-IGD).
To archive searchable PDF files using Document Pipeline for Content Server:
Rendering profile
Defines the rendering profile that you have configured on Rendition Server.
For more information, see OpenText Rendition Server - Installation and
Administration Guide (RS-IGD).
Configure
Specifies the settings for Content Server export. For more information, see
“Archiving documents on Content Server” on page 166.
In this scenario, documents are written directly to the desired logical archive on
Archive Center by means of the Document Pipeline. The connection from Enterprise
Scan to the Document Pipeline is either established by RPC, using a file system, or
by HTTP/HTTPS, without a local pipeline. For more information, see “Configuring
remote Document Pipelines” on page 174.
Information about the document, such as - the document id and the archive id is
sent to the leading application and assigned to the specific business data of the
leading application.
For more information, see section 9.4.1 “SAP Document Archiving Document
Pipelines” in OpenText Document Pipelines - Overview and Import Interfaces (AR-CDP).
If you are working with Unicode character set in notes, select Use UTF-8 encoding
for note in “Configuring general workstation options” on page 188 to transfer the
notes in Unicode (UTF-8) encoding format.
Important
For all archiving scenarios using Document Pipeline, an archive mode must
be configured in OpenText Administration Client and selected in the
archiving subprofile on the Enterprise Scan workstation.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
Archive server
Displays the name of the Archive Center to which you are connected.
Archive mode
Select the appropriate archive mode from the list of available archive
modes. These archive modes are configured on the selected Archive Center.
If the required archive mode is not available in the list, ask your Archive
Center administrator to create and assign it to the scan station in OpenText
Administration Client.
Click Details to view the configuration properties of the selected archive
mode. For more information, see “Viewing archive details for Document
Pipeline” on page 176. Enterprise Scan always uses the Document Pipeline
specified in the archive mode.
DMS Doctype
This setting is only needed for the Document Pipeline for TCP.
Note Format
Placeholders for a note. During archiving, the placeholders are replaced
with actual values and the note is stored with the document. The note can
contain a note that was sent by the leading application. For a list of
supported placeholders, see “Working with placeholders for notes“
on page 269.
Default Note
You can create a note if a note has not been specified by the leading
application.
Advanced
Adjust the output file format as described in “Defining advanced settings
for archiving” on page 179.
Note: Enterprise Scan always uses the Document Pipeline specified in the
archive mode. If there is no remote pipeline specified in the archive mode or no
archive mode is found, the local pipeline is used.
3. Set the protocol (HTTP or HTTPS), the pipeline host and the port. For more
information, see “Archive Modes properties” in OpenText Archive Center -
Administration Guide (AR-ACN).
4. Click OK.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
Archive Settings
Displays the settings for the selected archive mode. These settings are
defined in the OpenText Administration Client in the Archive Modes tab.
For more information, see “Archive Modes properties” in OpenText Archive
Center - Administration Guide (AR-ACN).
Remote Pipeline
Displays the settings for the remote pipeline, if a remote pipeline is
configured. These settings are defined in the OpenText Administration
Client in the Archive Modes tab. For more information, see “Configuring
remote Document Pipelines” on page 174 and “Archive Modes properties”
in OpenText Archive Center - Administration Guide (AR-ACN).
In this scenario, documents are written by means of the Document Pipeline into the
TCP Business Object Layer.
The connection from Enterprise Scan to the Document Pipeline is either established
by RPC, using a file system, or by HTTP/HTTPS, without a local pipeline. For more
information, see “Configuring remote Document Pipelines” on page 174.
For more information, see section 9.5.1 “TCP Document Pipelines” in OpenText
Document Pipelines - Overview and Import Interfaces (AR-CDP).
Important
• For all archiving scenarios using Document Pipeline, an archive mode
must be configured in OpenText Administration Client and selected in
the archiving subprofile on the Enterprise Scan workstation.
• The TCP Business Object Layer server is configured in the TCP Document
Pipeline configuration, and may be different from the underlying Archive
Center.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add Document Pipeline for TCP to the Flow, and then click Configure.
Archive server
Displays the name of the Archive Center where the configuration is stored.
Archive mode
Select the desired archive mode. The archive modes are configured on the
connected Archive Center. If the required archive mode is not available on
the list, ask your Archive Center administrator to create and assign it to the
scan station in OpenText Administration Client.
Click Details to view the configuration properties of the selected archive
mode. For more information, see “Viewing archive details for Document
Pipeline” on page 176. Enterprise Scan always uses the Document Pipeline
specified in the archive mode.
DMS Doctype
Select the document type. The document type was configured by the TCP
Modeler and stored on the TCP Business Object Layer (formerly known as
TCP Context Server). This is one of the record types imported in indexing.
The entered value is written into the COMMANDS file under the DMS_DOCTYPE
key.
Note Format
Placeholders for a note. During archiving, the placeholders are replaced
with actual values and the note is stored with the document. The note can
contain a note that was sent by the leading application. For a list of
Default Note
You can enter a note here if a note is not specified by the leading
application.
Advanced
Adjust the output file format as described in “Defining advanced settings
for archiving” on page 179.
Note: An external storage allows the scan operator to buffer the output of a
high volume scanning station so that the indexing load can be distributed
across many scan stations. The indexing values cannot be considered while
working with an external storage.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Add External Storage to the Flow list, and then click Configure.
Directory
Directory for the external storage where the scanned documents will be
archived.
Name
Name of the external storage.
Archive ID
Name of the archive on Archive Center where the documents are to be
archived later.
Conditions
Specify conditions that must be met in order to store the documents in an
external storage.
1. Go to the profile you want to configure. For more information, see “To
configure indexing and archiving:“ on page 127.
2. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
3. Select the operation, add it to the Flow list, and then click Configure.
4. Click Advanced.
Notes
• If you are scanning PDF files and you want to store them in the archive
as PDFs without any modifications, you must select the Transparent
passthrough for PDF check box in the File Import or File Input dialog
box. In this case the Advanced Settings are ignored.
• The Searchable PDF doctool is not supported using OpenText TCP
Document Pipelines.
• Depending on the number of pages, resolution, color depth, and page
size, archiving of a document may take some minutes to complete.
• If you want to use the PDF/A (image), PDF (text), and PDF/A (text)
output formats, the following prerequisites must be fulfilled, depending
on the Document Pipeline you want to use. This is necessary for the
Searchable PDF doctool to work.
Prerequisites
Overview The CLM solution enables you to store electronic and scanned documents on
Content Server. CLM consists of a number of components. The relationship between
these components is implemented by means of barcode technology.
How does it CLM contains the barcode module that creates, on user request, a placeholder for a
work? document inside the directory folder of Content Server. The user request is triggered
by selecting the Print Barcode menu item inside the menu of a container object.
The placeholder for the document and the path to that location is then associated
with a barcode value. The barcode module generates a cover letter that includes
information about the document and barcode. The cover letter is printed and
associated with the document. Later the cover letter is scanned with the document
body using Enterprise Scan and processed accordingly. The barcode is recognized
and used for document creation (Separate by barcode) as well as for connecting
with the barcode module and converting of the barcode value to the placeholder in
Content Server.
3. In the Configure Archiving Subprofile dialog box, click the Archiving tab.
4. Add Document Pipeline for Content Server to the Flow list, and then click
Configure.
5. In the Configure Document Pipeline for Content Server dialog box, click
Configure.
• Select the Use rendering server check box if you want to render the
archived documents to PDF format. For more information, see “Archiving
documents on Content Server using Document Pipeline” on page 171.
6. In the Configure Export to Content Server dialog box, select Link by barcode.
With this scenario the document is archived into the Content Server placeholder
where the barcode is generated and associated with the document. Additionally
to archiving, you can configure a workflow but the Workflow only option on
the Content Server Workflow tab is disabled as documents should be archived
to a specific placeholder only. For more information, see “Archiving documents
on Content Server” on page 166.
a. Select the Create new version if already exists check box to create a new
version of an existing document.
If the document does not exist, a new document will be created. If this
option is not selected and a document with the same name already exists,
the archiving will be aborted.
b. Select the Use strict mode for archival check box to stop archiving of
documents if the required attributes of the target folder in Content Server
are not provided.
Tip: If this setting is selected and Enterprise Scan stops the archiving
procedure you can import the attributes before archiving. For more
information, see “Importing Content Server attributes” on page 137.
Notes
• Use strict mode for archival only works for direct archiving to
Content Server.
• Only category attributes are supported.
• System node attributes, and workflow attributes are not supported.
Tip: Click Test to verify the availability of the barcode module on Content
Server.
7. Click OK.
LLCATEGORY4FOLDERS=0
Modified attribute values are not assigned to the newly created dynamic
folders.
LLCATEGORY4FOLDERS=1
Modified attribute values are assigned to the newly created dynamic
folders.
You can set parameters that are valid for the current user, as well as the profiles and
subprofiles assigned to this user.
Caution
Be very careful when changing registry entries, because errors in the
registry can disrupt the functionality of your computer.
Tip: If you require additional help with technical problems, contact OpenText
Customer Support. You can find the contact information for your region at
http://www.opentext.com/support.
• In the registry at
HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM
\CustomSettings, enter the path to the storage, for example
"S:StoragePath"="%HOMEDRIVE%\\OpenText\\%user%\\storage", and the
path to the thumbnails cache, for example
"S:PageThumbnailsPath"="%HOMEDRIVE%\\OpenText\\%user%\
\thumbnails".
Caution
• If these registry keys do not exist or the paths to the storage and
thumbnails cache are not accessible, the default paths in the
LocalApplicationData folder are used, typically this is the
LocalApplicationData folder below %USERPROFILE%.
• OpenText recommends not to use a storage path on the network share.
Instead keep the storage path on the local file system.
• Use a user specific path, that is a different path for all users.
Tip: Use this setting if you are working with drag & drop in the Tree
view because all possible target nodes are present then including
empty nodes and folders, that is unused groups, folders, or batches.
2. In the Configure Workstation Options dialog box, click the Document Index
tab.
3. In the Index can be modified if area, specify the cases in which the index in the
document header can be manually edited, if Barcode recognition is used for
document separation. For more information, see “Changing the index”
on page 39.
• Select the <none> or manually entered check box if no barcode has been
found, or when Barcode recognition is not defined, or when the index has
been entered manually.
• Select the Automatically recognized check box if the barcode has been
recognized and automatically filled in.
• Select the Not recognized check box if a barcode has been found but its type
is not known, or the barcode does not meet the set barcode conditions.
4. In the Validate manual index area, select one of the following options:
2. In the Configure Workstation Options dialog box, click the Global Script
Functions tab.
3. Click Edit to open the Global Function Depot. For more information, see
“Global function depot” on page 260.
2. In the Configure Workstation Options dialog box, click the Static Groups,
Static Batches or Static Folders tab.
3. Click Insert, and then enter a name to insert static document groups, batches,
and folders.
Then the scan operator can select these defined values in the Group, Batch, and
Folder field of the Properties view.
2. In the Configure Workstation Options dialog box, click the Scanning tab.
Page
The Page view works synchronously. During scanning, you cannot perform
any actions in Enterprise Scan. The number of scanned pages and the Page
view of the scanned pages is displayed. You can cancel the scan operation
by clicking Stop.
• Navigate in the stack in the Thumbnails view, in the View view, in the
Tree view, or in the Documents list.
• Add indexing data to documents.
• All actions that are available by right-clicking a page or document.
Note: All actions that modify the document stack are disabled.
Update Interval
Select how often the thumbnail view of the scanned pages is updated.
Selecting a longer interval accelerates the response to the actions that
you are simultaneously performing on the stack.
When Update Interval is set to 0 and the Select last document after
scanning check box is selected, the last scanned page is selected and the
Page view shows the last scanned page. The Page view is updated with
every incoming scanned page during background scanning. If the
Update Interval is greater than zero, then the last scanned document is
selected.
When the Select last document after scanning check box is cleared, the
document selection prior to scanning is retained. If there is no
document selection prior to scanning, then the first document is
selected, regardless of the value of the Update Interval.
Selected configuration
Downloads the entered configuration.
You can define groups of rectangular areas on the scanned page. You can specify if
these areas should be ignored, or if they should be the only part of the page where
the relevant operation is performed. This includes tasks such as, searching for
barcodes, patch codes, or blank pages. These area specifications are valid for all
processing subprofiles and the subprofile's elements reference the areas that you
have defined.
2. In the Manage Area Sets dialog box, click Create, and then enter a name for the
area.
Tip: Click Copy to take over the values of an existing area set.
3. Click Configure, and then define the settings in the Configure Area Set dialog
box. For more information, see “Configuring area sets” on page 194.
4. In the Page source for configuration dialog area, define the settings, and then
click OK.
Scanned documents
Specifies if the selected page or the first page of the selected document will
be used as the source. If the document stack is empty, this option is
disabled.
3. Click Add, define the size and position of the new rectangle, and then click OK.
The rectangle is shown in dotted-line frames and has handles for the frame. To
define its size and position use the mouse and select the displayed handles in
the frames or enter values directly into the list. Change size and position as
desired. In the page preview, you can see immediately whether the rectangle
has been positioned correctly.
Tips
• You can also add a new rectangle by drawing it directly on the
displayed page.
• The selected rectangle appears in the list with a different color.
• The unit of measure is set in the Tools > User Options menu.
• You can define the areas as Required or Ignored.
The scan user signs in to the scan host as a user of the Windows operating system. If
the user is a member of the operating system’s Administrator group, then the user
has administrator permissions and is an Administrator in the context of Enterprise
Scan. The permission levels described in the Permissions section apply to all users
logging into the scan host who are not members of the Administrator group.
The Administrator controls access to certain menu items and functions to ensure a
secure working environment for Enterprise Scan. The application is configured to
prevent a scan operator from accessing settings that must not be changed.
To change permissions:
Configure Profile
The user can switch between existing subprofiles.
You can share, export, and import these settings. For more information, see
“Sharing, exporting, and importing the configuration“ on page 199.
For more information, see also the OpenText Knowledge Center entry https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/15806606.
You can make the configuration available to other users who work with Enterprise
Scan either on this computer or elsewhere in the network. To do so, you must share,
or export and import the configuration. You also can upload and download the
configuration to and from Archive Center or Capture Center Server. The
configuration includes the following settings:
2. In the Server and Document Pipeline Settings dialog box, click the Server
Settings tab.
• Archive Center
If you select a server mode, you must also set the server settings accordingly.
S:SCANCONFIGMODE
This key replaces the behavior of the CONFIGMODE key which was used in earlier
versions of Enterprise Scan.
During installation of Enterprise Scan, the installer will check for the CONFIGMODE
key. If the key is present, the installer copies the value and creates a new key
S:SCANCONFIGMODE. Afterwards, the old key CONFIGMODE is deleted. If the
CONFIGMODE key is not present, no action is taken.
S:ScanConfigServer
Notes
• If the registry entry is missing Archive Center is used.
• If Configuration Management is set to registry mode this key is ignored.
Server vs. The following table shows the differences between the two modes:
registry mode
Warning
2. In the Export Configuration dialog box, select the profiles you want to export or
select the All subprofiles check box.
3. In the Save As dialog box, select the destination for the XML file, and then click
OK.
The configuration from the HKEY_CURRENT_USER\Software\IXOS
\IXOS_ARCHIVE\6.0\Scan\HKLM\ registry key is written into this XML file.
2. In the Open dialog box, navigate to the previously exported XML file, and then
click Open.
3. In the Import Configuration dialog box, select the profiles you want to import,
and then click OK.
In the Import mode field, select Replace to overwrite existing profiles, or select
Add to add the profiles to the configuration.
The configuration stored in the XML file is copied to the HKEY_CURRENT_USER
\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM\ registry key.
Note: The imported configuration is only valid for the user who imported
it. If you want to make the imported configuration available for all users
working on the computer, use Make Configuration Shared after the
import. For more information, see “Sharing the configuration”
on page 202.
To upload the configuration, you must configure the settings inside Enterprise Scan
and then upload the configuration to an Archive Center user group.
Notes
• If you are using Enterprise Scan 9.7 you do not need to migrate
configurations because Enterprise Scan 10.0 and higher supports Enterprise
Scan 9.7 configurations.
• If you are using Enterprise Scan 10.0 and higher you cannot load
configurations onto systems using Enterprise Scan 9.7. The Configuration
Management tool uploads configurations to a new container in Archive
Center.
• If you are using Enterprise Scan 10.0 not all configurations work on systems
using Enterprise Scan 10.5. The Configuration Management tool uploads
configurations to a new container in Archive Center.
• To use the Configuration Management tool, you must set the Configuration
Management to server mode in the Server and Document Pipeline Settings
dialog box. For more information, see “Sharing, exporting, and importing
the configuration“ on page 199. This sets the S:SCANCONFIGMODE registry key
to server mode.
• Click Start > All Programs > OpenText > Enterprise Scan Configuration
Management.
Notes
• Enterprise Scan Configuration Management implicitly starts the
Configuration Management tool that corresponds to your server mode
selection.
• You must have administrator privileges to start the Configuration
Management tool. Without administrator privileges you get an error
message that states that you do not have enough permissions to use this
tool.
You can start the Configuration Management tool that corresponds to the currently
selected configuration server using ConfigurationDownload.exe. This forces
profiles to be downloaded from the configured configuration management server
without taking any time stamp into account.
To upload the configuration, you must configure the settings inside Enterprise Scan
and then upload the configuration to a Capture Center Server.
• Click Start > All Programs > OpenText > Enterprise Scan Configuration
Management.
Notes
• Enterprise Scan Configuration Management implicitly starts the
Configuration Management tool that corresponds to your server mode
selection.
• You must have administrator privileges to start the Configuration
Management tool. Without administrator privileges you get an error
message that states that you do not have enough permissions to use this
tool.
You can start the Configuration Management tool that corresponds to the currently
selected configuration server using ConfigurationDownload.exe. This forces
profiles to be downloaded from the configured configuration management server
without taking any time stamp into account.
1. Start Enterprise Scan and configure the application according to your needs.
2. Open Configuration Management. For more information, see “To start the
Configuration Management tool:“ on page 203.
The Active configuration line displays the currently active configuration.
4. In the User Authentication dialog box, enter a name for the configuration in the
User Group field, the User Name and the corresponding Password of the super
user in Administration Server, and then click OK.
The configuration is uploaded to Archive Center and appears in the User
Groups for current version on <ADMS name> list.
1. Start Enterprise Scan and configure the application according to your needs.
This current configuration will be uploaded to Capture Center Server during
the next steps.
2. Open Configuration Management. For more information, see “To start the
Configuration Management tool:“ on page 203.
The Active configuration line still displays the last downloaded configuration.
3. Enter a new configuration name or select the configuration you want to upload
to the Capture Center Server, click Upload, and then confirm the messages.
1. Open Configuration Management. For more information, see “To start the
Configuration Management tool:“ on page 203.
2. Select the configuration you want to download from the User Groups for
current version on <ADMS name> list.
1. Open Configuration Management. For more information, see “To start the
Configuration Management tool:“ on page 203.
Notes
• ConfigurationDownload.exe implicitly starts the download tool that
corresponds to your server mode selection.
• After installing Enterprise Scan, this tool starts automatically whenever the
user signs in to the system.
• Admin users can also use Download in the Configuration Management tool
to switch between configurations.
• The configuration will be downloaded only if the timestamp differs.
2. Select the configuration you want to make the active configuration, and then
click OK.
3. Optional If you want Enterprise Scan to load the selected configuration every time
you sign in, select the Store this configuration as your default logon
configuration check box.
To enable your Archiving profile, you have to define some settings for the leading
applications.
2. In the Server and Document Pipeline settings dialog box, click the Server
Settings tab.
3. In the Archive Center area, define the Server name of Archive Center on which
the archive modes are defined, Protocol, and the Port number.
Notes
• The default port number is 8080.
• When you change the Server name or the Port number, you must
restart Enterprise Scan to update the archive modes.
• When Configuration Management is set to Archive Center this server is
also used for Configuration Management.
In case you are changing the Archive Center settings, click Use the above
settings for local Document Pipeline configuration. For more information, see
“Changing the Archive Center settings” on page 211.
5. Select the Off-line mode check box if you want to enable off-line mode. When it
is enabled, neither connection to the server nor archiving using the Document
Pipeline is possible.
7. In the Server and Document Pipeline settings dialog box, click the Document
Pipeline Configuration tab.
8. Select the Use local Document Pipeline or Use remote Document Pipeline
check box, enter the respective parameters, and then click OK. The default
values are shown in the particular fields. For more information, see
“Configuring remote Document Pipelines” on page 174.
Notes
• The remote pipeline interface is supported by the Document Pipeline for
Content Server version 9.7 and higher. To use the remote interface for
the Document Pipeline for Content Server, install Document Pipeline
Remote Interface and Core Services on the host where you want to run
the Document Pipeline for Content Server. Those additional
components are bundled inside the master setup for Document Pipeline
for Content Server. For more information, see OpenText Imaging
Enterprise Scan - Installation Guide (CLES-IGD).
• The parameters for the Document Pipeline target are globally
applicable. They are used when releasing documents to Document
Pipeline for Content Server or OpenText Document Pipeline for SAP®
Solutions.
3. In the Archive Center used for local Document Pipeline dialog box, verify the
changes, and then click OK.
The Spawner service is stopped and restarted to activate the changes.
Tips
• By clearing the check boxes you can exlude individual parameters from
being written to the Document Pipeline configuration.
• Use the tooltip functionality of the information icon to view the current
parameter used by the local Document Pipeline. It is shown only in
case the current parameter differs from the new one.
• In certain scenarios you may want to use a Notification Server that is
running on a different host than Archive Center. To retain the currently
configured Notification Server make sure to clear those two
parameters.
2. In the OpenText Content Server Sign In dialog box, enter the sign in
information on the Sign In tab.
Tips
• The name of Content Server is defined initially during installation.
• For a RPC connection, enter port 2099 (see Direct sign in on the
Options tab).
• For a HTTP connection, enter port 80 (see URL sign in on the Options
tab).
• For a HTTPS connection, enter port 443 (see URL sign in on the
Options tab).
3. Click the Options tab, and then select the connection to Content Server:
Direct sign in
If the connection to Content Server is established using RPC, select the
Direct sign in check box.
URL sign in
If the connection to Content Server is established using HTTP or HTTPS,
select the URL sign in check box.
URL
Enter the Content Server sign in URL into the URL field, for example
https:\\bngimg-w2k301\livelink\livelink.exe.
Use SSL
If you want to use a HTTPS connection between Enterprise Scan and
Content Server, select the Use SSL check box.
4. Click the RM tab if you use the import Records Management attributes feature. For
more information, see “Importing Records Management attributes”
on page 138.
Note: If you are using the anonymous submission script in Set Document
Pipeline Attributes, do not archive into the Personal Workspace in Content
Server because, as Admin user, you do not have the permission to write to your
Personal Workspace in Content Server.
Technical Technically, we use the “administrative account” to create objects like folders,
background documents or workflow instances in Content Server. That administrative account
does not need to be the admin, it might be any other account that is granted
sysadmin rights on Content Server. This account is used to create the object followed
by another call that actually impersonates the user that is actually triggering the
release operation from Enterprise Scan. This design pattern allows Document
Pipeline to maintain the connection to Content Server avoiding the handshake
negotiation and session initialization every time a document is released. The
impersonate call then makes sure that the document gets the right owner in Content
Server without terminating existing session and building new connection for
different user. Document Pipeline can process a queue of document originating from
different scanning station and released by differential users.
• Add the following line to the Document Pipeline for Content Server
configuration file DT_DOCTOLES.Setup:
IGNOREDTCREDENTIALS=true
Notes
• When you perform changes to the DT_DOCTOLES.Setup file, stop and
then restart the Spawner service to activate the changes.
• You must type IGNOREDTCREDENTIALS in upper case.
• Add a script like the following example to Set Document Pipeline Attributes:
Document.COMMANDS += "\n";
Document.COMMANDS += "IGNOREDTCREDENTIALS true\n";
If you have existing developer licenses these named persons already have the
required license to develop solutions based on the SAP .NET Connector. If
additional persons want to develop based on the SAP .NET Connector, you
will have to acquire additional developers licenses for them.
1. Download the SAP .NET Connector from the SAP Service Marketplace under
https://websmp101.sap-ag.de/CONNECTORS with your SAP Service
Marketplace user name and password.
2. Run the SAP .NET Connector installation directly from the msi file.
3. In the Welcome dialog box, click Next.
4. In the Select Installation Folder dialog box, do the following:
c. To install SAP .NET Connector for yourself, or for anyone, click Exeryone
or Just me.
d. Click Next.
5. In the Optional setup steps dialog box, select Install assemblies to GAC, and
then click Next.
2. In the Configure Archiving from Leading Application dialog box, define the
settings, and then OK.
• Enter the Archive Center name connected to Enterprise Scan. For more
information, see “Configuring Server and Document Pipeline settings”
on page 209.
• In the Start Archiving from area, specify which document is archived first
when archiving is started from the leading application.
If you select First selected document, which is the default value, make sure
the correct document is selected in the document stack before you start
archiving.
• In the Options area, select Remove deleted pages to remove pages that are
marked as deleted.
• In the Note format field, enter placeholders for the notes. For more
information, see “Working with placeholders for notes“ on page 269.
• In the Default note field, enter a default note for each document. The notes
are attached to the archived document. For more information, see “Working
with placeholders for notes“ on page 269.
• Click Advanced.
In the Advanced Settings dialog box, adjust the output file format as
described in “Defining advanced settings for archiving” on page 179.
Note: The Archive Monitoring Web Client requires that the Monitor Server be
running on the computer running the Document Pipelines.
If anything should interrupt the archiving process after the document information is
sent to the leading application but before the document is transferred to the archive,
the document will be known to the leading application, but it will not be retrievable
or viewable. The document is still in the Document Pipeline. Use Document Pipeline
Info to restart processing. For more information, see OpenText Document Pipelines -
Overview and Import Interfaces (AR-CDP).
The document stack and External Storage repositories used by Enterprise Scan as well
as the Document Pipeline directories may require a backup of their data in certain
cases.
If a large number of documents that have not yet been archived remain in the
document stacks, OpenText recommends that you back up these document stacks
between working sessions to avoid rescanning and reprocessing the documents in
case of a problem.
Document stacks are user-dependent and are stored in the file system in the
following directories:
For example:
%SystemDrive%\Documents and Settings\<user name>\Local Settings
\Application Data\OpenText\EnterpriseScan\StorageV1
The external storage repositories are configured in the Enterprise Scan Archiving
subprofiles. The directory path name is the value of the Directory field. For more
information, see “Archiving to external storage” on page 178.
Troubleshooting
• Back up the Enterprise Scan data regularly. For more information, see “Backing
up external storage repositories” on page 220.
• Monitor Enterprise Scan workstations and Document Pipeline hosts regularly
with Archive Monitoring Web Client and Microsoft Event Viewer. You can use
these tools remotely or locally. For more information, see “Monitoring archiving
through Document Pipeline“ on page 217, and “Troubleshooting Document
Pipelines for Enterprise Scan“ on page 229.
• Verify that all documents passing through the Enterprise Scan Document
Pipelines have been correctly processed and archived. Use Document Pipeline
Info to check the status of the different DocTools and archiving queues. For more
information, see “Monitoring archiving through Document Pipeline“
on page 217.
• Make sure that there is enough free space available for Enterprise Scan data
(document stacks, Document Pipeline directory, external storage repositories)
and for log files.
• Install the relevant patches.
• Follow the upgrade strategy for OpenText Imaging and other system
components. For more information, see Support Lifecycle (https://
knowledge.opentext.com/knowledge/llisapi.dll/Open/LifeCycle).
• Train administrators, operators and end-users.
• Follow the recommendations published in Release Notes and newsletters.
Release Notes are regularly updated in Knowledge Center.
• Perform regular maintenance on your hardware.
For advanced troubleshooting, use the Knowledge Center. You can either browse
Knowledge Center folders from the home page (https://knowledge.opentext.com/)
or use the search capabilities of the Knowledge Center.
For example: Which ports are used by the archive components? (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/15529922)
Parts of the logging information are also displayed in the Imaging Clients Message
Box. For more information, see log messages on page 226.
Log messages are displayed chronologically, with the most recent at the top. The
maximum number of messages to be kept in the error message stack is 100 by
default. Only servere log messages are displayed, for example Fatal, Error,
Warning, and Note.
Trace messages are not displayed. The difference between log messages and trace
messages is explained in “Logging and tracing” on page 226.
Messages
Log messages contain three types of information, displayed in two columns:
Severity
Severity classes, Fatal, Error, Warning, and Note, correspond to log
message categories, FATAL, ERROR, WARNING, and IMPNOTE.
The number in brackets after the log severity class is the identifier of the
log message.
Message Text
Text of the log message, displayed in the language selected for the
Imaging Clients.
Show
You can filter the log messages to be displayed. By default, all buttons are
selected, which means that all classes of log messages are displayed.
If you disable a button, the messages of the corresponding severity class
will be removed from the message window.
Send logfile to
You can send the IXClient.log file to different applications or to mail
recipients. Click Send logfile to to select your destination.
Note: Be aware that the content of the log file itself is sent, not the
contents of the error message stack.
The statistics file is updated every 30 minutes, and also during application
shutdown.
You can override the default file path manually in the registry:
HKEY_CURRENT_USER\SOFTWARE\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM
\CustomSettings\S:StatisticsPath
You can override the default file path manually in the registry:
HKEY_CURRENT_USER\SOFTWARE\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM
\CustomSettings\S:StatisticsPath
Note: If you change the file path consider that the statistics file of “Logging
Enterprise Scan usage statistics” are also redirected here.
3. Navigate to the folder where the statistics files are located, select a file, and then
click Open.
3. To view job details, select the job, and then click Open Job Details or double-
click.
To save the archive jobs or archived documents as a CSV file for further
processing:
2. In the dialog box, click Archive Jobs or Archived Documents, and then click
File > Save as.
3. In the Save As dialog box, navigate to the folder where you want to save the
file, enter a file name, and then click Save.
Microsoft Windows 7
%USERPROFILE%\AppData\Local\OpenText\Enterprise Scan\Log
Microsoft Windows 10
%LOCALAPPDATA%\OpenText\EnterpriseScan\Log
Note: Do not forget to reset the log levels after troubleshooting to avoid
generating unnecessarily large log files.
Logging and The distinction between log messages and trace messages is as follows:
tracing
Log messages
Log messages are log records written to the log files and also shown to the user
in the Imaging Clients Message Box. The log messages are written in the log files
in English but are displayed in the Imaging Clients Message Box in the language
selected for Enterprise Scan. These log messages are identified by identifiers.
Trace messages
Trace messages are trace records written to the log files only. They are in English
and are used for advanced troubleshooting.
Registry editor
The setting LogSeverity is stored in <Registry_branch>\Software\IXOS
\IXOS_ARCHIVE\CommonClientSettings.
User-specific settings
These settings are located in the registry branch HKEY_CURRENT_USER
(HKCU).
User-independent settings
These settings are located in the registry branch HKEY_LOCAL_MACHINE
(HKLM).
Log level
Registry entry: LogSeverity
The logging has two levels: 4 (normal) and 7 (extended). 4 is the default log
level, 7 is used for troubleshooting. For more information, see “Setting log
levels” on page 226.
Microsoft Windows 7
%USERPROFILE%\AppData\Local\OpenText\Enterprise Scan\Log
Microsoft Windows 10
%LOCALAPPDATA%\OpenText\EnterpriseScan\Log
In the same way as on an Archive Center, the different DocTools and processes used
by the Document Pipeline are started by the Spawner, which runs as a service on
Microsoft Windows platforms. They can be queried and controlled using the
spawncmd utility. Commands and capabilities of the utility are described in
“Working with the spawncmd utility” on page 229.
The Spawner, the DocTools, and other processes used by the Document Pipeline log
information in log files. For more information, see “Spawner and Document Pipeline
log files” on page 233.
To restart the Document Pipeline and all its DocTools and processes, stop, and then
restart the Spawner service. For information on performing this action using a
Command Prompt, see “Stopping and starting the Spawner” on page 232.
You can also use the Microsoft Windows functionality to restart the Spawner. For
more information, see the Microsoft Windows documentation.
Once the Document Pipeline has been restarted, check the status of the different
DocTools and processes using the spawncmd utility (for more information, see
“Status of DocTools and processes” on page 230), or by reading the spawner.log
file (for more information, see “Spawner and Document Pipeline log files”
on page 233).
Local DP To connect to the local Document Pipeline, use the following command:
spawncmd <command>
(for example spawncmd status)
Remote DP To connect to a remote Document Pipeline, use one of the following commands:
spawncmd -h <Document Pipeline_host_name> <command>
(for example spawncmd -h scan02 status, spawncmd -h scan02.ixos.de status)
or
spawncmd -h <Document Pipeline_IP_address> <command>
(for example spawncmd -h 207.46.230.219 status)
List of To display the list of all spawncmd commands, enter spawncmd at the Command
commands Prompt:
D:\>spawncmd
The following are output samples for different Document Pipelines for Enterprise
Scan.
Document Pipeline for Livelink ECM – Suite for SAP Solutions (Enterprise Scan
component only)
program-id sta pid start time stop time
-------------------------------------------------------------------------
cfbx R 2416 11/12/2015 16:47:06
docrm R 2424 11/12/2015 16:47:06
doctods_1 R 2432 11/12/2015 16:47:06
doctods_2 R 2440 11/12/2015 16:47:06
Output results The following are the descriptions of the different values for each column.
program-id
The DocTool or process name, for example, docrm.
sta
The DocTool or process status:
• R means that the process is running. Most DocTools and processes should
have this status.
• T means the process has been terminated. Only a few DocTools or processes
should have this status.
• S means the process is starting and initializing. This happens when you start
the Spawner. After a while, the status should change to R (running). Check
this by reprocessing the spwncmd status command.
Note: The correct status for each DocTool and process can be found in
“Status of DocTools and processes” on page 230. Be aware that the dp
process will have the S status for a long time if there are a lot of documents
in the Document Pipeline.
If the status of a DocTool or process is incorrect, look at the corresponding
log file and at the Spawner log file. For details about log files, see
“Spawner and Document Pipeline log files” on page 233.
pid
The DocTool or process program ID.
start time
Time when the DocTool or process started.
stop time
Time when the DocTool or process stopped.
About Consider the following points when determining which monitoring tool to use:
monitoring tools
• The information provided by the spawncmd status command is similar to that
displayed by the Archive Monitoring Web Client. For more information, see
Tip: Restarting the Spawner is the first action that should be taken if one or
more DocTools or processes are terminated. This should solve most problems
caused by accidental termination of processes. If not, look at the Spawner log
files and the Document Pipeline log files. For more information, see “Spawner
and Document Pipeline log files” on page 233.
Tip: You can also enable or disable a single DocTool by using the Document
Pipeline Info. For details, refer to the online help of the Document Pipeline
Info.
Tip: You can also resubmit documents to the DocTools by using the Document
Pipeline Info tool. For details, refer to the online help of the Document Pipeline
Info.
You normally need this command for advanced troubleshooting purposes only.
Tip: If the Monitor Server is running on the Document Pipeline computer, the
Spawner log file and all Document Pipeline log files can be accessed using
HTTP. For this, enter one of the following URLs in a browser:
https://<Document Pipeline_host_name>:4061/cgi-bin/tools/log.pl
or
https://<Document Pipeline_IP_address>:4061/cgi-bin/tools/log.pl
Spawner log file The Spawner log file spawner.log shows all DocTools and processes started and
stopped on the Document Pipeline. For more information, see section 35.1 “Spawner
log file” in OpenText Archive Center - Administration Guide (AR-ACN).
Document There are no log files for Document Pipelines. Instead, the processes of the different
Pipeline log DocTools are logged into the corresponding DocTool log files. The name of the log
files
file is the name of the DocTool plus the extension .log, for example the log file of
the DocTool docrm is docrm.log.
For most processes, the name of the log file is the name of the process plus the
extension .log. Some processes may use different log file names.
Tip: In order to find which process log files contain relevant information, sort
the <DP_ROOT>\var\log directory by date. Then look at the log files that were
modified when a problem occurred or look at the ones last modified, especially
if they are large.
For more information, see section 35.1 “Spawner log file” in OpenText Archive Center
- Administration Guide (AR-ACN).
You can use the SAP incident wizard to report technical issues related to Enterprise
Scan.
Note: To use the SAP incident wizard, you require the SAP authorizations
Report an incident, Send incidents to SAP, and Close incidents, respectively. To
request these, contact your administrator.
2. In the Report Incident To SAP dialog box, define the settings, and then click
Submit.
Server Details
Server
Server name hosting the SAP system.
Port number
Port number of the SAP Server.
Protocol
• http
• https
Incident Details
Priority
• Very High
• High
• Medium
• Low
Summary
Enter a short description of the problem.
Description
Describe the problem.
Log File
The IXClient.log file is attached automatically.
3. Logon to the SAP system, check your entries, and then click Send.
The following sections provide an overview of all Enterprise Scan menus and icons.
Fit Window Ctrl+O View > Fit Window In the View view:
Scale > Fit
Window
Fit Width Ctrl+W View > Fit Width In the View view:
Scale > Fit Width
Fit Height Ctrl+H View > Fit Height In the View view:
Scale > Fit
Height
Delete Marked CTRL+D Page > Delete Marked Erase > Delete
Marked
Bookmark Marker F3 Page > Bookmark Marker >
Marker Bookmark
Marker
Delete Marker DEL Page > Delete Marker Marker > Delete
Marker
Quality Marker F8 Page > Quality Marker Marker >
Quality Marker
As the used scanning and archiving scenarios are very specific to each company and
the single scan operator often does not have the time to read the whole Enterprise
Scan user guide, it is useful that the administrator creates a kind of checklist for the
daily work of the scan operators.
This chapter should serve as the basis for this checklist. Copy the text to a text editor,
delete the items that are not relevant to your company, and add your company-
specific scanning and archiving scenarios (see the paragraphs with in angle brackets
<>).
To prepare scanning:
2. Start Enterprise Scan by clicking Programs > Start > OpenText > Enterprise
Scan.
6. If a page gets folded during scanning, smooth the paper original, delete the
page in Enterprise Scan with Page > Delete and rescan it with menu File > Scan,
or click .
7. Archive the documents to the external storage with File > Archive all if the
postprocessing will be done on another workstation.
1. Scan the documents from the external storage if the physical scanning has been
performed on another workstation or by a service provider.
2. Check all pages for order, completeness and quality.
3. Mark the pages that are not scanned correctly and need further processing:
• Enter, modify, or delete an index with Document > Change Index if the
barcode or patch code was not recognized correctly.
• Subdivide a document into several documents if the automatic separation
has failed during scanning:
6. If you are not able to solve a problem by yourself, please contact your
administrator for further inspection:
Attach each scanned page to an e-mail with File > Send and send the e-mail to
your administrator.
7. Archive the documents to the external storage with Document > Archive all if
the archiving will be done by another person.
The archiving of the documents differs from one company to the other. Therefore,
there are few common steps. Add your company-specific steps to this section.
1. Scan the documents from the external storage if the scanning and
postprocessing have been performed on another workstation or by a service
provider.
3. Read the property, for example the customer name, in the Index Item view and
enter it in the corresponding field in the Indexing view.
The entered values are checked and the detailed information for the next index
field is displayed in the Index Item view.
Note: If the entered values are not correct, the icon appears behind the
index field. Move the cursor pointer into the respective index field to get
detailed error information.
To enhance the functionality of the document indexing, you can attach scripts to
each indexing field defined. For more information, see “Configuring custom index
fields” on page 133.
The scripting language is JScript.NET, part of the .NET family of languages, because
major parts of Enterprise Scan itself are written for the .NET platform.
Important
Indexing as defined within Enterprise Scan is not document-centric. This
means that the index information entered into an indexing form is not saved
to a document. It is only transferred as metadata along with the document to
the export process.
General Scripting support is an extension to Enterprise Scan, which allows you to integrate
overview business logic into the handling of the metadata as defined by the indexing process
within Enterprise Scan. These extensions can harness additional logic in the
following distinct areas:
• The processing phase.
• The interactive phase. For more information, see “Scripts in the interactive
phase” on page 251.
• The export phase. For more information, see “Scripts in the export phase”
on page 258).
Initialization script
This script is performed once per document to ease the indexing process.
After restarting Enterprise Scan, the initialization script is not performed for
documents that have already been initialized in previous sessions.
Use the script to:
1. Prefill each field with document specific values.
2. Initialize global list boxes (Field.Choices for fields with owner Global).
Another benefit of the Initialization script is the correct display of multiple
selections.
Notes
• With version 10.0 the old Initialization script was renamed to Selection
script.
• The old configuration of Initialization script version 9.7 is automatically
migrated to Selection script version 10.0.
• In earlier versions of Enterprise Scan initialization was performed for
every document selection, that is changes of field values by users were
overwritten by the script.
// Correct
Field.Value = Document["Barcode"];
Selection script
This script is performed to implement additional configuration for the indexing
mask:
1. Initialization of document list boxes: Field.Choices. Only for fields with
owner Document.
2. Locking in the field against modification: Field.ReadOnly
3. Changing the unit of the field: Field.Unit
4. Limiting the length of the value: Field.Length
5. Specifying the number of decimals: Field.Scale
For every field with the owner Global, this script is called for every document
selection change.
For fields with the owner Document, the script is only called for single
document selection change. In case of multi-document selection change, the
script is not called.
The scripts are called in the order the fields visually appear in the indexing form
from top to bottom.
Validation script
This script is performed when the users modify a field value or the document is
to be exported, for example:
When the user confirms the input by pressing the ENTER or TAB key and
validation succeeds, the focus changes to the next field in the indexing mask or,
if the mask is completed, the next document is selected. If validation fails, the
focus stays on the field for immediate correction.
Updating script
This script is called after a successful validation and should be used by the script
author to update the values of other fields, based on the current field value.
value
Current value as seen by the scan user in the application GUI. For every
value, the script writer can also define a display value. This is displayed to the
scan user in the GUI only. Any access to the value from scripts returns the
real value. This is done by assigning a pair of values: (displayvalue,
realvalue) to the field value instead of a single value.
The value should be initialized by Initialization script and validated by the
Validation script.
Field.Value = "a value"
choices
List of all possible values for list type fields.
The picklist should be initialized by the Selection script.
Field.Choices.Add("Option 1")
Field.Choices.Add("Option 2")
name
Internal name of field (different from display name), read-only.
It is specified in the configuration dialog box.
var s:string = Field.Name
unit
Abbreviation to display beside the string label to inform the user of the units
of measure.
Should be initialized by the Selection script.
Field.Unit = "mm"
length
Maximum length of data entered into a field (for string types, the length of
the string, for decimal types, the total number of digits in the number).
Should be initialized by the Selection script.
Field.Length = 10
scale
For decimal types, specifies the total number of digits before the decimal
point (it should be less than length above).
Should be initialized by the Selection script.
Field.Scale = 5
ReadOnly
Method of type bool for all indexing fields. When you set the field property
ReadOnly to true, the application restricts the user from entering any value
manually in the text box through the user interface. That means that the text
box becomes non-editable.
Should be initialized by the Selection script.
Field.ReadOnly = true;
Fields["other field"].ReadOnly = true;
Visible
Method of type bool for all indexing fields. When you set the field property
Visible to true, the application hides indexing fields to the scan operator.
Notes
• The visibility of a field does not affect the structure of the indexing
mask, that is every field stays at its current position. This can cause
gaps in indexing fields if invisible fields are not placed at the end.
• If invisible fields are placed at the end and the height of the indexing
view is too small for displaying all defined fields there will be a scroll
bar displayed although all visible fields are displayed.
• A field and its corresponding lable and border can be hidden, but
additional elements that are added when the indexing mask is
created are still visible, for example buttons, mandatory icon, or
separator lines. To hide a field, use plain fields.
Field.Visible = true;
• Context information:
This is a persistent storage location for the script writer. Any information saved
here will be kept across all script invocations if provided the scan user does not
switch the profile. If the user changes the profile this information is lost. The
script writer can use this to save log in information and so on. This is exposed as
a hash container and can be considered storage for global variables.
Context["hello"] = "world"
• Validation result:
Within this script, the script writer can at any time call the method
Validation.Fail("error message") with an error message that is displayed
by the scan application. This signals to the user that the data entered was not
correct. Enterprise Scan leaves the focus inside the field in question.
AppShutdown.Request("<MyMessage>");
For example:
Notes
3. Validation script, called at least once. With user selection F2 or F12 back to step
2.
4. Update script, called after successful validation. With user selection F2 or F12
back to step 3.
5. Archiving:
a. Pre-Archive script.
b. Add Document Attributes script.
c. Set Document Pipeline Attributes script.
Note: GUI operations should not be performed in this script as doing so will
interfere with the GUI handling of the main scan application.
The scripting language is JScript.NET. The information and context available within
this script are similar to the scripts in the interactive phase above with some
differences as explained in the following table.
Context This global object works exactly as in initialization, selection, update and
validation scripts. Values are shared among all scripts.
var s = Context["MyVal"];
Context["YourVal"] = "Abcd";
Application Used to communicate with the archiving procedure.
Application.DocumentCount Retrieves number of documents in
this archiving batch.
Application.SkipDocument Set to true to silently skip the
current document.
Application.StopArchiving Set to true to display a message to
the user. User may choose whether
to continue archiving.
Application.ErrorMessage If stop archiving was set to true,
text assigned to this property will
be displayed in the message.
Application.StopArchivingSi Set to true to cancel the current
lent(extension to archiving loop without prompting
Application.StopArchiving) the user. When script is performed,
no log message is displayed in the
log file.
Document The archived document. Works in the same way as other scripts.
OpenText recommends that you import the category specification or record type,
copy the field names, and remove the fields in question from the indexing mask.
The Global Function Depot enables you to collect script code in one global depot.
When you enter script in the Script field and click OK, the script is saved and
available across all main profiles and subprofiles wherever scripting is allowed. All
scripting configuration dialogs have the Open Global Function Depot button.
In any of the scripting configuration dialogs boxes, you can enter script that calls a
function that is defined in the Global Function Depot. Some properties, however,
are only valid in a certain context. For example, Application.StopArchiving is
only valid in Add Document Attributes and Pre-Archive scripts. So there are only
two places where you can use this property.
Each time a custom script is performed, the script from the Global Function Depot
will also be compiled along with the current script.
If the Global Function Depot contains a function that uses a script property, for
example Application.StopArchving, and that is not valid for the current context
or the current custom script, it will throw an error for compilation as well as for
execution of the script.
To avoid this, the Global Function Depot provides conditional compilation statements.
For more information, see “Conditional compilation statements” on page 261.
Use Load, Save and Compile to open, store and test the scripts.
Use References to add a reference to third party libraries. For more information, see
“Assigning third party libraries” on page 155.
You can share, export and import global functions. For more information, see
“Sharing, exporting, and importing the configuration“ on page 199. If you import
global functions on a computer with existing global functions, the imported global
functions are appended to the existing functions.
@SCRIPT_TYPE_INITPROFILE
Conditional compilation statements for the Init-Profile script. Currently Init-
Profile does not support any scripting proxies or attributes.
@SCRIPT_TYPE_INDEXING
Conditional compilation statements for indexing scripts (initialization, selection,
validation, and update).
@SCRIPT_TYPE_PROCESSING
Conditional compilation statements for the processing Scripting Extension
script.
@SCRIPT_TYPE_PREARCHIVE
Conditional compilation statements for the Pre-archive script.
@SCRIPT_TYPE_ADDDOCATTR
Conditional compilation statements for the Add Document Attributes script.
@SCRIPT_TYPE_SETDOCATTR
Conditional compilation statements for the Set Document Pipeline Attributes
script.
@SCRIPT_TYPE
Conditional compilation statements for checking for various scripting types.
You can find examples for compilation statements in the Global Function Depot
section in the Indexing and Scripting Guide in OpenText Developer Network (OTDN)
(https://knowledge.opentext.com/go/EnterpriseScan_OTDN).
The example in this chapter shows the settings in the processing subprofile which
are needed to separate and classify documents by barcode and regular expressions.
Other profile and subprofile settings are not explained.
The example allows scanning into three different groups. Two groups (group1 and
group2) will identify specific barcode-groups, which begin with two different
character strings, 021 and 131 for group1, and 022 and 232 for group2. The third
group (group3) will contain all documents which do not fit into one of the other
groups.
1. Create a new profile with the usual options you use for the input device.
2. Create a Processing subprofile, and then add the following operations to the
flow:
a. Click Add to enter new classification rules for the three groups.
b. Enter the three groups, the barcode type under Recognize barcodes and
the respective Regular expression:
• Group1: All barcodes beginning with 021 and 131. Regular expression:
[0][2][1][0-9]*|[1][3][1][0-9]*
• Group2: All barcodes beginning with 022 and 232. Regular expression:
[0][2][2][0-9]*|[2][3][2][0-9]*
• Group3: All barcodes that do not begin with 021, 131 and 022, 232.
Regular expression:
^[0][2][1][0-9]*|^[1][3][1][0-9]*|^[0][2][2][0-9]*|^[2][3]
[2][0-9]*|[0-9]*
Documents that fulfill the conditions are now assigned to group1, group2
or group3.
Notes
• This feature is disabled by default with installation of patch ESC_1050-002
and higher. You can activate it by setting the following registry key under
HKLM:
[HKEY_LOCAL_MACHINE\SOFTWARE\IXOS\IXOS_ARCHIVE\6.0\Scan]
"EnableRenditionWithExternalTool"=dword:00000001
• OpenText recommends to use the “Searchable PDF Doctool” to render PDF
files. For more information, see “Searchable PDF Doctool“ on page 287.
• %1: Fullpath of the input file (a short path without blanks, and so on)
• %2: Fullpath of the output directory where the rendered images must be
created by the command file. The path includes a backslash at the end (a
short path without blanks, and so on).
The rendered documents must be created in the output directory with names
that represent the correct order of the pages (alphabetically sorted names).
The following are examples for an ImageMagick PDF command file
(convert_pdf.cmd):
5. Configure the input directory. For more information, see “Configuring file
input” on page 67.
Troubleshoot- If the process exits normally, Enterprise Scan verifies that at least one image file
ing for exit code exists in the output directory. After further processing the rendered images in the
output directory are deleted by Enterprise Scan.
If the process exits with the value != 0, for example, exit 1 in command file,
Enterprise Scan aborts the handling of the input file and adds logging information:
ERROR 2010/12/03 14:35:50:050 EnterpriseScan.exe:
1772\Input.FileSystem.dll:3844 renderimages.cpp,274 MSG0 Input file
rendition process exit value is set
ERROR 2010/12/03 14:35:50:050 EnterpriseScan.exe:
1772\Input.FileSystem.dll:3844 renderimages.cpp,341 MSG0 ErrorCode: 1
ERROR 2010/12/03 14:35:50:050 EnterpriseScan.exe:
1772\Input.FileSystem.dll:3844 fileinptbase.cpp,647 MSG0 Cannot render
input file E:\FileInput\Images\Overview.pdf
If the user command file exits with an error, the command file handle the error
appropriately.
Tips
• If the command window is closed by the x-button this is also recognized as
an exit code and further processing of this file is aborted in Enterprise Scan.
• Exit Code 3221225786, 0xC000013A, -1073741510: The application is
terminated as a result of CTRL+C. This indicates that the application has
been terminated either by pressing CTRL+C, or CTRL+BREAK, or by
closing the command window.
Troubleshoot- If the command file returns without error (exit 0), Enterprise Scan checks the
ing for no output directory for files. But if there are no files in the directory, check the file input
rendered
images
configuration:
• If the check box Skip non image files is selected, Enterprise Scan ignores the
rendition failure but adds a log entry: ERROR 2010/12/03 15:00:14:552
EnterpriseScan.exe:3360\Input.FileSystem.dll:2984
fileinptbase.cpp,655 MSG0 No rendered images created from input file
E:\FileInput\Images\OEM Install.pdf
placeholder replaced by
%n note sent from the leading application
\n line break (new line)
© copyright character (no placeholder)
\t tab character
%u Windows log in name
%b document index (barcode)
%D.%M.%Y current date (day, month, year)
%h:%m current time (hour in 24 hour format,
minute)
%I hour in 12 hour format
%p AM/PM sign
%% % character
\\ \ character
Floyd-Steinberg dithering
Fastest algorithm for color dithering (reduction) for high-quality results.
Stevenson-Arce dithering
Slowest color reduction method. Uses an algorithm for color dithering.
Note: This method is very costly in terms of time and required storage
space. However, sometimes it can provide even better results than Floyd-
Steinberg dithering.
Nearest Color
Fast color reduction method. Provides very low-quality results and does not use
an algorithm for color dithering.
Ordered dithering
Fast color reduction method. Provides very low-quality results and does not use
an algorithm for color dithering, but is slightly better than Nearest Color.
The barcode module allows checking the recognized text of barcodes against a
regular expression. To match regular expressions, Enterprise Scan uses a public
domain library.
Regular expressions serve as a kind of filter for text. For example, it is possible to
find all words beginning with “S” and ending with “R” without having to determine
the characters in between. In this example search, the word “Scanner” would be a
match.
Example: wo+rd matches “word”, “woord”, and “wooord” and so on, but
it does not match “wrd”.
* An element followed by * matches zero or more of the predecessor.
[...] Brackets indicate a range. Ranges match any single character within the
sequence inside the brackets.
Regular expression:
(LEA-(?^2345)[0-9]{4,4}([-][0-9]*)?)
Explanation
LEA-
The first four characters have to be LEA-.
(?!2345)[0-9]{4,4}
The next 4 characters must not be 2345 and must be a repetition of 4
times 0-9.
[-]
Next character could be -.
[0-9]*
The next characters must be in the range 0-9 with a repetition from 0 to
x.
([-][0-9]*)?
Matches LEA-(?!2345)[0-9]{4,4} and optional ([-][0-9]*).
Regular expression:
(LEA-(?!2345)(?!6789)[0-9]{4,4}([-][0-9]*)?)
If the quality of the scanned page is not optimal, a variety of reasons are possible:
Note: If problems with certain paper qualities recur frequently, contact the
person sending you this type of paper.
The Imaging Enterprise Scan Web Interface module brings scanning capacity to the
user interface of Content Server. The scanning functionality is accompanied by the
indexing feature. Users can scan an image and run an indexing session in the same
user interface (Scan & Index).
Notes
• The Scan & Index function is only available for the Folder object type.
• You can archive to all object types, except Collection, LiveReport,
MileStone, Poll, Shortcut, Workflow Status, and URL.
Prerequisites The following applications must to be installed prior to work with the Imaging
Enterprise Scan Web Interface:
• Content Server
• Imaging Enterprise Scan Web Interface module. For more information, see
section 3 “Installing the OpenText Imaging Enterprise Scan Web Interface
module” in OpenText Imaging Enterprise Scan Web Interface - Installation Guide
(CLESW-IGD).
Notes
To use the Imaging Enterprise Scan Web Interface scenario Scan & Index for
folders:
3. In the context menu of a folder, select Scan & Index to start Enterprise Scan.
Indexing view - The user interface consists of several views for which you can
configure the position and size. The Indexing view is dynamically built and
reflects the system of attributes associated with the folder in Content Server, in
which the Scan & Index function has been called. Attributes originate in system
attributes as well as in categories.
Document Name
This field is always automatically added in the indexing form.
Behavior of the controls - The behavior of the controls imported from Content
Server is similar to that of the controls used in the web interface of Content
Server. Enterprise Scan interprets the attribute arrays as well as group of
attributes.
Limitation of the indexing form - Enterprise Scan indexing form is somewhat
limited compared with the web interface. Content Server allows defining arrays
for whole sets of attributes. Enterprise Scan then cannot process more than the
first set in such an array. However both sets and arrays (except array of sets) are
imported without limitations.
The indexing form is not able to display more than 100 rows for an array. The
maximum value of elements in an array is preset in Content Server to value 50.
This value however can be overridden by user configuration. Assuming that the
user value is higher than 100, then only the first 100 elements in the array can be
displayed in indexing form inside Enterprise Scan.
Behavior of other attributes - The behavior of other attributes related either to
the system node or to a category is inherited from Content Server.
4. Click Archive to release the document together with additional indexing data to
Content Server. In one indexing session, exactly one document can be released.
If more documents are sent (by accident or by design), Enterprise Scan releases
the first document only and holds the execution for other documents. Enterprise
Scan displays a dialog box where you can decide to create a new version or not.
5. Decide whether the release operation shall continue or not. Basically, all other
documents can be released as versions of the first document. This behavior is
determined by the fact that the Document Name attribute is constant for all
documents on the stack:
Introduction
The Searchable PDF Doctool, formerly known as OCR doctool, converts single or
multi-page image files into PDF files. For this task it makes use of the official RSO
(RecoStar Object Interface) API of OpenText Capture Recognition Engine.
The Doctool is just a small wrapper around the functionality of the recognition
engine, which itself exposes much more parameters than published in this Doctool.
But for simplicity these are reduced to only some major ones. For more information,
see “Commands” on page 287.
You can find more information and the documentation for OpenText Capture
Recognition Engine in the Knowledge Center (https://knowledge.opentext.com/
knowledge/llisapi.dll/Open/16516521).
You can use the Searchable PDF Doctool in the following Document Pipelines where
it is preconfigured:
• Store scanned documents with barcode into SAP (R3SC).
• Store scanned documents from R/3 dialog into SAP (R3SC).
• Store scanned documents into DocuLink (SCR3).
• Scan Pipeline for TCP (SCDMS).
• Document Pipeline for Content Server (DPLES).
Commands
Commands and their parameters for the Searchable PDF Doctool need to be placed
in the COMMANDS file. The following list contains the entries that are supported and
automatically written by Enterprise Scan according to the profile settings. For more
information, see “Configuring additional document attributes” on page 161.
Notes
• The Searchable PDF Doctool is only allowed to be used in combination with
so called scan pipelines, that is document pipelines which are intended to be
used with Enterprise Scan.
• It is only possible to run one instance of the doctool within the Document
Pipeline framework. Running more than one instance is not a useful scenario
since the workload is managed by the doctool itself. For more information,
see “Optimization options” on page 289.
OCRLANGUAGE <language>
This command is optional and specifies the language. Currently there is no
automatic language detection available.
The default value is ENGLISH.
Available values are { ENGLISH, AZERBAIJANI_LATIN, BULGARIAN,
CROATIAN, CZECH, DANISH, DUTCH, ESTONIAN, FINNISH, FRENCH,
GERMAN, GREEK, HUNGARIAN, IRISH, ITALIAN, LITHUANIAN,
LUXEMBOURGISH, NORWEGIAN, POLISH, PORTUGUESE,
RHAETO_ROMANIC, ROMANIAN, RUSSIAN, SLOVAK, SLOVENIAN,
SPANISH, SWEDISH, TURKISH }
See the xml attribute Country='ENGLISH' in the DefaultProject.rsp file.
OCRLANGUAGEEXTENSION <extension>
This command is optional and determines whether to recognize characters from
all languages which are associated with the same code page as the language
selected by the OCRLANGUAGE parameter.
The default value is off.
Available values are on and off.
This command is necessary if for example a mixture of German and French
documents should be converted. Specifying only GERMAN would lead to the
restriction that French accents are not correctly read.
In most cases ENGLISH in combination with OCRLANGUAGEXTENSION=on is the
best choice, because then all characters of the Western Europe code page 1252
will be read.
OCRTARGETSEARCHABLE <searchable>
This command is optional and determines whether output PDF contains OCR
data.
The default value is on.
OCRTARGETPDFA <pdfa>
This command is optional and determines whether output PDF is of type PDF-
A.
The default value is on.
Available values are on and off.
See the xml attribute PDFVersion='PDF/A-1b' in the
DefaultBatchOperator.xml file.
Optimization options
Reducing the Since the Doctool uses as much resources as possible it may happen that there is not
workload enough CPU power left for other processes. The Doctool creates by default as many
sub processes as CPU cores available and tries to makes use of them all. You can
adjust this behavior in a way that the Doctool can be restricted to a distinct number
of processes.
The behavior is defined in the xml attribute ProcessCount in the
Profiles/Default/DefaultBatchOperator.rsp file. The default value is
Automatic. Specify the number of processes, and then restart the Doctool.
Troubleshooting
In case of an error, the ocrdt.log file is created. The errors are written to this file
and to the DPprotocol file in the DPDIR directory.
Typical problems
• Set the parameter OCRTARGETPDFA to off. The resulting PDF files will not be
PDF-A compliant.
• Set OCRTARGETSEARCHABLE to off. The resulting PDF files will only contain
images and no further textual information that could be used to search
within the PDF.
You can use Enterprise Scan with JAWS screen reader software that allows blind
and visually impaired users to read the screen. For supported JAWS screen reader
versions, web browsers, and restrictions, see the Release Notes.
• Configure JAWS screen reader to read column headers such as Name, Input,
Processing, and Archiving. You must do this for each individual dialog of the
listview in the Profile Manager dialog box.
a. Start JAWS, and then select the dialog you want to to configure.
b. Click Insert, and then press F2.
c. In the Run JAWS Manager dialog box, select Customize ListView, and
then click OK.
d. In the Customize Headers dialog box, configure the settings for your
needs.
• Place the cursor above the word, and then press INSERT and 5.
Alternativelly, use the JAWS cursor (Num and minus) and after that arrow-up
or arrow-down the key to select a line.
Enterprise Scan has an online help included. It is also possible to include a customer
specific help file.
You can find the customer specific help in the Help menu, clicking Help > Customer
Help.
1. Generate your own chm file with your company specific user instructions, for
example using the HTML Help Workshop from Microsoft.
3. Copy this file to <Open Text installation directory>\bin and overwrite the
existing file.
Archive Mode
Specifies the different archiving scenarios used by Enterprise Scan. The archive
mode is configured in the OpenText Administration Client.
Barcode
During mass scanning, Enterprise Scan can detect barcodes or patch codes and
separate the documents automatically. Then the barcode or patch code is
displayed in the Index field of the Properties tab.
Batch
Capture Center
Configuration files
DocTools
Document Group
In Enterprise Scan you can subdivide documents in several groups. These groups
can be used to divide the archiving tasks between several employees.
Document Pipeline
Document Stack
DPDIR
The directory in which the documents are temporarily stored while being
processed by the Document Pipeline.
Endorser
Enterprise Scan
FaxLink
Folder
Index
The term Index has also a second meaning in Enterprise Scan. In the Index field of
the Properties tab, the recognized barcode or patch code is displayed. For more
information, see Barcode.
Indexing
Leading application
Administrative tool for setting up and maintaining the Archive Center and its
components, such as archives, devices, disk buffers, jobs, archive modes and
users.
Patch code
See Barcode.
Servtab files
Configuration files of the Spawner, which specify which DocTools and processes to
start and how to start them.
Spawner
Service that starts and terminates the DocTools and processes of the Document
Pipelines.