Blackout period

Data scans are scheduled to run on a schedule based on the agent cluster assigned to a source. You can refine or alter a schedule for a given dataset. At either the agent cluster level or the dataset level, you can set a blackout period during which time no new jobs will be started—in-progress jobs will continue.

  • When you define a blackout period for an agent cluster, all agents assigned to the cluster abide by the blackout period. These agents will not start any new scan actions during this time. For more information, see Agent clusters

  • When you define a blackout period for a dataset, new scans against the dataset are not performed during the blackout period. If you assign an agent cluster with a blackout period to the dataset's source, the blackout period for the dataset overrides the blackout at the cluster level. For more information, see Manage datasets

If you need to have all scans of a specific data source type completely stop for a set time period, even if mid-scan, you can configure a blackout period at the agent level. When you set this at the agent level, new jobs are not processed and in-progress jobs are stopped at the start of the blackout period. For example, you have a need to stop all scanning activity of your Content Manager data during employee work hours.

    NOTE:

  • Agent level blackout periods do not apply to Documentum, Extended ECM, Structured Data Manager, or structured data source types.

  • Agent level blackout periods stop in-progress scans. Data items that may have been partially processed when the agent level blackout period started will be rescanned during the next scan.

  • Agent level blackout periods must be defined on every agent host for the desired data type.

  • When an agent cluster or dataset level blackout period is assigned in addition to an agent level blackout period, both black out periods apply.

  1. On an agent host server, log on to the agent administration UI.

    From the Start menu, click OpenText Core Data Discovery & Risk Insights Agent > Agent Admin.

  2. In the navigation pane, click Advanced Settings.

  3. In the Category list, click the processor for the desired data type.

    For example, to set a blackout period for Content Manager, click Content Manager Processor.

  4. Complete the following options.

    Option Description
    Blackout Period Start Time

    Using Quartz cron expression, type the UTC time for the start of the blackout period.

    For example, to start the blackout period at 7:00 AM for the East Coast of the United States, Monday through Friday, type the following.

    0 0 12 ? * 2-6 *

    or

    0 0 12 ? * MON-FRI *

    IMPORTANT: Be sure to calculate the UTC time as it relates to the appropriate timezone.
    Blackout Period Duration (minutes) Type the number of minutes that the blackout period will last. For example, to define a 10 hour blackout duration, type 600.

  5. Click Save.

  6. Repeat on each agent host machine within agent clusters assigned to process the desired data source type.