ReportCaster > Using the Console > Using Blackout Periods

Using Blackout Periods

Topics:

How to:

Reference:

Blackout Periods are those dates and times on which schedules will not run and cannot be set to run. A user authorized to access the Blackout Periods tool can view, define, update, import, extract, and delete blackout periods.

To view schedule blackout periods, select Blackout Periods from the Show group in the Console. The Blackout Periods interface provides a calendar in the left panel and the right panel lists the blackout dates you are authorized to manage.

Users authorized to manage blackout periods can add new blackout periods, delete blackout periods, replace the description of existing blackout periods, import blackout period information defined within a file, and extract existing blackout period information to a file for future use. In the ReportCaster Blackout Periods interface, these tasks can be completed using the following features:

You can change the month or year using the arrows at the top of the calendar. Dates only appear as available or unavailable. You can show or hide the left panel by clicking the arrow in the top-right corner of the left panel.

Reference: Blackout Period Configurations

Every type of Blackout Period profile shares the same basic settings: Group Assignment, Name, Description, Details, and Blackout Time. Within that basic configuration, there are four types of Blackout Periods that accommodate differing scheduling requirements. These include:

  • Weekly Blackout Periods. Recur on a specified day or days of the week.
  • Monthly Blackout Periods. Recur on a specified monthly date or dates.
  • Single Day Blackout Periods. Occur only once on a specified date.
  • Every Day Blackout Periods. Recur at a specified time every day.

This variety of profiles enables you to build blackout periods into your reporting schedule that accommodate those regularly recurring and special one-day events that would cause you to suspend reporting.

Reference: Basic Blackout Period Settings

The Blackout Date and Time dialog box contains settings that define the timing and frequency of a scheduled Blackout Period. There are four variations of this dialog box to accommodate the Weekly, Monthly, Single Day, and Every Day frequency options.

The following table describes settings in the Global Blackout Date and Times profile.

Setting

Optional or Required/Default Value

Descriptions and Possible Values

Group

Displays the name (Global).

Displays the name (Global).

Name

Optional.

By default displays the name: Blackout-[Current Date] [Current Time]

For example: Blackout-Jun 26 2015 10:27 AM

A descriptive name for the Blackout Date and Time profile.

You can modify the default name by clicking within the Name field.

Description

Optional.

A detailed description of the Blackout Date and Time profile.

Details Label

Assigned to the profile after creation.

A summary of the detailed times and frequency of the Blackout Period.

This is a narrative description of the selections you make in the Weeks, Days, Months, and Blackout Time fields.

ReportCaster creates this description automatically when you save the profile, and updates it when you save changes to it. You cannot create, edit, or delete it directly.

Blackout Time check box

By default this check box is cleared.

Selected. The Blackout Period covers the hours specified in the Start (Time) and End (Time) fields.

Not Selected. The Blackout Period covers the entire day.

Note: If you change a profile from Single Date to any other frequency setting, you must clear this check box if the blackout period is to cover the entire day.

Start (Time)

Optional. By default, displays the current hour and minute.

The Hour and Minute in which a Blackout Period is to begin.

This value is relevant only if the Blackout Time check box is selected.

End (Time)

Optional. By default, displays the time two hours after the current hour and minute.

The Hour and Minute in which a Blackout Period is to end.

This value is relevant only if the Blackout Time check box is selected.

Frequency

Required. By default, the Weekly option is selected.

Weekly. Blackout periods that recur on a specified day of the week.

Monthly. Blackout periods that recur on a specified monthly date.

Single Day. Blackout periods that occur once on a specified date.

Every Day. Blackout periods that recur at a specified time every day.

Procedure: How to Configure a Blackout Period

