Scheduling

Prev Next

Pathfinder Core PRO Scheduling Module

Note - This feature requires an additional license as described below.

Overview

The Scheduling module is an additional module that may be enabled in Pathfinder Core PRO through a license add-on. It extends the Day of Week and Date/Time timers. This module lets you define resources and event templates, then apply them on a drag-and-drop calendar to schedule changes.

Scheduling License

This feature requires a scheduling license. For evaluation, we can also supply a 90-day demo license. Events created using this demo license continue to work after the demo expires, but you can no longer view them in the calendar. After the demo expires, you can still view and edit the events in the normal timers editor dialog. Because these timer events use a different object type, events created with the scheduling demo feature may not work if you downgrade to a previous version of the Pathfinder Core PRO software. You can also open a demo calendar that has non-functioning data to evaluate the concepts. This does not require a license.

Without a scheduling license, the Resources, Templates and Calendars tabs of the Timers page show a License Required message. Its Demo button opens the demo calendar.

Calendar

The Scheduling module adds an optional calendar-based scheduling system to Pathfinder Core PRO. While scheduling of time-based events has always been possible, the Scheduling module simplifies this process with a drag-and-drop calendar user interface and the ability to dynamically combine properties and values during that process.

The Scheduling module is made up of four objects:

  • Resources: A container for a set of events, which may also include properties and values that interact with templates that are dropped onto the resource. AirChain1, 2, and 3 are resources in the picture above.

  • Templates: An event template with duration and start and end actions. Templates are displayed in the list of rectangles on the left side of the screen in the picture above and can be dragged onto the calendar.

  • Calendars: A calendar-based visualization of resources and their associated events along with drag-and-drop visualizations of templates. The image above is a calendar with three resources, five currently displayed ResourceEvents, and four templates.

  • ResourceEvents: An event with a start and end time and action to perform at the start and end. The action data may include information from both the resource and template used to create the event. The events are displayed at the time values in the calendar.

To schedule an event, drag an event template onto the correct resource in the calendar, then adjust its duration or placement by dragging the event or its bottom edge. If you have the rights to do so, click the event to change its details, as shown below:

In the calendar shown earlier, each event makes a route change of the studio source defined in the template to the AirChain destination defined by the resource. So when we drop a studio onto the resource, the destination from the resource is combined with the source from the event template in a new event with the correct time parameters that we define by dragging the duration. This makes scheduling studio-to-air-chain routing a simple drag-and-drop procedure.

No changes take effect until you click the Apply button. The Apply and Cancel buttons flash when there are pending changes that have not been committed.

Creating a Resource

This section explains how resources, templates, calendars, and resource events are created and interact. To create a calendar such as the one above, an Administrator first defines the resources and templates. To do this, click the Timers navigation bar link and then click the Resources tab.

Click the Add + button to add a new resource:

Each resource can have a name and description, a color, a start property and value, and an end property and value. The start property and value determine what happens at the start of a newly created event, and the end property and value set what happens at its end. In each case where the start and end property fields are used (resources, templates, and events), if an end action is not defined, nothing will happen at the end of the event time range.

The values defined here are overridden by the template when a new template is dropped on the resource, unless the template says to take data from the resource. We will see more of this when we get to the templates section below. For example, we could leave all of the Start and End fields blank and define what happens only in the template. In the Studio and AirChain example above, we clicked the ellipsis button and defined memory slots and a blank start value in these fields. The dialogs for property and value selections are the same as for the Date/Time and Day of Week timers described in the Timers section of the manual.

Click the ellipsis buttons for each field and select the air chain destinations. The sources can be set to none or anything you like, because we will override them in the templates section below.

You can also pick a color. The clone resource link quickly duplicates a resource when you need several resources with only slight differences between them. Each resource requires a unique name.

Creating a Template

After creating several resources with different destinations for your air chains, click the Templates tab and then use the Add + button to define a new template.

Several fields have a checkbox next to them called Assigned by Resource. Selecting this checkbox means that the field is taken from the equivalent field in the resource when the template is dropped onto the resource. For example, use the import from resource drop-down to import the settings for the properties and values from one of the AirChain resources you created earlier, which is easier than selecting them again manually. Then provide a name and a start value, and enable the checkboxes on the start and end properties and the end value. The duration is the default duration used when the template is dropped in the calendar, and it can then be adjusted by dragging the event. The result will look like this:

Template to Resource Relationship

This means that when this template is dropped onto the resource, the template will provide the source values and the resource will provide the property (destination) and color values.

If we had not turned on any of the “Assigned by Resource” checkboxes, all of the parameters from the template would be used. Why is it useful to split the parameters up in this way? The original calendar shows why.

Here, if you drag Studio1 onto AirChain1, the event will have the air chain destination and the studio source. If you decide you made a mistake, you can drag the event to AirChain2, and the memory slot for the event will update to reflect the change.

Creating a Calendar

Returning to the administrative configuration, we still need to create the calendar. To do that, click the Calendars tab and click the Add + button. The calendars dialog allows us to create a new named calendar and configure which resources and templates the calendar can use.

Supply a name and description for the calendar and then select the resources and templates that are available for use. The same resources and templates can be used on multiple calendars. Think of a calendar as a view of resource-based events and the templates as the available events that may be applied. After you apply the new calendar settings, the calendar becomes available in the calendar list, and the view button lets a user start working with it.

