Enable email notifications

You can configure a connection to your SMTP or SendGrid email services so that you can share assets such as books, views, images, and links with others.

To enable the email service, specify the following parameters in the Planning Analytics Workspace Local configuration file:

  1. Set ENABLE_EMAIL to true to enable email service in Planning Analytics Workspace Local.
  2. Use the EMAIL_SMTP_URL or SENDGRID_API_KEY parameter to configure settings.
    If you specify both EMAIL_SMTP_URL and SENDGRID_API_KEY parameters, only EMAIL_SMTP_URL is used.
    EMAIL_SMTP_URL
    Use the EMAIL_SMTP_URL parameter to enable the SMTP email service. The default value of this parameter is empty. The following are examples of SMTP URLs:
    • EMAIL_SMTP_URL="smtp://username:password@smtp.example.com:587"
    • EMAIL_SMTP_URL="smtp://username:password@smtp.example.com:587?secure=false"
    • EMAIL_SMTP_URL="smtps://username:password@smtp.example.com:465"
    Where, username and password are your credentials and smtp.example.com is the server (for example, smtp.office365.com).
    Note: If the port number of your SMTP server is 465, the SMTP URL starts with "smtps://". Port 465 is typically the secure port for SMTP servers. For port number 587, use "smtp://" in the SMTP URL. Port 587 is a non-TLS port connection to an SMTP server.
    SENDGRID_API_KEY
    Use this parameter to enable the SendGrid email service; default is empty. This parameter specifies the API key for the SendGrid email account.
    You might need to contact the email administrator for your organization to obtain the API key that is specific to your email service.
    Note: If you use SENDGRID_API_KEY, you need to also specify the EMAIL_FROM parameter.
  3. Use EMAIL_FROM to specify the sender's email address. This parameter might be required by the email server and is mandatory when you use SENDGRID_API_KEY.
  4. If your SMTP server uses a custom TLS certificate, add the certificate to the paw/config/certs folder.
  5. Restart Planning Analytics Workspace services.
    Note: When you change a paw configuration file, you must run ./scripts/paw for your operating system or click Start in the Planning Analytics Workspace administration tool for your changes to take effect. Only services that are affected by the configuration change will restart.

The Email tab is now available in the user interface when you share a book or view.

Email tab available in Planning Analytics Workspace Local