To configure a blackout period:

  1. From the Manage Blackout Periods group on the ribbon, click New.

    The Blackout Date and Time dialog box opens.

  2. Accept the default Name assigned to the Blackout Period profile or enter a new value for Name.
  3. Type a description for the Blackout Period profile in the Description field.
  4. If this blackout period must cover the entire day, leave the Blackout Time check box cleared and skip to step 7.
  5. If this blackout period must be limited to a range of hours within a day, select the Blackout Time check box and configure the start and end time for the Blackout Period.

    For more information, see How to Configure a Start Time and End Time for a Blackout Period.

  6. Click the appropriate frequency option:
  7. Review your configuration.
    • If your configuration of dates and hours is unacceptable, the OK button will not respond when you attempt to click OK. Adjust your configuration and refresh the profile by clearing and reselecting the recurring check boxes.
    • If your configuration is acceptable, the OK button will be available, and the Details label will include a description summarizing your selections.
  8. When your configuration is complete, click OK.

    An entry for the Blackout Profile appears in the right pane of the Blackout Dates window and the Blackout Date Calendar in the left pane highlights the new blackout dates.

Configuring Weekly Blackout Periods

Topics:

The Weekly Blackout Period configuration bases its recurrence on a specified day of the week. It suits events that recur as part of a weekly schedule, regardless of the date on which that day falls.

Even though the name implies that this Blackout Period occurs only once a week, Blackout Periods using the weekly configuration can occur more or less frequently.

The tools in this configuration enable you to specify:

  • The day, or days, of the week on which the blackout period will occur.
  • The week, or weeks, of the month in which the blackout period will occur.
  • The month, or months, of the year in which the blackout period will occur.

Instead of requiring you to enforce blackout periods on the same day each and every week, this flexible configuration enables you to schedule Blackout Periods that occur more than once a week. It also enables you to configure Blackout Periods that skip one or more weeks in a month or skip one or more months in a year.

Weekly Blackout Period Settings

How to:

If you select the Weekly option, the Blackout Date and Time dialog box displays a unique set of options that enables you to schedule Blackout Periods for specified days of the week.

Setting

Optional or Required/Default Value

Descriptions and Possible Values

On

Week of the Month Check Boxes (Left Column)

Required (At least one selection from this column.)

The week of the month check boxes list ordinal weeks of the month. When you select one, you define the week of the month in which this blackout period is to occur. That is, the first week of the month, the second week, and so on.

You can select one or more individual weeks.

The Select All check box automatically selects every week of the month, establishing a blackout period that takes place every week in a month.

On

Days of the Week check boxes (Right Column)

Required (At least one selection from this column).

The day of the week check boxes list the days of the week. When you select one, you define the day of the week in which this blackout period will occur. That is, on Monday, Tuesday, and so on.

You can select one or more individual days.

The Select All check box automatically selects every day of the week, establishing a blackout period that takes place every day of your selected weeks in the month.

Months

Required (At least one selection from this group).

The Month check boxes list the months of the year. When you select one, you define the month of the year in which this weekly black out period will occur. That is, in January, February, and so on.

You can select one or more individual months.

The Select All check box automatically selects every month of the year, establishing a blackout period that takes place during every month on your selected week and day.

Procedure: How to Configure Weekly Blackout Period Settings

To configure weekly blackout period settings:

  1. From the Blackout Date and Time dialog box, click Weekly.

    The dialog box displays check boxes that support the Weekly frequency schedule.

    Note: In order to enable the OK button and save the profile, you must select at least one week, day, and month check box.

  2. Select the check boxes for the week or weeks of the month in which the Blackout Period is to occur, or click Select All to select every week automatically.
  3. Select the check boxes for the day or days of the week on which the Blackout Period is to occur, or click Select All to select every day of the week automatically.
  4. Select the check boxes for the month or months in which the Blackout Period is to occur, or click Select All to select every month automatically.

Configuring Monthly Blackout Periods

Topics:

The Monthly Blackout Period configuration bases its recurrence on a specified monthly date. It suits events that recur on the same date, regardless of the day of the week on which that date falls.

Even though the name implies that this Blackout Period occurs only once a month, Blackout Periods using this configuration can occur more or less frequently. They can occupy the entire day, or they can be limited to a range of hours within a single day.

