Runtime Environments

Back Next

Blackout file structure

The blackout file is an XML file that contains elements that define each blackout period and the frequency, start time, and end time for each blackout period.

The blackout file has the following structure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BlackoutWindows>
    <BlackoutWindow>
        <RepeatFrequency></RepeatFrequency>
        <Start></Start>
        <End></End>
    </BlackoutWindow>
    <BlackoutWindow>
        <RepeatFrequency></RepeatFrequency>
        <Start></Start>
        <End></End>
    </BlackoutWindow>
    …
</BlackoutWindows>

The file contains the following elements:

Element	Required/ Optional	Description
BlackoutWindows	Required	Contains a BlackoutWindow element for each blackout period. Must contain one or more BlackoutWindow elements.
BlackoutWindow	Required	Defines one blackout period. Must contain one RepeatFrequency element, one Start element, and one End element.
RepeatFrequency	Required	Repeat frequency for the blackout period. Must contain one of the following values: OneTime Daily Weekdays Sunday Monday Tuesday Wednesday Thursday Friday Saturday
Start	Required	Blackout period start time in the format yyyy-mm-dd hh24:mi:ss. For example, 2019-07-25 10:26:55 . The time zone is the Secure Agent time zone.
End	Required	Blackout period end time in the format yyyy-mm-dd hh24:mi:ss. For example, 2019-07-26 11:45:00 . The time zone is the Secure Agent time zone.

Rename Saved Search

Table of Contents

Runtime Environments

Runtime Environments

Blackout file structure

Blackout file structure