Calendars

From OpsWise Documentation Wiki

Open as PDF

Contents 1 Overview 2 Creating Custom Days 2.1 Field Descriptions 3 Creating a New Calendar 3.1 Field Descriptions 4 Assigning Existing Custom Days to the Calendar 5 Adding New Custom Days and Assigning Them to this Calendar

Overview

Calendars define business days, holidays, and other special days. They are used in conjunction with triggers to define when tasks are run. Specifically, calendars are used by the system to determine run dates as follows:

• If the user selects Business Days in a trigger, the calendar selected in the trigger defines the business days.
• If the user selects Day Style = Complex in the trigger, all the Custom Days attached to the calendar are written to the Date Noun drop-down menu.
• If the user selects Special Restriction in the trigger, the calendar defines what the Holidays or Non Business days are.

The process for setting up your calendars is to define the custom dates you will need, create one or more calendars, and assign the custom days to the calendars.

Creating Custom Days

A custom days definition might define a single one-time date, a repeating date, or a list of dates. Custom days are attached to calendars.

1. From the Navigation Pane, select Custom Days. The system displays a the Custom Days list shown below:



2. To add a new day, click New. The system displays a blank Custom Days field.
3. Using the field descriptions provided below, fill in the fields.
4. Click the Submit button to save the record and return to the menu or right-click on the title bar and select Save to save the record and remain on the current display.

Shown below is a sample Custom Days definition, an absolute repeating date.

Field Descriptions

The following table provides descriptions of the fields on the custom days form.

Name	Description
Name	A descriptive name for this Custom Day.
Holiday	Indicates whether or not this Custom Days record is defining a holiday. Dates flagged as holidays come into play when the user enables Special Restriction on a trigger and selects a situation of On Holiday.
Comments	A description of this day, which displays on the Custom Days list.
Type	Options: Single Date - Any one-time date. Relative Repeating Date - An annual (repeating) date that changes from year to year. For example, the U.S. Thanksgiving falls on the 4th Thursday of November, and is therefore on a different date every year. Absolute Repeating Date - An annual (repeating) date that does not change from year to year. For example, the Canadian holiday Canada Day falls on July 1st of every year. List of Dates - The dates are listed below.
When	If Type = Relative Repeating Date, the type of selection. Options: 1st, 2nd, 3rd, 4th, Last. Example: The fourth Thursday of November.
Day of Week	If Type = Relative Repeating Date, the day. Example: The fourth Thursday of November.
Month (Relative Repeating Date)	If Type = Relative Repeating Date, the month of the year, or All. Example: The fourth Thursday of November.
Month (Absolute Repeating Date)	If Type = Absolute Repeating Date, the month. Options: January through December, or All. Example: December 25.
Day (Absolute Repeating Date)	If Type = Absolute Repeating Date, the day. Options 1 through 31. Example: December 25.
Date (Single Date)	If type = Single Date, this field allows you to enter or select a single date.
Date (List of Dates)	If Type = List of dates, this field allows you to manually add a series of dates by typing each one in and clicking the Add key
Submit button	Submits the new record to the database.
Update button	Saves updates to the record.
List Qualifying Dates button	Opens a new browser and displays a list of the next 20 dates on which this day occurs.
Delete button	Deletes the current record.
Calendar Custom Days tab	Displays all calendars that use this custom day.

Creating a New Calendar

1. From the Navigation Pane, select Calendars. The system displays the Calendars list. Shown below is the default calendars list:



2. From the wizard, select New. OpsWise Automation Center displays a blank calendar screen.
3. Give the calendar a name and description, and select the business days for this calendar. The default selection is Monday through Friday.
4. Right-click on the title bar and select Save to save the record and remain on the current display.
5. Follow the appropriate instructions below to assign existing custom days to this calendar or add new custom days to the calendar.
6. If appropriate, repeat these steps for any additional calendars you want to add.

Shown below is the default Canadian calendar, which defines Canadian holidays.

Field Descriptions

The following table provides field descriptions for the calendar form.

Field Name	Description
Name	User-defined. Name used within OpsWise Automation Center to identify this calendar. Up to 40 alphanumerics. It is the user’s responsibility to develop a workable naming scheme for calendars.
Comments	User-defined. Provides a description for the calendar.
Member of Groups	User-defined. Allows you to select one or more Opswise groups that this calendar definition belongs to. Click on the lock icon to unlock the field and select groups.
Business Days	User-defined. Allows the user to select which days of the week constitute business days for this calendar.
Submit button	Submits the new record to the database.
Update button	Saves updates to the record.
Calendar Preview button	Opens a new browser and displays a calendar for the next four years (including the current year). All the dates specified in this calendar are highlighted and identified.
Delete button	Deletes the current record.
Calendar Custom Days tab	Displays all custom days associated with this calendar.

Assigning Existing Custom Days to the Calendar

1. Open the calendar to which you want to assign one or more existing custom days.
2. Click on the Calendar Custom Days tab or scroll down to that section.
3. Click the Edit button. The Edit Members form displays:



4. The days listed under Collection are existing Custom Days that do not already belong to this calendar. The days listed under Has Custom Days List are days that belong to this calendar. You can filter the days listed under Collection as follows:
   1. Click Add Filter. See To create a filter for information about how to construct a filter.
   2. When you have defined the filter you want, click Run Filter. The Collection list now displays only those days that match the filter.
   3. To remove filtering, click the minus sign to the left of each condition, then click Run Filter again.
5. To add to or remove days from the Has Custom Days List:
   • To add a day to the list, double-click on the day in the Collection list.
   • To remove a day from the list, double-click on the name in the Has Custom Days List.
   As you click on a day the system displays details about the day at the bottom of the form.
6. When you are finished, click Save.

Adding New Custom Days and Assigning Them to this Calendar

1. Open the calendar to which you want to add and assign custom days.
2. Click on the Calendar Custom Days tab or scroll down to that section.
3. Click New. The system displays the Custom Days screen.
4. Fill in the fields using Creating Custom Days for guidance.
5. When you click Submit from the calendar form, the custom day is automatically added to the Has Custom Days List.