Skip to main content

Define A Warn Message

In the previous step we learned that Error messages are the highest level of escalation. Warn messages are the second.

Their main purpose, therefore, is to alert operators so that they can resolve issues before they ever escalate to an error.

In this step, we're going to define an example warning message that alerts operators when a temperature has reached a threshold value.

←→
  1. Add New Message Type

Choose the Add Type within the Message Types View view and

←→
  1. Choose a Unique Code

We'll use WARN-1 as the code for now:

←→
  1. Choose the Right Level

Choose Warn as the Level of the new message.

  1. Choose a Descriptive Title

Define the Title that will be displayed in the message dialog. Make sure you're choosing unique translation keys and provide translations for each language of your project.

  1. Choose a Descriptive Title

Define the Title that will be displayed in the message dialog. Make sure you're choosing unique translation keys and provide translations for each language of your project.

  1. Provide a Clear Description

Add your Description of the error:

  • Describe the error as clearly as possible
  • But also describe it as briefly as possible, using as few empty words as practical.
  1. Offer a Structured Solution

Add your Solution and keep in mind that clear, step-by-step instructions are key.

Mission accomplished!

Wonderful, we've got our message type defined. So let's go ahead define message of the final level that we've been missing so far.