This documentation supports an earlier version of BMC Helix Operations Management.

To view the documentation for the latest version, select 23.3 from the Product version picker.

Setting event policy schedules by using time frames

As an administrator, use time frames to specify when an event policy is active. With time frames, you can schedule event policies to run during a specific duration, which gives you the flexibility to control when an event policy is run. If an event policy is configured with a time frame, the policy processes incoming events according to the time specified in the time frame. You can schedule different event policies to run once or multiple times for a specific duration based on your requirement. 

Example

Sarah is an administrator at Apex Global. Apex Global is scheduled to back up their systems every Tuesday for one hour. Sarah does not want to receive unnecessary events during this period. To achieve this goal, Sarah uses time frames in her event policies and specifies the backup time during which no event is generated.

You can associate a single time frame with multiple event policies. However, you cannot associate multiple time frames to a single event policy.

You can use REST APIs to manage time frames. For more information, see Time frame management endpoints in the REST API.

Conditions of policy execution with time frames

Event policies that are associated with time frames are executed based on the following conditions:

Policy statusTime frame statusIs the policy executed
EnabledActiveYes
EnabledInactiveNo
DisabledActiveNo
DisabledInactiveNo

Important

For events to be impacted by a time frame setting, the time frame must be active for the entire time that is specified in the policy.

Example:

An escalation policy is defined to escalate the event severity after 30 minutes with an active time frame from 5.00 P.M. to 7:00 P.M. At 6:45 P.M., events are generated. The active time frame expires at 7:00 P.M.; therefore, events generated at 6:45 P.M. are not impacted by the policy because the time frame is not active at 7:15 P.M.


The following video (3:07) helps you understand how you can create a time frame in event policies.

https://youtu.be/ggj6-6Mw4tE


To create a time frame

  1. Select Configuration > Event Policies.
  2. Click Create.
  3. In Time Frame, click .
    You can see all the active time frames in a tenant. The Always active option is the default, which means that the time frame will always be active until you specify the time frame settings.

  4. In the Time frame settings dialog box, add a name and description for the time frame. 
  5. Select one of the following schedules:
    • One Time: Use this option to configure a time frame to run only once.
      • Select the start date for the time frame and click Next.
        You can click the arrows to change the month and the year.

        Time frame date

        If you copy and paste the date, make sure that you use a date format that matches the date format you have set on the User Preferences page.

      • Set the start time for the time frame; the time is in the 24-hour format and the current system time is the default: 
        • Move the hours hand to set the hours part of the time.
        • Move the minutes hand to set the minutes part of the time.
        • Select the time of the day: A.M. or P.M.
        • Click Next.
      • Select the end date for the time frame and click Next.
        You can click the arrows to change the month and the year.
      • Set the end time for the time frame; the time is in the 24-hour format and the current system time is the default: 
        • Move the hours hand to set the hours part of the time.
        • Move the minutes hand to set the minutes part of the time.
        • Select the time of the day: A.M. or P.M.
        • Click OK.
    • Recurring: Use this option to configure a time frame that is repeated after a specific duration.

      • In Appointment time, specify the start time and end time of the time frame. The time is in the 24-hour format. Make sure that the duration between the start time and end time is within 24 hours.

      • Specify the recurrence pattern of the time frame.

        Recurrence pattern
        NameDescription
        Repeats

        Indicates how often the time frame schedule will run.

        • Daily: Select this option to run the time frame schedule daily.
          For example, the time frame schedule runs daily from 2 A.M. to 3 A.M except on weekends.
        • Weekly: Select specific days of the week when you want the time frame schedule to run.
          For example, the time frame schedule runs twice a week every Tuesday and Friday from 2 A.M. to 3 A.M.
        • Monthly: Specify dates of the month when you want the time frame schedule to run.
          For example, if you specify dates in the following format:
          • 5,10,15 (comma-separated values): The time frame schedule runs on these dates.
          • 5-15 (range of values): The time frame schedule runs on all dates in this range.
        Exclude Weekends

        Select this option if you don't want to run the time frame schedule on weekends.

      • Specify the range of recurrence of the time frame.

        Time frame date

        If you copy and paste the date, make sure that you use a date format that matches the date format you have set on the User Preferences page.

        Range of recurrence
        NameDescription
        Start DateSpecify the date when you want the time frame to begin.
        No End DateSelect this option if you don't want the time frame to end, which means the time frame schedule is executed perpetually.
        End DateSpecify the date when you want the time frame to end.
        End AfterSpecify the number of occurrences after which you want the time frame to end.
  6. In Advanced Settings, specify the time zone details.
    The time zone on the User Preferences page is the default time zone. The time zone that you specify overrides the default time zone. To know more about user preferences; see
    Setting your console preferences.

  7. Click Save.

You can also use REST APIs to create a time frame. For more information, see Time frame management endpoints in the REST API.

Example

Sarah is an administrator at Apex Global. Apex Global is scheduled to back up their systems every Tuesday for 1 hour from 2.00 A.M. to 3:00 A.M. Sarah does not want to receive unnecessary events during this backup period to reduce unnecessary event accumulation. She can schedule a time frame by using the following settings:


To associate a time frame with an event policy

You can associate the same time frame to multiple event policies. However, you cannot associate multiple time frames to a single event policy. For instructions about associating a time frame with an event policy, see Creating and enabling event policies.


To edit a time frame

You can edit a time frame if it is associated with an event policy. You can also use REST APIs to edit a time frame. For more information, see Time frame management endpoints in the REST API.

  1. Select Configuration > Event Policies.
  2. Edit the event policy by doing one of the following actions:
    • Select the policy and click Edit.
    • From the Actions menu of a policy, select Edit.
  3. In Time Frame, select the time frame that you want to edit from the list of time frames and click .
  4. In the Time frame settings dialog box, make the required updates and click Save.


To delete a time frame

Use REST APIs to delete a time frame. For more information, see Time frame management endpoints in the REST API.

Was this page helpful? Yes No Submitting... Thank you

Comments