The tools in this configuration enable you to specify:

  • The day, or days, of the month on which the blackout period will occur.
  • The month, or months, of the year in which the blackout period will occur.

Instead of requiring you to enforce blackout periods on the same day of the month, each and every month, this flexible configuration enables you to schedule Blackout Periods that occur more than once a month. It also enables you to configure Blackout Periods that skip one or more months.

Monthly Blackout Period Settings

How to:

If you select the Monthly option, the Blackout Date and Time dialog box displays a unique set of options that enables you to schedule Blackout Periods for specified dates of the month.

Setting

Optional or Required/Default Value

Descriptions and Possible Values

Days

Required.

The Days check boxes list the dates within a month. When you select one, you define the day of the month on which this blackout period will occur. That is, on the first day of the month, the second, the third, and so on.

You can select one or more individual dates.

The Select All option automatically selects every day of the month, establishing a blackout period that takes place every day during your selected months.

Months

Required.

The Months check boxes list the months of the year. When you select one, you define the month in which this black out period will occur. That is, in January, February, and so on.

You can select one or more individual months.

The Select All option automatically selects every month of the year, establishing a blackout period that takes place during every month on your selected day or days.

Procedure: How to Configure Monthly Blackout Period Settings

To configure monthly blackout period settings:

  1. From the Blackout Date and Time dialog box, click Monthly.

    The Blackout Date and Time dialog box displays the check boxes that support the Monthly frequency.

    Note: At a minimum, you must select a check box for one day and a check box for one month. Until you do, the OK button will be unavailable, and you will be unable to save the profile.

  2. Select the check boxes for the day or days of the month on which the Blackout Period is to occur, or click Select All to select every date in the month automatically.
  3. Select the check boxes for the month or months in which the Blackout Period is to occur, or click Select All to select every month automatically.

Configuring Single Day Blackout Periods

Topics:

Single Day Blackout Periods occur once, on a single, specified date. They can occupy the entire day, or they can be limited to a range of hours within a single day.

Single Day Blackout Period Settings

How to:

If you select the Single Day option, the Blackout Date and Time dialog box displays a copy of the Blackout Dates calendar, which enables you to select a single date for a scheduled Blackout Period.

Procedure: How to Configure Single Day Blackout Period Settings

  1. From the Blackout Date and Time dialog box, click Single Day.

    The dialog box appears, displaying the calendar automatically set to the current date.

  2. Click the single arrows to change the month and click the double arrows to change the year.
  3. When you have found the month and year for the scheduled single day blackout period, click on the date on which you want the Blackout Period to occur.

    The calendar highlights the new date.

Configuring Every Day Blackout Periods

Topics:

Every Day Blackout Periods recur every day. To prevent Every Day Blackout Periods from blocking the release of any reports, you must limit them to a range of hours within the day.

Every Day Blackout Period Settings

How to:

If you select the Every Day option, the Blackout Date and Time dialog box limits its display to the Beginning and End time for the Blackout Period. No other options are relevant.

Procedure: How to Configure Every Day Blackout Period Settings

  1. From the Blackout Date and Time dialog box, click Every Day.

    The Blackout Time check box is selected automatically, and the dialog box displays a note reminding you to select the start and end time.

    The Start time is automatically set to the current time, and the End time is automatically set to a value two hours later.

  2. To change the Start or End Time values, see How to Configure a Start Time and End Time for a Blackout Period.

Procedure: How to Configure a Start Time and End Time for a Blackout Period

