sc-roster

This document is a user guide for the sc-roster component release version 7.1.24.

1 Purpose

The sc-roster component places an interactive gantt chart field on a form, displaying a list of Resources and the Tasks (if any) assigned to them, where:

• Resource data (e.g. Resource name) is retrieved from Resource documents.

• Task data (e.g. start date/time, end date/time, assigned Resource(s)) is retrieved from Task documents.

• Resources are listed vertically down the left side of the gantt chart.

• A timeline runs horizontally across the top of the gantt chart.

• Tasks are represented by Task bars below the timeline, each adjacent to the resource it is assigned to. The start date/time, end date/time and duration of a Task determine the length of a Task bar and its position under the timeline .
• A red vertical dateline highlights the current date/time.

The sc-roster gantt chart provides or can be defined with the following functions:

1. The ability to scroll vertically up and down the list of resources.

2. The ability to scroll horizontally across the timeline.

3. The ability to drag and drop a Task bar allowing a Task to be resheduled to an earlier of later time leaving its duration unchanged OR to reassign the Task to a different Resource. When a Task bar is moved, its Task document will be automatically updated to reflect any changes to the its start date, end date and assigned Resource(s).

4. The ability to drag the end point of a Task bar in order to change the Task start date and/or end date OR to lengthen/shorten the Task duration. When an end point of a Task bar representing is dragged, its Task document will be automatically updated to reflect any changes to its start date and end date.

5. Mouse over of a Task bar will display a tooltip showing the Task document's sumaryDescription field value.

6. Clicking the "Now" button positions the gantt chart at the current date/time.

7. Clicking the "Hour" button sets the timeline scale to days, with each day divided into 24 one-hour cells.

8. Clicking the "Day" button sets the timeline scale to months, with each month divided into its days.

9. Clicking the "Week" button sets the timeline scale to months, with each month divided into its weeks.

10. Clicking a Task bar opens the document for that Task.

11. Clicking a Resource opens the document for that Resource.

The sc-roster definition provides fields for setting the properties of sc-roster gantt chart and is fully described below.

2 Definition

The sc-roster component is defined by a set of name/value pair fields consisting of:

• Required system fields
• Required customizable fields
• Optional customizable fields

Note:

1. Default values for fields described in the tables below are shown in bold text.

2.1 Required System Fields

2.2 Required Customizable Fields

2.3 Optional Customizable Fields

3 Typical Definition

Below is a typical sc-roster component definition, defined with its required fields plus any optional field whose value is typically other than its default value.

        {
            "componentName": "sc-roster",
            "name": "scRosterTypicalDefinition",
            "assignmentField": "taskResource",
            "assignmentId": "{'query':{'bool':{'must':[{'match':{'businessType':{'query':'Resource'}}},{'match':{'systemHeader.systemType':{'query':'document'}}}]}}}",
            "defaultView": "Day",
            "enableDragging": true,
            "endDateField": "taskEndDate",
            "filter": "{'query':{'bool':{'must':[{'match':{'businessType':{'query':'Appointment'}}},{'match':{'systemHeader.systemType':{'query':'document'}}}]}}}",
            "fullWidth": true,
            "label": "sc-roster Typical Definition",
            "maxHeight": 200,
            "refreshInterval": 60,
            "startDateField": "taskStartDate",
            "urlOpenIn": "newWindow",
            "viewType": "gantt"
        }

One or more of the optional fields shown below can be included in the above definition should a value other than their default value be required.

            "backgroundRefresh": true,
            "enabled": false,
            "visible": false,

4 Examples

Example 1

sc-roster component defined with the typically needed fields.

        {
            "componentName": "sc-roster",
            "name": "scRosterTypicalDefinition",
            "assignmentField": "taskResource",
            "assignmentId": "{'query':{'bool':{'must':[{'match':{'businessType':{'query':'Resource'}}},{'match':{'systemHeader.systemType':{'query':'document'}}}]}}}",
            "defaultView": "Day",
            "enableDragging": true,
            "endDateField": "taskEndDate",
            "filter": "{'query':{'bool':{'must':[{'match':{'businessType':{'query':'Appointment'}}},{'match':{'systemHeader.systemType':{'query':'document'}}}]}}}",
            "fullWidth": true,
            "label": "sc-roster Typical Definition",
            "maxHeight": 200,
            "refreshInterval": 60,
            "startDateField": "taskStartDate",
            "urlOpenIn": "newWindow",
            "viewType": "gantt"
        }

Resulting sc-roster gantt chart field on the form:

Mouse over of a Task bar:

Example:

Mouse over the "Task 0003" Task bar will display a tooltip showing the Task document summaryDescription field value.

Clicking a Task bar:

Example:

Clicking the 'Task 0002" Task bar will opens a new window displaying the "Task 0002" document.

The "Task Resource(s)" field on the form is a sc-related-document field showing "Field Resource 007" and "Field Resource 008" are assigned to "Task 0002". "Task 0002" start date/time and end date/time values together with its 2 assigned Resources are used to position the two Task bars for "Task 0002" shown on the sc-roster gantt chart above.

Example:

Clicking the Task bar for "Task 0003" opens a new window displaying the "Task 0003" document.

The "Task 0003" start date/time and end date/time values together with its one assigned Resource are used to position the Task bar for "Task 0003" shown on the sc-roster gantt chart above.

Dragging a Task bar and/or grabbing and dragging either of its end points to a new location on the gantt chart:

Example:

Dragging the "Task 0003" Task bar from "Field Resource 003" to "Field Resource 001" and to a start date of 28 Jun 2023 and grabbing and dragging its end point to reduce its duration from 9 days to 5 days:

In addition to changing its position on the gantt chart, the "Task 003" document will be automatically updated to reflect changes to its start date/time, end date/time and assigned rsource(s).

Clicking a Resource listed on the right side of the gantt chart:

Example:

Clicking "Field Resource 008" opens a new window displaying the "Field Resource 008" document.