The FOSCONFIGURATION Parent Element - 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

The FOSCONFIGURATION parent element contains general Front Office Scanning system options.

It also indicates the beginning and the end of the Front Office Scanning configuration file.

<FOSCONFIGURATION FileImportPath="C:\FOS\Default Image Import" PreventAutoFillOnUpload="true" encryptfiles="false" multiplepaths="true" aedatasetselect="false" reusedatasets="false" foregroundupload="true" disconnected="false" deleteafterimport="true" closeafterupload="false" UseSOAPUpload="false" UseSOAPDownload="false" maintainLocalCopy="false" allowmodifykeywords="false" RemoveSharePathDataSetsOnClose="false" imagepng="false" DisableFileImport="" FileImportSpec="">
Note:

The name of the FOSCONFIGURATION parent element must be in all capital letters for the Front Office Scanning configuration file to load successfully.

The following settings are found in the FOSCONFIGURATION parent element:

FOSCONFIGURATION Parent Element Settings

Description

FileImportPath

This setting allows you to specify a default folder location to initially display in the Open dialog when performing an ad hoc import of an image file into the Front Office Scanning client (i.e., by selecting File | Import Image File).

You can specify either a local path or a UNC path. For example:

  • FileImportPath="C:\FOS\Default Image Import"(local path)

  • FileImportPath="\\test-000100\FOS\Default Image Import"(UNC path)

PreventAutofillOnUpload

This setting allows you to prevent AutoFill Keyword Sets from being expanded when uploading documents to OnBase from the Front Office Scanning client.

  • If PreventAutofillOnUpload is set to true, then AutoFill Keyword Sets will not be automatically expanded when you upload documents to OnBase from the Front Office Scanning client.

  • If PreventAutofillOnUpload is set to false, or if no value is present, then AutoFill Keyword Sets will be automatically expanded when you upload documents to OnBase from the Front Office Scanning client.

Note:

In order to expand AutoFill Keyword Sets when manually creating a Data Set within the Front Office Scanning client (i.e., when the KeywordAutofill setting is set to true), the PreventAutofillOnUpload setting must be set to true.

encryptfiles

This setting controls if documents scanned/created in the Front Office Scanning client (and their corresponding indexing information) are encrypted while being temporarily stored on the Front Office Scanning client workstation and during upload.

  • If encryptfiles is set to true, then documents and their indexing information are encrypted while pending and during upload to OnBase.

  • If encryptfiles is set to false, or if no value is present, then documents and their indexing information are not encrypted while pending and during upload to OnBase.

multiplepaths

This setting allows you to filter the Data Sets displayed in the Available Data Sets list by allowing users to select which sub-folder(s) of the sharepath folder they would like to access Data Sets from.

  • If multiplepaths is set to true, then the user at the Front Office Scanning workstation can select which sub-folders of the sharepath folder they would like to display Data Sets from in the Available Data Sets list.

  • If multiplepaths is set to false, or if no value is present, then the Front Office Scanning scanning workstation will display all Data Sets available in the sharepath folder in the Available Data Sets list.

Note:

The functionality offered by this setting is only available if your Front Office Scanning solution is designed to access Data Sets from a shared folder. It is not available if your Front Office Scanning solution is designed to retrieve Data Sets from a network location via your OnBase Application Server.

In order to use the functionality offered by this setting, additional configuration is required. For more information, see Configuring Data Set Sub-Categories.

aedatasetselect

This setting allows you to automatically select a Front Office Scanning Data Set when an Application Enabler screen scrape event is performed and a Data Set already exists with the same values as those obtained from the screen scrape event.

Note:

The Front Office Scanning Enabler Service is not required to use this feature.

  • If aedatasetselect is set to true, then an existing Front Office Scanning Data Set is selected when an Application Enabler screen scrape event is performed if the Data Set values match the values obtained from the screen scrape event.

    This setting also prevents the Front Office Scanning client from automatically refreshing the Available Data Sets list. The Front Office Scanning client is unresponsive while the Available Data Sets list is being refreshed; unnecessarily refreshing it may be undesirable to users.

  • If aedatasetselect is set to false, or if no value is present, then no Data Set is selected when the Application Enabler screen scrape event is performed.

Note:

To use the functionality offered by this setting, the Front Office Scanning client, Application Enabler, and the line of business application that the values are being captured from must all be running on the same workstation.

