Creating the FOSEnabler.ini File - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential
Note:

After making any changes to your FOSEnabler.ini file, you must relaunch both the Front Office Scanning Enabler Service and Application Enabler for those changes to take effect.

The FOSEnabler.ini file must contain the following settings. A detailed description of the settings in the FOSEnabler.ini file is given below.

Note:

While it is recommended that you use the following sample configuration file as a guide, a less comprehensive configuration file template is also created when you install the Front Office Scanning client using the Hyland Front Office Scanning installer. By default, this file template is stored in C:\Program Files\Hyland\Front Office Scanning\Template\FOS or C:\Program Files(x86)\Hyland\Front Office Scanning\Template\FOS. If you use this file template as a starting point, be aware that you must still edit, add, or remove settings as necessary to accommodate your Front Office Scanning solution.

[FOSEnabler]
SharePath=C:\Program Files\Hyland\Front Office Scanning\Patients
ActivateConsole=false
EncryptKeywords=true
ScrapeMsgDuration=2
ScrapeMsgText=Capture Successful!
ActiveKeywords=True

FOSEnabler.ini File Settings

Description

SharePath

This setting identifies the sharepath, or the shared location where Data Set XML files are stored. Set it to the path to the sharepath folder.

If your Front Office Scanning solution is configured to organize Data Sets by category, then this setting should be set to the path of the appropriate sub-folder of the sharepath folder instead of the path to the sharepath folder.

Note:

If you are configuring a Front Office Scanning solution where the Data Set XML files are stored in a network location accessible by the Application Server and then made available to the Front Office Scanning client via a web service, this setting is not needed.

ActivateConsole

This setting allows you to enable/disable Automated Console Mode for the Front Office Scanning client.

  • If ActivateConsole is set to true, then Automated Console mode is enabled.

    When Automated Console mode is enabled, the Front Office Scanning client is automatically launched when an Application Enabler screen scrape event is performed, and the Data Set captured by the screen scrape event is automatically used as the selected Data Set.

  • If ActivateConsole is set to false, then Automated Console mode is not enabled and the screen scrape event will not automatically launch the Front Office Scanning client.

Tip:

For more information on Automated Console mode, see Automated Console Mode.

EncryptKeywords

This setting controls if the Keyword Values captured by Application Enabler for Front Office Scanning Data Sets are encrypted or stored as plain text.

  • If EncryptKeywords is set to true, Keyword Values captured by Application Enabler and stored as Front Office Scanning Data Sets are encrypted and cannot be viewed outside of the Front Office Scanning client.

  • If EncryptKeywords is set to false, Keyword Values captured by Application Enabler and stored as Front Office Scanning Data Sets are stored as plain text and can be viewed outside of the Front Office Scanning client.

Tip:

In a production environment, the EncryptKeywords setting should always be set to true. The ability to disable Keyword Value encryption is included solely for installation/configuration and troubleshooting purposes.

ScrapeMsgDuration

This setting controls the amount of time (in seconds) that the successful capture message (i.e., the message represented by the ScrapeMsgText setting) is displayed.

By default, this setting is set to 1.5 seconds.

ScrapeMsgText

This setting allows you to customize the message displayed when a screen scrape event is performed and Data Set Keyword Values are successfully captured.

By default, the message is FOSEnabler – Capturing Keywords….

ActiveKeywords

This setting allows you to capture individual Keyword Values configured in conjunction with Application Enabler hotspots separately from the rest of the Keyword Values present in the line-of-business application.

For more information on configuring Application Enabler hot spots, see the Application Enabler documentation.