Use Cases

Different use cases for maintenance tasks, maintenance cycles, and their catalog configuration are described below.

Hours To Service

The simpler nature of this mode results in a simpler catalog.

There are no unique activities for now and only one cycle per model is allowed, which sits at a fixed 0 hours (hours to next service).

---
settings:
  base: "hours"
  advance: 25
signals:
  hours_to_service:
    key: "hours_to_service_signal_key"
    mandatory: true
  service_counter:
    key: "service_counter_signal_key"
    mandatory: true
models:
  Example Model:
    links:
      en:
        link_name: "example doc link"
    cycle_activities:
      0:
        en:
        - Replace:
          - part B
          - part C
        - Check:
          - liquid P
        - Clean component Q
        - Perform activity R

Default Maintenance

A special entry can be added to the catalog: default_maintenance.

This is a reserved name.

If this entry is found in the catalog, all machines or models of the customer's fleet are used for maintenance.

For every model that does not already have an entry in the catalog, see Catalog Configuration Example, the default maintenance entry is applied, with exception to the ignored_models list.

This list can be added to the default_maintenance entry. Defined models are ignored for the default maintenance.

A model cannot be present in the catalog and in the ignored_models list at the same time.

---
settings:
  base: "hours"
  advance: 50
models:
  default_maintenance:
    ignored_models: ['Ignore_Old_Model', 'Ignore_Broken_Model']
    cycle_activities:
      500:
        en:
          - A Default Activity

Note

As soon as this entry is found, maintenance will be performed for all machines of the fleet, if the required data, signals, and properties are given and the machine model is not present in the ignored_models list.

Multimodel Entries

If models share the same maintenance configuration, they can be set in a single entry by adding all model names to the key separated with ;.

Instead of configuring as follows:

Model_A:
  cycle_activities:
    1000:
      en:
        Replace:
        - Part X
Model_B:
  cycle_activities:
    1000:
      en:
      Replace:
      - Part X

The models can be configured together as follows:

Model_A;Model_B:
  cycle_activities:
    1000:
      en:
        Replace:
        - Part X

This results in the same configuration.

Complete Catalog Sample

The following is a complete example for the catalog regarding Operating Hours Maintenance.

The example also shows how to configure machine property keys and action ids, if they are required for the customer's maintenance logic.

---
task:
  name:
    en: "english name"
  description:
    en: "english description"
settings:
  base: "hours"
  advance: 50
  set_checklist_activities: true
  group_root_activities: true
signals:
  operating_hours:
    key: "operating_hours_signal_key"
    mandatory: true
  service_counter:
    key: "service_counter_signal_key"
    mandatory: true

models:
  default_maintenance:
    ignored_models: ['Test Model', 'Ignored_Old_Model']
    cycle_activities:
      500:
        en:
        - default maintenance information

  Model A;Model B;Model C:
    links:
      en:
        Maintenance Information: "link to maintenance information"
    unique_activities:
      200:
        en:
          Check:
          - part x
          - part y
    cycle_activities:
      500:
        en:
          Replace:
          - part e
          - part f
          Refill:
          - liquid p
      1000:
        en:
          Check:
          - component d
          - part g
          - part h
          Refill:
          - liquid q

  Model D:
    links:
      en:
        Maintenance Information Model D: "link to maintenance information Model D"
    cycle_activities:
      2000:
        en:
          Replace:
          - part k
          - part l
          Refill:
          - liquid p
          - liquid q