Scheduler

The scheduler portlet allows the user to easily schedule, display and edit appointments or tasks. It can be in different time views; day, week, month, timeline, agenda or customized view, and can be grouped horizontally and vertically.

The scheduler is based on three tables; Resource, Task and Assignment, where the Resource is the who or where, the Task is the what and the Assignment is the connection of the Resource and Task. A resource can be a person that is to perform certain task, or the resource can be a room in which a meeting (the task) is to take place.

Delete task must be handled by a workflow, consistant with how the other visual planning portlets work.

Important time zone information: The scheduler is expecting the time standard to be UTC (Coordinated Universal Time). Any adjustments due to server location and setting must be handled in the workflows.

Basic Data

Internal name - unique string to identify this portlet.

Portlet title - title of the portlet, does not have to be unique.

Checkbox options

Enable header - enables the portlet header, ie makes it visible in the portal. It is possible select a header background color by clicking on one of the color in the color palette, remove the color by pressing the X underneath the palette
Header background color - select a header background color by clicking on one of the color in the color palette, remove the color by pressing the X underneath the palette
Header color text - select a header text color by clicking on one of the color in the color palette, remove the color by pressing the X underneath the palette

Scheduler View and Custom Timeline

Height - the height of the scheduler shown in the portlet.

Major tick - the number of minutes each time header represents, ie the setting 60 means the headers will be full hours, 120 every second hour and 1440 a full day. See major tick example below.

The start time of the week and day views - the first hour the scheduler should show when in day or week views.

The end time of the week and day views - the last hour in the scheduler when in day or week views.

Start of the work day - the first hour of the work day. In day and week views it is possible to in the portlet to select to show only business hours.

End of the work day - the end hour of the work day. In day and week views it is possible to in the portlet to select to show only business hours.

Scheduler views - configure which views that are to be available to the user. It is possible to select one or multiple.

Horizontal grouping - tick the box if the resource is to be shown horizontally instead of vertically.

Show times in header - untick if time is not to be shown in header.

Custom timeline title - the title that will be shown to the user for customTimeline if included in Scheduler View.

Custom timeline column width - the width of the columns.

Number of days to show in custom timeline - the customer timeline will start two days before today so if this field is set to 7, the day before yesterday, yesterday, today and the future four days will be shown. The idea with custom timeline is that the customers can create a rolling timeline configured to their needs when planning etc.

Auto Refresh

Enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

Self-Hosting Flows

Enables the portlet to continue running when the user reaches for another portlet.

Commands

Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

onRowSelected
onGenericTreeNodeSelected
onRefresh
onFilter

The portlet will listen to the following portlets: Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

Data Source configuration

The scheduler is to be configured with tasks, resources and assignment data.

Tasks

The datasource must include a unique task identifier, a title and the start and end date and time.

Resource

The data source must include a unique resource identifier and as optional a title and a group. The group can be used as a scheduler specific filter, see Filtering Options - Group further down in the text.

Assignments

An assignment must have a unique id and the configuration connects the resource id with the task id.

Flow Configuration

See Flow Configuration in Table Portlet.

Workflows:

Create Task - this workflow is to be able to create new tasks in the scheduler, the user clicks in a timeslot to run the workflow.

Drag and Drop - this workflow it to change or move tasks. A task can have the time period extended or decreased, moved in an earlier or later timeslot for the resource or moved to a different resource altogether.

Double Click - double click on a task to run a workflow.

Task Icon Configuration

It is possible to display icons on Scheduler tasks.

Default Icon - field where a default icon value can be added.

Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be displayed on the activity. Us the Add button to add rows, the X on row level to remove.

Task Coloring Configuration

The tasks for the Scheduler can be configures to be displayed in different colors. Select a default color or set up specfic color rules.

Color rule setup:

First value - variable.
Func - parameter to consider.
Second Value - the value to be measured against the variable.

In tooltip configuration enter the text and the variables that are to be seen in the tool tip when the cursor hovers above a task.

Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

Tooltip - add the text and variables, using {}, which are to be displayed

Usage in Client

Scheduler views

Settings in examples:

Week/Day view Start and End time = 07:00 - 17:00 Start and End workday = 08:00 - 16:00 Major tick = 240 Horizontal grouping unticked Custom timeline column width = 50Day

Day:

Week (shows 7 days, including Saturday and Sunday):

WorkWeek (shows 5 days, excluding Saturday and Sunday):

Month:

Agenda:

Timeline (shows one day):

TimelineWeek (shows timeline for one week, scrollbar available at the bottom of the portlet):

TimelineMonth (shows timeline for one month, scrollbar available at the bottom of the portlet):

CustomTimeline:

Filter Option - Group

The resources can be filtered by group, if a group has been mapped in the resource data source configuration. The groups are top right in the scheduler and by ticking and unticking the boxes the resources shown will be filtered.