Monitoring FME Server Activity with Notifications
FME Server is pre-configured to publish content about significant events, such as when a workspace run from FME Server succeeds or fails, or when a backup or restore operation succeeds or fails. This content is delivered to a set of pre-existing topics. Additionally, FME Server includes a set of subscribers that are already subscribed to these topics. When configured completely, these subscribers can deliver their content over the specified protocol.
Pre-Configured Topics
To view these topics, select the Topics tab on the Notifications page of the FME Server Web User Interface.
Note: You can specify your own topics to receive success or failure notifications in the following situations:
When you publish a workspace to FME Server to the Data Download or Job Submitter services.
In the settings of a FME Workspace Subscriber.
In these cases, the corresponding topics below are not notified, unless they are also explicitly specified.
Topic Name | Description |
---|---|
DATADOWNLOAD_ASYNC_JOB_FAILURE | A notification for this topic is generated following a Data Download Service FME transformation that fails. |
DATADOWNLOAD_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a Data Download Service FME transformation that succeeds. |
JOBSUBMITTER_ASYNC_JOB_FAILURE | A notification for this topic is generated following a Job Submitter Service FME transformation that fails. |
JOBSUBMITTER_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a Job Submitter Service FME transformation that succeeds. |
MIGRATION_ASYNC_JOB_FAILURE | A notification for this topic is generated following a backup or restore request that fails. |
MIGRATION_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a backup or restore request that succeeds. |
GENERATE_DASHBOARD | A notification for this topic is generated when job history statistics are available for Dashboards. |
SAMPLE_TOPIC | This is a sample topic. By default, no notifications are generated for this topic. It is used for testing notifications. |
Pre-Configured Subscribers
To view these subscribers and, if desired, complete their configurations, select the Subscriptions tab on the Notifications page of the FME Server Web User Interface.
Subscriber Name | Topic(s) Subscribed To | Protocol | Description |
---|---|---|---|
DataDownload_Email_JobFailure | DATADOWNLOAD_ASYNC_JOB_FAILURE | Email Subscriber | Sends e-mails to specified recipients following a Data Download FME transformation that fails. |
DataDownload_Email_JobSuccess | DATADOWNLOAD_ASYNC_JOB_SUCCESS | Email Subscriber | Sends e-mails to specified recipients following a Data Download Service FME transformation that succeeds. |
JobSubmitter_Email_JobFailure | JOBSUBMITTER_ASYNC_JOB_FAILURE | Email Subscriber | Sends e-mails to specified recipients following a Job Submitter Service FME transformation that fails. |
JobSubmitter_Email_JobSuccess | JOBSUBMITTER_ASYNC_JOB_SUCCESS | Email Subscriber | Sends e-mails to specified recipients following a Job Submitter Service FME transformation that succeeds. |
Logger_Default | All default topics | Logger Subscriber | Logs all notifications of the topics to which it is subscribed. |
Migration_Email_JobFailure | MIGRATION_ASYNC_JOB_FAILURE | Email Subscriber | Sends e-mails to specified recipients following a backup or restore operation that fails. |
Migration_Email_JobSuccess | MIGRATION_ASYNC_JOB_SUCCESS | Email Subscriber | Sends e-mails to specified recipients following a backup or restore operation that succeeds. |
Dashboards_AverageRunningTime | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs a workspace that writes the AverageRunningTime.html to the Dashboards\dashboards folder on the Resources page. This report is then displayed on the Dashboards page. |
Dashboards_DailyTotalJobs | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs a workspace that writes DailyTotalJobs.html to the Dashboards\dashboards folder on the Resources page. This chart is then displayed on the Dashboards page. |
Dashboards_DailyAverageQueuedTime | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs a workspace that writes DailyAverageQueuedTime.html to the Dashboards\dashboards folder on the Resources page. This chart is then displayed on the Dashboards page. |
Dashboards_DailyTotalRunningTime | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs a workspace that writes DailyTotalRunningTime.html to the Dashboards\dashboards folder on the Resources page. This chart is then displayed on the Dashboards page. |
Dashboards_FailuresByWorkspace | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs a workspace that writes FailuresByWorkspace.html to the Dashboards\dashboards folder on the Resources page. This chart is then displayed on the Dashboards page. |
Attaching Log Files to Notification E-mails
You can configure the following subscribers to attach an FME job log file with each e-mail:
- DataDownload_Email_JobFailure
- DataDownload_Email_JobSuccess
- JobSubmitter_Email_JobFailure
- JobSubmitter_Email_JobSuccess
- Open the following files:
- <FMEServerDir>\Utilities\tomcat\webapps\fmedatadownload\WEB-INF\conf\propertiesFile.properties
- <FMEServerDir>\Utilities\tomcat\webapps\fmejobsubmitter\WEB-INF\conf\propertiesFile.properties
- In each file, locate the ATTACH_TRANSFORMATION_LOG parameter.
- To attach a job log file, set this parameter to
true
. To stop the subscribers from attaching job log files, set this parameter tofalse
. (This is the default setting.) - Restart the FME Server Application Server.