Notification events

Administration Page Application/Contract Syracuse/Collaboration class notificationEvents Representation notificationEvent

This entity defines events that trigger sending an email. Currently, only four predefined events are available and can be set up.

The following information is associated with a notification event:

Code

The code identifies the event. Currently, only four codes are available and defined in the corresponding section.

Description

User-friendly description of the event. This information is entered by default in the current language.

Translation link:

Translate descriptions into different languages using the corresponding widget.

Title template

Defines the text for the title of the notification email. It can be set up by language using the same widget. The text can include variables between
curly brackets. For example:

This title includes a {variable}

The variable available depends on the event and is described in the corresponding section.

Text template

Defines the text included in the notification email. It can be created per language using the same widget. The text can also include variables described in the corresponding section.

Mail servers

References the mail servers used for sending the notification. If no server is defined, the default mail server declared in the global settings is used. Otherwise, the first available mail server is used.

Recipients

Indicates the list of email addresses to receive the notification.

Event list

Code Event description variable available
license This event is triggered 30 days before the license expires to remind the user that he/she has to take care of the license renewal.
  • user entity values, for example user.firstName
  • productTitle: the name of the product.
  • productVersion: the current product version number.
  • policyTitle: the policy that the expiring license is associated to.
  • policyVersion: the version number of the policy.
  • daysBefore: the number of remaining validity days.
  • date:expiryDate: the expiration date of the license.
license_web_max This event is triggered when the data volume limit allocated to the web services by the license has been exceeded. When this happens, the web server will no more return answers to the requests. This is meant to remind the user that he/she has to enhance the license characteristics.
  • user entity values, for example user.firstName
  • productTitle: the name of the product.
license_web_grace This event is triggered when the data volume limit allocated to the web services by the license is almost reached. When this happens, the web server slows down until the limit is reached. This is meant to remind the user that enhancing the license characteristics should be considered.
  • user entity values, for example user.firstName
  • productTitle: the name of the product
  • graceSlowdown: the slowdown percentage that applies on web services.
license_web_warn This event is triggered when the data volume limit allocated to the web services by the license is significantly close to the limit. This is meant to remind the user that he/she should take care of the limit and maybe consider enhancing the license terms.
  • user entity values, for example user.firstName
  • productTitle: the name of the product
  • percentage: the percentage of volume reached.
  • graceSlowdown: the slowdown percentage that applies on web services at the next warning level.
  • totalPercentage: the percentage of volume where the web services stops.