Naming scheme

It is essential to keep the users informed about the system's current status and guide them through the platform, best by preventing errors. Each type of feedback message has specific characteristics or advantages and is more suitable for some use cases than others. Use the proper feedback to inform the user in the best possible way.

Error

Error messages block the users from performing a job responding in case of a detected platform error. Users should feel informed and notified, but not frustrated or feared.
Try to complement help to the error message, so the users are aware of what they need to do to proceed. If possible (and useful), we also provide a primary action that supports the user in going through the next necessary steps.

Error messages, displayed in forms, modals, tables, widgets, and on detail pages, are of the type:

  • An error occurred while loading [items]. Please try again later.

Growl messages should be of the type:

  • The [item] could not be added to the shopping cart.

Further error messages are:

  • You do not have the permissions required to access this page.
  • Your requested page could not be found.
  • Only a maximum of [n] suppliers may be selected.
  • A content source with the same name already exists. Specify another name.

Warning

Warning messages do not block the users from generating their job. They provide information before significant actions take place. Users should feel informed and notified about what will happen if they proceed, but not alarmed. Provide an alternative step for the users whenever possible, for example, an action to cancel the intended process.

  • Are you sure you want to discard your changes? This action cannot be undone.
  • Are you sure you want to delete the request? This action cannot be undone.
  • If you leave this page, any changes you have made will be lost. Are you sure you want to leave this page?

Validation

Data entered in a form is validated in most cases. If users provide any unacceptable data, a validation message is displayed informing them to check their data and submit it again. The validation messages are displayed next to affected fields and controls, via tooltip or in a widget. Try to complement help to the validation message so the users are aware of what they need to do to fix the data referring to the affected control.

  • The [field name] cannot be blank.
  • Please enter a valid [order quantity]. Note: Only numbers are allowed. The decimal separator must correspond to your language setting.
  • The currency is invalid. Specify another currency.
  • A validation of your entries is not possible since this buying channel is disabled.
  • The material group of item {x} is not allowed.
  • The total exceeds the maximum allowed amount of {x} for this buying channel.

Info

Info messages provide users with more information without disrupting their work or requiring them to take action. These messages help the users with details to a specific control or explain the meaning of an action.

  • No items available.
  • The creditor number is the unique identifier of the creditor throughout the platform. It must be unique in combination with the restrictions.
  • Activate this checkbox to save filter settings persistently.
  • If you already have an exact [price], please enter it here.

Success

A typical success message tells your users that their action has been completed successfully. This way, we celebrate their success with them and motivate them to proceed. Usually, success messages are displayed as growls or in a validation widget.

  • The item has been successfully added to the shopping cart.
  • The restriction has been successfully added. Changes to restrictions only take effect once the buying channel has been saved.
  • Congratulations! You are using the right buying channel.

Empty state

If no entity exists, we show an empty state image (ESI) in the initial state of a view. To motivate users to start creating entities and guide them in the first step, we use the following terms combined with at least one call to action button.

  • [Entities] are not yet available, but that doesn't have to stay that way.
  • There are no items on your [shopping list], but that doesn't have to stay that way. Just add products from the shopping search results to your shopping list.

Alert box

Alerts are relatively discreet. The information contained is more of a tip or hint but not required to complete the task. Users are not interrupted by alert boxes even if they are displayed where users are taking action. The header contains the feature status followed by a description, so the users are aware of what the feature is all about or what they need to do to use the feature.

Button

The button naming depends on the appropriate process and contains the entity name. Buttons do not have articles (a, an, or the).

  • The button for creating a new and blank entity, primarily used in the management UI, is called New [entity].
  • If the entity has not been saved yet, the button is called Create [entity].
  • If the entity has already been saved, the button is called Update [entity].

Do: New creditor, Create creditor, Update creditor
Don't: Create new creditor

Filter

We use the following terms with our filter component:

  • Filter by [entity]
  • No [entities] found matching your filter selection.
  • No [entities] available.
  • [entity]: {x} selected
  • An error occurred while loading [entities]. Please try again later.

We use the following terms with our search component:

  • Search for [entities]
  • No [entities] found matching your filter selection.
  • Your search did not return any hits.
  • No [entities] available.
  • An error occurred while loading [entities]. Please try again later.
  • Search results for “xyz” (# results)


This site is a living document and is in some places ahead of the platform. We are always trying to implement and adapt wescale content according to the guidelines from this document. The standardization of all content on the entire platform is a real mammoth task and will take some time until completion. Nevertheless, you are welcome to use this document as a basis for your work and feel free to contact us at any time if you have any questions or comments.

Some features in this style guide may not work as expected because they are not supported by the browser version you are using.

For the best experience, we recommend upgrading to a newer browser such as Microsoft Edge, Mozilla Firefox, or Google Chrome.