Scheduled Archive - Archive Services for Microsoft SharePoint - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Archive Services for Microsoft SharePoint

Platform
OnBase
Product
Archive Services for Microsoft SharePoint
Release
Foundation 22.1
License
Standard
Essential
Premier

This archive method automatically archives documents and revisions according to mappings and rules after a specified period has elapsed. When the scheduled process runs, a verification report containing information about the archived documents is automatically generated and stored in the SYS Verification Reports Document Type. To facilitate searching, the report name includes the name of the content type. (Content type names longer than 14 characters may be truncated, depending on the configured maximum for the Description Keyword Type in OnBase.)

For scheduled archival to work, the user account running the SharePoint application's application pool must have Read/Write access to the SharePoint configuration database and also must be granted the db_owner role on this database.

CAUTION:

If a SharePoint value has more characters than the mapped OnBase Keyword Type allows, then the value is truncated on the archived document. The verification report captures warnings for Keyword values that have been truncated.

Note:

After configuring a content type for scheduled archival, restart the SharePoint Timer Service to ensure the new timer job will run. This service is administered in the Windows Services console.

Available options are described in the following table:

Options

Description

Enable Scheduled Archive

Automatically archives a document the specified amount of time after the document has been created or modified.

You can set up rules that documents must meet in order to be archived. To set up rules, see Rules. If no rules are specified, every document in the library is eligible for scheduled archival.

Note:

If the mapped Document Type is not revisable, documents that meet specified criteria are re-archived each time the scheduler runs.

Time Span

In the Days, Months, and Years fields, specify the period of time that must elapse before a document is archived.

Time Elapsed Since

Created

Select if you want documents to be archived the specified Time Span after documents are created.

Modified

Select if you want documents to be archived the specified Time Span after documents are modified.

Run Time Interval - Global for all scheduled content types.

This setting applies to all content types that are configured using the scheduled archive method. If you change this setting on one content type, all content types using the scheduled archive method are affected.

Once Daily Mode

Select to have the scheduled archival service check for qualified documents once a day. In the Run Time Hour and Min drop-downs, select the time of day when the service will run.

Note:

In SharePoint 2019, the Min drop-down offers only 15-minute intervals.

Minutes Past the Hour

Select to have the scheduled archival service check hourly for qualified documents. Use the drop-down menu to select how many minutes after the hour the service will run.

Minutes

Select to have the scheduled archival service check for qualified documents within a specified interval. Use the drop-down menu to select how many minutes the service will wait between runs.

Test Mode

CAUTION:

Do not use this option in a production environment.

Select to have the scheduled archival service check for qualified documents once per minute. This option is provided for testing so you can quickly verify whether documents are being archived correctly.