The Front Office Scanning Configuration File - OnBase/Front-Office-Scanning/Foundation-23.1/Front-Office-Scanning/The-Front-Office-Scanning-Configuration-File - 2023-09-11
Front Office Scanning
Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential
Documentation Notice
Overview
Introduction
Data Entry Workstations and the Front Office Scanning Workstation
Front Office Scanning & Application Enabler
Front Office Scanning & HL7
The Benefits of a Front Office Scanning Solution
Applications
System Prerequisites
Licensing
Simplified Licensing
Additional Licensing
Installation
Requirements
General Requirements
Client Scanning Workstation Hardware Requirements
Creating the FOS/Application Enabler Automated Console Registry Settings
Licensing
Pre-Installation
OnBase Requirements
OnBase Application Server
OnBase Client
Application Enabler
Additional OnBase Modules
Enabling Active Directory and LDAP Authentication
Enabling IdP Authentication
Upgrade Installation
Installation
Installer Options
Running the Front Office Scanning Client Installer
Change, Repair, or Remove an Installation
Running the Installer From the Command Line
Feature Names
Properties
Additional Installation Information
Specifying a Language Resource DLL
Manually Installing the Front Office Scanning Client
Installing the Front Office Scanning Enabler Service
Manually Installing and Registering the FOSEnabler.exe File
Administrative Installations
Skip Persistence
Registry Settings
LastLocation
OnTop
Application Server Web.config Settings
watchFolder
siteIDKeywordType
cleanupTimerInterval
maxFileAgeInHours
Command-Line Switches
Front Office Scanning Client
-LANG
Front Office Scanning Enabler Service
-REGSERVER
-UNREGSERVER
INI Settings
ConfigFile
Backup/Recovery
Backup
Configuration
Registry Settings
LastLocation
OnTop
External Files
Module-Related INI Options
Additional Steps
Recovery
Configuration
Registry Settings
LastLocation
OnTop
External Files
Module-Related INI Options
Registration
Additional Steps
Upgrade Considerations
Front Office Scanning Upgrade Considerations
Troubleshooting
Common Issues
Document Date Formats
Settings in the Configuration File Are Not Being Respected
Images Created from E-Forms Are of a Lower Quality than Expected
Images Created from E-Forms Not Being Displayed Correctly
Signature Pad Issues
Document Uploads and/or Retrievals are Slow or Failing
Notes, Redactions, Burned Markups, and Deficiencies on Documents with Overlays
Error Messages
‘Bad Configuration File' Errors
Data Set Errors
Scanning Errors
Importing Errors
Document Type Assignment Errors
Uploading Errors
Log On Errors
Contacting Support
Configuration
Configuration Overview
The Front Office Scanning Configuration File
Elements of the Front Office Scanning Configuration File
The FOSCONFIGURATION Parent Element
The Display Element
The ScreenName Element
The Columns Element
The SharePath Element
The DataSetSourceURL Element
The SiteID Element
The MaintainLocalCopyPath Element
The Application Element
The DataSetListText Element
The DataSetLifeSpan Element
The DataSetForm Element
The Printer Element
The CommParams Element
The ScanOptions Element
The TempPath Element
The Keywords Element
The DataSet Element
The Retrieval Element
The RetrievalDocTypes Element
The Filter Element
The MergeItems Element
The SignatureItems Element
The SignatureOnFilePath Element
The DocTypes Element
Configuring an Application Enabler/ Front Office Scanning Solution
Configuring Application Enabler to Capture Data
Configuring Front Office Scanning to Interact with Application Enabler
Creating the FOSEnabler.ini File
Determining how the Front Office Scanning Client Responds to Application Enabler
A Data Set is Created But Not Selected
An Existing Data Set is Selected (No Data Set Creation)
Automated Console Mode
Configuring an HL7 Import Processor/ Front Office Scanning Solution
Considerations for Configuring HL7
Message Templates
Process Settings
Encrypting Keyword Values
Creating a Directory Structure
Configuring the Front Office Scanning Client
Configure User Groups Rights for Front Office Scanning
Configuring Front Office Scanning Startup Options
Specifying a Default Configuration File for the Front Office Scanning Workstation
When Launching from the Windows Desktop
When Launching from the OnBase Client
Specifying a Default User Account for the Front Office Scanning Client
Enabling Active Directory or LDAP Authentication for the Front Office Scanning Client
Enabling IdP Authentication for the Front Office Scanning Client
Configuring the FOS Client to Automatically Close After Upload
Configuring Multiple Monitors for Front Office Scanning
Configuring Full Screen Swapping
Configuring Cloning
Supported Hot Keys
Specifying Scanners, TOPAZ Devices, or Touchscreen Devices
Specifying a Default Scanner, TOPAZ Device, or Touchscreen Device
Specifying a Scanner, TOPAZ Device, or Touchscreen Device at the Document Type Level
Configuring the Front Office Scanning Client to Prompt Users to Select a Scanner, TOPAZ Device, or Touchscreen Device
Configuring General Scanning Options at the Front Office Scanning Client Level
Enabling Batch Scanning
Specifying the Default Image Scale
Specifying a Default Printer
Configuring Front Office Scanning to Launch Another Application
Launching OnBase Disconnected Scanning from within Front Office Scanning
Configuring Scanner Settings
Buffered Transfer Mode vs. Native Transfer Mode
Compressed Scanner Data vs. Uncompressed Scanner Data
Specifying the Number of Pixels Per Color Plane
Configuring Upload Settings
Specifying an Upload Method
Encrypting Documents Awaiting Upload
Enabling Disconnected Mode for the Front Office Scanning Client
Saving a Local Backup Copy Upon Upload
Configuring Data Sets
Creating Data Sets
Configuring Data Set Keyword Types
Configuring Required Keywords
Configuring Non-Required Keywords
Configuring an HTML Form for Manually Creating Data Sets
Creating/Configuring the HTML Form
Modifying the Front Office Scanning Configuration File
Ordering Keyword Values in a Data Set
A Data Set created via HL7, an Application Enabler screen-scrape event, or Automatically by a Line of Business Application
A Manually Created Data Set
Specifying the Location of the Data Set XML Files
Configuring a Local Shared Folder
Configuring a Network Location
Configuring the Application Server To Use the Data Set Service
Configuring the Configuration File To Allow Data Set Retrieval from a Network Location
Configuring Site-Based Data Set Filtering
Configuring a Data Set Lifespan
Configuring Data Sets to Be Reusable
Configuring Data Set Sub-Categories
Configuring Keyword Value Validation
Configuring the Document Date To Be Editable
Configuring Front Office Scanning to Allow Document Retrieval
Enabling Front Office Scanning to Allow Document Retrieval
Specifying Retrieval Document Types
Specifying Retrieval Keyword Types
Specifying a Date Range for Document Retrieval
Retrieving Only the Most Recently Archived Documents
Printing Documents from the Related Documents List
Configuring Input Buttons
Enabling the Front Office Scanning Client to Display Multiple Input Buttons
Configuring an Input Button to Restrict Document Type Assignments
Configuring an Input Button to Scan Documents
Configuring Scanning Options at the Document Type Level
Configuring an Input Button to Acquire Still Images from a Webcam
Configuring an Input Button to Append Virtually Printed Documents to Documents in the Working Window
Configuring an Input Button to Create Documents from Image Templates
Specifying the Location of the Image Used as an Image Template
The Image Is Stored Locally or Is Accessible via a UNC Path
The Image Is Stored in OnBase
The Image Is Captured by the Hyland Virtual Print Driver
Specifying The Page of the Image Template To Be Displayed
Configuring an Input Button to Create an E-Form
Specifying the Location of the HTML Form To Be Used To Create E-Forms
The HTML Form Is Stored Locally or Is Accessible via a UNC Path
The HTML Form Is Stored in OnBase
Configuring E-Form Options at the Document Type Level
E-Form Limitations
Customizing the Text Labels on Your Input Buttons
Automatically Printing a Document Once It Is Created
Automating Document Type Assignments
Automating Document Type Assignments on a Global Level
Automating Document Type Assignments for an Individual Input Button
Automating Document Type Assignments to an E-Form for an Individual Input Button
Configuring Document Type Buttons
Assigning a Document Type to a Document Type Button
Customizing the Text Labels on a Document Type Button
Adding a Graphic to a Document Type Button
Specifying the Size of the Document Type Buttons
Configuring a Required Document Type
Configuring a Document Type Button Filter
Configuring the Settings of a Filter
Assigning a Filter ID to a Document Type Button
Considerations for Manually Creating Data Sets
Configuring a Document Type Button to Allow Signatures To Be Applied to a Document
Configuring a Document Type Button to Capture a Signature as a Markup from a Signature Device
Configuring a Document Type Button to Use a Signature on File
Specifying a Default Scanner, TOPAZ Device, or Touchscreen Device for a Document Type Button
Automatically Printing Documents After Document Type Assignment
Configuring a Document Type Button to Allow Documents To Be Copied
Enabling Document Copying for a Document Type Button
Allowing Multiple Documents to be Assigned to a Document Type
Configuring Documents to Be Uploaded as a Batch of a Scan Queue
Configuring General Document Options at the Document Type Level
Configuring Markup Options at the Document Type Level
Configuring Merge Items
Configuring Document Merge Items
Creating a Document Merge Item
Assigning a Document Merge Item to a Document Type
Configuring a Data Set Keyword Merge
Configuring a Data Set Keyword Merge Item
Assigning a Data Set Keyword Merge to a Document Type Button
Configuring an Image Merge
Configuring an Image Merge Item
Assigning an Image Merge to a Document Type Button
Configuring a Signature Merge
Configuring a Signature Merge Item
Assigning a Signature Merge Item to a Document Type Button
The Front Office Scanning Configuration File
Configuration File Overview
Sample Front Office Scanning Configuration File
The Front Office Scanning Data Set File
Data Set File Overview
Sample Front Office Scanning Data Set XML File
Scanning Feature Matrix
Scanning Feature Matrix Overview
Scanning
Scan Methods
Scan Formats
Scanning Complete Dialog Box Options
Sweeping
Scanning from Disk
Batch vs. Ad Hoc Import
Viewing Documents
Image Document Options
Deleting/Reordering Pages
Rubber Band
Image Markups
Indexing Documents
Keywords
Batch Processing
QA Processes
Scripting
HL7
Application Enabler
Virtual Print Driver
E-Forms
Unity Forms
Scheduling
Legacy Licensing
Legacy Licensing Introduction
Overview
Additional Licensing
Front Office Scanning Best Practices
Recommended Best Practices
Solution Design
General Usage
Registering Front Office Scanning in the OnBase Client
Removing Old/Outdated Data Sets
Printing Documents Scanned/Created in the Front Office Scanning Client
Configuration
Configuring the Front Office Scanning Enabler Service
Configuring Data Set Settings
Configuring Input & Document Type Buttons
Creating E-Forms in the Front Office Scanning Client
Keyword Values
Keyword Type Mapping in Disconnected Mode
Converting E-Forms to Images
Specifying the Resolution of an Image
Installation
The Front Office Scanning Client
Usage
General Usage
Workstation Registration
Registering a Workstation
Verifying and Revoking Workstation Registrations
Clearing Excess Workstation Registrations
Workstation Cleanup
View Current Users
The Front Office Scanning Client Overview
Opening the Front Office Scanning Client
Configuring the Front Office Scanning Client to Open Automatically
Resolving Session Interruption
Resolving Session Timeout
Resolving Session Invalidation
The Front Office Scanning Client
Front Office Scanning Client Layout
The Front Office Scanning Toolbar
Exiting the Front Office Scanning Client
General Setup
The Data Entry Workstations
Using Application Enabler on the Data Entry Workstation
Starting the FOSEnabler Service
Enabling/Disabling the Front Office Scanning Enabler Service to Create Data Sets
Stopping the Front Office Scanning Enabler Service
Initiating a Screen Scrape Event
The Front Office Scanning Workstation
Selecting a Data Set
Selecting a Data Set from the Data Set List
Manually Entering Keyword Values into an Existing Data Set
Sorting Data Sets
Deleting a Data Set
Selecting the Data Set Category
Manually Creating a Data Set
Scanning/Creating Documents
Scanning a Document
Scanning Documents Using Batch Scanning
Creating a New Document by Importing an Image or PDF Document
Importing a Multi-Page Image or PDF Document to Create Multiple Documents
Importing Multiple Image Documents as a Single Document
Creating a Document from an Image Template
Marking Up an Image Template in the Front Office Scanning Client
Marking Up an Image Template Using a Signature Device
Adding the Signature as a Markup to an Image Template
Stamping the Signature on the Image Template
Stamping a Signature on File on the Image Template
Creating an E-Form
Stamping a Signature on an E-Form
Stamping a Signature on File on the E-Form
Working with Documents in the Working Window
Single Page, Full Screen, & Thumbnail View
Single Page View
Full Screen View
Thumbnail View
Printing Documents
Print Preview
Performing Document Retrieval in the Front Office Scanning Client
Viewing a Related Document
Copying an Existing Document
Reindexing a Related Document
Printing Related Documents
Deleting a Related Document
Refreshing the Related Documents List
Uploading Documents to OnBase
Viewing Documents Pending Upload
Deleting Documents Pending Upload
Reindexing Documents Pending Upload
Refreshing the List of Documents Pending Upload
Uploading Documents Pending Upload
Restarting Pending Uploads
System Maintenance
Cleaning Up Outdated/Unused Data Sets
System Interaction
Application Enabler
AutoFill Keyword Sets
Disconnected Scanning
Document Imaging
HL7
E-Forms
Virtual Print Driver