1. Field Service Management
  2. FSM Configuration
  3. Configuring FSM Features
  4. FSM Schedule Board Configuration
  5. Configuring FSM Schedule Board Colors and Status Presentation

Configuring FSM Schedule Board Colors and Status Presentation

The configuration uses the spelling colour.

This topic includes the following sections:

The following table lists color properties, standard defaults, and their purposes.

Property

Standard Default

Purpose

colour.enabled

true

Enables color grouping.

colour.readonly

false

When true, prevents customization of color items and swatches. You can still select a color group.

colour.default

"priority"

Supplies the default color-group ID.

colour.group

Priority, status, Task type, and Case type groups.

Defines the mapped property and items used by each group.

colour.palette

Named palettes containing color swatches.

Defines palettes available to groups.

Color Group and Palette Properties

A group identifies the mapped event property to color. Its items associate returned values with labels, swatches, and optional map-cluster precedence. Keep a single value for a color category: the all-ID array used by the Case Type filter is not a suitable color category.

The following table describes color group, item, and palette properties.

Property Within colour

Accepted Value and Effect

group.<group ID>.label

Label displayed for the group.

group.<group ID>.column

Mapped event property whose value identifies a color item.

group.<group ID>.palette

Existing palette ID, such as "rainbow", "cool", "warm", or "contrast".

group.<group ID>.items

Array of items, or a resolved search or combined collection that returns that array.

An item's id

Value matching the group's mapped event property. Use record IDs rather than labels for record-based choices.

An item's label

Label displayed for the item.

An item's swatch

Named swatch included in the group's palette. An omitted swatch is assigned from the palette in item order, cycling when necessary.

An item's cluster

Optional precedence for the color of a map cluster. Lower values take precedence. Use consistent numeric ranks when defining this behavior.

group.<group ID>.eventswatch

When true, a populated event-level swatch takes precedence over the group item. When false, the group replaces that event-level swatch. The standard groups use true.

palette.<palette ID>.label

Palette label displayed to the user.

palette.<palette ID>.swatches

Nonempty array of named swatches available to the palette. An override replaces the inherited array.

Include an explicit item swatch in the group's configured palette. If a user chooses another palette, the corresponding position in that palette is used. Saved item swatch choices can also take precedence.

Adding Colors to a Palette

The following fragment makes redpigment and sizzlingsunrise available in Cool by replacing cornflowerblue and cyanprocess. It retains the other six entries and the palette's eight positions.

            {
  "routes/scheduler": {
    "colour": {
      "palette": {
        "cool": {
          "swatches": [
            "redpigment",
            "viridiangreen",
            "sizzlingsunrise",
            "mediumaquamarine",
            "inchworm",
            "electricpurple",
            "electricindigo",
            "battleshipgrey"
          ]
        }
      }
    }
  }
}

The swatches array replaces the inherited array. This example changes the choices for every group using Cool. An inherited item whose configured swatch was removed falls back to a palette color unless a saved choice takes precedence.

Use recognized swatch names. These values identify the board's supplied styles. Entering a new name or a hex color doesn't define a new swatch.

Keep matching positions available in every palette that you can select. The color picker wraps additional swatches onto another row. If you switch to a shorter palette, a configured or selected color can lose its corresponding position. This example preserves eight positions, matching the standard palettes.

Changing an Existing Color Group

Combine this fragment with the preceding Cool-palette change. The fragment changes the Priority group to use Cool and preserves all three priority IDs and cluster ranks. It sets High to redpigment, Medium to sizzlingsunrise, and Low to viridiangreen.

            {
  "routes/scheduler": {
    "colour": {
      "group": {
        "priority": {
          "palette": "cool",
          "items": [
            {
              "id": "1",
              "label": "High",
              "swatch": "redpigment",
              "cluster": "1"
            },
            {
              "id": "2",
              "label": "Medium",
              "swatch": "sizzlingsunrise",
              "cluster": "2"
            },
            {
              "id": "3",
              "label": "Low",
              "swatch": "viridiangreen",
              "cluster": "3"
            }
          ],
          "eventswatch": true
        }
      }
    }
  }
}

The complete items array replaces the inherited Priority items. The priority values on the tasks are unchanged. eventswatch: true retains event-level presentation, including the standard gray color for completed tasks.

Status Presentation

eventstatus defines labels and icons for mapped event statuses. Standard entries include not started, in progress, completed, tentative, confirmed, and overdue.

Changing a color, label, or icon doesn't change the underlying record status or the rules governing its transitions. For automated case and CRM task status behavior, see FSM Case and CRM Task Status Automation.

Additional Information

Related Topics

General Notices