TPM Stop Reason Configuration

TPM Stop Reason Configuration objects are used to configure built-in Stop Reasons and define custom reasons for equipment stops. If these stops are unintended, i.e. 'not scheduled', they affect the calculation of OEE Indices, while scheduled stops do not affect the OEE. By default, all built-in Stop Reasons are 'not scheduled', but this behavior can be overridden using this configuration object.
Additionally, in this object translations can be configured for Stop Reasons, which will then be used in WebStudio.

This configuration object type can be created on Site, Area and Cell level.

A fully configured Site Configuration object is required for this configuration object to work properly.

Creating a TPM Stop Reason Configuration Object

  1. To create a TPM Stop Reason Configuration object, in the ISA-95 Equipment Model right-click on the intended parent object of one of the types listed above and select Admin  New  TPM  Stop Reason Configuration to open the Create Stop Reason Configuration wizard. In this example we will configure the Stop Reasons for a whole Site, therefore we will use 'The OEE Demo Site' .

  2. Enter a suitable name, and optionally a description for the object. Then click Next to continue.

    Stop Reason Configuration
    Figure 1. Stop Reason Configuration

  3. Click Create to create the Stop Reason Configuration object in the ISA-95 Model.

    The New Stop Reason Configuration Object in the ISA-95 Model
    Figure 2. The New Stop Reason Configuration Object in the ISA-95 Model

Linking the TPM Stop Reason Configuration Object to the OEE Equipment Monitor

If no Stop Reason Configuration Source is configured in its Configuration Options, the OEE Equipment Monitor will use the very first Stop Reason Configuration object, which it finds when traversing the ISA-95 Equipment Model tree upwards.

To explicitly specify the TPM Stop Reason Configuration for the OEE Equipment Monitor, follow these steps:

  1. Go to the Configuration Options section in the monitor’s properties and click on …​ button for the Stop Reason Configuration Source to open the object picker in the ISA-95 Model.

    Setting the Stop Reason Configuration Source
    Figure 3. Setting the Stop Reason Configuration Source

  2. Select the intended Stop Reason Configuration Object from the ISA-95 Model.

    Linking the TPM Stop Reason Configuration to the OEE Equipment Monitor
    Figure 4. Linking the TPM Stop Reason Configuration to the OEE Equipment Monitor

  3. Click OK to confirm and close the dialog. Finally, Apply the changes to the properties.

Mapping Error Codes to Stop Reasons

When the equipment monitor is running, it will detect stops, which are then recorded in the “Equipment Stops” table, by tracking error code or failure inputs. The stops recorded in this way will initially be assigned a “0 - No Reason” code, until an operator provides the actual stop reason. This manual step can be avoided, provided the machine being monitored emits sufficiently detailed error codes that can be directly associated with the defined Stop Reasons.

For stop reasons to be automatically assigned a failure reason, the error code corresponding to it needs to be mapped in the OEE Equipment Monitor configuration. To do so, follow these steps:

  1. Select the OEE Equipment Monitor object and go to the Properties Panel.

  2. In the Performance Options section expand the Equipment Failure Options subsection and click on the table icon for the Equipment Error Stop Reasons property.

    Mapping Errors to Stop Reasons
    Figure 5. Mapping Errors to Stop Reasons

  3. Add a new row to the table by clicking the + icon.

    Mapping Errors to Stop Reasons
    Figure 6. The Equipment Errors Stop Reasons Table

  4. In the 'Source' column select the criteria which identifies the error from the drop-down list. Select 'Error Code' for this example.

  5. Leave the 'Function' column as 'Equal'.

  6. In the 'Value' column set the error code which you want to map to the stop reason, using '1' for this example which is based on the OEE Simulation Script.

  7. To map the error code to a built-in Stop Reason, select the appropriate reason from the drop-down list in the 'Stop Reason' column.

  8. If you want to map an error code to a custom stop reason, enter the ID of the respective reason in the 'Custom Stop Reason ID' (as configured in the Custom Stop Reason Configuration in the Stop Reason Configuration object). Any entry (other than '<null>') in this cell will overwrite whatever is selected in the 'Stop Reason' column. If the value for the 'Custom Stop Reason ID' is '<null>' the 'Stop Reason' will be applied.

  9. Click OK to confirm and close the dialog and Apply the changes to the properties.

Overriding Built-in Stop Reasons as 'Scheduled'.

By default, all built-in Stop Reasons are configured as 'unscheduled' stops, i.e. these stops affect the calculated OEE indices. This behavior can be overridden as follows:

  1. Select the Stop Reason Configuration object and go to the Properties Panel. Expand the Common section and click on the table icon for the Stop Reason Configuration property.

  2. Click on the + icon to add a new row to the table.

  3. From the drop-down list in the 'Stop Reason' column, select the reason for which you want to overwrite the default behavior.

  4. To treat this reason as a scheduled stop instead of an unscheduled stop, select the checkbox in the 'Is Scheduled Stop' column.

    Overriding Built-in Stop Reasons as 'Scheduled'
    Figure 7. Overriding Built-in Stop Reasons as 'Scheduled'

  5. Then click OK to confirm and apply your changes.

Creating Custom Stop Reasons

