Spotfire Automation Services "Send Email" task fails with error "Failed to send email using SMTP server 'smtp.company.com'"

Product:TIBCO Spotfire Server
Versions:All

Summary:
When executing the Spotfire Automation Services task "Send Email", it fails with the error "Failed to send email using SMTP server 'smtp.company.com'". This error is seen when the external SMTP server details have not been added to the Automation Services service configuration.

Details:
When executing the Spotfire Automation Services task "Send Email", it fails with the error "Failed to send email using SMTP server 'smtp.company.com'" and no email is sent. The following error is seen:
'Send Email' failed with Failed to send email using SMTP server 'smtp.company.com' 

And the following is seen in the Spotfire.Dxp.Automation.log:

Task 'Send Email' failed with: Failed to send email using SMTP server 'smtp.company.com' from 'xxxx' to 'xxxx'.
Reason: System.Net.Mail.SmtpException: Failure sending mail. ---> System.Net.WebException: The remote name could not be resolved: 'smtp.company.com'
   at System.Net.ServicePoint.GetConnection(PooledStream PooledStream, Object owner, Boolean async, IPAddress& address, Socket& abortSocket, Socket& abortSocket6)
   at System.Net.PooledStream.Activate(Object owningObject, Boolean async, GeneralAsyncDelegate asyncCallback)
   at System.Net.ConnectionPool.GetConnection(Object owningObject, GeneralAsyncDelegate asyncCallback, Int32 creationTimeout)
   at System.Net.Mail.SmtpConnection.GetConnection(ServicePoint servicePoint)
   at System.Net.Mail.SmtpClient.GetConnection()
   at System.Net.Mail.SmtpClient.Send(MailMessage message)
   --- End of inner exception stack trace ---
   at System.Net.Mail.SmtpClient.Send(MailMessage message)
Done

This error is seen when your external SMTP server details have not been added to the Automation Services service configuration. The "smtp.company.com" server is the default value from the Automation Services configuration, but to successfully use the "Send Email" task you must manually add the SMTP settings to the Spotfire.Dxp.Worker.Automation.config file and assign the new configuration to a service running Automation Services.
 

Resolution:
To resolve, first ensure you have the correct information for your SMTP server and that it is accessible for sending emails.

Then update SMTP server details in the configuration per Adding SMTP settings to the Spotfire.Dxp.Worker.Automation.config file. Details:

1.  Launch a command prompt as Administrator on the Spotfire Server machine.
2.  Export the Automation Services configuration using the "export-service-config" command. Here is an example: config export-service-config --capability=AUTOMATION_SERVICES --deployment-area=Production
   • For 10.2 and below, the exported configuration files will be saved under the \tomcat\bin\config\root folder.
   • For 10.3 and above, the exported configuration files will be saved under the \tomcat\Spotfire-bin\config\root folder.
3. Open the Spotfire.Dxp.Worker.Automation.config file in a plain text editor.
4. Search for Spotfire.Automation.SendMail.SMTPHost parameter and update the parameter value with the correct SMTPHost and FromAddress values:

   <!-- SMTP Host for Email Notification -->
   <add name="Spotfire.Automation.SendMail.SMTPHost" value="smtp.company.com" />
   <!-- From Address for Email Notification -->
   <add name="Spotfire.Automation.SendMail.FromAddress" value="TsasService@company.com" />

5. Save the file. If you get a prompt to override the existing file, select "Yes".
6. Import the modified configuration using the "import-service-config" command. Enter the "config-name" value relevant to the changes made. An example is config import-service-config --config-name="SMTP details."
7. Launch the Spotfire administration user interface in a web browser and select "Nodes & Services."
8. Edit the Automation Service services to use the updated configuration. Look for the "config-name" value you entered while importing the service configuration and update it to use it.