Open Text Imaging Enterprise Scan 9.7.1 User and Administration Guide
Open Text Imaging Enterprise Scan 9.7.1 User and Administration Guide
CL090701-UES-EN
User and Administration Guide
Open Text Imaging Enterprise Scan
CL090701-UES-EN
Rev.: 2010-Apr-12
This documentation has been created for software version 9.7.1.
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 Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
E-mail: [email protected]
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com
PRE Introduction 9
i Target groups for this guide ..................................................................... 9
ii Structure of this guide ............................................................................ 10
iii What's new in version 9.7.1? ................................................................. 10
iv Help functions ........................................................................................ 12
v Product documentation .......................................................................... 13
vi Conventions ........................................................................................... 14
vii Contact information ................................................................................ 15
viii Respect for legal guidelines................................................................... 16
10 Configuring input.....................................................................71
10.1 Configuring the format checker.............................................................. 72
10.2 Configuring file input .............................................................................. 74
10.3 Configuring external storage.................................................................. 76
10.4 Configuring File Import........................................................................... 77
10.5 Configuring ISIS scanners ..................................................................... 77
10.6 Configuring Kofax certified scanners and VirtualReScan...................... 90
10.7 Configuring fax input .............................................................................. 90
11 Configuring processing...........................................................93
11.1 Page processing .................................................................................... 94
11.2 Separating documents (Document creation) ....................................... 122
11.3 Batch/folder creation or assignment .................................................... 126
11.4 Document processing ......................................................................... 130
11.5 Document classification ....................................................................... 132
15 Permissions........................................................................... 221
16 Sharing, exporting and importing the configuration .......... 223
16.1 Sharing the configuration ..................................................................... 223
16.2 Exporting and importing the configuration ........................................... 223
16.3 Uploading and downloading the configuration..................................... 224
There might be overlap between the different user groups because one task might be
carried out by one target group or the other.
• GetRecognizedBarcodeCount
• GetBarcodeType
iv Help functions
Open Text Imaging Enterprise Scan provides you with comprehensive Help
functions.
Searching in help
You can execute a full-text search in the online help. To open the Search tab directly,
open the Help menu and click Search for Help on. Enter a search request and click
List Topics. The documents found are listed for selection. In the online help's
Options menu, click Search highlights on to highlight the search hits.
Customized help
If implemented by Open Text Global Services or by the customer, a customized help
is available in addition to or instead of the standard Help function.
In the Help menu, click Custom Help. This opens the Custom Help start page.
v Product documentation
Other useful It is useful to have also a look in these manuals:
manuals
vi Conventions
Read the following conventions before you use this documentation.
Typography In general, this documentation uses the following typographical conventions:
New terms
This format is used to introduce new terms, emphasize particular terms,
concepts, long product names, and to refer to other documentation.
User interface
This format is used for elements of the graphical user interface (GUI), such as
buttons, names of icons, menu items, names of dialog boxes, and fields.
Filename
command
sample data
This format is used for file names, paths, URLs, and commands at the command
prompt. It is also used for example data, text to be entered in text boxes, and
other literals.
Note: If a guide provides command prompt examples, these examples may
contain special or hidden characters in the PDF version of the guide (for
technical reasons). To copy commands to your application or command
prompt, use the HTML version of the guide.
Key names
Key names appear in ALL CAPS, for example:
Press CTRL+V.
<Variable name>
The brackets < > are used to denote a variable or placeholder. Enter the correct
value for your situation, for example: Replace <server_name> with the name of
the relevant server, for example serv01.
Hyperlink
Weblink (e.g. http://www.opentext.com)
These formats are used for hyperlinks. In all document formats, these are active
references to other locations in the documentation (hyperlink) and on the Inter-
net (Weblink), providing further information on the same subject or a related
subject. Click the link to move to the respective target page. (Note: The hyperlink
above points to itself and will therefore produce no result).
Cross- The documentation uses different types of cross-references:
references
Internal cross-references
Clicking on the colored part of a cross-reference takes you directly to the target
of the reference. This applies to cross-references in the index and in the table of
contents.
External cross-references
External cross-references are references to other manuals. For technical reasons,
these external cross-references often do not refer to specific chapters but to an
entire manual. If a document is available in HTML format, external references
can be active links though, that directly lead you to the corresponding section in
the other manual.1
Tip: Tips offer information that make your work more efficient or show
alternative ways of performing a task.
Note: Notes provide information that help you avoid problems.
Important
If this important information is ignored, major problems may be
encountered.
Caution
Cautions contain very important information that, if ignored, may cause
irreversible problems. Read this information carefully and follow all
instructions!
Only menu items Different individuals will use the program in different ways. Many users prefer
are described mouse operation whereas others prefer using keyboard shortcuts. To meet all these
requirements, Enterprise Scan usually provides a number of different ways of
performing the most frequent functions.
For the sake of clarity, this documentation only describes the use of the menus for
activating functions. If you prefer to work with toolbar icons, keyboard shortcuts or
context-sensitive menus, then you should refer to the reference part of this manual
“Reference” on page 259.
Leading The application to which Enterprise Scan is connected, for example SAP systems,
applications Livelink ECM – Enterprise Server, or Open Text TCP, is referred to as the leading
application.
1 This applies, if target and source document are shipped together, e.g. on a product or documentation CD-ROM.
The following information and support sources can be accessed through Open Text
Online:
Knowledge Center
Open Text's corporate extranet and primary site for technical support. It is the
official source for:
• Open Text products and modules.
• Documentation for all Open Text products.
• Open Text Developer Network (OTDN): developer documentation and
programming samples for Open Text products.
• Patches for Open Text products.
The following role-specific information is available:
Partners
• Information on the Open Text Partner Program.
• Programs and support for registered partners.
Business Users
• Tips, help files, and further information from Open Text staff and other users
in one of the Open Text online communities
Administrators/developers
• Downloads and patches
• Documentation
• Product information
• Discussions
• Product previews
Feedback on If you have any comments, questions, or suggestions to improve our
documentation documentation, contact us by e-mail at [email protected].
documents. After archiving, you should make sure that the documents are
actually available in the leading software system. To do this, you can check the
Scan Document Pipeline to ensure that processing was successful. If documents
are only scanned and archived after the data is entered into the leading system,
you should do spot checks to ensure that they are archived correctly.
• For tax purposes, your business may also be required to store the paper originals
for all documents archived electronically. The paper archive should be clearly
structured and permit rapid access to documents.
• A legal basis of all business operation is the prompt execution of operations. For
electronic archiving with Open Text Imaging Enterprise Scan, this basic principle
is not directly applicable, as the time needed for scanning and archiving depends
on the timely accounting in the leading software system. Therefore, take the
necessary organizational actions to ensure that scanning and archiving is
coordinated with the processes on the leading application. Keep in mind that
these actions have to meet your local legal requirements.
• The scanning software allows you to delete pages. However, if relevant pages or
documents are deleted, there is a risk that the pages for archiving may not be
complete. Before deleting pages, make sure that the paper original of the
corresponding page is still available. When deleting, you should also observe
any mandatory, national retention periods for documents.
• If a scan operation is interrupted, there is no guarantee that all the pages will be
available in the scan dialog. In this case, check carefully to see if all the pages
have been scanned and that documents are complete.
This part deals with the basic tasks of a scan operator. As these tasks contain
company-specific elements, e.g. 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 where the
company-specific parts are described.
Build number To display the build number of Enterprise Scan, click Help > About Enterprise Scan
in the menu. The build number gets updated when applying a patch.
Patch level To display the patch level of Enterprise Scan, click Start > Control Panel. Double-
click Add or Remove Programs. Mark the entry Open Text Imaging Enterprise
Scan 9.7.1 and click the Click here for support information link. The Support Info
window displays, among others, the product version and, in the Comments line, the
patch level.
Toolbars A list of the available toolbars can be found in the reference part (see “Menus and
icons” on page 261). The toolbars can be customized (see “Customizing toolbars” on
page 53).
Views You can open different frames in the program window, also known as Views. The
following views are available:
Document section
Index
This field is used for the scenario Late archiving with barcode. The
barcode or patch code is detected automatically and included in
this field.
Group
You can classify the documents into several groups. Use these
groups if you want to exchange documents between several
employees; see “Exporting to External Storage” on page 48.
Page section
Endorser
Some scanner models support endorsing, this means a stamp is
printed on each scanned sheet to confirm scanning. This field
displays the endorser stamp.
Status bar At the bottom of the screen to the right, the status bar is located. It reports the
number of documents archived in the last archive operation and the number of
pages scanned in the last scan operation. It also shows which document in the
document stack has the focus and which page in this document has the focus.
Accessibility All functions are available via keyboard. All available shortcuts are listed in “Menus
and icons” on page 261.
Note: To close Enterprise Scan, open the File menu and click Exit. Pages that
are scanned but not archived are saved locally on your computer.
1. Select the respective profile in the list box of the Profiles toolbar.
Rescan
To rescan pages, e.g. if they have not been scanned correctly, select the pages,
open the File menu and click Rescan. 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. Click the Scan & Close button to start the rescan.
If you do not have the permission to change the input device settings, you can
only rescan with the same settings as in the initial scan. This, however, makes
sense in case of a paper jam or a similar problem with the physical scanner.
External Storage
Here you find storage types that have been registered in the Profile
Configuration dialog box. When no External Storage is configured, you do not
get a message, the list is empty.
Groups of documents
The Group name and the Number of documents in the group are displayed.
To start the scanning operation:
1. Select a storage type in the list.
2. Click the group you want to scan.
3. Click the Scan button.
Received faxes
The Fax line, ID, Number, Sender and Received attributes of all received faxes
are shown.
Preview
When the Enable preview option is enabled, you can see a preview of the pages
using the page scroll tool.
To start the scanning operation:
1. Select one or more of the faxes shown in the dialog box.
2. Click the Scan button.
Important
When archiving, Enterprise Scan will export the source color data, not the
processed monochrome image data.
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. See “Configuring input” on page 71.
Hardware dual stream
This option is only available for scanners that support Multi Streaming. Enter-
prise Scan configures the scanner driver to send 2 streams (monochrome and
color) for each scanned color page. See “Page settings for ISIS scanners” on
page 79.
If these simple correction steps do not work, an experienced scan operator or the
administrator can use additional advanced correction functions (see “Page
processing” on page 94).
If the postprocessing will be done by another person, you can mark documents for
further corrections (see “Marking documents for further processing” on page 43).
Select one or more Select the document(s) with the mouse in the Documents view.
documents
Select one or more There are several possibilities to select one or more pages:
pages • Select the pages in the Thumbnails view with the mouse using the
Shift and Ctrl keys.
• Draw a frame with the mouse in the Thumbnails view.
• Select a single page in the Thumbnails view and expand the selec-
tion 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 sev-
eral 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... (see “Marking documents for further processing” on
page 43).
Important
When archiving, Enterprise Scan will export the source color data, not the
processed monochrome image data.
To display the original color image, right-click to open the context menu and click
View source image. To switch back to the monochrome view, select another
document or page and then change back.
1. Select each page you want to rotate in the Thumbnails, Documents or View
view.
2. Select the appropriate item in the Page menu (see “Page menu” on page 263):
Rotate 180° to flip the selected pages, Rotate Left or Rotate Right to rotate
selected pages by 90 degrees.
2. Drag the selected files to the position in the Thumbnails view, where you want
to insert them.
Tip: Enterprise Scan indicates the drop position.
The files are added to the document as new pages.
Note: Importing documents to Enterprise Scan by Drag and Drop will skip all
processing steps that are defined in the processing subprofile for the current
active profile.
Tip: You can also import a complete folder of image files. All files in the folder
are added to the document as new pages.
Notes:
• Copying image files from the file system and pasting them into Enterprise
Scan is not possible.
• Enterprise Scan does not support copying of more than one image at a time.
1. Select the page that should be the first page of the new document.
2. In the Document menu, 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.
Note: To keep the original index information also in the new document, the
registry key of type REG_SZ
HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM\Doc
umentIndex\B:InheritIndexForSeparation must be set to “True”.
• Joining documents
If a separation condition has been mistakenly recognized, the document is
divided into two documents that belong together. The documents have to be
joined again:
1. In the Documents or Thumbnails view, select one document to which you
want to add document(s).
2. Additionally, select the document(s) you want to add.
3. In the Document menu, select Join.
The pages of the last selected documents are appended to the first selected
document.
Note: If only one document is selected, the Join operation joins the
selected with the next document.
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 document(s) and page(s), select them and press Shift+Del or select
Delete from the Page menu. A popup window asks you to confirm the deletion. 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 delete the marked pages
permanently, select them and press Ctrl+D or choose Delete Marked in the Page
menu. A popup window asks you to confirm the deletion. For details on working
with markers, see “Marking documents for further processing” on page 43. The
corresponding toolbar icons are listed in “Page menu” on page 263.
To show the Tree view, click Tree in the View menu. Select the Filter by Group
check box to select a group from the drop-down-list and display only documents
that belong to the selected group. The Tree view displays the batches as primary
nodes, and the folders as secondary nodes with the documents below the folders.
A right-click on a node opens a context menu providing the following actions:
• Click Archive to archive the documents below the selected node.
Tip: The Archive action is also available for single documents in the Tree
view.
• Click Rename to change the name of the currently selected batch or folder.
If there are still legibility problems, contact an experienced scan operator or your
administrator to use advanced filter methods (see “Page processing” on page 94).
Pages without the selected marker get the marker. If the page has already been
marked, the marker is removed (“toggle”). For keyboard shortcuts and
additional icons for navigation between markers see “Edit menu” on page 261
Note: The Custom marker option is only used for project specific solutions
where the markers have be defined e.g. by a plug-in.
3. Click on the OK button.
All pages marked with the chosen marker are selected.
You can specify some print configuration settings in the Configure Printing dialog
box.
Note: You can move the indexing items (the highlighted areas) in the Indexing
view as shown in the table:
In the Indexing view you enter the properties of the document that are later
used to retrieve the document in the archive. The cursor is in the first indexing
field.
2. Read the property, e.g. the customer name, in the Index Item view and enter it
in the corresponding field in the Indexing view.
3. Press Enter to go to the next index field.
The entered values are checked and the detailed information for the next index
field is displayed in the Index Item view.
Notes:
• If the entered values are not correct, the icon and an error message
pop-up appear behind the index field.
• This correctness check allows you to go on with another indexing field
and correct the error later. However, you will not be able to archive the
document before correcting the error.
1. Move your mouse over the toolbar you want to customize and select the context
menu item Customize.
The Customize Toolbars dialog box opens.
2. Select the button you want to add to the toolbar in the Available toolbar
buttons list. Click on the Add button to append it to the toolbar.
3. Select the button you want to remove from the toolbar in the Current toolbar
buttons list. Click on the Remove button to delete it in the toolbar.
4. Select large or small icons for the toolbar in the Icon options drop-down menu.
2. Choose the Category and the Command you want to create a keyboard shortcut
for.
3. Create the new shortcut by clicking into the text field and pressing the
corresponding key(s) on the keyboard.
4. Click Assign to store the new shortcut.
Configuration Description
tasks
Input Determines the document source:
• External Storage
• File Import
• File Input
• Scanner
• Fax input (Lotus Notes, Microsoft Exchange)
9.1 Preparations
The profiles for the Enterprise Scan are defined in coordination with Open Text
Global Services. Before you can define these profiles, you have to analyze the
company circumstances:
• How many documents should be handled per day?
• Do you use different document sources (scanners, External Storage, Microsoft
Exchange or Lotus Notes)?
• Of what quality are the paper documents?
In this dialog box, all existing profiles with the corresponding subprofiles for
input, processing and archiving are listed. You can change existing profiles via
the Modify, Rename and Delete buttons.
Notes:
• You cannot delete the default profile (marked with ).
• When deleting a profile, you do not delete the referenced subprofiles.
They remain in the corresponding subprofile lists, so that you can use
them for other profiles.
2. Create a profile:
a. Click on the Create button. The Profile Creation Wizard opens.
c. Enter the profile name and click on the Next button. The step 2 of the
Subprofile Creation Wizard opens.
d. Define the detailed configuration of the subprofile:
• the subprofile Input (see “Configuring input” on page 71)
• the subprofile Processing (see “Configuring processing” on page 93)
• the subprofile Archiving (see “Configuring indexing and archiving” on
page 137)
e. Check the check box for the subprofile you want to use in the new profile.
The selected subprofiles are listed in the Page flow field.
1. Select the respective profile or subprofile in the list box of the Profiles toolbar.
2. Click on the respective profile or subprofile button in the Profiles toolbar.
Manage Use Profile > Manage Profiles to modify any existing profile.
Profiles menu The Profile Manager opens (see “Creating a profile” on page 64).
item
Configure Use Profile > Configure Current to modify the active profile.
Current menu
item
Configure Use Profile > Configure Input, Configure Processing or Configure Export to
subprofile modify the active subprofile.
Click the tab for the kind of subprofile you want to modify.
Create
Based on the tab (Input, Processing, or Archiving) you have clicked, the Create
button opens the corresponding Subprofile Creation Wizard, where you can
create the new subprofile.
Modify
Highlight the subprofile you want to change and click on the Modify button.
The functionality available here depends on which tab you have open:
Input tab
After clicking the Modify button, you can change the input source. Select the
correct input source from the Scanners list in the Configure Input
subprofile dialog box.
To configure the parameters for the selected input source, click on the
Configure button.
Processing and Archiving tab
After clicking on the Modify button, you can change the settings and
parameters of the selected subprofile for Processing and Archiving.
Rename
To rename a subprofile
1. Select (highlight) the subprofile whose name you want to change.
2. Click on the Rename button. The Rename Subprofile dialog box opens.
3. Enter a new name for the subprofile.
4. Click on the OK button.
Delete
To remove a subprofile, select the one you want to remove.
Notes:
• An active subprofile cannot be deleted. If you want to delete a
subprofile, clear its check box.
• A subprofile that is being used by a profile cannot be deleted.
Next, click on the Delete button.
Configure
This button is only available in the Input subprofile. A dialog box appears,
where you can change the settings of the currently selected input device.
The dialog box shows whether 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.
Scanners
Here, you select the input device for electronic pages to be scanned. Click on the
Configure button to set the options for your scanning operation.
Options
Check input file format
Select this check box to have the files checked before scanning. Click
Properties to set the parameters for checking.
Do not create a new document
Select this check box to add the files to the last document. Otherwise the
pages will be scanned into a new document.
Emulate dual stream mode
Select this check box to enable the software emulated dual stream. See “Dual
stream scanning” on page 30. In the UI, only monochrome images are
displayed.
Note: If you select an ISIS scanner as input device, this check box is not
visible.
Check if the listed pages are sorted into the right group and if you have selected the
right profile.
Warning
You can lose original data if the original image is in the wrong format
or if the scanning profile configuration uses plug-ins and so does not
support the color depth of the scanned page. If you use File input as
the input device and enable the option Delete scanned files, and then
an error occurs, the original files on the disk are deleted without
warning.
Document Options
Create new document for directory
If this option is enabled, a new document is created for every subdirectory
present with the directory specified under Root directory.
Filename as document index
Enable this option to use the file name of the first file in the directory as the
index for the document.
Warning
When you scan from the file system in this way, the scanned
documents are not locked. After the documents are processed and
imported into Enterprise Scan, they are deleted from the location
(based on the option above). This means that this input source cannot
be used to distribute work to different operators by putting it on a
network file share. In this case, there is a high risk of two or more
people importing the same document more than once.
After finishing the file input options, click Scan & Close to start the scanning
process. The Configure File Input dialog box is closed.
Example:
C:\extstorage\MyGroup\00000002.00000000\
• 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.
The following is an example for using External Storage.
For detailed information about the Options, see “Configuring input” on page 71.
Select your driver from the list. Then click on the Configure button to open the
Configure ISIS Scanner dialog box.
Common rules, valid for all fields in the Configure ISIS Scanner dialog box
• Your changes are validated immediately 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 change automatically to make the
whole configuration valid. Also, the available options for a parameter may be
limited by the current value of other parameters. (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
In the Configure ISIS Scanner dialog box, you always see the standard tabs
Page and Image, where you can set the parameters for the paper format and
image quality options.
Optional tabs
There may also appear Advanced and Endorser tabs and special tabs for some
scanners. These tabs are only available if the driver supports at least one of the
corresponding parameters.
Page
Paper Size
Here, you can specify the settings for Page format, Orientation, Width,
Height, Left and Top offset.
Advanced
If Border detection is On, the scanner recognizes page borders during
scanning and determines the Page format. This box can be selected only if the
scanner supports this function.
If the Deskew box is selected, the page is deskewed during scanning. With
some scanners, this box can be selected only if Border detection is On.
If Overscan is selected, the scanning area is enlarged by the specified size. So
you can, for example, easily select A4 size with a 5–mm safety margin.
Paper source
You can select whether to scan pages from the scanner's stack Feeder, or to scan
each page individually from the Flatbed scanner. If you select Automatic and
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.
Feeder timeout
Sets the length of time in seconds that the scanner can wait for another
document without interrupting the scanning operation.
Double-sided scanning
When you have pages that are printed on both sides, you can specify whether
you want to scan both sides.
Show device dialog
Select this check box to display the Configure Device Settings dialog ...
• once per scan session, on the first scanning.
• if you switch to another input device (profile) and then switch back to the
ISIS input device, once, on the first scanning.
• when you click the configure button for the ISIS scanner.
In the Configure Device Settings dialog, the following settings are available:
Selected Device
In case you have multiple scanners attached to the computer, select the
scanner ID from the list.
Rescan Bus button
Update the list of attached scanners.
Default Page Size
Set the default page size for scanning.
Dual stream option
For general information about dual stream scanning, see “Dual stream scanning”
on page 30. The following options are available:
None
Default setting. Dual stream is disabled.
Emulated by software
Click this radio button to enable the software emulated dual stream. The
software emulated dual stream is similar to the Emulate dual stream mode
option for non-ISIS input devices in the input configuration dialog box. See
“Configuring input” on page 71.
Note: The Emulated by software radio button is only available if the
image color depth is 24bit color and the compression is not none. See
“Image settings for ISIS scanners” on page 81.
Hardware
Click this radio button to enable the hardware dual stream provided by the
scanner.
Note: The Hardware radio button is only available if the image color
depth is 24bit color, the compression is not none, and the scanner
hardware supports Multi Streaming.
Image Format
Color depth
Color depth options depend on the color settings that are supported by the
selected scanner.
Note: Scanning with a large number of colors requires a powerful
computer with a large memory.
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 is dependent on the pages that are to be
scanned, you must test the settings to find which one provides the best
results. It is recommended that you use 300 dpi for black-and-white scanning
and 100 dpi for color or gray scale scanning.
Brightness
The greater the percentage value you select here, the lighter the electronic page
will appear. If Automatic is checked, 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 here, the higher the
contrast in the electronic page.
Advanced
Dithering
This 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
connected scanner.
Emphasis
Enhances the image.
White level follower
If the option is enabled, the scanner compensates for non-white background.
Invert image
Inverts the color of each pixel in the image.
Mixed scan
Optimized scanning method for pages containing both images and text.
Outline extraction
Makes edges black while leaving monochrome areas white.
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.
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 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 press 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.
Note: The options available in the Advanced tab depend on the functions
supported by the connected scanner.
Mode
Here, you can specify how the stamp is printed.
Disabled
No stamp is printed.
Manual
If this option is enabled, no stamp is printed during scanning. However, you
can enter a stamp identification manually by using the Properties view. The
manual setting can be used for pages that have already been time stamped.
Automatic
The stamp is printed automatically on every scanned page.
Automatic Counter
This counter increases by 1 after every scanned page. To change the value used
for the next page, enter the value into the edit field.
Endorser string
Settings defining the printed appearance of the endorser:
• %c: computer name
• %n: serial number of the page. Using this counter will reduce performance of
fast scanners, because different strings must be generated for each page and
the scanner cannot scan in advance.
• %d: the current date
• %t, %T: the current time. For higher performance but less accuracy, use %T.
If you need high accuracy, use %t. If %n is already in the string, it does not
matter whether %t or %T is used; the performance is lower due to different
strings on different pages.
• %u: the user name
Position
Specifies the position of the stamp on the page relative to the margins.
Note: The options available depend on the functions supported by the
connected scanner. The Canon 5020/5080 imprinter functionality is available
through the Endorser tab.
This tab is meant for support cases in which everything else fails, not for normal
work. Contact Open Text Global Services in these cases.
Manual feed
Controls the automatic feeder. If enabled, the user must press a button on the
scanner before each page.
Skew stop
This option 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.
Note: The options available depend on the functions supported by the
connected scanner. Other scanner specific modes may also be available. For
more information, refer to the manual for the Kodak scanner.
Threshold
Dynamic thresholding 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.
For more information, refer to the manual for the Fujitsu scanner.
Important
When scanning fax attachments from Lotus Notes, only the first
attachment will be scanned. In case of multiple attachments, the other
attachments will be ignored. Configure your Fax software to create a
single multi-page file instead of creating a file for each page.
Note: Scanning fax attachments from Lotus Notes is only possible from the
Folders folder. The automatic creation places the folders at the correct
location.
Page process- Page processing improves the legibility of the document. Usually, page
ing processing is performed automatically during the scanning operation.
However, it might be necessary to improve the document quality manu-
ally.
For details, refer to “Page processing” on page 94.
Document During mass scanning, the beginning of a new document must be de-
creation tected automatically. This can be done in various ways: via barcode,
blank pages, the page number or blank pages.
For details, refer to “Separating documents (Document creation)” on
page 122.
Batch/folder You can use batches and folders to build a hierarchical structure of your
creation or as- documents, with batches as the highest level and folders under batches.
signment
For details, refer to “Batch/folder creation or assignment” on page 126.
Document If you are using blank pages to detect the end of a document, the obso-
processing lete blank pages can be removed automatically during scanning.
For details, refer to “Removing blank pages” on page 130.
The scripting extension enables you to configure document processing,
using a script.
For details, refer to “Scripting extension” on page 131.
Document During mass scanning, the documents can be separated automatically
classification into document groups. This can be done via barcode, default group or
patch code.
For details, refer to “Document classification” on page 132.
In addition to page processing steps, the settings for recognition of separation and
classification requirements have to be defined for this operation:
• “2D barcode recognition” on page 96
• “Barcode recognition” on page 98
• “Blank page detection” on page 104
• “Patch code recognition” on page 115
Recognize Barcodes
Select the barcodes that you want to search for.
Checksum
If you activate this check box, the checksums of the recognized barcodes are
examined.
Licence
This box indicates the license for the 2D barcode recognition. If you select a 2D
barcode in the Recognize Barcodes column, without having an appropriate
license, a warning message is displayed.
Barcode
2D Barcode
Recognize Barcodes
Select the barcodes that you want to search for.
Checksum
If you check this box, the checksums of the recognized barcodes are examined.
For more information on checksums, see “Questions about barcodes” on
page 308)
Remove Checksum
Here you can specify whether the checksum is to be removed.
Regular Expression
Here you can enter a Regular Expression against which the index is checked.
Note: The strings, rules and separators should correspond to the
conventions of the UNIX programming language. For examples of entries
possible here, refer to “Regular Expressions” on page 301.
Remove Chars
You can remove certain characters or strings from the index in accordance to the
rules entered in this box.
to prevent the comparison from being performed too far above or below the
barcode.
Comparison attempts
Specifies the frequency at which comparisons are performed. The higher the
value, the more precise the result.
Comparison tolerance
Specifies the maximum horizontal distance between the lines to be compared.
Minimum number of characters in the code
Specifies the minimum number of characters that the code must contain before it
can be registered as a barcode.
Comparison Shift
Specifies the maximum horizontal shift of the lines that are to be compared.
Increasing this value improves the recognition of oblique or less legible barcodes.
Bad lines to stop smoothing
When barcodes are being checked, an algorithm checks whether the upper and
lower located lines match. Increasing this value results in a greater tolerance
threshold during this check, which may in turn lead to better results in case of
oblique barcodes.
Maximum bar width
This sets the maximum width a bar can have if it is to be recognized as part of a
barcode.
Minimum bar width
This sets the minimum width a bar can have if it is to be recognized as part of a
barcode.
Minimum barcode height
This sets the minimum height of a stripe if it is to be recognized as a barcode.
This value prevents graphics, characters, badly scanned lines or dirty areas from
being incorrectly identified as a barcode.
Ignore barcode-like patterns
Patterns that look similar to a barcode will be ignored.
Recognize duplicates
If this option is enabled, the identified barcodes are compared. If two identical
barcodes appear on a page, then only one is considered.
Example
The original is on the left. For the center page, this filter was set to a very small
value, whereas a higher value was chosen for the page on the right.
Tested Area
Enable Restrict area for detection if you want only a specific area to be checked
for Blank Page Detection. You must configure the area set before you can select
it here (see “Defining areas for recognition” on page 217).
Tolerance
Here you can select tolerance percentages for Blank Page Detection. The higher
the value you choose, the less permeable the filter will be.
Note: Click Default to restore the original settings.
Global Sampling
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
When Adaptive is set, the image is split into squares, each with a specific
threshold.
Adaptive Grids
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
When the Secondary pass option is set, an additional function is activated for the
improvement of the image, in case some problem areas appear after conversion.
These areas are then reevaluated in the second cycle.
Note: Click Default to restore the original settings.
The histogram shows the number of pixels for all intensities (0 to 255) for the
chosen channel. The representation of the number of pixels (vertical lines in the
histogram) is adjusted to fit this rectangle.
2. Set Channel and Threshold
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 taken for 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 with regard to one channel only. (Default: 100
for all channels)
Preview
When you check Preview, a simplified preview of the image appears,
showing the potential result of the conversion to black-and-white.
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 information on dithering methods, see “Color reduction
methods” on page 299.
Note: Click Default to restore the original settings.
Mode
You can specify 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 (removed).
Reserve borders
Only borders that exceed this size are cropped.
Ignore dots smaller than
Only empty borders are cropped. This parameter specifies the size of dots that
are ignored when detecting whether an area is empty.
Note: Click Default to restore the original settings.
In the left-hand figure, the angle was set to 5°, whereas on the right-hand side it
was set to 45°. Since the text is skewed by more than 5° and this value is greater
than the filter setting, the page is considered to be correct, and is not rotated.
Example B: Algorithm Precision
The higher the sampling value, the more precise the result.
In this example, the original graphic is very complex and detailed. The higher
the selected value, the better the result.
However, here, too, precision is achieved at the expense of speed - the higher the
value you set, the slower scanning becomes.
Language
Select the language to be recognized. The following languages are supported:
• English
• German
• French
• Spanish
• Italian
In the processing script, the OCR result can be accessed with
PageAttributes.GetOcrText();. For details on the processing scripting extension,
see “Scripting extension” on page 131.
Patch Codes
Select the name of each patch code.
The highlighted code is shown in the Preview.
Orientation
Specify whether the code is to be read vertically or horizontally by checking the
corresponding box.
Restrict area for recognition
If you have configured areas before, you can restrict recognition to one of the
area sets. For details on area definition, refer to “Defining areas for recognition”
on page 217.
For a description of the settings, refer to the relevant section on Barcode recognition
(see “Recognition tab” on page 101).
You can restore the default values by clicking Default.
11.1.17 Rotation
It may not be possible for a large number of pages to be scanned with the same
orientation as their text. You can automatically rotate these pages to the correct
orientation for scanning.
Select the correct rotation.
Select the patch code from the list. Click on the OK button to confirm and close the
dialog box.
Note: Enable the option Delete page with recognized patch code if the
separation pages only contain the patch code, and if these pages should be
deleted automatically.
You can select the color you used for the blank pages, or check Accept any color.
Note: Click Default to restore the original settings.
Click on the OK button to confirm your selection and close the dialog box.
Separation
<code>
// separates only
//Separation.Separate(props);
// separates and deletes the current page
//Separation.Separate(props, Separation.Flags.DeletePage);
Use the buttons Load, Save and Compile to open, store and test the script.
The following additional buttons are available:
References
Use this button to add a reference to third party libraries, see “Assigning third
party libraries” on page 170.
Open Global Function Depot
Use this button to open the Global Function Depot where you can collect all
your Enterprise Scan scripts. See “Global function depot” on page 280.
For general information about scripting in Enterprise Scan, see “Scripts for indexing
and archiving” on page 273.
Remove
When you click on the Remove button, the selected line will be deleted.
During scanning, patch codes are checked in the sequence in which they appear in
the list. To change this sequence, click a patch code entry and then the Move Up or
Move Down button.
Settings “Archiving”
Indexing Indexing with TCP.
Settings “Archiving”
Preconditions • Open Text Administration: create archive mode with DMS_Indexing
scenario (see section 10 "Configuring scan stations" in Open Text
Archive and Storage Services - Administration Guide (AR-ACN)</doc>).
In the archive mode, the following Extended Conditions must be set:
PDMS: BIZ_ENCODING_BASE64_UTF8N and BIZ_REG_INDEXING
TCP: PS_ENCODING_BASE64_UTF8N
See section 35 "Functional description of the TCP DocTools" in Open
Text Transactional Content Processing - Administration Guide (TCP-
AGD)</doc> for details.
• Document Pipeline: install Document Pipelines for TCP.
Enterprise Configure the Document Pipeline with the archive mode defined in the
Scan customiz- Open Text Administration and select DMS doctype (see “Administration
ing Server and Document Pipeline” on page 231).
Starting ar- In Enterprise Scan
chiving
Communica- The document is archived. Further steps like sending a notification or
tion starting a process depend on the configuration of Document Pipelines for
TCP. All steps are done in Document Pipelines for TCP.
Pre-indexing With the pre-indexing scenario , you can store additional document properties along
with the scanned document in the Archive Server. A Transactional Content
Processing (TCP) user can use these properties to retrieve the document.
Settings “Pre-indexing”
Indexing Pre-indexing with Enterprise Scan, final indexing with TCP.
Preconditions • Open Text Administration: create archive mode with DMS_Indexing
scenario (see section 10 "Configuring scan stations" in Open Text
Archive and Storage Services - Administration Guide (AR-ACN)</doc>).
In the archive mode, the following Extended Conditions must be set:
PDMS: BIZ_ENCODING_BASE64_UTF8N and BIZ_REG_INDEXING
TCP: PS_ENCODING_BASE64_UTF8N
See section 35 "Functional description of the TCP DocTools" in Open
Text Transactional Content Processing - Administration Guide (TCP-
AGD)</doc> for details.
• Document Pipeline: install Document Pipelines for TCP.
Settings “Pre-indexing”
Starting ar- In Enterprise Scan
chiving
Communica- The document is archived. Further steps like sending a notification or
tion starting a process depend on the configuration of Document Pipelines for
TCP. All steps are done in Document Pipelines for TCP.
Late archiving In this scenario, paper documents are passed through the office and are not archived
with barcode 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 the leading application.
Documents are identified by a barcode or patch code on their first page.
Note: If an SAP system is the leading application, the corresponding scenario
name is Late storing with barcode.
else
{
Context["b_check"] = true;
}
if(Context["b_check"] == false)
{
MessageBox.Show("Precondition not met. Archiving not possible.");
Application.StopArchivingSilent = true;
}
1. Click Add > New field or Edit (if you have selected an existing indexing field)
in the Indexing tab of the Configure Archiving Subprofile dialog box.
Document
The values in indexing fields with the owner Document are 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.
Global
The values in indexing fields with the owner Global are valid for
all documents. They are persistent when archiving but they are
lost if the (sub)profile is changed or if Enterprise Scan is shut
down. Indexing fields of type Global are highlighted in light blue
in the Indexing view and in the Indexing tab of the Configure
Archiving Subprofile dialog box.
Count, Maxi- Configure the number of rows for the indexing field, only relevant
mum, Locked for multivalue indexing, see “TCP multivalue attributes” on
page 147 and “Indexing multi-row attributes from Livelink” on
page 156.
More This button is only enabled for importing TCP relations, see “TCP
relations” on page 149.
Initialization This script is performed when the indexing form is opened for a
script new document or when the user switches to another field with the
TAB key.
Validation This script is performed when a user presses ENTER.
script
Update script This script is performed when the user changes a field or presses
ENTER.
Important
• In case of multi-selection, that means if the user selects more than
one document in the stack, the Initialization script and the Update
script are not executed for indexing fields with owner Document.
The Validate script, however, is executed also in case of multi-
selection.
• For indexing fields with owner Global, this restriction does not ap-
ply. In case of multi-selection, all indexing scripts for fields with
owner Global are executed.
Use the buttons Load, Save and Compile to open, store and test the scripts.
Click the Open Global Function Depot button to display the Global Function
Depot, see “Global function depot” on page 280.
Tip: For a detailed description of scripting and its use in the indexing
process, refer to “Scripts for indexing and archiving” on page 273.
4. Confirm your configuration with the OK button.
4. In the Configure Field dialog box, configure the number of rows (Count) that
are displayed initially in the Indexing view. Default value is 1.
5. For multivalue fields imported from TCP, there is no upper limit for the number
of rows. If needed, configure such a limit with the checkbox Maximum and the
corresponding value.
6. For single-value properties: To make sure that the number of lines cannot be
changed in the Indexing view, check Locked in the Configure Field dialog box .
7. In the Indexing view, add and remove rows for indexing multivalue attributes
by clicking the and icons.
1. Decide if the Indexing view shall show the mapping properties or the relations,
and remove the other field.
Alternatively, keep both fields, so the scan operator can choose either to insert
e.g. the customer number or select the customer from a list of customer names.
2. In the Configure Archiving subprofile, mark the indexing field of an imported
relation, and click the Edit button. The Configure Field dialog box is displayed.
3. Click the More button to open the Properties for Relation Account dialog box.
4. Select the property type to be displayed in the Indexing view and the fetchlimit,
the maximal number of lines displayed for this property type in the Indexing
view.
1. Click Add > Import from Livelink in the Indexing tab of the Configure
Archiving Subprofile dialog box.
2. Log in to the Enterprise Server (see “Livelink log in” on page 234). The Import
Attributes dialog box is displayed.
3. Select the required folder, category or workflow and click the Import button.
The attributes are imported.
Notes:
• Enterprise Scan supports Unicode (UTF-8) strings for indexing values
when archiving through the Document Pipeline for LES. As a
prerequisite, the Enterprise Server must support UTF-8.
• The relevant system attributes defined by the Enterprise Server instance
are automatically imported as well. If they are not needed, delete them.
• Enterprise Scan constructs a correct indexing form when Copy is used
in Livelink ECM – Enterprise Server web interface.
• The default value for an attribute defined in Livelink ECM – Enterprise
Server can contain quote or double quote characters. The Enterprise
Scan indexing module can process such default values and initialize the
Indexing view accordingly.
• RSI
• Other Addressee(s)
• Originating Organization
See “To select the Records Management classification in the Indexing view:” on
page 155
Once the document is released from Enterprise Scan to the Enterprise Server
indirectly (using the Document Pipeline for LES), the Records Management
attributes are written to the IXATTR file for further processing of the Document
Pipeline for LES module.
2. Select from the Classifications drop down list how to import the classification:
Browse Classification
In the Classifications Tree, browse through all available Records
Management classifications and select 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.
5. In the Configure Field dialog box, enter the number of rows (Count) to be
displayed initially in the Indexing view for the attribute. Minimum value is 1.
Note: The initial number at Count corresponds with the “default” value
defined for the multi-row attribute in the Livelink ECM – Enterprise
Server.
The default value for a multi-row attribute results from the default value
definition inside the corresponding category in the Livelink ECM –
Enterprise Server. Items with index between “default” and “max” do not
have a default value because this value is not defined in Livelink ECM –
Enterprise Server.
6. Define a Maximum number of rows. Otherwise, check Locked to make sure that
the number of lines cannot be changed in the Indexing view.
7. In the Indexing view, you can add as many new rows as defined in the
parameter “max” for the respective attribute in the Livelink ECM – Enterprise
Server: Click the icon near the appropriate indexing field. Use the icon to
reduce number of rows.
Note: An overflow of the “max” number can happen, when the number of
rows added in the Indexing view exceeds the maximum available count of
rows for a multi-row attribute defined in the Livelink ECM – Enterprise
Server. The scan operator should know the “max” number of rows to avoid
this problem.
Scripting
Validation/Update scripts are triggered for every item in the array. Initialization
scripts are called just once.
The following methods/properties for Field objects are available in
Initialization/Validation/Update scripts:
For more information about scripting, see “Scripts for indexing and archiving” on
page 273.
Limitations
Indexing of multi-row attributes is not supported
• in export script plug-ins (see “Scripts in the export phase” on page 278).
• in the Document Pipeline for LES (see “Storing documents in Livelink via
Document Pipeline (searchable PDF files)” on page 194).
• for existing archiving subprofiles. In order to use this functionality for existing
subprofiles you must re-import the indexing fields from Livelink ECM –
Enterprise Server or edit them manually in the Configure Field dialog box:
Remove the Locked checkmark and set Count and Maximum suitably.
2. Click the user icon to the right of the text field to open the dialog box Select
User.
3. Select a search parameter (e.g. User Last Name) and enter a search term in the
field. Click the Find icon.
The search is performed in the Livelink ECM – Enterprise Server User
Database.
4. Select the user from the listed results.
5. Click OK to insert the selected user into the text field in the Indexing view.
3. If you want to use a field multiple times for indexing, right-click on the
respective line.
5. In the Count dialog box, enter the number of times you want the field to be
displayed in the Indexing view and click Ok.
6. Repeat step 3 to step 5 for all fields you want to use multiple times 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 multiple times 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 have the indexing fields grouped by complex fields in the Indexing view,
select the Group fields by sets check box.
You can perform some editing and also scripting to the indexing fields, using
the Configure Field dialog box. See “Configuring custom index field” on
page 143 for general information.
10. In the Indexing tab, select one line and click the Edit button.
The Configure Field dialog box opens.
Important
Do not change the indexing field Name. The exact format is required to
display the fields in the Indexing view.
The value of Count and Maximum must be 1, the Locked check box
must be selected.
To configure that the field must be filled in the Indexing view before the
document can be archived, select the Mandatory check box.
In scripting, you can use the field names:
Note: For detailed information about scripting, see “Scripts for indexing
and archiving” on page 273
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 along 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
1. Create templates via DocuLink for the IXATTR file and the COMMANDS file, using
the customer specific table in SAP. These files control the indexing and
archiving process. See “Creating templates” on page 165.
2. Adapt the pipeline script scanr3.pl. See “Adapting pipeline script” on
page 166.
3. Configure indexing information in the Configure Field dialog. See
“Configuring indexing information” on page 167
4. Add a script in the Set Document Pipelines Attributes dialog box. See “Adding
a Document Pipeline Attributes script” on page 169
Creating In DocuLink, in the Attribute objects settings dialog, you create templates for the
templates IXATTR file and the COMMANDS file. See section 11.3.1.1 "General" in Open Text
DocuLink for SAP Solutions 9.6.2 - Customizing and Administration Guide (DC-
CGD)</doc>.
For details on automatic field entry, see section 9.3.4.3 "Automatic entry of field
values using DocuLink" in Open Text Document Pipelines - Overview and Import
Interfaces (AR-CDP)</doc>.
Adapting After installing Open Text Document Pipeline DocuLink (SCR3), the pipeline script
pipeline script file scanr3.pl is located in: %ProgramFiles%\Open Text\DocuLink Document
Pipeline 9.7.1\scripts\perl\. The change you must perform tells the script that
there is no need to run additional custom scripts for the SCR3 scenario.
Change the following lines of the scanr3.pl.
Original:
sub service {
my $docdir = shift;
my $dttype = shift;
IXOS::DTLogging::logmsg(IXOS::DTLogging::_ERROR(), "\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" You have to replace the scanr3.pl script with a project script !!!\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n");
Changed script:
sub service {
my $docdir = shift;
my $dttype = shift;
IXOS::DTLogging::logmsg(IXOS::DTLogging::_ERROR(), "\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" You have to replace the scanr3.pl script with a project script !!!\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" .
" ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n");
#return(0, "script 'scanr3.pl' has not been replaced by a project script");
return(1, "script 'scanr3.pl' done"); # return success - no need to run additional
custom scripts
}
Configuring You configure the indexing information manually in the Configure Field dialog. For
indexing general information about this dialog, see “Configuring custom index field” on
information
page 143.
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>
stands for the name of the SAP table in which entries are to be made
<column_name>
stands for the name of the column in the SAP table <r3_table_name>.
<col_type>
stands for the data type of the <value>. The following data types are used for
SAP indexing:
CC
for character strings
NN
for character strings comprising numbers only
D2
standard date format DD.MM.[YY]YY. This is converted to database format
internally.
<value>
Stands for the value to be entered either in plain text or as a placeholder
specifying the value type (%s, %d, ...).
For further information, see section 9.3.4 "IXATTR for SAP applications/DocuLink"
in Open Text Document Pipelines - Overview and Import Interfaces (AR-CDP)</doc>.
Important
Whenever the IXATTR file is modified in the Set Document Pipeline
Attributes script, the automatic IXATTR creation with indexing information
does not take place. In this case, you have to generate the entire contents for
IXATTR by script, yourself.
To get the desired syntax in the IXATTR file, you need to define the indexing fields in
the Configure Field dialog the following way:
Note: See also “IXATTR file template” on page 166. 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:
Type field <col_type> string <value> format in IXATTR
in IXATTR
String CC <input>
Integer NN <input>
Flag CC true or false
Decimal CC <input>
Time CC hh:mm:ss
Date D2 DD.MM.YYYY
DateTime CC DD.MM.YYYY:hh:mm:ss
Adding a In the Set Document Pipeline Attributes dialog box (see “Configuring Document
Document Pipeline attributes” on page 181 for details), enter the following script that will be
Pipeline
Attributes script evaluated for the COMMANDS file:
Note: See also “COMMANDS file template” on page 166. The template can
help you to define the script.
Most entries in the COMMANDS file are passed by Enterprise Scan, directly.
The entries are passed to the COMMANDS file by the Set Document Pipeline
Attributes script. By parsing the COMMANDS file, the link table information is
transferred to the IXATTR file. For a comprehensive description, see section 9.3.4.2
"Entries in SAP link tables" in Open Text Document Pipelines - Overview and Import
Interfaces (AR-CDP)</doc>.
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 above:
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: A NEWINSERT entry is generated in the IXATTR file if multiple tables are
referenced in the indexing fields.
Note: For details on automatic field entry, see section 9.3.4.3 "Automatic entry
of field values using DocuLink" in Open Text Document Pipelines - Overview and
Import Interfaces (AR-CDP)</doc>.
1. To open this window, click the References button in the Indexing tab of the
Configure Archiving Subprofile dialog box.
2. Click the Browse button to select the *.dll file in the file system.
The *.dll file is displayed in the Path field.
3. Click the Add button. The *.dll file is listed in the Referenced assemblies
field.
4. Confirm your configuration with the OK button.
Example 12-7: Elevating permissions for selected file shares using CasPol.exe
Use CasPol to fully trust some 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 share \\FS01\Tools, use the following
command:
CasPol.exe -m -ag 1.2 -url file://\\FS01/Tools/* FullTrust
Parameter explanation
-m
Modify the machine level of the policy. This is needed, since the machine level is
where all of the default policy lives.
-ag 1.2
Add 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/*
Set the membership condition for the new code group as an UrlMembership
condition. It should match anything with a URL that starts with
1. To open this window, click the Field areas button in the Indexing tab of the
Configure Archiving Subprofile dialog box.
2. Navigate to the document page that is representative for the documents that
should be processed with this profile.
3. Click the Add button. A rectangle is added to the page and a new row is added
to the List of rectangles tab.
4. Move the rectangle to the correct position and define the size.
5. Select the index field for which this area is valid in the list box of the Indexing
field column.
6. Confirm your configuration with the OK button.
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.
3. Add the following script to the Configure Pre-Archive Script dialog box:
import System.Collections;
import Ixos.Scan.DocumentModel;
var selectedDoc:IDocumentSelection;
var doc:IDocument;
var strTotalDoc:String;
var strSelectedDoc:String;
var i:int;
try
{
strTotalDoc = "Total no:of Documents in the stack =
"+Application.DocumentStackCount+"\n";
selectedDoc = Application.ArchivingDocuments;
doc= selectedDoc[i];
strIndex = doc.DocumentIndex;
strGroup = doc.Group;
strSelectedDoc=
strSelectedDoc+"Doc"+i.ToString()+"\n";
strSelectedDoc= strSelectedDoc+"Index
="+doc["Index"]+","+"Group ="+doc["Group"]+","+"Pages
="+doc.PageCount.ToString()+","+"Batch="+doc.ScanBatch+"\n";
}
var strOutput:String;
strOutput=
strTotalDoc+"*********************************\n"+strSelectedDoc;
{
Application.StopArchivingSilent = true;
}
}
catch(Exception)
{
MessageBox.Show("Exception caught");
}
5. Now, click Archive All and confirm in the Archive Documents dialog box..
The following Archiving details dialog box is displayed.
For details on scripting, see “Scripts for indexing and archiving” on page 273.
1. Add Delete Marked Pages to the Flow list and click on the Configure button.
2. Select the marker type:
• delete for the Delete Marker
For details on scripting, see “Scripts for indexing and archiving” on page 273.
When exporting documents to Open Text Capture Center, OCR, its validation and
archiving are delegated to Capture Center. The images and their attributes are
stored for handover in a shared directory. After receipt, Capture Center removes the
stored files from the shared directory.
In regular configurations, the path to the shared directory has the following syntax:
\\<server name>\OpenTextCaptureCenterData\<profile name>
This directory is created and configured by Capture Center. If the directory does not
exist, the export from Enterprise Scan will fail with an error message. To avoid this,
configure Capture Center first and make it ready for document import. Afterwards,
proceed with the configuration in Enterprise Scan.
Note: Field names of Capture Center must be XML compliant element names.
Enterprise Scan does not implement this restriction so that indexing field
names can be configured that are not valid in Capture Center.
If you use invalid field names, the export to Capture Center will fail. So, ensure
that indexing field names match the following regular expression:
2. Configure the following parameters for the export to Oracle Web Service:
Web Service End Point
Enter the Web Service URL where the Document Pipeline for Oracle
Applications connects for communication about attributes/field release.
Example: http://<server address>/orabpel/AP_V01_01/-
OTOS_AcceptScannedInvoice/1.0?WSDL
Important
For all archiving scenarios using Document Pipeline, an archive mode must
be configured in Open Text Administration and selected in the Archiving
subprofile on the Enterprise Scan workstation.
DMS Doctype
This setting is only needed for the Document Pipeline for TCP.
Select the document type that should be used. This document type was
configured by the Document Modeler and stored on the Open Text TCP
Context Server. This should be one of the record types imported in indexing.
The entered value is written into COMMANDS file under the DMS_DOCTYPE key.
Note Format
Enter the placeholders for a note. During archiving, the placeholders are
replaced with actual values and the note is stored together with the
document. The note can contain a note that was sent by the leading
application. For a list of valid placeholders, refer to “Placeholders for Notes”
on page 297.
Default Note
You can enter a note here if a note is not specified by the leading application.
Details
If you click this button, the details of the archive settings as defined in the
Archive Server are displayed (see “Archive (Document Pipeline) Details” on
page 188).
Advanced
Click the button to adjust the output file format as described in “Advanced
settings for archiving” on page 196.
2. In the Pipeline host panel, select the Connect to Pipeline radio button.
3. Set the protocol (HTTP or HTTPS), the pipeline host and the port.
See section 10.3 "Archive mode settings" in Open Text Archive and Storage
Services - Administration Guide (AR-ACN)</doc> for details.
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.
Directory
Enter or select the directory for the External storage where the scanned
documents will be stored.
Name
Enter a meaningful name here.
Archive ID
Specify an archive name where the documents are to be stored later on the
Archive Server.
Conditions
Here, you can specify any conditions that must be met in order to store the
documents in External Storage:
• Barcode: A barcode must exist.
• Endorser: Only documents with a stamp are stored.
• Group: The documents must belong to a group.
Root
The folder path from Livelink where the files will be archived. The browse
dialog box enables you to select from folder hierarchies in the Category
depot in Livelink.
Dynamic Folder
Specifies the path to the folder where the files will be archived. Use the
Insert button to define a pattern, e.g. <INDEX><GROUP><USER><COMPUTER>.
The pattern will be replaced with the real values during archiving.
To define a folder hierarchy, use the ":" as a separator. Each colon (":")
specifies a new directory level.
Document Name
Specifies the document name. Use the Insert button to define a pattern, e.g.
<INDEX><GROUP><USER><COMPUTER>. The pattern will be replaced with the
real values during archiving.
Notes:
• Some characters are not valid in a document name; therefore, ensure
your selection in this dialog box does not generate invalid
characters. For a list of invalid characters, see the Enterprise Server
documentation.
• Enterprise Scan supports Unicode for folders and documents with
multilingual names while archiving (for example Chinese, Japanese,
Arabic, Latvian). As shown in the screenshot, you can choose and
specify multilingual folders and file names. The same multilingual
names will be created or updated in Livelink.
Important
• All folders with at least READ permission are listed. Make sure
that the selected folder has the sufficient rights for archiving.
Otherwise archiving will not be possible.
• If you log in as a user without Administrator privileges, you are
only entitled to archive into your Personal Workspace in the En-
terprise Server. However, you can bypass this restriction by us-
ing anonymous submission. See “Document Pipeline for LES
9.7.0: impersonate vs. anonymous submission” on page 238 for
details.
To configure storing searchable PDF files via Document Pipeline for Livelink:
1. Configure a new archiving profile (see “Configuring archiving” on page 178).
2. In the Configure Archiving Subprofile dialog box select the document export
operation Document Pipeline for Livelink and click the Add button.
The operation is listed in the Flow field.
Important
The Document Pipeline for Livelink has to be always the last plug-in in
the flow.
3. Select the Document Pipeline for Livelink operation in the Flow field and click
the Configure button to define the properties of the operation:
Important
If you want to use the output formats PDF/A (image), PDF (text), and
PDF/A (text), the following prerequisites must be fulfilled, dependant on the
Document Pipeline you want to use. This is necessary for the OCR doctool
to work.
OCR doctool
The OCR doctool DT_OCR.msi (available at
https://knowledge.opentext.com/go/14710919) must be installed. This
applies for all Document Pipelines.
Document Pipeline Base 9.7.1
Patch DPL-0971-037 must be installed if you want to use any of the
following Document Pipelines.
Document Pipeline for LES 9.7.0
Patch 003 must be installed.
Document Pipeline SAP 9.7.1
Patch DPL-0971-039 must be installed.
Document Pipeline DocuLink 9.7.1
Patch DPL-0971-038 must be installed.
The OCR doctool is currently not supported when using the Document
Pipelines for TCP.
CLM – Basics The CLM solution enables you to mix electronic and scanned documents on Livelink
ECM – Enterprise Server. CLM consists of a number of loosely coupled components.
The relation between components is implemented by means of barcode technology.
How does it CLM contains a module that, on user request, creates a placeholder for a document
work? inside the directory structure of Livelink ECM – Enterprise Server. The user request
is triggered by selecting the menu item Print Barcode inside the pop up menu for a
folder object. The placeholder for the document and the path to that location is then
associated with a barcode value. Enterprise Server 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
connection with the CLM module and conversion of the barcode value to the tuple
(name, path) or (name, volID|nodeID). To connect with the CLM module hosted by
Enterprise Server, a script is necessary, see “Sample Script” on page 202.
Important
The Document Pipeline for Livelink has to be always the last plug-in in
the flow.
4. Select the Document Pipeline for Livelink operation in the Flow field and click
the Configure button to configure the document format conversion.
The Configure Document Pipeline for Livelink dialog box opens.
Use rendering server
Select the check box to request the connection to Rendition Server.
Note: If you use the rendering server, the Advanced button in the
Configure Export to Livelink dialog box is disabled. The output file
format is set to the default value TIFF. Rendition Server will process the
TIFF images and convert them into searchable PDFs.
Rendering profile
Enter the name of the profile that is used for document conversion. For
details about Rendition Server profiles, refer to Open Text Rendition Server -
Installation and Administration Guide (RS-IGD).
5. Click the Configure button to determine the location in Livelink ECM –
Enterprise Server for the processed documents.
Root
Define the start location in Livelink ECM – Enterprise Server. You can re-
strict access to folders in either Enterprise or Personal workspace. This con-
figuration option must correspond to the home position in Livelink. This
configuration element controls the root whether or not the user requested
another root.
Important
Users can issue the request from within personal workspace.
However, the settings might override the root to the Enterprise
workspace and thus install an awkward situation.
Dynamic Folder
Provide the name of the attribute that has been defined in the plug-in Add
Document Attributes. The syntax is <attribute name>. Mind the symbols “<”
and “>” surrounding the attribute name. Without surrounding symbols, the
string is handled as a normal string. The surrounding symbols force
processing to handle the value as the name of an attribute. The release
process then replaces the attribute name by the attribute value.
The Dynamic Folder can be represented either by a path string or by a
combination volID|nodeID. All information is extracted using the Add
Document Attributes script. The script calls CLM modules at Enterprise
Server and requests conversion from the detected barcode to the four items
fully characterizing the document inside Enterprise Server.
Document Name
Provide the name of the document. Like for the Dynamic Folder, the
document name is dynamically created based on the value of the attribute
<document_name>. The attribute is defined inside the Add Document
Attributes plug-in.
Create new version if already exists
Select this check box to automatically generate a new version, if the docu-
ment already exists. If this check box is not selected, it prevents the release
module from creating a new version automatically.
Important
Unlike the direct release to Livelink scenario (see “Storing in Livelink”
on page 190), ContractManagement does not support any other
connection than native Livelink (typically port 2099). This scenario does
not support HTTP or HTTPS.
ContractManagement.BARCODE
BARCODE. GetDataForBarcode Method
Get the designation for the document reserved in Livelink ECM – Enterprise
Server. The designation consists of path, document name, volID, and nodeID.
The parameter is a barcode recognized for the document.
Public int GetDataForBarcode( int barcode, LLValue ret);
Parameter
int: integer value of a recognized barcode. This value is always used as
document index unless user overrides the settings.
LLValue: reference to data container. The data structure contains the following
items:
path
path to the document in Livelink ECM – Enterprise Server
docname
document name for the released document
volID
volume ID
nodeID
node ID
Return Value
Return error code. Zero means OK, other values represent failure.
Sample Script
// ATTENTION: This sample demonstrates the use of the Extended
LAPI function.
// The sample utilizes the existing functionality of
EnterpriseScan. Therefore
// the workspace needs be inserted before the scanning is carried
out. The workspace
// definition is part of EnterpriseScan configuration and cannot
be dynamically
// processed.
import Ixos.Scan.Extension.Livelink
import com.opentext.api
import ContractManagement
import System.Windows.Forms
if(Context.Contains("lapisession"))
{
session = LLSession(Context["lapisession"])
} else {
session = new LLSession( getCredentialsSession.Server,
getCredentialsSession.Port, "", getCredentialsSession.Username,
getCredentialsSession.Password, null )
Context["lapisession"] = session
}
LLCATEGORY4FOLDERS = [0|1]
0: The category is assigned to the document only. New default behavior.
my_attribute = nodeID|volID
Example:
Note: Mind the specific formatting of the tuple (nodeID, volID). The pair must
be always provided as one string, where the nodeID value is separated from
the volID value by the symbol “|”.
The attribute is then parsed by DOCTOLES and processed accordingly.
HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM
Caution
Be very careful when changing registry entries, because errors in the registry
can disrupt the functionality of your computer.
Note: The path to the storage and thumbnails cache can be customized by
registry entries.
[HKEY_CURRENT_USER\Software\IXOS\IXOS_ARCHIVE\6.0\Scan\HKLM\CustomSet
tings]
"S:PageThumbnailsPath"="C:\\Ixos\\Thumbnails"
"S:StoragePath"="C:\\Ixos\\Storage"
If registry keys do not exist or the paths to storage and thumbnails cache are not
accessible, the default paths in the LocalApplicationData folder are used, typically
in directory C:\Documents and Settings\<user>\Local Settings\Application
Data\Open Text\EnterpriseScan\9.7.
Tip: If you require additional help with technical problems, contact Open Text
Customer Support. You can find the contact information for your region at
http://www.opentext.com/services/support.html.
Use the Insert button to add new static groups and the Remove button to delete no
longer needed groups.
Create
Creates a new set of areas. Enter a name for the area set.
Copy
To copy a set, select the set in the Area sets list and click on the Copy button.
Then enter a name for the new set.
Remove
To remove a set, select the set in the Area sets list and click on the Remove
button.
Configure
To configure a set, select the set in the Area sets list and click on the
Configure button. The Configure Area Set dialog box opens, where you can
enter the settings for the set (see “Configuring area sets” on page 219).
Page Source for configuration dialog
Scanned documents
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.
Configure page size
When you set this option and click on the Settings button, you can select
the paper size for the blank page.
Select a Standard paper size or enter the parameters for Custom paper
size.
You can share, export and import these settings (see “Sharing, exporting and
importing the configuration” on page 223).
Also refer to the following Knowledge Center topic
(https://knowledge.opentext.com/knowledge/llisapi.dll/Open/15806606).
Warning
Do not edit any configuration settings within the XML file.
To upload the configuration, you must configure the settings inside Enterprise Scan
and then upload the configuration to an Archive Server user group.
S:SCANCONFIGMO The registry key S:SCANCONFIGMODE is located in the registry at
DE HKEY_LOCAL_MACHINE\SOFTWARE\IXOS\IXOS_ARCHIVE\6.0\Scan. 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 patch 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.
• 1 for Registry mode (default mode) – to store the configurations in the local
Windows registry
Note: If the registry entry is missing, Registry mode is used.
Server vs. See the following table for the differences of the 2 modes:
Registry mode
Table 16-1: Behavior of the configuration in Server mode and Registry mode
Configuration The configurations of Enterprise Scan 9.5.x and Enterprise Scan 9.7.x differ
Management essentially. This makes it necessary to migrate 9.5 configurations for use in
tool
Enterprise Scan 9.7.1. For uploading and downloading the configuration, as well as
for migrating 9.5 configurations, you can use the Configuration Management tool.
Important
To use the Configuration Management tool, S:SCANCONFIGMODE must be in
Server mode.
Note: The buttons in the Configuration Management dialog are only available
if you are logged in with Administrator privileges. Otherwise, they are
disabled.
Important
Complete the migration process before using the ScanCfgDownload tool
(described in “Switching between configurations assigned using ADMS” on
page 228). The modified configuration that is not uploaded yet will be
overwritten by the ScanCfgDownload tool.
For configurations of Enterprise Scan 5.1 that are available on the Archive Server,
you have to upgrade them to 9.5 before migrating them to 9.7:
The 5.1 configurations are upgraded to 9.5; so you can open them using
Enterprise Scan 9.5.x.
3. In the 9.5.x environment, upload the configurations to the Archive Server as 9.5
configurations, using the Livelink Imaging Configuration.
You can now proceed and migrate the 9.5 configurations to 9.7, as described in
“To download and migrate a 9.5 configuration:” on page 227.
Notes:
• Admin users can also use the Download button in the Configuration
Management tool to switch between configurations.
• The configuration will be downloaded only if the timestamp differs.
Notes:
• The configuration will be uploaded to the Archive Server to a user
group.
• You can rename the configuration in the User Group field.
4. Enter the User Name of the super user in the ADMS and the corresponding
Password and click OK.
The configuration is uploaded to the Archive Server and appears in the User
Groups for version 9.7 on <ADMS name> list.
2. Check the Off-line mode option if you want to toggle the off-line mode on.
When it is enabled, neither connection to the server nor archiving through the
Document Pipeline is possible.
3. LEA Server
In the Server name field, enter the name of the Archive Server on which the
archive modes are defined.
Enter the Port number.
Important
Since LEA Server 9.7.1, the default port number is 8080. Only LEA
Server 9.6.1 and older versions use port number 4060 by default.
Note: When you change the server or the port number, you must restart
Enterprise Scan to update the archive modes.
4. Document Pipeline
Click Use local pipeline or Use remote pipeline and enter the respective
parameters. The default values are shown in the particular fields. See “Remote
Pipeline” on page 187 for further information about the remote pipeline.
Notes:
• The Remote Pipeline Interface is supported by the Document Pipeline
for LES 9.7. To use the Remote Interface for the Document Pipeline for
LES, install Document Pipeline Remote Interface and Core Services on
the host where you want to run the Document Pipeline for LES 9.7.
Those additional components are bundled inside the master setup for
Document Pipeline for LES 9.7. See Open TextImagingEnterprise Scan -
Installation Guide (CL-IES).
• The parameters for the Document Pipeline target are application global.
They are used when releasing documents to Document Pipeline for
LES, Document Pipeline SAP, or Document Pipeline for Oracle
Applications.
If your archiving configuration for Document Pipeline SAP includes an archive
mode (stored on ADMS), the Document Pipeline target configured for this
particular archive mode takes precedence:
Remote pipeline
In case a remote Document Pipeline is explicitly configured in the archive
mode, the specified Document Pipeline target will be used. The Document
Pipeline target that is configured in Enterprise Scan will be ignored.
Local pipeline
In case a local Document Pipeline is configured in the archive mode, the
Document Pipeline target as specified in the local configuration of Enterprise
Scan will take preference. This local configuration may target either a local
Document Pipeline or a remote Document Pipeline.
5. Confirm your settings with the OK button.
8. Click the Connect button to establish the connection to the Enterprise Server.
Note: When you perform changes to the DT_DOCTOLES.Setup file, stop the
Archive Spawner service and start it again to activate the changes.
Profile
To configure anonymous submission for certain profiles, add a script like the
following sample to Set Document Pipeline Attributes (see “Configuring
Document Pipeline attributes” on page 181).
Document.COMMANDS += "\n";
Document.COMMANDS += "IGNOREDTCREDENTIALS true\n";
Important
If you are using the anonymous submission script in Set Document
Pipeline Attributes, do not archive into the Personal Workspace in
Enterprise Server because, as Admin user, you do not have the permission
to write to your Personal Workspace.
2. Enter the login information and the server information for your SAP System.
3. Click on the Connect button to test the connection to the SAP System.
Archive Server
Server name of the Livelink ECM – Archive Server connected to Enterprise Scan
(see “Administration Server and Document Pipeline” on page 231)
Start Archiving from
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.
Options
Remove deleted pages
Pages that are marked as deleted are removed and not sent to the archive.
Note format
Enter placeholders for the notes in Note format field. For an overview, see
“Placeholders for Notes” on page 297.
Default note
Define the default note for each document. The notes are attached to the
archived document. See also “Placeholders for Notes” on page 297.
Advanced
Clicking this icon opens the Advanced Settings dialog box. Adjust the output
file format as described in “Advanced settings for archiving” on page 196.
Important
In order to use the Monitor Web Client, the Monitor Server must 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 (see online help for details).
address the problem. To find the location of the Document Pipeline directory
(DPDIR) on the Document Pipeline host computer, open the Tools menu and click
LEA Administration and Pipeline.
Important
The content of the Knowledge Center entries is updated by Open Text
Customer Support independently of the content of this documentation.
Check that the information in the Knowledge Center entries corresponds to
the version of the Open Text products you use.
If you require additional help with technical problems, contact Open Text
Customer Support. You can find the contact information for your region at
http://www.opentext.com/services/support.html.
Log messages are displayed chronologically, with most recent at the top. Only log
messages (i.e. those of severities Fatal, Error, Warning and Note) are displayed.
Note: Trace messages are not displayed in the Imaging Clients Message Box.
The difference between log messages and trace messages is explained in
“Logging and tracing” on page 251.
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
This is the text of the log message, displayed in the language selected for the
Imaging Clients.
Show
The Show buttons filter the log messages to be displayed. By default, all buttons
are selected, which means that all classes of log messages are displayed (Fatal,
Error, Warning and Note).
If you disable a button, the messages of the corresponding severity class will be
removed from the message window.
Clear messages on dialog end
This option is activated by default. When the Imaging Clients Message Box is
displayed the next time, it will display only newly logged messages. If disabled,
previous log messages will be shown along with new ones.
Send logfile to
You can send the IXClient.log file to different applications or to mail
recipients. Click on 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 maximum number of messages to be kept in the error message stack is 100 by
default.
The Registry entry for maximum number of messages is
HKCU\SOFTWARE\IXOS\IXOS_ARCHIVE\CWin\DeMoS\MaxSizeOfMsgStack.
Important
If the value of MaxSizeOfMsgStack is set to 0, the Imaging Clients Message
Box will not appear in case of an error.
Important
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 the Imaging Clients. 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.
D:\>spawncmd
Here 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
-------------------------------------------------------------------------
Document Pipeline for Open Text Enterprise Process Services (Enterprise Scan
component only)
program-id sta pid start time stop time
-------------------------------------------------------------------------
docrm R 2224 11/19/2003 17:20:55
doctods_1 R 3148 11/19/2003 17:20:55
doctods_2 R 1112 11/19/2003 17:20:55
doctods_3 R 3864 11/19/2003 17:20:55
dp R 1624 11/19/2003 17:20:54
pmsdt R 2408 11/19/2003 17:20:55
stockist T 0 11/19/2003 17:20:55 11/19/2003 17:20:56
Output results Here is the description 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 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.
Important
The correct status for each DocTool and process can be found in “Status
of DocTools and processes” on page 254. 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, refer to “Spawner and Document Pipeline log files” on page 257.
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 monitoring Here are the pros and cons for the different monitoring tools: Spawncmd, Monitor
tools Web Client and Document Pipeline Info.
• The information provided by the spawncmd status command is similar to that
displayed by the Monitor Web Client (see “Monitoring archiving through
Document Pipeline” on page 243). However, the Monitor Web Client provides
information on the DocTools only, not on the other Document Pipeline
processes. On the other hand, the Monitor Web Client provides additional
information, such as the amount of free log disk space, and detailed information
about the objects being monitored (detailed DocTool status, number of
documents in input and error queues).
• The spawncmd utility gives accurate information more quickly than the Monitor
Web Client. On the other hand, information displayed by the Monitor Web
Client is refreshed regularly (by default every two minutes).
• The Document Pipeline Info gives the same information about DocTools and
document queues as the Monitor Web Client. Additionally, it allows an
administrator or power user to start and stop single DocTools, to resubmit
documents for processing and to delete documents from the queues (see
“Monitoring archiving through Document Pipeline” on page 243).
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 (see “Spawner and Document
Pipeline log files” on page 257).
Important
Be aware that some processes must be started in a defined sequence, so
simply restarting them will not solve a problem. It is better to restart the
Spawner itself (see “Stopping and starting the Spawner” on page 256).
You normally need this command for advanced troubleshooting purposes only.
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 31.1
"Spawner log file" in Open Text Archive and Storage Services - Administration Guide
(AR-ACN)</doc>.
Document There are no log files for Document Pipelines. Instead, the processes of the different
Pipeline log files DocTools are logged into the corresponding DocTool log files. The name of the log
file is the name of the DocTool plus the extension .log (e.g. the log file of the
DocTool docrm is docrm.log).
Tip: To find the names of the DocTools used by a particular Document
Pipeline, use Document Pipeline Info or Monitor Web Client. All the DocTools
are listed here by Document Pipeline. Mark the name of a processing step and
look at the status bar. The corresponding DocTool name is displayed (e.g. the
Remove document from document pipeline processing step corresponds to the
docrm DocTool).
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 31.1 "Spawner log file" in Open Text Archive and
Storage Services - Administration Guide (AR-ACN)</doc>.
Prepare scanning:
A good scanning preparation can simplify scanning and postprocessing of the
documents. Which steps are required depends on the quality of the paper
documents, your type of separation and so on.
1. Sort the documents according to the used scan profiles:
• Document content (e.g. invoices, offers)
• Document legibility (e.g. very good, normal, bad, very bad)
2. Insert empty pages for separating the individual documents, if needed.
3. <Insert additional preparation tasks.>
In the Indexing view, you enter the properties of the document that are later
used to retrieve the document in the archive. The cursor is in the first index
field. Mandatory fields are marked with .
In the Index Item view, the document part where the needed information for
indexing can be read is enlarged. This part highlighted in the View view in a
defined color (default: red) so that the area can be seen in context of the whole
page.
3. Read the property, e.g. the customer name, in the Index Item view and enter it
in the corresponding field in the Indexing view.
4. Press Enter to go to the next index field.
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 with the cursor into the respective index field to get
detailed error information.
5. Fill all index fields for the document.
6. Press F12 to archive the document.
The document is archived and the next document in the document stack
appears in the Index Item view.
7. Perform the indexing of all documents in the document stack.
8. Press F2 to archive all documents in the document stack.
The documents are archived.
Note: You can cancel the archiving operation with Stop. When the
archived documents have been handed over to the leading application, the
other documents stay in the document stack of the Enterprise Scan.
After all documents are archived, the document stack is empty.
9. <Enter here your scenario-specific steps for the archiving.>
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.
name Internal name of field (different from dis- var s:string = Field.Name
play name), read-only.
unit Specifies an abbreviation to display beside Field.Unit = "mm"
the string label that informs the user of the
units of measure.
b. Context information:
This is a persistent storage 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 profile is changed by the user, this information is lost. This can
be used by the script writer to save log in information etc. This is exposed as a
hash container and can be considered storage for "global" variables.
Context["hello"] = "world"
c. Validation result:
Within the validation 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 and Enterprise Scan leaves input focus inside the field in question.
Data objects are defined in the table below:
a. Information about the current document (available in the init script only):
Information Code sample Note
Barcode Document["Barcode"]
Patchcode Document["Patchcode"]
Endorser Document["Endorser"]
Index Document["Index"]
Group Document["Group"]
Pagecount Document.PageCount
Ixattr Document["IxAttrFile"]
Commands Document["CommandsFile"]
Page Document.Pages[<page_no>]
Unique ID Document["UniqueID"]
As per the table above, the Validate script is in all cases called at least once. This
gives the script writer the guarantee that even if the user does not fill any values in
the index mask, the validation process is enforced.
Notes:
• For the purposes of indexing, all index field types are processed the same
way, that means the scripts are fired according to the table above. There is
one exception and this is the picklist type of field. For this field, the
validation script is called as soon as the selection is changed by the user.
Based on the success or failure of this, the corresponding update script is
called.
• Due to the behavior mentioned above, multiple picklist type fields in a
mask can leverage this to create a cascading effect whereby one user
selection automatically updates the value of a number of other picklists.
Context This global object works exactly as in initialization, update and validation
scripts. Values are shared among all scripts.
var s = Context["MyVal"];
Context["YourVal"] = "Abcd";
The initial content of Fields is taken from the interactive part of indexing
(indexing mask). Each archived document receives a copy of the data;
therefore, a change made to one document index values is not propagated
to another document.
The Script field contains the script code available in the Global Function Depot.
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, 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 executed, the script from the Global Function Depot
will also be compiled along with the current script.
If the Global Function Depot contains a function which uses a script property, for
example Application.StopArchving 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,
see “Conditional compilation statements” on page 282.
Use the buttons Load, Save and Compile to open, store and test the scripts.
Use the References button to add a reference to third party libraries, see “Assigning
third party libraries” on page 170.
You can share, export and import global functions. See “Sharing, exporting and
importing the configuration” on page 223 for details. If you import global functions
on a computer with existing global functions, the imported global functions are
appended to the existing.
import System.Windows.Forms;
/*************************************/
function indexing()
{
//Field.Value = "something from global "
var i:int = Application.DocumentCount;
//MessageBox.Show(i.ToString());
}
@end
/*************************************/
/*************************************/
import Ixos.Scan.DocumentModel;
function prearchive()
{
var selectedDoc:IDocumentSelection;
selectedDoc = Application.ArchivingDocuments;
}
@end
/*************************************/
/*************************************/
@end
/*************************************/
//////Common functions
function global()
{
MessageBox.Show("Some global functions to call");
Try entering a number less than 5 in the Amount field; the check is done in the
validate script of the Amount field.
4. Using dependent picklists
Switch to profile: "Business trip reports"
Selecting a "Car make" will automatically refresh the values in the "Car Model"
field.
This is done in the update script of the "Car Make" field.
5. Logging steps in your script
When using the standard .NET logging, the information is stored in the
standard Scan log file IXClient.log
System.Diagnostics.Trace.WriteLine("Information to log").
Severity can also be passed as an optional feature for better classification of the
logs. Severity can be passed with 7 different levels using OTlog as:
System.Diagnostics.Trace.WriteLine("Information to log", OTlog.-
S_ERROR).
Fields.SetInt("0:xxx", 5);
To add document into category with id 1234 (category must exist on server,
there must be an integer field named yyy and no other mandatory fields), add
this line:
Fields.SetInt("1234:yyy", 5);
Latest version of category 1234 will be used. If you wish to specify the version
manually, change the field name from "1234:yyy" to "1234.<version>:yyy".
9. Zonal OCR enabling
The image area associated with the index item is accessible to script authors
within the init script in order to prefill index mask information. The specific
OCR engine to be used for this can be chosen by Open Text Consulting.
To use this function you have to define an init script in Enterprise Scan. For
details refer to “Scripts for indexing and archiving” on page 273.
You can copy this example script and adapt it to your needs:
import Ixos.Scan.Indexing;
import LeadToolsOCRWeb
import System.IO
if(Context.Contains("ocrsession"))
{
_sc = ScanOCREngine(Context["ocrsession"])
} else {
_sc = new ScanOCREngine()
Context["ocrsession"] = _sc
}
Field.Value = _sc.recognize("c:\\tmp\\testocr.tif").ToString()
File.Delete("c:\\tmp\\testocr.tif")
Note: This OCR scenario is completely independent from the OCR plug-in
in the processing subprofile.
Field.Choices.Clear()
if (tconnection != null)
{
sapProxy = new IxosSAPProxy.IxosSAPProxy()
sapProxy.Connection= tconnection
}
if (sapProxy != null)
{
// call the SAP function BAPI_COMPANYCODE_GETLIST
sapProxy.Bapi_Company_Getlist(&retVal, &companyList)
SAMPLE #2:
Create a new indexing fields (String Popup) [field1, field2] and in the
Initialization script of the field1 type the code below:
<CODE>
import System
import System.Diagnostics
import System.Collections
import IxosSAPProxy
import SAP.Connector
import Ixos.Scan.Extension.SAPExtension
Field.Choices.Clear()
if (tconnection != null)
{
sapProxy = new IxosSAPProxy.IxosSAPProxy()
sapProxy.Connection= tconnection
}
if (sapProxy != null)
{
try
{
sapProxy.Ixos_Sc_Generic_Function("BAPI_COMPANYCODE_GETLIST
", &strValid, &retVal, &pctData)
var count:int= pctData.Count
var i:int= 0
var entry1:IXOS_SC_S_DATA
For details refer to “Scripts for indexing and archiving” on page 273.
11. More than one barcode on a page
If a scanned page contains more than one barcode, there is a scripting option
(Initialization Script) to show the recognized barcodes' numbers in a field in
the Indexing view, separated by a “|”.
The corresponding script is:
var result:String = ""
if (Application.SelectedDocumentCount > 0)
{
var barcodes:Array = Document["Barcodes"]
if (barcodes != null)
{
var i:int;
for(i=0; i < barcodes.Length; i++)
{
if (result.Length > 0)
result = result + "|"
Field.Value = result
See “Configuring custom index field” on page 143 and “Scripts for indexing
and archiving” on page 273.
12. Enlarged barcode in the Index Item view
For an easier manual control of barcodes and document index, a script is
provided which shows the barcode enlarged in the Index Item view.
This script sets the area where the barcode has been found and recognized as a
defined area. The barcode is then automatically displayed enlarged in the Index
Item view, once the Indexing view gets the focus. This feature is intended to
enhance the manual control procedure when the operator optically checks the
barcode with the document index. The barcode is always zoomed inside the
Index Item view, no matter where the real position on the page is. The script is,
as follows:
Indexing initialization script:
-------------------------------------cut-------------------------
------------------
import System.Drawing;
import System.Windows.Forms;
import Ixos.Scan.Indexing;
Context["current"] = Document["UniqueID"]
if (Context[Context["current"]] == null)
{
if (Document["Index"] != null)
{
Context[Context["current"]] = Document["Index"]
}
else
{
Context[Context["current"]] = ""
}
}
if (Context["defaultRect"] == null)
{
Context["defaultRect"] = Field.IndexArea
}
var index:String
index = Context[Context["current"]]
if (Document["IndexArea"].IsEmpty() == false)
{
r.top = Document["IndexArea"].Top - margin
r.bottom = Document["IndexArea"].Bottom + margin + 100
r.left = Document["IndexArea"].Left - margin
r.right = Document["IndexArea"].Right + margin
Field.IndexArea = r
}
else
{
Field.IndexArea = Context["defaultRect"]
}
Field.Value = index
-------------------------------------cut-------------------------
------------------
Indexing validation script:
-------------------------------------cut-------------------------
------------------
Context[Context["current"]] = Field.Value
-------------------------------------cut-------------------------
------------------
Important
Document index will not be changed within the indexing field. Use the
following export scripting plug-in to get this effect.
-------------------------------------cut-------------------------
------------------
See “Configuring custom index field” on page 143 and “Scripts for indexing and
archiving” on page 273.
[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]*
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
• LEA-0002-3456789
• LEA-1234
• LEA-3456
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 have to be a repetition of 4 times 0-9.
[-]
Next character could be -.
[0-9]*
Characters 0-9 with a repetition from 0 to x.
([-][0-9]*)?
Matches LEA-(?!2345)[0-9]{4,4} and optional ([-][0-9]*).
Scenario 2 The following barcode values should be accepted:
• LEA-0001-2345678
• LEA-0002-3456789
• LEA-3456
• LEA-6789
Regular expression:
(LEA-(?!2345)(?!6789)[0-9]{4,4}([-][0-9]*)?)
To use the Enterprise Scan Webinterface: Scan & Index for folders:
1. Install Enterprise Scan on client side.
2. Start Enterprise Server.
3. The menu item Scan & Index appears in the context menu for a folder.
Important
The Scan & Index function is only available for object type Folder. The
release is not supported for other object types e.g. Document,
Discussion, Project, Channel, etc.
Indexing view – The user interface consists of several views. The position and
size of the views can be freely configured. The Indexing view constitutes a very
important part of the user interface. This view is dynamically built and reflects
the system of attributes associated with the folder in Enterprise Server, in which
the function Scan & Index has been called. Attributes originate in system
attributes as well as in categories.
Note: Indexing attributes in the Enterprise Scan Webinterface are “per
document”, that means they persist with the document, even when the
focus switches to another document or the application is closed.
Additionally, an attribute Document name is displayed.
6. 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:
• Select Yes to release the new version.
• Select No to skip the processing of the current document and proceed with
the next one.
• Select Cancel to interrupt the release operation immediately. Only the first
document is actually released.
Configuration
1. Configuration is implemented in the Livelink Administration page.
2. Locate the module Enterprise Scan Web Interface and click the link.
Important
Incorrect configuration of the module results in inaccessible functionality.
The menu item Scan & Index is not available for Personal and Enterprise
Workspace and virtually does not exist. The option Scan Group Name is
especially sensitive. A misspelled group name results in preventing all
Livelink users to use the function. This version provides neither Browse nor
Check buttons that would simplify the configuration of the field Scan
Group Name.
Archive Mode
Specifies the different archiving scenarios used by Enterprise Scan. The Archive
Mode is configured in the Open Text Administration.
Archive Server
Short term for Open Text Archive and Storage Services, formerly known as
Livelink ECM – Archive Server. The Archive Server stores the documents on
long-term storage media. It consists of several server software and services, a
database instance, connection to and management of storage systems, and
administration tools.
ArchiveLink
The interface between SAP and the Archive Server. The ArchiveLink DLL
ixar2_32.dll is used for communication.
Barcode
During mass scanning, the 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
Hierarchical document attribute in Enterprise Scan. In the hierarchy of attributes,
batch is located above folder. Hierarchical attributes can be assigned to
documents automatically during scanning or manually. The attributes are
displayed in the Properties view.
Configuration files
Configuration files contain configuration information for a particular program.
When the program is executed, it consults the configuration file to see what
parameters have been set. Important configuration files for Open Text Imaging
Clients are the install.ini file, which contains the installation configuration
for Windows Viewer, DesktopLink, and Enterprise Scan, and the viewer.cfg
files, which contain the configuration of Java Viewer and Web Viewer.
DocTools
Programs for automatically processing documents in a Document Pipeline.
Document Group
In the Enterprise Scan you can subdivide the documents in several groups. These
groups can be used to divide the archiving tasks between several employees.
Document Pipeline
A collection of processing modules (DocTools) that are used, for example, to
transfer or otherwise process documents to and in the Archive Server.
Document Stack
All scanned or imported documents that are currently displayed in the
Enterprise Scan.
DPDIR
The directory in which the documents are temporarily stored while being
processed by the Document Pipeline.
Endorser
Some scanner models support endorsing, i.e. a stamp is printed on each scanned
sheet to confirm scanning. The endorser is displayed in the Properties tab in the
Enterprise Scan.
Enterprise Scan
Short term for Open Text Imaging Enterprise Scan. It is a component of Open
Text Imaging. Enterprise Scan is designed for mass scanning scenarios: you can
scan documents from various input sources, sort them into documents and
archive these documents.
FaxLink
Functionality of Enterprise Scan that connects Enterprise Scan to fax or mail
servers (Microsoft Exchange Server, Lotus Domino Server).
Folder
Hierarchical document attribute in Enterprise Scan. In the hierarchy of attributes,
folder is located below batch. Hierarchical attributes can be assigned to
Index
Special collection of information used to locate documents or data objects more
rapidly during searches.
The scan operator can define the index information in a form before archiving
the document. The fields of this form are defined in Enterprise Scan itself, with
the TCP Modeler or on Livelink ECM – Enterprise Server.
The term Index has also a second meaning in the Enterprise Scan: In the Index
field of the Properties tab the recognized barcode or patch code is displayed (see
Barcode).
Indexing
Provision of additional information (index) to speed up search functions. When
record properties are indexed, values are entered in the properties fields of the
records. In general, user input is required here, or the values are automatically
extracted and entered from documents or from their context using special
processing modules (e.g. in a Document Pipeline).
Leading application
Software solution connected to a Livelink product, for example SAP, Siebel,
Microsoft Office SharePoint Server, ...
Patch code
See: Barcode
Registry
The Registry is an internal database used by Windows to store configuration
information. It is used as a replacement for configuration files, i.e. to manage
initialization data for applications.
You can edit the Registry directly with the Registry Editor (regedit.exe). Be
very careful, because errors in the Registry can prevent your computer from
functioning correctly.
Servtab files
Configuration files of the Spawner, which specify which DocTools and processes
to start and how.
Spawner
Service that starts and terminates the DocTools and processes of the Document
Pipelines.
L N
Landscape to portrait 114 Navigating 34
Late indexing scenario Note format 297
TCP 137
Leading application 15 O
archiving from 240 OCR 114
defining archiving settings 231 Open Text Capture Center
Legal guidelines 16 Archiving subprofile 181
Livelink Open Text Imaging Enterprise Scan 321
indexing and archiving scenario 140 Open Text Online 15
storing in 190 Oracle Web Service attributes
Livelink attribute User importing 159
indexing 158
Livelink attributes P
importing 151 Page processing 94
Livelink Barcode Module 198 Pages
Log files copying and pasting to other applications
Document Pipeline 258 36
IXClient.log 250, 251 deleting 40