Blackout Dates

In this section:

How to:


Schedule blackout dates are those dates on which schedules will not run and cannot be set to run. A user authorized to access the Blackout Date tool can view, define, update, and delete schedule blackout dates.

To view schedule blackout dates, in the Console, select Blackout Dates. The Schedule Blackout Dates interface, shown in the following image, provides a calendar and a list of groups to which you belong in the left panel. The right panel displays a list of schedule blackout dates for the selected group .

blackout dates

Authorized users can set and manage blackout dates globally, affecting all ReportCaster users, or exclusively by targeting specific user groups. The group list in the left panel shows the groups to which the user belongs.

Users authorized to manage schedule blackout dates can add new blackout dates, delete and replace the description of existing blackout dates, and extract existing blackout dates to a file for future use. In the ReportCaster Blackout Dates interface, these tasks can be completed using the following:

To view the schedule blackout dates for a particular group, select that group in the left panel. The list of blackout dates in the calendar and right panel refresh to display the selected group blackout dates, which are shaded in yellow, along with the global blackout dates, shaded in gray.

You can change the month or year using the arrows at the top of the calendar. Click Refresh to load the latest blackout dates. Dates only appear as available or unavailable. You can toggle between exposing and hiding the left panel by clicking the arrow in the top-right corner of the panel. The following image shows the display with the left panel hidden.


Top of page

Reference: Schedule Behavior for Blackout Dates

Blackout dates are enforced during schedule creation and at run time:

Top of page

Procedure: How to Define Blackout Dates

To define blackout dates:

  1. In the left panel of the Blackout Dates tab, select the group for which you are defining blackout dates.

    Note: Only authorized users can set Global schedule blackout dates.

  2. In the calendar, click on the dates that you want to black out. Click the single arrows to change the month and click the double arrows to change the year.

    If you are choosing global dates, the day on the calendar turns gray. If you are choosing a group blackout date, the day on the calendar turns yellow. The following image shows an example of group (August 11, 19, and 30) schedule blackout dates.


  3. Click Save.

    A confirmation window opens to tell you that the dates have been saved.

  4. Click OK.

The blackout dates you saved appear in the Schedule Blackout Dates calendar and are displayed in the right panel.

Top of page

Importing Blackout Dates

How to:

You can import a file that contains blackout dates into ReportCaster.

Procedure: How to Import Blackout Dates From the User Interface

To import schedule blackout dates:

  1. In the Blackout Dates tab, select the group for which you are importing blackout dates.
  2. On the toolbar, click Import.

    The Import Dates dialog box opens, as shown in the following image.

    import dates

  3. In the File Name field, type the full path to the file, or click Browse and navigate to the file you want to import.
  4. Select one of the following Import Actions:
    • Add. Adds the dates specified in the import file to the blackout dates.
    • Remove. Deletes the dates specified in the import file from the blackout dates.
    • Replace. Updates the description of the specified dates.
    • Use the actions specified in the file. Use this option when the import file contains a combination of commands (add, remove, replace) and date ranges.
  5. Click OK.

    The following confirmation message is displayed:

    Blackout Dates have been successfully imported. 
    Select Save on the Schedule Blackout Dates toolbar to save the changes.
  6. Click OK.
  7. In the Schedule Blackout Dates option menu, click Save.

    Note: The imported blackout date changes do not take effect until you save them.

  8. In the save confirmation window, click OK.

The Schedule Blackout Dates calendar is updated with the blackout date changes.

Top of page

Extracting Blackout Dates

How to:

You can extract existing blackout dates in the ReportCaster Development Interface to a .txt file.

Procedure: How to Extract Schedule Blackout Dates From the User Interface

To extract schedule blackout dates:

  1. On the toolbar of the Blackout Dates tab, click Extract.

    The Extract Blackout Dates dialog box opens. The group name from which you are extracting the blackout dates appears at the top of the dialog box, as shown in the following image.

  2. Select one of the following from the Date Range Options:
    • All to extract all currently saved blackout dates.
    • Date Range to specify the range of dates with blackout dates that you want to extract.

    If you select Date Range, type or select the Start Date and End Date. To select a date, click the down arrow next to the field. A calendar opens, as shown in the following image, from which you can choose a date.

    extract blackout dates

  3. Click OK.

    A window opens, asking if you want to open or save the file.

    If you choose to open the file, a window opens, displaying the contents of the extracted content. The following is an example of the data in an extracted file.

    If you choose to save the file:

    1. Click Save.
    2. In the Save As window, browse to the directory where you want to save the extract file and click Save.

Note: The default extract file name is rcbdextract_GroupName_YYMMDD_HHMMSS.txt, where GroupName is the name of the group from which the blackout dates are extracted, YYMMDD and HHMMSS are the date (year, month, day) and time (hour, minute, second) that the file was created.