Email templates can be defined when creating email subscriptions. For more information on Email template syntax, see Email Template Language.
Job Keywords
Every transformation job with notification enabled automatically supports the following keywords:
| Keyword Placeholder Name | Description |
|---|---|
| {id} | The ID assigned to this transformation. |
| {requestKeyword} | The request keyword string from the client that accompanied the request. |
| {timeStarted} | The date when the transformation request started to be processed. |
| {timeFinished} | The date when the transformation result was received from an FME Engine. |
Client Custom Keywords
All notification manager directives specified by a client are also available as keyword placeholder names. In the case of the Data Download Service and Job Submitter services this means any URL parameters prefixed with “nm_” are available.
For example, a Data Download Service URL like the following will also have keyword placeholder {title} with value “Sample” and keyword placeholder {desc} with value “Hello World” available to be used within an email template:
http://localhost/fmedatadownload/Samples/austinDownload.fmw?opt_servicemode=async&opt_requesteremail=test%40email.com&nm_title=Sample&nm_desc=Hello%20World
In addition to the above Web Services, notification manager directives can also be specified via the REST, Java, .NET and C++ APIs.
Client-Specific Keywords
Every client that invokes a transformation job specifies a request keyword that corresponds to a specific FME Engine configuration. Clients can also specify additional keywords to customize the job results on job success and job failure. By default, all FME Engine response parameters also available as keyword placeholder names. Additional FME Engine response parameters can also be defined by editing the respective FME Engine configuration.
For the Data Download Service and Job Submitter services, the available keywords are:
| Keyword Placeholder Name | Description |
|---|---|
| {statusMessage} | The descriptive string representation of the job status. |
| {statusNumber} | The status number of the FME transformation. |
| {urlPrefix} | The URL prefix to download transformation results. |
| {ResultRootDir} | The root directory of the transformation results. |
| {OutputLocation} | The location of the transformation results. |
| {NumFeaturesOutput} | The number of features written when job transformation is successful. |
| {LogFileName} | The name of the job transformation log file. |
| {email_to} | The email address to send to. |
| {jobsuccess_topic} | The name of the topic notified on job success. |
| {jobfailure_topic} | The name of the topic notified on job failure. |