From the Blackout Date and Time dialog box:

  1. To change the hour of the start time, click in the Hour section of the Start field.
    1. Click the up or down arrow to move the value ahead one hour or back one hour, respectively.
    2. You can also type the hour in this section, but be careful to stay within the twelve hour range. If you enter a value outside of this range, the dialog box will automatically recalculate your value in terms of a twelve hour clock. For example, 44 hours would become 8. (44-(12X3))=(44-36)=8
    3. Ensure that the start time is earlier than the end time.
  2. To change the minutes of the start time, click in the Minutes section of the Start field.
    1. Click the up or down arrow to move the value ahead one minute or back one minute, respectively.
    2. You can also type the minutes in this section, but be careful to stay within the sixty minute range. If you enter a value outside of this range, the dialog box will automatically recalculate your value in terms of the number of minutes within an hour. For example, 88 minutes would become 28. (88-60 = 28).
    3. Ensure that the start time is earlier than the end time.
  3. To change the start time from AM to PM, click in the AM/PM section of the Start field.
    1. Click the up arrow to move from AM to PM.
    2. Click the down arrow to move from PM to AM.
    3. You can also type AM or PM directly into this section.
  4. To change the hour of the end time, click in the Hour section of the End field.
    1. Click the up or down arrow to move the value ahead one hour or back one hour, respectively.
    2. You can also type the hour in this section, but be careful to stay within the twelve hour range. If you enter a value outside of this range, the dialog box will automatically recalculate your value in terms of a twelve hour clock. For example, 44 hours would become 8. (44-(12X3))=(44-36)=8.
    3. Ensure that the end time is later than the start time.
  5. To change the minute of the end time, click in the Minutes section of the End field.
    1. Click the up or down arrow to move the value ahead one minute or back one minute, respectively.
    2. You can also type the minute in this section, but be careful to stay within the sixty minute range. If you enter a value outside of this range, the dialog box will automatically recalculate your value in terms of the number of minutes within an hour. For example, 88 minutes would become 28. (88-60 = 28).
    3. Ensure that the end time is later than the start time.
  6. To change the end time from AM to PM, click in the AM/PM section of the End field.
    1. Click the up arrow to move from AM to PM.
    2. Click the down arrow to move from PM to AM.
    3. You can also type AM or PM directly into this section.

    Important: You must use the right or left arrow keys to move between the Hour, Minutes, and AM/PM sections of the Start and End fields.

    If you try to use the Tab key to move between sections, you will move down to the next option instead of across to the next section of the Start or End field.

    For example, if you use the Tab key to move from the Hours section of the Start field, you will move down to the Hours section of the End field, not over to the Minutes section of the Start field. To move right, you must use the right direction key instead.

    Similarly, the Shift+Tab key combination will move you to the previous option, not back to a previous section within the Start or End field. To move left, you must use the left direction key instead.

Procedure: How to Delete a Blackout Period Profile

  1. In the left pane of the Blackout Dates dialog box, click the folder for the Group to which the Blackout Period profile you want to delete is assigned.
  2. In the right pane, click the entry for Blackout Period profile you want to delete.
  3. On the ribbon, in the Manage Blackout Periods group, click Delete.
  4. When you receive a confirmation message, click Yes.

    Your newly deleted entry disappears from the right pane and the dates assigned to that entry are no longer highlighted on the Blackout Dates calendar in the left pane.

Importing Blackout Periods

Topics:

How to:

You can use the Blackout Period Import operation to automate Blackout Period management tasks. Using a properly formatted import file with this tool, you can:

  • Create new Blackout Period profiles.
  • Remove Blackout Period profiles.
  • Replace Blackout Period information.
  • Perform the actions specified in an uploaded file.

The source file for the import contains the following information about a Blackout Period Profile:

  • Date. The date on which the Blackout Period profile becomes effective. This date can be omitted for Every Day Blackout Period profiles.
  • Start Hour. The time (HH:MM:SS) at which the Blackout Period becomes effective. This value is optional for all but Every Day Blackout Period profiles.
  • End Hour. The time (HH:MM:SS) at which the Blackout Period ceases to be effective. This value is optional for all but Every Day Blackout Period profiles.
  • Description. A detailed description of the Blackout Period profile.
  • Name. The unique name assigned to a Blackout Period profile.

Note: Additional Codes precede entries for Weekly or Monthly Blackout Period profiles. For more information, see Weekly Blackout Period Import File Entry Layout and Monthly Blackout Period Import File Entry Layout.

