E-mail Template Keys
E-mail templates can be defined when creating Email external actions. For more information on e-mail template syntax, see E-mail Template Language.
Job Keys
Every transformation with notification enabled automatically supports the following keys:
| Key Placeholder Name | Description |
|---|---|
| {id} | The ID assigned to this transformation. |
| {requestKeyword} | The request keyword string from the client that accompanied the request. |
| {timeRequested} | Time the job was submitted. |
| {timeStarted} | The date when the transformation request started to be processed. |
| {timeFinished} | The date when the transformation result was received from an FME Engine. |
| {workspace} | Name of the workspace that was run. |
| {repository} | Repository in which the workspace is stored. |
| {logUrl} | Full URL to the log file for the job. |
Client Custom Keys
All Notification Directives specified by a client are also available as key 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, this Data Download Service URL contains key placeholder {title} with value Sample, and keyword placeholder {desc} with value Hello World:
http://localhost/fmedatadownload/Samples/austinDownload.fmw?opt_servicemode=async&opt_requesteremail=test%40email.com&nm_title=Sample&nm_desc=Hello%20World
Client-Specific Keys
Every client that invokes a transformation job specifies a request key that corresponds to a specific FME Engine configuration. Clients can also specify additional keys to customize the job results on job success and job failure. By default, all FME Engine response parameters are also available as key placeholder names. Additional FME Engine response parameters can also be defined by editing the respective FME Engine configuration.
The following keys are available for the Data Download and/or Job Submitter services, as indicated:
| Key Placeholder Name | Description | Data Download Service | Job Submitter Service |
|---|---|---|---|
| {StatusMessage} | The descriptive string representation of the job status. | X | X |
| {StatusNumber} | The status number of the FME transformation. | X | X |
| {urlPrefix} | The URL prefix to download transformation results. | X | |
| {ResultRootDir} | The root directory of the transformation results. | X | |
| {OutputLocation} |
The location of the transformation results. Note: To retrieve the filename fragment of the URL used to download any job transformation result files, use the @getFileName function. |
X | |
| {NumFeaturesOutput} | The number of features written when job transformation is successful. | X | X |
| {LogFileName} | The name of the FME job log that was created by the transformation. | X | X |
| {logFullPath} | Full path to the FME job log. | X | X |
| {logUrl} | Link to the FME job log. | X | X |
| {logHome} | Path to the FME Server <LogDir> directory. (For more information, see About Log Files in FME Server.) | X | X |
| {jobsuccess_topic} | The name of the topic notified on job success. | X | X |
| {jobfailure_topic} | The name of the topic notified on job failure. | X | X |
| {workspace} | The name of the workspace that ran the transformation. | X | X |
| {repository} | The name of the repository in which the workspace resides. | X | X |
| {downloadUrl} | URL pointing to the transformation results. | X | |
| {subscriber_folder} | Full path to the transformation results. | X | X |