Spotfire® Server and Environment - Installation and Administration

Configuring an email notification

You can configure email notifications by setting up recipient lists, choosing which job statuses to notify about (all, failed, and successful), and you can review detailed email content that includes job information.

Before you begin

You must have administrative credentials for Spotfire Server.

About this task

To send and receive emails, the Simple Mail Transfer Protocol (SMTP) is used. To allow your email notifier to communicate with the SMTP server, you must configure the SMTP settings using an authentication method that requires a username and password, and specify the settings in the commands as described below.

For better management and scalability, use a distribution list of recipients created with the email providers.

Procedure

  1. Open a command-line interface and export the active configuration by using the export-config command. (For details on using the Spotfire command line, see Executing commands on the command line.)
    config export-config configuration.xml
  2. Run the command config-email-notification to configure the notification service.
  3. Run the command add-notification-preference to add preferences for the source (automation-services or scheduled-updates) and category (all, failed, and successful).
  4. Execute the command import-config to import the configuration file back to the Spotfire database and restart the server.
  5. After the restart, execute the Automation Services job or a scheduled update job.
    The email notification is sent according to the configured settings.
    Note: If you want to remove preferences for the notification service, use the command line reference remove-notification-preference.