YAML File Configuration¶

YAML files are used for the configuration and should be written in a clear, structured format.

Familiarize yourself with YAML syntax, including key-value pairs, lists, and nested structures.

Catalog Configuration Example¶

The following example shows the configuration of the catalog for Operating Hours Maintenance.

---
task:
  name:
    en: "Maintenance at $target hours"
  description:
    en: "A generic description which is added to every task."
  source: "customer_name.maintenance"
settings:
  base: "hours"
  advance: 25
  set_checklist_activities: False
  set_description_activities: True
  sort_description_activities_by_text: False
  sort_description_activities_by_cycle: True
  group_root_activities: True
  set_activity_cycle: False
signals:
  operating_hours:
    key: "operating_hours_signal_key"
    mandatory: true
  service_counter:
    key: "service_counter_signal_key"
    mandatory: true
models:
  Example Model:
    links:
      en:
        link name: "href 1"
        link name 2: "href 2"
    unique_activities:
      250:
        en:
        - control part A
        - check part B
      5000:
        en:
          Special Engine Maintenance:
            - setup OEM appointment
            - check part K
          Special Module Maintenance:
            - setup OEM appointment
            - perform action L
    cycle_activities:
      500:
        en:
          - Clean component Q
          - Perform activity R
          - Replace:
            - part D
            - part E
          - Check:
            - liquid P
      1000:
        en:
        - inspect component X
        - report machine state

Explanation¶

Explanation of the keys used in the catalog configuration example above.

Note

Note that a maintenance task may have the states deadline ("upcoming", "overdue") and progress ("unplanned", "planned", "skipped", "completed"), which are calculated and set by the Maintenance Planner.

With exception to "planned" and "completed" progress, which can be actively set by the user, for example a service technician, in the DataPortal.

For more information, see Maintenance Tasks in the DataPortal manual.

Config	Description
`task`	Task related configurations
`name`	Internationalized name used for every task, template string (e.g., $target $cycle)
`description`	Internationalized description for each task, template string (e.g., $machine_operating_hours)
`source`	Used internally to filter and identify tasks of the same machine's sub-history
`settings`	Settings to steer task presentation and logic
`base`	Entry to define the base of the catalog (hours or dtc)
`set_checklist_activities`	Set activities as checklist items
`set_description_activities`	Set activities in the description field as a string
`sort_description_activities_by_text`	Sort top-level activities by text (relevant if set_description_activities is true)
`sort_description_activities_by_cycle`	Sort top-level activities by cycle (relevant if set_description_activities is true)
`set_activity_cycle`	Sets activity cycle in front of every activity string (e.g., '1000h inspect component X')
`group_root_activities`	Groups sub-activities if root activity has the same text (relevant for merged cycles)
`advance`	Hours in advance a task is opened, also defines the size window for detecting upcoming tasks
`signals`	Signal keys for querying last measurements and timeseries, filters machines based on the last measurement
`models`	Model machines that are maintained, filters machines to match configured model names
`links`	Internationalized links added to a task of a machine of that model
`unique_activities`	Internationalized activities that occur only once at the given operating hours
`cycle_activities`	Internationalized activities that repeat in a cycle every time a multiple of the operating hours is reached

Internationalized Configuration¶

If an item or configuration is internationalized, it needs to be configured with at least one language code such as (en, de, it, fr). See also the example above.

Warning

Completeness and order matter.

If multiple languages are provided, all configuration items need to support all languages, including task name, task description, links, and activities.

The order of configuration with the same meaning but in different languages matters for activities and links.

Wrong Ordered Example¶

en:
  - english activity A
  - english activity B
de:
  - german activity B
  - german activity A

A and B activity texts would be mixed up on task creation and show different meanings when switching the DataPortal's language setting.

Correct Ordered Example¶

en:
  - english activity A
  - english activity B
de:
  - german activity A
  - german activity B

Additional Tips¶

Comments: Use # for comments to explain sections or parameters for future reference.
Indentation: YAML is sensitive to indentation. Ensure consistent use of spaces, not tabs, for nested elements.
Consistency: Be consistent with naming conventions and structure throughout the document.