The task you select when you run an import operation determines the way in which ReportCaster uses the information in the source file for the Import.

If you select:

  • Add, the import creates new Blackout Period profiles from the records in the import source file.
  • Remove, the import compares date and additional information in import file records to that of existing Blackout Period profiles and removes those profiles that match the file records.
  • Replace, the import compares date information in import file records to that of existing Blackout Period profiles and adds Name and Description information to them.
  • Use the actions specified in the file, the import runs the add, remove, and replace operations as required by commands included in the Import file along with entries for the Blackout Period profiles affected by them.

The automation of these tasks frees you from manually creating, updating, or deleting Blackout Period profiles when operational changes, such as monthly, quarterly, or annual operation schedule updates, require a sweeping review and revision of your reporting schedule.

For example, at the start of the year, you have a file containing the dates and names of all scheduled holidays that must be incorporated into your reporting schedule. The Blackout Period Import enables you to import that file and establish the holiday blackout schedule for an entire year in a single operation. Without the import you would have to create a Single Date Blackout Date and Time profile for each holiday in the coming year.

Viewing Blackout Period Import File Format

Even though entries in the Import File format for Blackout Period records use the same basic structure, each profile type contains minor variations that identify the type of Blackout Period profile ReportCaster must create from the entry details.

Single Date Blackout Period Import File Entry Layout

You can import Single Date Blackout Date and Time profiles from a flat file that lists the information for each profile on a separate line. Each line must follow the following layout:

For example:

#Schedule Blackout Date Extract created 161004 102629 by admin
#for date range:(All)
#Dates Extracted from Group: administrators
##BLACKOUT DATE: yyyyMMdd/HH:mm:ss|HH:mm:ss description|name
##BLACKOUT TIME: /HH:mm:ss|HH:mm:ss description|name
##BLACKOUT PATTERN: [101000000000/00000000000000000000000000000001]/HH:mm:ss|HH:mm:ss description|name
##BLACKOUT PATTERN: [101000000000/00001:0001000]/HH:mm:ss|HH:mm:ss description|name
[000001000000/01000:0000100]/11:44:00|15:44:00 Administrators February 4, 2016|Blackout-Feb 4 2016 11:25 AM
  • Dates use the format YYYYMMDD
  • Hours use the format HH:MM:SS
  • You can omit the hours to schedule an all day blackout.

The Weekly, Monthly, and Every Day Blackout Date and Time profiles use a variation of this format.

Weekly Blackout Period Import File Entry Layout

You can import Weekly Blackout Date and Time profiles from a flat file that lists the information for each profile on a separate line. Each line must follow the following layout: 

[Blackout Pattern] [Description]|[Name]

For example:

[111111111111/10000:0000010]/17:00:00|23:59:00 Report Blackout First Friday of Every Month 5:00 PM to 11:59 PM|First Friday Afternoons

This information identifies the entry as a Weekly Blackout Period, and includes its Description and Name. The Blackout Pattern indicates the selected Month(s) and Selected Day(s) of the Week. A '1' means that a month or day is selected. A '0' means that a month or day is not selected.

Monthly Blackout Period Import File Entry Layout

You can import Monthly Blackout Date and Time profiles from a flat file that lists the information for each profile on a separate line. Each line must follow the following layout: 

[Blackout Pattern]/[Start Hour]|[End Hour] [Description]|[Name]

For example:

[111111111111/10000:0000010]/17:00:00|23:59:00 Report Blackout First Friday of Every Month 5:00 PM to 11:59 PM|First Friday Afternoons

This information identifies the entry as a Monthly Blackout Period, and includes its Description and Name. The Blackout Pattern indicates the selected Month(s) and Selected Day(s) of the Month. A '1' means that a month or day is selected. A '0' means that a month or day is not selected.

Every Day Blackout Period Import File Entry Layout

You can import Every Day Blackout Date and Time profiles from a flat file that lists the information for each profile on a separate line. Each line must follow the following layout: 

