Runtime Environments

Back Next

Configuring agent blackout periods

You can configure blackout periods for a Secure Agent. Blackout periods prevent data integration jobs from running on the agent during a certain period. Configure an agent blackout period to configure specific hours, days, or intervals in which no data integration jobs can run on the agent.

Agent blackout periods stop the Data Integration Server service from running jobs on a Secure Agent during the blackout period. They do not prevent other types of jobs from running on the agent. Configure an agent blackout period in the following circumstances:

The Data Integration Server is the only service enabled on the agent and you want to stop all data integration jobs from running during a certain period.

The Secure Agent runs multiple services and you want to stop only the data integration jobs from running during a certain period.

The agent blackout period is different than the schedule blackout period for the organization. During an organization's schedule blackout period, no jobs can run on any agent. For more information about schedule blackout periods, see

Organization Administration

To configure a blackout period on a Secure Agent, you must create a blackout file. The blackout file is an XML file that specifies the repeat frequency, start date, and end date for each blackout period.

For example, the following blackout file contains two blackout periods: one blackout period from July 27, 2021, 5:00 AM through July 28, 2021, 11:00 PM and a second blackout period that repeats on Fridays from 2:00-4:00 PM:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BlackoutWindows>
    <BlackoutWindow>
        <RepeatFrequency>OneTime</RepeatFrequency>
        <Start>2021-07-27 5:00:00</Start>
        <End>2021-07-28 23:00:00</End>
    </BlackoutWindow>
    <BlackoutWindow>
        <RepeatFrequency>Friday</RepeatFrequency>
        <Start>14:00:00</Start>
        <End>16:00:00</End>
    </BlackoutWindow>
</BlackoutWindows>

To configure one or more blackout periods, create a file named "blackoutWindows.dat" in the following directory on the Secure Agent machine:

<Secure Agent Installation Directory>\apps\Data_Integration_Server\conf\

If the Secure Agent is in a Secure Agent group, copy the blackout file to the

...\conf\

directory on each agent machine in the group.

If you want to use a different file name and directory, you can override the file name and file path.

After you create a blackout file, restart the Data Integration Server service on the Secure Agent so that the blackout periods take effect.

Secure Agents

Overriding the blackout file name and directory

Blackout file structure

Download Guide

Watch