{ "$ref": "#/definitions/ManifestSchema", "definitions": { "ManifestSchema": { "type": "object", "properties": { "version": { "type": "string", "const": "v1", "description": "Schema version. Currently 'v1'" }, "account": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique account identifier (e.g., 'acme-manufacturing', 'global-ops')" }, "domain": { "type": "string", "description": "Email domain of the account's users (e.g., 'acme.com'). Users on this domain can log in without being added." }, "stationCountLimit": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Maximum number of stations allowed across all plants" }, "electricalPricePerKwh": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Cost per kilowatt-hour for electrical consumption (e.g., 0.15)" }, "electricalCo2PerKwh": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "CO2 emissions per kilowatt-hour (e.g., 0.233)" }, "currency": { "type": [ "string", "null" ], "description": "ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')" }, "maxProductionCountPerSchedule": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9999999 }, { "type": "null" } ], "description": "Maximum production units a single schedule may record before recording stops. Null/absent means no limit." }, "dashboardConfig": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "null" } ], "description": "Custom dashboard configuration (key-value pairs)" }, "redshiftPassword": { "type": [ "string", "null" ], "description": "Redshift database password (system managed)" }, "uploadTransforms": { "type": [ "string", "null" ], "description": "Upload transformation configuration (system managed)" }, "durationFormat": { "anyOf": [ { "type": "string", "enum": [ "months", "days", "hours", "minutes" ] }, { "type": "null" } ], "description": "Duration display format (e.g., 'months', 'days', 'hours', 'minutes')" }, "appUrls": { "type": [ "string", "null" ], "description": "Custom application URLs (system managed)" }, "includeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Reason Codes: If set, only these reason codes are available at this level. Applied before excludeReasonCodes." }, "excludeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Reason Codes: These reason codes are removed at this level. Applied after includeReasonCodes." }, "includeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task Codes: Legacy, no longer applied. Superseded by includeTaskListCodes." }, "excludeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task Codes: Legacy, no longer applied. Superseded by excludeTaskListCodes." }, "includeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task List Codes: The Task lists available at this level. Unlike reasons, no level setting this means no Task lists are available — lists must be included explicitly before their Tasks appear on a station." }, "excludeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task List Codes: These Task list codes are removed at this level. Applied after includeTaskListCodes." }, "createdAt": { "type": [ "string", "null" ], "description": "Account creation timestamp (ISO 8601, system managed)" }, "updatedAt": { "type": [ "string", "null" ], "description": "Last update timestamp (ISO 8601, system managed)" }, "archivedAt": { "type": [ "string", "null" ], "description": "Archive timestamp (ISO 8601, system managed). When set, the account is archived and hidden from active lists." }, "enableTasks": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Enable Tasks: Enable the Tasks feature for this account (OI-managed paid feature)." }, "enableCycleTimeAnalysis": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Enable Cycle Time Analysis: Show the Cycle Time Analysis menu item for this account (OI-managed)." }, "enableLostProductionCost": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Enable Lost Production Cost: Enable tracking of lost production costs." }, "enableAutoEndOnQuantityComplete": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Auto-End on Quantity Complete: Automatically end schedules when their target quantity is reached (account default)." }, "enableDragBetweenStationsOnGantt": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Drag Between Stations on Gantt: Allow schedules to be reassigned to a different station by dragging on the Gantt chart." }, "enableProductionCorrection": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Production Correction: Allow operators to correct production counting errors during a running schedule from the tablet." }, "enableHistoricalCorrection": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Historical Production Correction: Correct production counts on schedules that have already ended. Available to admins from the action menu on the schedule list and Gantt chart. This is separate from the tablet's live correction feature." }, "enableManualProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Manual Production: Allow operators to manually enter production quantities." }, "enableQuickScheduleStart": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Ad Hoc Schedules: Allow operators to start ad-hoc schedules from the tablet." }, "enableScheduleCutShort": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Cutting Schedules Short: Allow operators to end a schedule before its planned end." }, "enableRejectProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Rejecting Production: Allow operators to reject (scrap) produced units." }, "enableEditPartsPerCycle": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Editing Parts Per Cycle: Allow operators to override the parts-per-cycle value on a schedule." }, "enableScheduleStationFlexibility": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Schedule Station Flexibility: Allow schedules to run on any station within the group." }, "enableManualDowntime": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Allow Manual Downtime: Allow operators and API users to manually trigger downtime on a station, blocking production while active." }, "enableAlwaysConnected": { "anyOf": [ { "type": "string", "enum": [ "on", "off" ] }, { "type": "null" } ], "description": "Always Connected: Force this station to always show as connected, regardless of device signals. Useful for stations with no physical device. Inherits from parent level if not set." }, "shiftPatterns": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 64, "description": "Unique shift pattern identifier" }, "title": { "type": "string", "description": "Shift Pattern Title: The name of this shift pattern (e.g., 'default', '5-day', '24/7'). Used to reference the pattern from station groups and stations. Must be unique within the account." }, "shifts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Shift Name: The name of this shift. Multiple shifts can share the same name for grouping purposes (e.g., 'Day Shift' for split periods like 09:00-12:00 and 13:00-17:00). Does not need to be unique." }, "startHour": { "type": "number", "minimum": 0, "exclusiveMaximum": 24, "description": "Start Hour: The start hour in the day of this shift as a decimal (0-24). Example: 14.5 represents 14:30 (2:30 PM), 9 represents 09:00, 17.25 represents 17:15" }, "duration": { "type": "number", "exclusiveMinimum": 0, "maximum": 24, "description": "Duration: Duration of the shift in hours as a decimal. Example: 8 for 8 hours, 4.5 for 4 hours 30 minutes" }, "weekDay": { "type": "string", "pattern": "^[1-7]$", "description": "Week Day: The day of the week this shift starts on as a number string: 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday, 7 = Sunday" } }, "required": [ "name", "startHour", "duration", "weekDay" ], "additionalProperties": false }, "minItems": 1, "description": "Array of shifts that make up this pattern (minimum 1). Shifts define the working periods throughout the week." } }, "required": [ "code", "title", "shifts" ], "additionalProperties": false }, "description": "Array of shift patterns defining working schedules (optional). Shift patterns can be referenced by ID from station groups and stations." }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique reason code used to reference this reason (e.g., 'MAINTENANCE', 'BREAKDOWN', 'PLANNED-PM'). Must be unique within the account." }, "description": { "type": "string", "description": "Human-readable description of this reason (e.g., 'Planned maintenance', 'Equipment breakdown', 'Material shortage')" }, "type": { "type": "array", "items": { "type": "string", "enum": [ "downtime", "non-production", "quality" ] }, "minItems": 1, "description": "Array of reason types this code applies to. Options: 'downtime' (for unplanned stoppages), 'non-production' (for planned activities), 'quality' (for bad/rejected production). A reason can have multiple types. Example: ['downtime'], ['non-production'], ['downtime', 'non-production']" }, "requireNotes": { "type": "boolean", "description": "Require Notes: When enabled, operators must enter notes before the reason can be confirmed. Only applies when the reason is assigned to a downtime. Omit the field to inherit the nearest ancestor reason's setting; set false to explicitly opt out of an inherited true." }, "reasons": { "type": "array", "items": {}, "description": "Optional array of child reasons that are subcategories of this reason. Used to create hierarchical reason structures (e.g., 'Maintenance' → 'Preventive Maintenance' → 'PM Check')." } }, "required": [ "code", "description", "type" ], "additionalProperties": false }, "description": "Array of reason codes for categorizing non-productive time (optional). Reasons can be hierarchical with nested child reasons. Used for both planned non-production schedules (e.g., maintenance, breaks) and categorizing downtime detected by Busroot." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique Task code used to reference this procedure (e.g., 'TASK-001', 'STARTUP-CHECK'). Must be unique within the account." }, "title": { "type": "string", "description": "Human-readable title of the Task (e.g., 'Machine Startup Checklist', 'Quality Inspection Procedure')" }, "description": { "type": "string", "description": "Detailed description of the Task and its purpose" }, "trigger": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "schedule", "description": "Once per production schedule: pending from when the schedule starts, missed if it ends first." } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "cron" }, "pattern": { "type": "string", "minLength": 1, "description": "Standard 5-field cron pattern (minute hour day-of-month month day-of-week), evaluated in the station's plant timezone" }, "availableBeforeDeadlineMinutes": { "type": "integer", "exclusiveMinimum": 0, "description": "How many minutes before the deadline (the cron fire) this Task becomes available to complete on the tablet. Required for cron Tasks; must be shorter than the smallest gap between consecutive cron fires." } }, "required": [ "type", "pattern" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "on_demand", "description": "On Demand: no deadline; the operator starts the list from the tablet whenever it is needed." } }, "required": [ "type" ], "additionalProperties": false } ], "description": "What makes this Task pending. 'schedule' = once per production schedule; 'cron' = at every fire of a cron pattern (Timer); 'on_demand' = whenever the operator starts the list from the tablet; never missed for time." }, "requireNotes": { "type": "boolean", "description": "When enabled, operators must enter notes before this Task can be confirmed as complete." }, "taskListCodes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "Code of the Task list this Task belongs to" }, "order": { "type": "number", "description": "Display order of this Task within this list: greater than 0 and at most 100. Decimals are allowed, so a Task can be inserted between two others." } }, "required": [ "code" ], "additionalProperties": false }, "description": "The Task lists this Task belongs to, with its display order within each. A Task can belong to several lists and is completed independently in each." } }, "required": [ "code", "title" ], "additionalProperties": false }, "description": "Array of Tasks (optional). Tasks can be linked to stations or SKUs via taskCodes arrays." }, "taskLists": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "description": "Unique Task list code used to reference this list (e.g., 'DAILY-CHECKS'). Must be unique within the account." }, "name": { "type": "string", "description": "Human-readable name of the Task list (e.g., 'Daily Checks')" }, "description": { "type": "string", "description": "Detailed description of what this Task list groups together" }, "trigger": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "schedule", "description": "Once per production schedule: pending from when the schedule starts, missed if it ends first." } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "cron" }, "pattern": { "type": "string", "minLength": 1, "description": "Standard 5-field cron pattern (minute hour day-of-month month day-of-week), evaluated in the station's plant timezone" }, "availableBeforeDeadlineMinutes": { "type": "integer", "exclusiveMinimum": 0, "description": "How many minutes before the deadline (the cron fire) this Task becomes available to complete on the tablet. Required for cron Tasks; must be shorter than the smallest gap between consecutive cron fires." } }, "required": [ "type", "pattern" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "on_demand", "description": "On Demand: no deadline; the operator starts the list from the tablet whenever it is needed." } }, "required": [ "type" ], "additionalProperties": false } ], "description": "What makes every Task in this list pending. Set on the list, not the Task — all Tasks in a list share it." } }, "required": [ "code", "name" ], "additionalProperties": false }, "description": "Array of Task lists (optional). A purely organisational grouping of Tasks, referenced by Tasks via taskListCodes." }, "skus": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code: Unique SKU code used to reference this product (e.g., 'WIDGET-001', 'PART-A'). Must be unique within the account." }, "name": { "type": "string", "description": "Name: Human-readable name describing this SKU. Example: 'Widget Type A', 'Component Assembly'" }, "specifications": { "type": [ "string", "null" ], "description": "Specifications: Detailed specifications or technical description of the SKU" }, "instructionsUrl": { "type": [ "string", "null" ], "description": "Instructions URL: URL to manufacturing instructions or work instructions for this SKU" }, "cycleTime": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 43200000 }, { "type": "null" } ], "description": "Cycle Time: Standard cycle time in milliseconds for producing this SKU. Used for discrete operations with defined cycles. Exactly one of cycleTime, unitsPerMinute, or unitsPerHour must be set. Example: 30000 (30 seconds), 600000 (10 minutes)" }, "unitsPerMinute": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Units Per Minute: Standard production rate in units per minute. Used for moderate-speed processes. Exactly one of cycleTime, unitsPerMinute, or unitsPerHour must be set. Example: 2, 4, 10" }, "unitsPerHour": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Units Per Hour: Standard production rate in units per hour. Used for high-speed continuous manufacturing. Exactly one of cycleTime, unitsPerMinute, or unitsPerHour must be set. Example: 1200, 2400, 6000" }, "minimumCycleTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200000 }, { "type": "null" } ], "description": "Minimum Cycle Time: Absolute minimum cycle time in milliseconds. Used to filter erroneous or duplicate production signals. Example: 5000 (5 seconds), 10000 (10 seconds)" }, "partsPerCycle": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Parts Per Cycle: Number of units produced in a single cycle. Used when production complete signals are received. Example: 1, 2, 10" }, "lineSpeedTarget": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 99999 }, { "type": "null" } ], "description": "Line Speed Target: Target line speed for this SKU. Example: 100, 120, 50" }, "downtimeDurationThresholdMultiplier": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Downtime Duration Threshold Multiplier: Multiple of cycle time used as downtime threshold when production-based downtime detection is enabled. Example: 2.0 means downtime triggers after 2x cycle time" }, "value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Value: Nominal value for 1 unit of this SKU in account currency. Used in calculating lost production cost. Example: 5.50, 12.00, 0.75" }, "allowUseInQuickSchedule": { "type": [ "boolean", "null" ], "description": "Allow Use In Quick Schedule: Determines if this SKU can be selected when creating ad-hoc schedules from tablets" }, "stationCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Station Codes: Array of station codes allowed to produce this SKU. If specified, only these stations can be scheduled with this SKU. Example: ['STA-01', 'STA-02']" }, "stationGroupCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Station Group Codes: Array of station group codes allowed to produce this SKU. If specified, only stations in these groups can be scheduled with this SKU. Example: ['LINE-01', 'LINE-02']" }, "taskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Task Codes: Array of Task codes linked to this SKU. References Tasks defined at the account level. Example: ['TASK-001', 'QC-CHECK']" } }, "required": [ "code", "name" ], "additionalProperties": false, "description": "A record for an SKU (aka part or component) that is referenced when scheduling production." }, "description": "Array of SKUs (products/parts) that can be manufactured (optional). SKUs define production characteristics and can be referenced when scheduling." }, "plants": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 3, "maxLength": 55, "pattern": "^[a-z0-9\\-]*$", "description": "Plant Code: The unique code for this plant." }, "name": { "type": "string", "description": "Human-readable plant name (e.g., 'Main Production Facility', 'East Coast Plant')" }, "timezone": { "type": "string", "description": "IANA timezone database name (e.g., 'America/New_York', 'Europe/London', 'Asia/Tokyo'). See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" }, "dayStartHour": { "type": "integer", "minimum": 0, "exclusiveMaximum": 24, "description": "Hour when the production day starts in 24-hour format (0-23). Example: 6 = 6:00 AM, 0 = midnight" }, "weekStartDay": { "type": "integer", "minimum": 0, "maximum": 6, "default": 0, "description": "Day the production week starts. 0 = Monday (default, ISO standard), 1 = Tuesday, 2 = Wednesday, 3 = Thursday, 4 = Friday, 5 = Saturday, 6 = Sunday" }, "includeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Reason Codes: If set, only these reason codes are available at this level. Applied before excludeReasonCodes." }, "excludeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Reason Codes: These reason codes are removed at this level. Applied after includeReasonCodes." }, "includeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task Codes: Legacy, no longer applied. Superseded by includeTaskListCodes." }, "excludeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task Codes: Legacy, no longer applied. Superseded by excludeTaskListCodes." }, "includeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task List Codes: The Task lists available at this level. Unlike reasons, no level setting this means no Task lists are available — lists must be included explicitly before their Tasks appear on a station." }, "excludeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task List Codes: These Task list codes are removed at this level. Applied after includeTaskListCodes." }, "totalEnergyStationCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Total Energy Station Codes: When set, this plant's energy (kWh, cost, CO2) is the sum of these stations' energy instead of the additive sum over member stations." }, "stationGroups": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique group identifier within the plant (e.g., 'LINE-01', 'ASM-A', 'PACKAGING')" }, "name": { "type": "string", "description": "Human-readable group name (e.g., 'Assembly Line 1', 'Packaging Line A')" }, "shiftPatternCode": { "type": [ "string", "null" ], "description": "Shift Pattern: The ID of the shift pattern this group follows" }, "includeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Reason Codes: If set, only these reason codes are available at this level. Applied before excludeReasonCodes." }, "excludeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Reason Codes: These reason codes are removed at this level. Applied after includeReasonCodes." }, "includeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task Codes: Legacy, no longer applied. Superseded by includeTaskListCodes." }, "excludeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task Codes: Legacy, no longer applied. Superseded by excludeTaskListCodes." }, "includeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task List Codes: The Task lists available at this level. Unlike reasons, no level setting this means no Task lists are available — lists must be included explicitly before their Tasks appear on a station." }, "excludeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task List Codes: These Task list codes are removed at this level. Applied after includeTaskListCodes." }, "totalEnergyStationCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Total Energy Station Codes: When set, this group's energy (kWh, cost, CO2) is the sum of these stations' energy instead of the additive sum over member stations." }, "createdAt": { "type": [ "string", "null" ], "description": "Group creation timestamp (ISO 8601, system managed)" }, "updatedAt": { "type": [ "string", "null" ], "description": "Last update timestamp (ISO 8601, system managed)" }, "enableProductionCorrection": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Production Correction: Allow operators to correct production counting errors during a running schedule from the tablet." }, "enableManualProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Production: Allow operators to manually enter production quantities." }, "enableQuickScheduleStart": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Ad Hoc Schedules: Allow operators to start ad-hoc schedules from the tablet." }, "enableScheduleCutShort": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Cutting Schedules Short: Allow operators to end a schedule before its planned end." }, "enableRejectProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Rejecting Production: Allow operators to reject (scrap) produced units." }, "enableEditPartsPerCycle": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Editing Parts Per Cycle: Allow operators to override the parts-per-cycle value on a schedule." }, "enableScheduleStationFlexibility": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Schedule Station Flexibility: Allow schedules to run on any station within the group." }, "enableSchedulingOnly": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Scheduling Only: Restrict the station to scheduling only (no live production capture)." }, "enableManualDowntime": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Downtime: Allow operators and API users to manually trigger downtime on a station, blocking production while active." }, "enableAlwaysConnected": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Always Connected: Force this station to always show as connected, regardless of device signals. Useful for stations with no physical device. Inherits from parent level if not set." }, "enableMeterOnly": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Meter Only: Meter Only: When true, this station represents a physical energy meter (e.g. a plant incomer). It only publishes electrical signals and is hidden from production views, rollups, and station pickers by default." }, "stations": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^([a-zA-Z0-9-_]+)$", "description": "Code: Assign a Code to the Station, this cannot be changed once set." }, "name": { "type": "string", "minLength": 1, "maxLength": 32, "description": "Name: The friendly name for this Station (1-32 characters). Example: 'Assembly Station 1', 'Quality Check'" }, "description": { "type": [ "string", "null" ], "description": "Description: Brief description of the station's purpose or function" }, "shiftPatternCode": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "description": "Shift Pattern: The ID of the shift pattern this station follows (overrides the group's shift pattern)" }, "minimumCycleTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200000 }, { "type": "null" } ], "description": "Minimum Cycle Time: Minimum time between production signals, set in seconds — if multiple signals arrive within this period, only one unit is counted. Useful for filtering signals during setup. Stored as milliseconds in the manifest." }, "speedScale": { "anyOf": [ { "type": "number", "minimum": -9999, "maximum": 9999 }, { "type": "null" } ], "description": "Speed Scale: If the value on the Performance Chart doesn't reflect actual running speed, it can be calibrated by setting this value. For example current value = 20, but actual speed = 10, scale should be set to 0.5." }, "speedOffset": { "anyOf": [ { "type": "number", "minimum": -9999, "maximum": 9999 }, { "type": "null" } ], "description": "Speed Offset: Fine tune a Speed value. For example if a Station's speed is showing as 0.5 when stopped, set the value to -0.5." }, "speedToProductionRatio": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999 }, { "type": "null" } ], "description": "Speed to Production Ratio: Convert a speed value into a production count. Set the conversion ratio, can be a decimal. If left blank no production units will be counted." }, "electricalPowerNominalKw": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Electrical Power Nominal (kW): The expected power usage in kW during normal operation." }, "idleCostPerMinute": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999 }, { "type": "null" } ], "description": "Idle Cost Per Minute: Cost per minute during idle time in account currency. Used for calculating scheduling losses, planned non-production losses, and downtime losses when SKU doesn't have a specific value." }, "downtimeDetectionMode": { "anyOf": [ { "type": "string", "enum": [ "off", "production", "utilisation", "line_speed" ], "default": "utilisation" }, { "type": "null" } ], "description": "Downtime Detection Mode: How to detect when the station is down. Options: 'off' (no detection), 'production' (use production cycle data), 'utilisation' (use utilisation signals - most common), 'line_speed' (use line speed monitoring). Default: 'utilisation'" }, "utilisationDowntimeThreshold": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Utilisation Downtime Threshold: Minimum stop duration before registering downtime, set in minutes — only stops at least this long are recorded. Stored as milliseconds in the manifest. Defaults to 1 hour." }, "slowDurationThreshold": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Slow Duration Threshold: Minimum duration running below 80% of the line speed target before registering slow running, in milliseconds. Defaults to 1 minute." }, "forceAllShiftTimeAsPlannedProduction": { "type": [ "boolean", "null" ], "description": "Force All Shift Time As Planned Production: Treat all shift time as planned production time" }, "productiveStatusMode": { "anyOf": [ { "type": "string", "enum": [ "productive_signal", "electrical_usage", "line_speed" ], "default": "productive_signal" }, { "type": "null" } ], "description": "Productive Status Mode: How to measure when the station is engaged in value-adding activity. Options: 'productive_signal' (use productive signal input), 'electrical_usage' (use electrical consumption), 'line_speed' (use line speed value). Default: 'productive_signal'" }, "electricalUsageStoppedThresholdKw": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Electrical Usage Stopped Threshold (kW): Minimum power consumption in kilowatts that indicates the station is active. Below this threshold, Busroot will regard the station as stopped/downtime. Example: 2.0, 1.0, 5.0" }, "lineSpeedStoppedThreshold": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Line Speed Stopped Threshold: Minimum speed value that indicates the station is running. Below this threshold, Busroot will regard the station as stopped/downtime. Example: 10, 5, 20" }, "productiveHoldOnTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400000 }, { "type": "null" } ], "description": "Productive Hold On Time: How long to keep considering the station active after a productive signal, set in minutes — each new signal restarts the hold-on timer. Stored as milliseconds in the manifest." }, "currentOperatorInitials": { "anyOf": [ { "type": "string", "minLength": 3, "maxLength": 8 }, { "type": "null" } ], "description": "Current Operator Initials: Current operator's initials (3-8 letters/numbers, system managed)" }, "statusCode": { "type": [ "string", "null" ], "description": "Status Code: Current status code of the station (system managed)" }, "statusCodeUpdatedAt": { "type": [ "string", "null" ], "description": "Status Code Updated At: Timestamp when status was last updated (ISO 8601, system managed)" }, "cycleTime": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 43200000 }, { "type": "null" } ], "description": "Cycle Time: Standard cycle time for production, set in seconds. Stored as milliseconds in the manifest." }, "unitsPerMinute": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Units Per Minute: Expected production rate in units per minute. Example: 2, 4, 10" }, "unitsPerHour": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Units Per Hour: Expected production rate in units per hour. Example: 120, 240, 600" }, "lineSpeedTarget": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 99999 }, { "type": "null" } ], "description": "Line Speed Target: Target operating speed for the station. Example: 100, 120, 50" }, "includeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Reason Codes: If set, only these reason codes are available at this level. Applied before excludeReasonCodes." }, "excludeReasonCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Reason Codes: These reason codes are removed at this level. Applied after includeReasonCodes." }, "includeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task Codes: Legacy, no longer applied. Superseded by includeTaskListCodes." }, "excludeTaskCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task Codes: Legacy, no longer applied. Superseded by excludeTaskListCodes." }, "includeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include Task List Codes: The Task lists available at this level. Unlike reasons, no level setting this means no Task lists are available — lists must be included explicitly before their Tasks appear on a station." }, "excludeTaskListCodes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Exclude Task List Codes: These Task list codes are removed at this level. Applied after includeTaskListCodes." }, "alertMessage": { "type": [ "string", "null" ], "description": "Alert Message: Current alert message for the station (system managed)" }, "alertExpiresAt": { "type": [ "string", "null" ], "description": "Alert Expires At: Timestamp when alert expires (ISO 8601, system managed)" }, "createdAt": { "type": [ "string", "null" ], "description": "Created At: Station creation timestamp (ISO 8601, system managed)" }, "updatedAt": { "type": [ "string", "null" ], "description": "Updated At: Last update timestamp (ISO 8601, system managed)" }, "archivedAt": { "type": [ "string", "null" ], "description": "Archived At: Archive timestamp (ISO 8601, system managed)" }, "enableProductionCorrection": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Production Correction: Allow operators to correct production counting errors during a running schedule from the tablet." }, "enableManualProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Production: Allow operators to manually enter production quantities." }, "enableQuickScheduleStart": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Ad Hoc Schedules: Allow operators to start ad-hoc schedules from the tablet." }, "enableScheduleCutShort": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Cutting Schedules Short: Allow operators to end a schedule before its planned end." }, "enableRejectProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Rejecting Production: Allow operators to reject (scrap) produced units." }, "enableEditPartsPerCycle": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Editing Parts Per Cycle: Allow operators to override the parts-per-cycle value on a schedule." }, "enableScheduleStationFlexibility": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Schedule Station Flexibility: Allow schedules to run on any station within the group." }, "enableSchedulingOnly": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Scheduling Only: Restrict the station to scheduling only (no live production capture)." }, "enableManualDowntime": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Downtime: Allow operators and API users to manually trigger downtime on a station, blocking production while active." }, "enableAlwaysConnected": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Always Connected: Force this station to always show as connected, regardless of device signals. Useful for stations with no physical device. Inherits from parent level if not set." }, "enableMeterOnly": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Meter Only: Meter Only: When true, this station represents a physical energy meter (e.g. a plant incomer). It only publishes electrical signals and is hidden from production views, rollups, and station pickers by default." } }, "required": [ "code", "name" ], "additionalProperties": false }, "description": "Array of stations within this group (minimum 1)" } }, "required": [ "code", "name", "stations" ], "additionalProperties": false, "description": "Station group configuration with nested stations" }, "description": "Array of station groups within this plant (minimum 1)" }, "createdAt": { "type": [ "string", "null" ], "description": "Plant creation timestamp (ISO 8601, system managed)" }, "updatedAt": { "type": [ "string", "null" ], "description": "Last update timestamp (ISO 8601, system managed)" }, "archivedAt": { "type": [ "string", "null" ], "description": "Archive timestamp (ISO 8601, system managed)" }, "enableProductionCorrection": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Production Correction: Allow operators to correct production counting errors during a running schedule from the tablet." }, "enableManualProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Production: Allow operators to manually enter production quantities." }, "enableQuickScheduleStart": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Ad Hoc Schedules: Allow operators to start ad-hoc schedules from the tablet." }, "enableScheduleCutShort": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Cutting Schedules Short: Allow operators to end a schedule before its planned end." }, "enableRejectProduction": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Rejecting Production: Allow operators to reject (scrap) produced units." }, "enableEditPartsPerCycle": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Editing Parts Per Cycle: Allow operators to override the parts-per-cycle value on a schedule." }, "enableScheduleStationFlexibility": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Schedule Station Flexibility: Allow schedules to run on any station within the group." }, "enableManualDowntime": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Allow Manual Downtime: Allow operators and API users to manually trigger downtime on a station, blocking production while active." }, "enableAlwaysConnected": { "anyOf": [ { "type": "string", "enum": [ "on", "off", "inherit" ] }, { "type": "null" } ], "description": "Always Connected: Force this station to always show as connected, regardless of device signals. Useful for stations with no physical device. Inherits from parent level if not set." } }, "required": [ "code", "name", "timezone", "dayStartHour", "stationGroups" ], "additionalProperties": false }, "description": "Array of plants belonging to this account (minimum 1)" } }, "required": [ "id", "domain", "plants" ], "additionalProperties": false, "description": "Account configuration with nested shift patterns, reasons, SKUs, plants, station groups, and stations" } }, "required": [ "version", "account" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" }