Custom Stop Reasons can be created, following these steps:

  1. Select the Stop Reason Configuration object and go to the Properties Panel. Expand the Common section and click on the table icon for the Custom Stop Reason Configuration property.

  2. Click on the + icon to add a new row to the table.

    The Custom Stop Reasons Table
    Figure 8. The Custom Stop Reasons Table

  3. In the 'Parent Stop Reason' column, select the Stop Reason (category) underneath which the new Custom Stop Reason should be placed. For this example, select '021010 - Lunch Break'

  4. In the 'Custom Stop Reason ID' enter a unique ID. For organizational reasons it might be helpful to base this ID on the Parent Stop Reason’s ID. For this example, enter '021010-01'.

  5. In the 'Custom Stop Reason' column, give the reason a name, using 'Coffee Break' for this example.

  6. If the new Stop Reason is a scheduled event, like the 'Coffee Break' in the example, select the checkbox in the 'Is Scheduled Stop' column, so that this Stop Reason does not affect the OEE Calculation.

  7. (optional) For filtering which Stop Reasons are to be displayed in WebStudio, using the Stop Reason Filter Options in OEE Equipment Monitor objects, custom attributes can be set in columns 'Custom Attribute 1 .. 3'.
    How these attributes can be applied for filtering is described in the OEE Equipment Monitor Setup.

  8. When you are done, click OK to confirm and apply your changes.

Deleting a Custom Stop Reason might affect the OEE Calculation for historical Data! So don’t delete rows from this table unless you are sure that this Reason was never applied to OEE calculation. Instead, for Stop Reasons which you want to remove, select the checkbox in the 'Is Deleted' column. Stop Reasons which have this checkbox selected, will no longer be applied or displayed in any other place but remain available for later reference.

Translating Stop Reasons

Translations for how Stop Reasons are displayed in WebStudio can be configured for ranges of built-in Stop Reasons and for and individual built-in Stop Reasons as well as for Custom Stop Reasons. Translations can be configured for multiple languages. They will be applied according to the browser language preferences. The default language of the system will be used as a fallback if there is no match between browser preferences and configured Stop Reason Translation language.

Stop Reason Range Translation

Translations based on Reason Range Codes are configured following these steps:

  1. Select the Stop Reason Configuration object and go to the Properties Panel.

  2. Expand the Translations section and click on the table icon for the Reason Range Codes Translation property.

  3. To add a new language, click on the 'New Column' icon.

    Adding a new column
    Figure 9. Adding a new column

  4. In the Column Settings dialog, for Column Name enter the ISO-639-1 language code (e.g. 'DE' for German) and click OK to create the new column.

    Setting the target language as column name
    Figure 10. Setting the target language as column name

  5. Click OK icon to close the Column Settings dialog and add the new language column to the table.

  6. Click the + icon to add a new row to the table.

  7. From the drop-down list in the 'Reason Range ID' column select the range ID which should be translated and enter the translation string in the language column(s).

    Selecting the range and providing the translation
    Figure 11. Selecting the range and providing the translation

  8. When the translations for all the Reason Range IDs have been provided, click OK to close the Table Property Grid.

  9. Finally Apply the changes to the Object Properties.

Individual Stop Reason Translation

To provide translations for individual built-in Stop Reasons, follow these steps:

  1. Select the Stop Reason Configuration object and go to the Properties Panel.

  2. Expand the Translations section and click on the table icon for the Reason Codes Translation property.

  3. To add a new language, click on the 'New Column' icon.

  4. In the Column Settings dialog, for Column Name enter the ISO-639-1 language code (e.g. 'DE' for German) and click OK to create the new column.

  5. Click OK icon to close the Column Settings dialog and add the new language column to the table.

  6. Click the + icon to add a new row to the table.

  7. From the drop-down list in the 'Reason ID' column select the Reason ID which should be translated and enter the translation string in the language column(s).

    Selecting the Reason ID and providing the translation
    Figure 12. Selecting the Reason ID and providing the translation

  8. When the translations for all the Reason IDs have been provided, click OK to close the Table Property Grid.

  9. Finally Apply the changes to the Object Properties.

Custom Stop Reason Translation

To translate Custom Stop Reasons …​

  1. Select the Stop Reason Configuration object and go to the Properties Panel.

  2. Expand the Translations section and click on the table icon for the Custom Reasons Translation property.

  3. To add a new language, click on the 'New Column' icon.

  4. In the Column Settings dialog, for Column Name enter the ISO-639-1 language code (e.g. 'DE' for German) and click OK to create the new column.

  5. Click OK icon to close the Column Settings dialog and add the new language column to the table.

  6. Click the + icon to add a new row to the table.

  7. In the 'Custom Reason ID' enter the ID of the Custom Stop Reason for which translations should be provided.

  8. In the 'Translation Target' column select which property of the Custom Stop Reason this translation refers to.

    Selecting the Translation Target
    Figure 13. Selecting the Translation Target
    If multiple properties of a Custom Stop Reason are to be translated, each property requires an individual row in this table (with the same value in Custom Reason ID column).

  9. Enter the translation for the target property in the language column(s)

    The complete row for a Custom Reasons Translation
    Figure 14. The complete row for a Custom Reasons Translation

  10. When you’re done, click OK to close the Table Property Grid.

  11. Finally Apply the changes to the Object Properties.