Setting-Up Notification Services

Innovator provides a notification service which e-mails users on single sign-on models when changes are made to the model.

Notification Basics

Model users in single sign-on models can be e-mailed when changes are made to the model. The user can decide for each element whether the notification should be sent straight away, daily, weekly or monthly. A notification is sent when the element itself or an element in its (transitive) content was changed. Users can deactivate notifications.

The notification service needs to be configured.

Note

Users then receive a notification if an e-mail address is configured for them in the user management.

The notification language can be set as Correspondence Language for each user in the user configuration.

If you have administration rights, then you can manage user notifications in an Innovator model and control what happens when the model is exported. Three properties are shown for the Innovator model in the Properties tool window.

Configuring the Notification Service

You must configure the notification service before you can use notifications. E-mail configuration should be set in the configuration file.

Use the INONOTIFY environment variable to set the working directory. It contains the notification service's configuration file, database and log files.

If the environment variable is not set and notifications are set-up, then the $INOPRJ\inonotify directory is set as the working directory.

The notification service can be set-up as a service in Windows and Linux.

The Innovator installation's InnoNotify subdirectory contains the template file for the appsettings.json configuration. Copy this file to $INONOTIFY\innonotify.json.

Make the following settings in the file:

  • E-Mail Configuration

    Entries in "EmailConfiguration" are relevant. You must change the "SmtpServer" and "FromAddress" entries.

    As sender address for "FromAddress", enter the address for the employee who is allowed to modify the configuration.

    The sender can be set using "FromName". The e-mail’s subject can be changed with "Subject".

    The commented out lines contain the default setting for the correspondence language used in the message.

  • Optional: Change Schedules

    Entries in "NotificationScheduler" are relevant. The specific times are set in Cron syntax. The link takes you to a website which supports interactive interpretation and creation of an entry.

    https://www.freeformatter.com/cron-expression-generator-quartz.html

     

Setting Notification Services as Services

Windows

InnoNotify [Options]

  • /L <INOHOST>

    Use license server entered.

Linux

Setting-Up InnoNotify.service

You can find the InnoNotify.service file under $INOEXE/InnoNotify. Copy this file using root rights into the /etc/systemd/system/ directory.

In some cases you may need to change certain entries in this file.

  • USER

    Enter the operating system user InnoNotify should run on here.

  • Environment=INOHOST

    Enter the INOHOST value used here.

  • Environment=INOPRJ

    Enter the INOPRJ directory to be used here.

  • Environment=INONOTIFY

    Enter the directory that uses the notification service for configuration and logging here. You may need to create one.

  • ExecStart

    Enter the fully-qualified InnoNotify path name here.

If you have not installed Innovator under /usr/innovator, then you need to replace this section of path in the entries with the directory you chose.

Using the Service

Use the systemctl command to control services.

Reload the configuration files with:

sudo systemctl daemon-reload

Start the service with:

sudo systemctl start InnoNotify

Check the status of the service with:

sudo systemctl status InnoNotify

To automatically start the service when the system is started, use:

sudo systemctl enable InnoNotify
Related Topics Link IconRelated Topics