Tip:

If a Data Set with the same values as those obtained from the screen scrape event does not already exist, no Data Set is selected in the Front Office Scanning client. To create a Data Set via an Application Enabler screen scrape event and then automatically select it in the Front Office Scanning client, see The Display Element.

reusedatasets

This setting is used to determine what happens to Data Sets after they are used.

  • If reusedatasets is set to false, or if no value is present, Data Set XML files (and the Data Sets they represent) are automatically deleted once they are associated with one or more documents and the document(s) are uploaded to OnBase.

  • If reusedatasets is set to true, Data Set XML files (and the Data Sets they represent) are not deleted and remain available for use after they are associated with one or more documents and the document(s) are uploaded to OnBase.

Note:

Regardless of the value of the reusedatasets setting, manually created Data Sets are always deleted once they are associated with a document that is uploaded to OnBase.

Tip:

If reusedatasets is set to true, it should ALWAYS be used in conjunction with the DataSetLifeSpan setting to ensure that the Data Set XML file (and the Data Set it represents) is eventually deleted. If the reusedatasets setting is not used in conjunction with the DataSetLifeSpan setting, Data Sets will never be automatically deleted and will continue to accrue in the sharepath folder.

foregroundupload

This setting is used to specify how documents are uploaded to OnBase.

  • If foregroundupload is set to false, or if no value is specified, then documents are uploaded using a background upload process while users continue to perform other tasks in the Front Office Scanning client.

  • If foregroundupload is set to true, then the upload process takes place in the foreground and users are unable to perform other tasks in the Front Office Scanning client until the upload is complete.

Note:

This setting must be set to true when configuring the Front Office Scanning client to close automatically after a document is uploaded to OnBase(i.e., the closeafterupload setting is set to true).

disconnected

This setting allows you to enable Disconnected mode for your Front Office Scanning client workstations.

  • If Disconnected is set to true, then your Front Office Scanning client workstations will run in Disconnected mode.

    In Disconnected mode, users are able to scan/create documents for multiple Data Sets using the Front Office Scanning client (i.e., select the first Data Set, scan/create documents for that Data Set, select a second Data Set, scan/create documents for that Data Set, etc.) and queue them locally on the workstation until they can all be uploaded to OnBase at a later time.

  • If Disconnected is set to false, or if no value is present, then your Front Office Scanning client workstation will run in Standard mode.

    In Standard mode, all documents associated scanned/created for a Data Set must be uploaded before another Data Set can be selected and documents can be scanned/created for it.

For more information, see Determining how the Front Office Scanning Client Responds to Application Enabler.

deleteafterimport

This setting allows you to automatically delete a document from its source location once you import it into the Front Office Scanning client.

  • If deleteafterimport is set to true, then any document you import into the Front Office Scanning client is automatically deleted from its source location.

  • If deleteafterimport is set to false, or if no value is present, then any document you import into the Front Office Scanning client also remains in its source location.

closeafterupload

This setting allows you to configure the Front Office Scanning client to automatically close after a document is uploaded to OnBase.

Note:

In order to use this setting, the foregroundupload setting must be set to true. This prevents the Front Office Scanning client from closing before background uploads are completed and prevents users from performing additional actions in the Front Office Scanning client before it is closed.

  • If closeafterupload is set to true, then the Front Office Scanning client will automatically close after a document is uploaded to OnBase.

  • If closeafterupload is set to false, or if no value is present, then the Front Office Scanning client will remain open after a document is uploaded to OnBase, allowing you to scan/create additional documents.

UseSOAPUpload

This setting controls which transfer method is used to upload documents from the Front Office Scanning client to OnBase.

Note:

The SOAP XML transfer method should only be used if the binary method is not functional due to environment issues.

  • If UseSOAPUpload is set to true, then the SOAP XML transport method is used to upload documents into OnBase.

  • If UseSOAPUpload is set to false, or if no value is present, then the binary transport method is used to upload documents into OnBase.

UseSOAPDownload

This setting controls which transfer method is used to retrieve documents within the Front Office Scanning client.

Note:

The SOAP XML transfer method should only be used if the binary method is not functional due to environment issues.

  • If UseSOAPDownload is set to true, then the SOAP XML transport method is used to retrieve documents within the Front Office Scanning client.

  • If UseSOAPDownload is set to false, or if no value is present, then the binary transport method is used to retrieve documents within the Front Office Scanning client.

