Email from STEP

Multiple STEP components support using email to deliver data, error reports, and messages via a standard mail server or a mail server with TLS (Transport Layer Security). As defined below, a one-time STEP configuration of SMTP (Simple Mail Transfer Protocol) is required.

Once configured, email can be generated from STEP in the following areas:

  • Asset Push - as defined in the Monitoring Asset Push topic (here) and the Creating and Maintaining Asset Push Configurations topic (here)
  • Event Processors - as defined in the EPW - Configure Error Reporter Processing Plugin topic (here)
  • Export Manager - as defined in the Email Delivery Method topic (here)
  • IIEPs - as defined in the IIEP - Configure Error Reporter topic (here)
  • OIEPs - as defined in the OIEP - Configuration Flipper topic (here)
  • Workflows - as defined in the Send Email from a Workflow topic (here)

Mail Server Configuration

Using the standard mail server functionality requires the following setup:

  1. As an admin user, log in to the STEP application server and edit the sharedconfig.properties file.
  2. Add the case-sensitive Mail.MailServerURL property, including the mail server URL as the value. For example,
Mail.MailServerURL = my.mailserver.com
  1. Add the case-sensitive Mail.DefaultFromMailAddress property, including the default mail address displayed in the 'From' field as the value. For example,
Mail.DefaultFromMailAddress = noreply@mailserver.com

If no default mail address is provided, STEP sets the default 'From' email address as 'noreply@step-system.invalid'.

  1. Restart the STEP application server to apply the changes to the properties file.

Mail Server with TLS Configuration

Using a mail server with TLS (Transport Layer Security), for example office365.com, requires the following setup:

  1. As an admin user, log in to the STEP application server and edit the sharedconfig.properties file.
  2. Add the case-sensitive Mail.UseTLS property, including 'true' as the value. For example,
Mail.UseTLS = true

Important: This property and value are required to activate the additional properties below.

  1. Add the case-sensitive Mail.MailServerURL property, including the mail server URL as the value. For example,
Mail.MailServerURL = smtp.office365.com
  1. Add the case-sensitive Mail.DefaultFromMailAddress property, including the default mail address displayed in the 'From' field as the value. For example,
Mail.DefaultFromMailAddress = noreply@mailserver.com

If no default mail address is provided, STEP sets the default 'From' email address as 'noreply@step-system.invalid'.

  1. Add the case-sensitive Mail.MailServerPort property, including the mail server port as the value. For example,
Mail.MailServerPort = 00
  1. Add the case-sensitive Mail.MailAuthenticationUser.Name property, including the authorized user name as the value. For example,
Mail.MailAuthenticationUser.Name = AuthUser
  1. Add the case-sensitive Mail.MailAuthenticationUser.Password property, including the authorized user password as the value. For example,
Mail.MailAuthenticationUser.Password = AuthPassword

Note: This property holds the password of the authorized user. When that password changes, the value on this property must also be updated.

If no default mail address is provided, STEP sets the default 'From' email address as 'noreply@step-system.invalid'.

  1. Restart the STEP application server to apply the changes to the properties file.