Configuration

XML Index Document Import Processor

Platform: OnBase
Product: XML Index Document Import Processor
Release: Foundation 24.1
License: Premier; Essential; Standard

Documentation Notice
Overview
Introduction
Process Overview
About This Manual
Licensing
Simplified Licensing
Legacy Licensing
Licensing - Additional Functionality
Installation
Requirements
General Requirements
Licensing
Upgrade Considerations
Installation
Command-Line Switches
Applying the –SCHED Switch
INI Options
DIPTextNumberOfPages
DIPDeleteSource
DIPDeleteSourceFile
DIPDocumentPerFile
Process Tuning Parameters
Process Tuning
Lock Disk Group During Processing
Document Handle Block Size
System File Name Block Size
Keyword Block Size
Keyset Block Size
Checks Per File
Status Window Update Interval
Backup / Recovery
Backup
Configuration
Registry Settings
External Files
Preprocessors
Module-related .INI Options
Recovery
Configuration
Registry Settings
External Files
Preprocessors
Module-Related INI Options
Registration
Directory Structure
Troubleshooting
Common Issues
>>Rendition & >>Rendition/New Document Keyword Troubleshooting
Contacting Support
Configuration
Configuration Overview
Create an XML Index DIP Format
Process Settings Configuration
The Processing Tab
Download and Process
Download Protocol
FTP Download Considerations
Using FTP with No Download
Preprocess Options
Configure a Preprocessor
Set a Backup Path
Other Processing Options
The Options Tab
The Advanced Tab
The Medical Tab
Send to Scan Queue - Automatically Commit Batches
Document Types
Document Type Default File Format Considerations
Process Settings
XML Index DIP Field Order Configuration
Understanding Field Tags
Conditional Keyword Values
With a Child Attribute Value Based on the Value of the First Attribute of the Immediate Parent Element.
With Element Text Based on the Value of the last Attribute in the Target Element
With a Target Attribute Based on a Target Element's First Attribute Value
With Element Text Based on the Value of another Element within the Target Element
Document Types Within the XML Import Index File
Using Relative XPaths
Absolute Path Configuration
Field Order
Relative Path Configuration
Field Order
Copying Field Configurations
Assigning Processor Notification Groups
User Group Rights
Document Types
Product Rights
Privileges
Configuration Rights
Renditions and XML Index DIP
Rendition Criteria
When Rendition Criteria Are Not Met
Multiple Matching Files and Rendition Rules
Adding Notes to Documents During An XML Index DIP Process
Keyword Configuration
Date Formatting
Date Formatting Options
Currency Formatting Options
Multi-Instance Keyword Type Groups and XML Index DIP
The Number of Instances of the Multi-Instance Keyword Type Group
The Presence & Order of Keyword Values in the Document
Configuring Processor Notifications
Configuring a Processor Notification Group
Configuring a Processor Notification
Configuring the Distribution Service
Changing or Editing an XML Index DIP Format
Edit a Format
Delete a Format
Rename a Format
Index Extraction Format
Working with Reports
Adding Comments to a Verification Report
Accumulate Processing Information
Configuration Reports
Run Configuration Reports After Configuring New Disk Groups, Document Type Groups, Document Types or Keywords
Global Client Settings
Scheduling
Scheduling Overview
Configuring & Using the Scheduler
Requirements for Configuring/Running a Scheduled Process
Using the -SCHED and -SCHEDINST Switches
-SCHED
-SCHEDINST
Verifying the Scheduler is Running
Running Multiple Scheduled Processes
Scheduled Process Configuration Reports
Working With Process Formats
Creating a Scheduled Process Format
Schedule Configuration
Calendar
Default Daily Schedule
Selected Day
Processing Options
Viewing Scheduled Processes
Modifying a Scheduled Process Format
Deleting a Scheduled Process Format
Running/Suspending a Scheduled Process Format
Working With Process Jobs
Creating a Job
Configuring a Job
Scheduling a Job
Schedule Configuration
Calendar
Default Daily Schedule
Selected Day
Processing Options
Viewing a Job
Modifying a Job
Renaming a Job
Deleting a Job
Running/Suspending a Job
Viewing the Activity Log
Enabling Processor Status Log
Processor Status Log Messages
Creating Schedule Templates
Calendar
Default Daily Schedule
Selected Day
Configuring Schedule Logging
Creating a Scheduler Workstation Group
Editing a Scheduler Workstation Group
Deleting a Scheduler Workstation Group
Scheduling a Commit
Import Index File
Overview of the Import Index File
XML Import Index Parameters
Important Considerations for the Import Index File and XML Index DIP Format
Field Order Considerations
Date and Currency Formatting Considerations
XML Import Index File Read/Write Access
In-Place XML Index DIP Configuration Window
File Name, File Path and Full Path Character Length
Configuring an In Place XML Index DIP Process to Run Silently
Examples of XML Index DIP Format Process Settings and Field Order
Absolute XML Example
Relative XML Example
Default Keyword Types
Default Keyword Types Used in XML Index DIP Processes
Note-Specific Default Keyword Types
Check Processing Download Protocols
Available Check Processing Download Protocols
Accessing Check Processing Download Protocols
User Group Rights
Overview of User Group Rights
Client User Group Configuration
Admin User Group Configuration
XML Index Document Import Processor Best Practices
XML Index Document Import Processor Best Practices Overview
Usage
Store Files on the Processing Workstation
Use As Few Index Files as Possible
System Administration & Maintenance
Commit Batches Regularly
Purge Incomplete Process and Incomplete Commit Queues
Periodically Check to Ensure Processes are Accurate
View Verification Reports
Review the SYS-Unidentified Items Document Type
Ensure Temporary Disk Space is Sufficient
Monitor Disk Group Space and Database Size
Maintain Processing Queues
Maintain Backup Locations
Delete Files After Processing
Configuration
Use Absolute Path Configuration
Validate Your XML Code
Settings
Processing Tab
Download and Process Section
FTP Download
Preprocess Options Section
Options Tab
Add Documents to Workflow Option
Installation
Workstation Location
Licensing
Usage
Primary Usage (Main Concepts)
Register the Workstation
Verifying Registration
Running an XML Index DIP Process
The ERROR_FILES Folder
Verifying the Process
Verify the Batch
Commit or Purge the Batch
Committing a Batch
Purging a Batch
Deleting a Batch that has Been Committed
Committed Queue Options
Running An In-Place XML Index DIP
Additional Usage (Secondary Concepts)
Create Keyword List
Extract Index Information
AutoFill Keyword Set Considerations
Process Multiple Files into One Document Using XML Index DIP
Multiple Image Files Processed Into One Document
Expand AutoFill Keyword Sets
Administrative Concerns
Maintenance Tasks for XML Index DIP Queues
Ensure Batches are Committed on a Regular Basis
Check for Incomplete Processes or Incomplete Commits
Check Daily Verification Reports by Accumulating Processing Information
Purge the Daily Report
View SYS Unidentified Items
View Batch History
Batch History
Generating a Document History Report
Clean Up Queues
Network and Database Concerns
Access
Monitor Database Space
Processing Resource Consumption on the Database Server
Ensure Data File Location Space is Sufficient
Maintain/ Clean Up Data Backup Areas
Delete the Data Files From Their Original Location
Delete the Import Index File From Its Original Location
Disk Group Document Types
XML Import Index File
Imported Files
Verification Report
Disk Group Maintenance - Monitor Available Space
Document Type, File Format and Keyword Concerns
Document Types and File Formats
Note Types
Keyword Values
Keyword Type Groups
Documents do not have to be Committed to be able to be Viewed
Adding New Document Types to an existing XML Index DIP Format
Periodically Review Documents Imported Using XML Index DIP
Review the Process to Change Keyword Values and Re-Index Documents
View/Change Keyword Values
Re-Index a Document
Security
Network Security
User Group Security
System Interaction
Document Imaging
E-Forms
Exporting and Importing
OCR
Verification Reports
The Importance of Verification Reports
What is a Verification Report?
Why Incorporate Verification Reports into the Processing Procedure?
What Can a Verification Report Identify?
Errors Concerning Document Types
Errors Concerning Keywords
Errors Concerning Identifying Documents
Inaccurate Number of Documents and Pages
How Do You Access a Verification Report?
Opening a Verification Report from a Batch
Opening a Verification Report from the Document Search Results List
Can a Verification Report be Added to a Workflow Life Cycle?

Back to home page