Model output

The modelOutput object of the output dataset includes shifts and employees.

When shift generation is enabled, modelOutput additionally includes a generatedShifts collection containing the shifts produced from demand curves and templates. See shift-service-constraints/demand-based-scheduling.adoc#_shift_generation for details. Shift generation is a preview feature subject to change.

shifts contains the shift assignments, identified by the shift ID and the employee ID of the employee assigned to the shift:

{
  "modelOutput": {
    "shifts": [
      {
        "id": "2027-02-01",
        "employee": "Beth"
      },
      {
        "id": "2027-02-02",
        "employee": "Carl"
      }
    ]
  }
}

employees contains metrics for each employee. Note, only metrics with a value are present. For instance, if no overtime is worked, the overtimeWorked metric will not be present in the output.

{
  "modelOutput": {
    "employees": [
      {
        "id": "Beth",
        "metrics": {
          "assignedShifts": 10,
          "durationWorked": "PT40H",
          "durationOfTimePreferencesMet": "PT8H",
          "durationOfTimeUnpreferencesViolated": "PT8H",
          "disruptedShifts": 5,
          "durationOfDisruptedShifts": "PT8H",
          "overtimeThresholdDuration": "PT40H",
          "overtimeWorked": "PT40H",
          "maximumAvailabilityDuration": "PT48H",
          "costDefinitionTotalCost": 5,
          "costDefinitionOvertimeDuration": "PT48M"
        }
      }
    ]
  }
}

Next