Workspace notifications, Part 2: Configuring the default subscribers

Liz Sanderson
Liz Sanderson
  • Updated

FME Version

  • FME 2016.x

Introduction

When a job is run asynchronously (i.e. you provide an email address) via data download or job submitter, a notification is sent on completion. The standard workflow is to request data, providing an email address. Once the data is processed, a link to download the result is emailed to the requester.

FME Server has four default topics used by the Job Submitter service and Data Download service:

  • DATADOWNLOAD_ASYNC_JOB_SUCCESS
  • DATADOWNLOAD_ASYNC_JOB_FAILURE
  • JOBSUBMITTER_ASYNC_JOB_SUCCESS
  • JOBSUBMITTER_ASYNC_JOB_FAILURE


There are also default email subscriptions to these topics which can be configured to use your SMTP server:

  • DataDownload_Email_JobSuccess
  • DataDownload_Email_JobFailure
  • JobSubmitter_Email_JobSuccess
  • JobSubmitter_Email_JobFailure

 

Step-by-step Instructions

Use the "Manage Notifications" button on the FME Server home page, and open the Topic Monitoring tab. Set the Topics to Monitor to: DATADOWNLOAD_ASYNC_JOB_SUCCESS.


Open a new tab or window, and configure austinApartments.fmw in the Samples repository (Manage > Workspaces > Samples) with the Data Download service, and supply the “Email results to” input box with an email address:

jobsubmitteremailresults.png



When you run it, you will be able to see the default notification content on the Monitoring tool.

emailtopicstomonitor.png

Once you have verified the notification has been received successfully, you can configure the notification subscription DataDownload_Email_JobSuccess to send email. Open the Subscriptions, (Manage > Notifications > Subscriptions) and select the "DataDownload_Email_JobSuccess" Subscription. You'll see that the Topics Subscribed to is set to DATADOWNLOAD_ASYNC_JOB_SUCCESS. Select "email" as the protocol to use, and make the necessary changes to your protocol settings.

Note: You will need to supply credentials for an SMTP server, or use the configuration parameters for a Gmail SMTP server. If using 2-factor authentication with Google, you will also need to generate an app password, and replace the SMTP password with this 16 digit app password code.

subscription-jobemailsuccess.png


You can modify the content of the message through the Email Template input box. Any of the keywords listed in the notification message (id, downloadURL, etc.) can be used in the email template by surrounding the keyword with curly braces, { }. Please see the email Template Language documentation for further details on configuring email content.

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.