Configuring a Data Set Lifespan - 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

Depending on your configuration, it may be necessary to manage the Data Set XML files located in the sharepath folder. This may be particularly important to your solution if:

  • Data Sets are created, but not be used, leaving the outdated and unneeded Data Set XML files associated with unused Data Sets in the sharepath.

  • If your solution is configured to allow Data Sets to be reused (i.e., the reusedatasets setting in the FOSCONFIGURATION parent element is set to true), the Data Set XML files associated with Data Sets that are no longer needed to will remain in the sharepath.

If the sharepath is not properly managed, a large number of no-longer-needed and/or out-of-date Data Set XML files may be left in the sharepath. To help manage the sharepath folder, you can configure Data Sets to have a lifespan; a Data Set expires at the end of its specified lifespan and its Data Set XML file is automatically deleted.

The Data Set lifespan is specified in the DataSetLifeSpan element of the Front Office Scanning configuration file.

To configure a Data Set lifespan for your solution:

  1. In the Front Office Scanning configuration file, locate the DataSetLifeSpan element. If this element is not present, add it to the configuration file.
  2. Enter the amount of time (in hours) that Data Sets are to be available to the Front Office Scanning client directly between the DataSetLifeSpan tags.

    The Front Office Scanning client checks the difference between the current time on the Front Office Scanning workstation and the time that the Data Set XML files were created each time the Available Data Sets list is refreshed. Once the Data Set expires, the Data Set XML file associated with it is deleted from the sharepath and the Data Set is no longer available to the Front Office Scanning client.

    If the DataSetLifeSpan setting is not present, or is set to 0, the Data Set lifespan feature is disabled.

    Tip:

    When this feature is enabled, you can prevent a Data Set from being deleted by marking its Data Set XML file as read-only.

    CAUTION:

    If a user manually changes the clock on the Front Office Scanning workstation, Data Sets may be deleted even if they have not existed for the amount of time specified by the configuration setting.

    CAUTION:

    NTFS file systems store the file times in Coordinated Universal Time (UTC) whereas FAT file systems store the file times in local time. Therefore, time changes due to Daylight Savings do not affect Data Sets on NTFS systems but could shorten or lengthen the time a Data Set is considered valid on a FAT system.

    Tip:

    For more information on the Front Office Scanning configuration file's DataSetLifeSpan element and its settings, see The DataSetLifeSpan Element.

  3. Save and close the configuration file.