Property and Action Key Configuration

This section defines the configuration of property and action keys used within the maintenance setup.

Property keys can be specified to access additional machine properties that are relevant for maintenance.

Action keys can be specified to reference actions that can be executed as part of the maintenance process.

Both configurations are optional and allow mapping between logical keys used in the configuration and the actual property or action identifiers used in the fleet.

Configured properties can be used to exclude individual machines from maintenance based on a defined property value.

type: scheduled
task:
  ...
signals:
  ...
properties:
  equipment_id: "equipment_id_property_key"
actions:
  service_hours_reset: "action_id"
models:
    ...

Explanation

• properties: (optional) key and value (property key) that are used for getting additional maintenance relevant machine properties.
• actions: (optional) key and value (action key) that are used for executing an action.

Note

The actual machine property key is free of choice for the fleet use.

Ignore Individual Machines

If a property configuration with the normalized key maintenance_service_excluded is defined in the catalog, machines can be excluded from maintenance based on this property.

The following example shows how to configure the property in the catalog.

properties:
  maintenance_service_excluded: "maintenance_service_excluded_example_key"

All machines that have the property maintenance_service_excluded_example_key configured and populated with the value true (case-insensitive) will be excluded from maintenance, even if their model is present in the catalog.

Calendar Activation Date

If a property configuration with the normalized key maintenance_activation_date is defined in the catalog, its value is used as the starting point for calendar-based maintenance items.

If the machine's commission date is available, it is used instead.

For more information, see Calender-based Maintenance in the DataPortal manual.

The following example shows how to configure the property in the catalog.

properties:
  maintenance_activation_date: "activation_date_example_key"

Inject Extra Activities

If a property configuration with the normalized key maintenance_activities is defined in the catalog, its value is used to inject additional activities into a task at creation time, alongside the catalog-defined activities. This requires activities.set_property: true to also be set in the catalog.

The property value must be JSON-encoded with the same shape as catalog activities, for example:

{
  "en": [
    {"parent_en": ["activity_a_en", "activity_b_en"]},
    "activity_c_en"
  ],
  "de": [{"parent_de": ["activity_a_de", "activity_b_de"]}, "activity_c_de"]
}

Note

If the property is missing, malformed, or doesn't match the catalog's configured languages, it is silently skipped and the task is created from the catalog only.