/[Start Hour]|[End Hour] [Description]|[Name]

For example:

/21:04:00|23:04:00 Every Day Blackout between 3:00 PM and Midnight|Daily Afternoon Blackout

This information identifies the entry as an Every Day Blackout Period and includes its Description and Name.

Procedure: How to Add Blackout Period Profiles Using an Import File

To add a Blackout Period profile through the import utility is to create a new Blackout Period profile from information in the import file. Your Import file must therefore contain records for all Blackout Period profiles you want to add to ReportCaster through this import operation.

  1. In the Blackout Dates pane, click the folder of the group for which you are importing Blackout Period profiles.
  2. On the ribbon, in the Manage Blackout Periods group, click Import.

    The Import Dates dialog box opens.

  3. In the File Name field, type the full path to the file, or click Browse or Choose File and navigate to the file you want to import.

    Note: When viewed in Internet Explorer, the dialog box displays a Browse button to the right side of this field, and the field displays no text. When viewed in Google Chrome, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file chosen. When viewed in Firefox, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file selected.

  4. In the File Name field, type the full path to the file, or click Choose File and navigate to the file you want to import.
  5. Click Add, and click OK.

    The Import Blackout Data dialog box opens, listing details of the new Blackout Profiles based on each entry in the Import file.

  6. Click Add to add the new Blackout Period profiles listed in the Import Blackout Data dialog box to the Blackout Dates Calendar and Group entries.

    A message displays, informing you that the blackout dates have been successfully imported.

  7. Click OK.

    The Blackout Dates calendar highlights the newly imported Blackout Period Dates in the left pane of the Blackout Dates window, and entries for the new Blackout Period profiles appear in the right pane.

Procedure: How to Replace Blackout Periods Using an Import File

To replace a Blackout Period profile through the import utility is to add updated information to its Name and Description fields. To ensure that the import-based update affects the proper profiles, your import file must contain records whose dates match those of the existing Blackout Period profiles that must be enriched by this Import operation.

  1. In the right pane of the Blackout Dates dialog box, select the group for which you are importing Blackout Period profiles.
  2. On the ribbon, in the Manage Blackout Periods group, click Import.

    The Import Dates dialog box opens.

  3. In the File Name field, type the full path to the file, or click Browse or Choose File and navigate to the file you want to import.

    Note: When viewed in Internet Explorer, the dialog box displays a Browse button to the right side of this field, and the field displays no text. When viewed in Google Chrome, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file chosen. When viewed in Firefox, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file selected.

  4. Click Replace, and then click OK.

    The Import Blackout Data dialog box opens, listing the details from each entry in the Import file that will be added to their corresponding Blackout Period profiles.

  5. Click Replace to add new the information listed in the Import Blackout Data dialog box to the designated Blackout Period profiles.

    A message displays, informing you that the blackout dates have been successfully imported.

  6. Click OK.

    Enriched entries for the updated Blackout Period profiles appear in the right pane.

Procedure: How to Remove Blackout Periods Using an Import File

Removing a Blackout Period profile through the import utility deletes it. To ensure that the import-based deletion affects the proper profiles, your import file must contain records whose dates match those of the existing Blackout Period profiles that are to be deleted by this Import operation.

  1. In the Blackout Dates tab pane, select the group containing blackout period profiles that must be removed.
  2. On the ribbon, in the Manage Blackout Periods group, click Import.

    The Import Dates dialog box opens.

  3. In the File Name field, type the full path to the file, or click Browse or Choose File and navigate to the file you want to import.

    Note: When viewed in Internet Explorer, the dialog box displays a Browse button to the right side of this field, and the field displays no text. When viewed in Google Chrome, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file chosen. When viewed in Firefox, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file selected.

  4. Click Remove, and then click OK.

    The Import Blackout Data dialog box opens, listing details from each entry in the import file that successfully matched an existing Blackout Period profile.

  5. Click Remove to delete those Blackout Period profiles listed in the Import Blackout Data dialog box.

    A window opens, informing you that the blackout dates have been successfully imported.

  6. Click OK.

    Blackout Period profiles removed by this operation are no longer highlighted in the left pane of the Blackout Dates window or as entries for the new Blackout Period profiles in the right pane.

