Error Definitions
Prerequisites
-
Role
-
Display error definitions
User
orExpert
orAdministrator
-
Remove duplicate error definitions
Expert
orAdministrator
-
Create, edit, delete or translate/export error definitions, or export translations
Administrator
-
-
The user is logged on to the Web Portal.
Procedure
-
In the menu, click Master data management > Equipment > Error definitions.
The Error definitions tab appears:
-
Search and/or filter the error definitions according to the following criteria: Filter and Search for Error Definitions
-
Filter by device type
Error definitions connected to a device type: Manage or Create a New Error Definition for a Device Type
-
Filter by device
Error definitions connected to a device: Manage or Create a New Error Definition for a Device Type
-
Filter by equipment
Error definitions connected to equipment: Connect equipment to error definitions
-
No relationship
Error definitions not connected to any device type, device, or equipment
-
-
Click Display ID to also display or hide the column containing the internal ID (for example 0409062f-730a-4793-9dfd-2d1d6ccbdeb4).
-
The following functions are available for managing the error definitions, and they can be accessed via the toolbar. If they are hidden, click
for more functions.
-
Export translation: Export translation
-
Export error definitions: Export error definitions
-
Translate error definition: Translate error definition
-
Create error definitions
Click to create a new error definition.
Information on the dialog: Create Error Definition for a Device Type |
Edit error definitions
Click to edit the error definition.
Information on the dialog: Edit Error Definition of a Device Type |
Delete error definitions
-
Click
to delete the error definition.
The dialog for deleting error definitions appears.
-
Click Delete.
The error definition is deleted and is no longer displayed on the error definitions tab.
Filter and Search for Error Definitions
Error definitions can be searched for by error number and/or error text and filtered according to different aspects.
-
In the menu, click Master data management > Equipment.
-
Click the Error definitions tab.
The list of errors that have already been defined is displayed.
-
To filter error definitions, enter one or more characters of the error number or error text in the search field.
-
Filter error definitions.
Filter conditions cannot be combined.
To disable a filter, clickbehind the corresponding filter condition.
Optional: To reduce the length of the list, enter a search term in the search field.-
Click Filter by device type and select device type.
The error definitions connected to the selected device type are displayed.
-
Click Filter by equipment and select equipment.
The error definitions connected to the selected equipment are displayed.
-
Click No Relationships.
All error definitions that do not have a connection to a device type, device, or equipment are displayed.
-
Error definitions that were found based on the selected filter and search text entered are displayed.
Translate error definition
-
In the menu, click Master data management > Equipment.
-
Click the Error definitions tab.
-
In the list of error definitions, search or filter for the error definition to be translated.
-
In the row of the error definition to be translated, click on one of the language codes in the Translations column.
The Error definition translations dialog appears.
-
Supplement or edit translations in the supported languages.
-
To accept the changes, click Save.
In the Translations column, the language codes of the missing translations are shown crossed out. The language codes of the available translations are displayed normally.
Export translation
Exporting a translation is intended for the following functions:
-
Exporting existing translations, for instance in order to import them to another plant
-
Exporting missing translations, for instance in order to send them to an external translation agency
When creating an error definition, for example for a device type or device, only the English error text has to be entered at first. |
-
Exporting existing translations, for instance in order to send them to an external translation agency for editing
Procedure
-
In the menu, click Master data management > Equipment.
-
Click the Error definitions tab.
-
Select one, several or all error definitions using the checkboxes on the left or in the table header.
-
In the toolbar, click Export translation.
If Export translation is not displayed in the toolbar, click
and then click Export translation.
The Export for translation dialog appears.
-
Select the language for which the error text(s) is/are to be exported.
-
Select the file format to which the error texts are to be exported. The formats CSV and JSON are supported.
-
To monitor progress during the export, click Details.
During the export, the number of data points read and written is displayed under Details.
The ID and error text for the error definition(s) are written to the specified file in the selected format.
-
Click Export translations and in the file system select the file to which the error texts are to be written.
-
To export additional error definitions, repeat steps 4 to 7.
-
Click Continue export to export the selected translation again, for example after a cancellation.
-
Click Close to finish the export.
The translations have been exported and can be imported into another system or sent to an external translation agency.
Export error definitions
-
In the menu, click Master data management > Equipment.
-
Click the Error definitions tab.
-
Select one, several or all error definitions using the checkboxes on the left or in the table header.
-
In the toolbar, click Export.
If Export is not displayed in the toolbar, click
and then click Export.
The Export error definitions dialog appears.
-
To monitor progress during the export, click Details.
During the export, the number of data points read and written is displayed under Details.
-
Click Export to start the process, or click Close to cancel the process.
-
Specify the name and directory of the export file to be saved and click Save.
-
Click Continue export to export the selected translation again, for example after a cancellation.
-
Click Close to finish the export.
The error definitions (error number, category, severity, [English] error text, error text in other languages, if any) have been exported.