maintainLocalCopy

This setting controls whether a local copy of each document is saved before the document is uploaded to OnBase. The location of the local copy is specified using the MaintainLocalCopyPath element.

  • If maintainLocalCopy is set to true, then each time a document is uploaded to OnBase, a local copy of that document is saved to the location specified in the MaintainLocalCopyPath element.

  • If maintainLocalCopy is set to false, or if no value is present, then no local copy of the document is saved upon upload to OnBase.

allowmodifykeywords

This setting allows you to modify existing Keyword Values that are associated with a selected Data Set from within the Front Office Scanning client.

  • If allowmodifykeywords is set to true, then you are able to modify existing Keyword Values that are associated with a selected Data Set from within the Front Office Scanning client.

  • If allowmodifykeywords is set to false, or if no value is present, then you are not able to modify existing Keyword Values that are associated with a selected Data Set from within the Front Office Scanning client.

Note:

Modifying Keyword Values in this way will not affect the Data Set XML file.

Note:

This setting has no impact on your ability to modify the Keyword Values associated with a manually created Data Set.

Note:

If there is no Keyword Value associated with a Keyword Type for a selected Data Set, a Keyword Value can be manually entered into that Data Set from within the Front Office Scanning client. This is true even if allowmodifykeywords is set to false. See Manually Entering Keyword Values into an Existing Data Set for more information.

RemoveSharePathDataSetsOnClose

This setting controls whether all Data Set XML files are deleted from the sharepath after the Front Office Scanning client is closed.

  • If RemoveSharePathDataSetsOnClose is set to true, all Data Set XML files will be deleted from the sharepath when the Front Office Scanning client is closed.

  • If RemoveSharePathDataSetsOnClose is set to false, or if no value is present, then the Data Set XML files will not be deleted from the sharepath when the Front Office Scanning client is closed.

Once the Data Set XML files are deleted, the Data Sets are no longer available to the Front Office Scanning workstations.

CAUTION:

Depending on your configuration, the Data Set XML files may be deleted from the sharepath for other reasons (e.g., when the reusedatasets setting is set to false and a Data Set XML file is associated with one or more documents and the document(s) are uploaded to OnBase). Setting RemoveSharePathDataSetsOnClose to false will not prevent the deletion of the Data Set XML files in those cases.

Note:

If the DataSetSourceURL element is set to true, this setting is ignored.

Tip:

When RemoveSharePathDataSetsOnClose is set to true, you can prevent a Data Set from being deleted by marking its Data Set XML file as read-only.

imagepng

This setting controls how temporary image files and images created from E-Forms are stored.

  • If imagepng is set to true, all temporary images and image files created from E-Forms will be stored as uncompressed PNG images.

  • If imagepng is set to false, or if no value is present, all temporary images and image files created from E-Forms will be stored using the default image file formats.

Note:

Setting imagepng to true may increase the quality of temporary images and images created from E-Forms. However, uncompressed PNG images require more space than the default temporary image formats.

DisableFileImport

The DisableFileImport setting allows you to disable the File | Import File menu option, preventing users from importing an image or PDF document into the Front Office Scanning client.

  • If DisableFileImport is set to true, the File | Import File option is disabled.

  • If DisableFileImport is set to false, or if no value is present, the File | Import File option is enabled when a valid data set is available in the Front Office Scanning client.

FileImportSpec

This setting allows you to specify default file types to initially display in the Open dialog box when performing an ad hoc import of a file into the Front Office Scanning client.

You can specify either a single file type or a set of file types. Each file type is represented by its extension, and each extension must be preceded by the * wildcard. If more than one file type is set, each corresponding extension must be separated by semicolons. For example:

  • FileImportSpec = "*.pdf"(a single file extension)

  • FileImportSpec = "*.jpg;*.pdf"(multiple file extensions)(

When FileImportSpec is set to one or more file extension, the Open dialog box will be displayed with a default filter that corresponds to your setting. For example, if you set FileImportSpec = "*.pdf"(as in the first example above), only PDF files will be displayed by default.

Note:

When FileImportSpec is set to one or more file extension, you still have the option to display all file types once the Open dialog box is displayed.

If FileImportSpec="", or if the element is not present, the default Open dialog box will be displayed.