Zip One Dialer Example

All of the examples so far make route changes, but they do not have to. Any property in the system can be used in a resource or template and therefore scheduled. For example, we could change the resource and template to use ZipOne dialing parameters. When creating the resource, click the ellipsis button, then use the Endpoints button to open the normal Logic Flows endpoint selector.

Suppose we create our resource to look like this:

And our template to look like this:

In this instance, the resource defines the Zip One Connect property as well as the Zip One drop property and value, and the template supplies only the dial location. Using this method, we could create a calendar for scheduling Zip One dialing, such as:

In this example, our event templates are dial locations and our resources are the Zip One to use for the dialing.

Show Profiles

As one last example, we could create a calendar to schedule the loading of show profiles on a console:

In this example, the templates are show profiles and the only resource on the calendar is the iQs console on which they are being scheduled.

These examples show that anything Pathfinder Core PRO knows about can be scheduled, and that you can create multiple calendars to schedule different types of things.

Timezone Selector

The calendar has a time zone selector in the top left corner. By default, when the calendar is displayed, it queries Pathfinder Core PRO for its current time zone and sets the calendar to that time zone. Changing the time zone changes how the events are viewed. If you add events while the calendar is in a different time zone than Pathfinder Core PRO, the event times are converted to the Pathfinder Core PRO time zone when the Apply button sends the changes to the system.

Check the selector when the calendar opens. If the system's time zone is set under a name the selector does not list, such as US/Eastern, the calendar falls back to the first zone in the list (Africa/Abidjan, which is UTC). Choose the correct zone, for example America/New_York, before adding events.

Below the template list is a slider that sets how finely the day and week views divide each hour, from one-hour slots to one-minute slots. The default is 15 minutes.

Calendar Controls and Views

There are several controls across the top of the calendar. In the right-hand corner are several buttons that change the view.

Clicking these buttons will change the calendar view to one of the following:

Month: Dropping templates onto the month view is not allowed because there is not enough resolution for time selection.

Week: Dropping a template onto a week view will always assign the template to the first resource assigned to the calendar. This can then be adjusted if necessary in the day view.

Day: This is the primary and default scheduling view.

List: This view is for informational purposes only and cannot be a drag-and-drop target.

On the left-hand side are a today button that returns the view to the current day and left and right arrows for moving by day, week or month, depending on the view.

The Apply and Cancel buttons apply or cancel any pending changes to the Pathfinder Core PRO timer engine. These buttons will flash if there are pending changes. Events that have not been applied do not exist in Pathfinder Core PRO and are not acted on.

Calendar Url option for calendar only display

If you want to display a scheduling calendar without the rest of the Pathfinder header and navigation bar, add a parameter to the URL. The parameter is nonavnohead. Place it after the ? in the URL, followed by an ampersand. For example:

http://172.16.250.201/admin-timers-calendar.php?nonavnohead&calendarName=MyCalendar

This can also be used with the iframe widget in panels to embed the scheduling calendar into a panel.

Colors

You can define colors in the templates, in the resources, and in the events themselves. Internal logic decides which color is used when an event is created. If the template has the Assigned by Resource checkbox enabled for the color, then the resource color will be used. This is the default because in a week or month view, where the resource columns are not visible, events for a specific resource all have the same color, which makes it easy to tell which events belong to which resource. However, you may prefer the color to relate to the template that created the event. In that case, clear the Assigned by Resource checkbox in the template, and newly created events will use the template color. Finally, once an event is created, you can click it and select a color specific to that event instance.

Event Editing

After an event is created, if the settings generated by the resource/template combination are not what you want, you can click the event and edit it as needed.

This is essentially the same timer editing dialog that is described in the Timers section of the manual above. The only differences are the presence of the color, template, and resource fields and different options in the timer type field. Calendar-based timers must be of type Resource Event or Recurring Resource Event. These two types equate to the DateTime event type and the DayOfWeek type but are designed to work with the calendar. You can change the name of the event from the default one that is generated, but the name must be unique within the timers in the system.

Recurring Events

When creating an event template or editing an event, you can make it a recurring event rather than a one-time event by selecting the Recurring timer type.

This will add fields for selecting the days of the week on which the event should occur.

Dragging a recurring template onto the calendar makes it appear at the selected time slot on all days of the week for which the template is configured, from that date on. Here the Weekday_News template, set for Monday to Friday, was dropped onto Wednesday, so it appears on Wednesday, Thursday and Friday of this week and on every weekday after that:

It can be confusing if you drag a recurring event to a day view on a day of the week when the event is not scheduled to take place. This will appear to have no effect, but if you use the week view to zoom out, you will see that the event has been added and applied to the correct days.

Changing the length or any of the properties of a recurring event changes the base recurring event and therefore affects all days the event takes place. For example, in the week view above, if you grab the duration handle on the bottom of one of these events and make the event longer, all of them will change because they are all just views of a single recurring event.

Deleting an Event

When editing an event, you will also see the trash can icon in the bottom right corner.

To delete an event that has been added to a calendar resource, click the event and then click the trash can icon. The system asks whether you are sure you want to delete the event:

Click Delete, and then click the Apply button to remove the event from the system. Deleting a recurring event will delete all instances of that recurring event. There is currently no way to delete a single day of a recurring event. Instead, disable that day in the event and then re-enable it afterward if you want it to happen on that day in the future.