Procedure: How to Manage Multiple Blackout Period Updates Using an Import File

The Use the actions specified in the file option allows the import process to add, remove, and replace multiple Blackout Period profiles in a single operation. Your Import file must therefore contain the all necessary commands followed by entries representing Blackout Period profiles that must be added, removed, or replaced by the import operation.

  1. In the right pane of the Blackout Dates dialog box, select the group for which you are managing Blackout Period profiles.
  2. On the ribbon, in the Manage Blackout Periods group, click Import.

    The Import Dates dialog box opens.

  3. In the File Name field, type the full path to the file, or click Browse or Choose File and navigate to the file you want to import.

    Note: When viewed in Internet Explorer, the dialog box displays a Browse button to the right side of this field, and the field displays no text. When viewed in Google Chrome, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file chosen. When viewed in Firefox, the dialog box displays a Browse button to the left side of this field, and the field contains the text, No file selected.

  4. Click Use the actions specified in the file, and then click OK.

    The Import Blackout Data dialog box opens, listing details from each entry in the Import file and a note about its proposed update.

  5. Click OK.
  6. When you receive the Blackout Dates have been successfully imported message, click OK.

    The Blackout Dates calendar highlights the dates of the newly imported Blackout Periods in the left pane of the Blackout Dates window. Entries for the new and enriched Blackout Period profiles appear in the right pane. Calendar highlights and entries for profiles removed by the Import no longer appear.

    Note: You will be unable to use the Edit command to update Blackout Period profiles created from a direct file import. You will be required to update these profiles using the Replace option in the Import operation.

Extracting Blackout Period Profiles

Topics:

How to:

You can extract existing blackout period profile information from the ReportCaster Development Interface to a .txt file.

A direct file extract minimizes the time it would take to transfer information about multiple Blackout Periods to a text file that can serve as a backup of your Blackout Calendar configuration or as the source of an import to an external system for reporting or auditing purposes.

For example, if your group is required to maintain a backup copy of blackout dates for the coming six months, the extract operation enables you to transfer the Description, Date, and Name of all scheduled blackout periods during that time. You can recreate basic information about these profiles from the backup file in an emergency, shortening the time required to reconstruct your reporting schedule.

Extracting File Formats

The Import and Extract file operations use the same layout and format conventions. The Extract file contains additional comments that document the range of dates selected for the extract and templates for the format of the entries it contains.

For more information about each entry type layout, see Viewing Blackout Period Import File Format.

Procedure: How to Extract Schedule Blackout Period Profiles to a File

To extract schedule blackout period profiles:

  1. In the Blackout Dates pane, select the group from which you are extracting blackout period profiles.
  2. In the Manage Blackout Periods Toolbar group, 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.

  3. Select one of the following from the Date Range Options:
    • All to extract all currently saved blackout period profiles.
    • Date Range to specify the range of dates containing scheduled blackout period profiles 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, from which you can choose a date.

  4. Click OK.
  5. To open the file, click the Open button when your browser presents it.

    A window opens, displaying the contents of the extracted content profiles.

    You can save and close the file using the commands in the File menu.

  6. To accept an automatic download of the extract file, click the Save button (users of Google Chrome need only close the page displaying the new file name).

    You can later retrieve the file from the Downloads folder of your computer, rename it if necessary, and save a copy of it in another folder for archival or other purposes.

  7. To rename and save the file in a different location, click the Open or Open With button, and select the Save As command from the program that opens the file.
  8. From the Save As window, navigate to the folder in which you want to save the file, rename the file if necessary, and click Save.

    You can close any additional web pages that may remain open after you save the file.

    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.

WebFOCUS

Feedback