FMEServerJobSubmitter
Submits FME Spatial ETL jobs to be run on an FME Server. A job consists of a workspace (housed within a repository on an FME Server) together with values for each of its published parameters. This transformer submits one job per feature which enters it. Any published parameters of the server workspace will be given values as specified in the transformer, or taken from attributes of the feature which enters it.
Dependencies
This transformer requires an FME Server connection.
Output Ports
Features that successfully submitted the requests to the server.
Features that failed to submit the requests to the server.
Wizard Panes
Connect to an FME Server
Direct Connection: The server Host and Port number identify the server that will be used to execute the job.
Web Connection: You can also enter a URL to access FME Server using the REST API. Note that when you enter a URL, the Port field will disappear. You may need to contact your System Administrator for information on host names or URLs.
Username and Password: These are optional, but, depending on your configuration, you may need them in order to access the server.
Note: You can click the Test... button at the bottom of the dialog to ensure that the FME Server connection has been successfully established.
Select Workspace
Choose a repository, the select the workspace that will be run for each feature that enters the transformer.
Edit Job Parameters
Edit parameters to enable the current workspace to submit jobs to the FME Server
If this parameter is set to Yes, then the transformer will wait until the job is completely processed by the server before proceeding. In this case, the initiating feature is output via the Succeeded port if the job successfully ran to completion, and will have these attributes added to it:
- _job_id: The integer ID the server assigned to this job.
- output_datasets{}: A list attribute that is provided when Output Data Location (see below) is set to Temporary Folder.
- output_datasets{}.name: The unique name for the dataset (for example, SHAPE_1). If multiple writers use the same format, the name will be unique for each writer.
- output_datasets{}.format: The format name. The same name applies to all writers that output to the same format (for example, SHAPE for shapefile).
- output_datasets{}.path: The physical location where the dataset is written. You can use this attribute as input to downstream transformers for further processing.
- _NumFeaturesOutput: The number features that were output by the job.
- _priority: The priority assigned to the job.
- _requesterHost: The name of the machine hosting FME Workbench that submitted the job.
- _requesterResultPort: The port on the host machine through which results are returned.
- _status: Job status indicator; can be SUBMITTED, QUEUED, ABORTED, SUCCESS, FME_FAILURE, JOB_FAILURE or PULLED.
- _statusMessage: The translation result message.
- _timeFinished: The time the job finished .
- _timeRequested: The time the server received the job request.
- _timeStarted: The time the server started processing the job.
Note:
All times are in YYYYMMDDhhmmss format.
The feature will be output via the Failed port if the job either did not run to completion, or the server could not be contacted, and will have these attributes added to it:
- _job_failure_type: Holds one of "Connection or Server Problem" or "Translation Failed". If the latter, then the following attributes will also have values; otherwise, they are empty.
- _NumFeaturesOutput: The number features that were output by the job.
- _priority: The priority assigned to the job.
- _requesterHost: The name of the machine hosting FME Workbench that submitted the job.
- _requesterResultPort: The port on the host machine through which results are returned.
- _job_id: The integer ID the server assigned to this job.
- _status: Job status indicator; can be SUBMITTED, QUEUED, ABORTED, SUCCESS, FME_FAILURE, JOB_FAILURE or PULLED.
- _statusMessage: The error message returned from the server explaining why the request failed.
- _timeFinished: The time the job finished.
- _timeRequested: The time the server received the job request.
- _timeStarted: The time the server started processing the job.
Note: Note: _job_id is included only if the job failure is related to an error during translation. If the job did not run due to a connection or server problem, then _job_id is not included.
If this parameter is set to No, the transformer will output the initiating feature as soon as the job is submitted to the server. In this case, the initiating feature is output via the Succeeded port if the request was successfully submitted, and only the _job_id attribute will be added to it. If the server could not be contacted or the job submission otherwise failed, then the feature is output via the Failed port, and the _job_failure_type attribute will hold the "Connection or Server Problem" value.
Job Priority defines the order in which the job will be executed on the server. The default is 100, the lowest priority possible.
Job Tag, if supplied, defines the tag associated with this workspace for use with FME Server’s Job Routing. No default value is specified.
- Temporary Folder: The job writes its output data to a temporary folder, overriding the output data location(s) specified in the workspace. Specifying Temporary Folder can be useful when linking multiple FMEServerJobSubmitter transformers to manage the workflow of multiple jobs. For an example, see the FME Knowledge Center article, FME Server Workflow Management.
- As Specified in Workspace: The job writes its output data to the location(s) specified in the workspace.
Any published parameters of the workspace to be run appear here. For each one, specify the value to pass when the workspace runs.
Buttons
Test | This button appears on the first wizard pane. Click it to confirm that the FME Server connection has been successfully established. |
Help | Displays the help text for this transformer. |
Back | Displays the previous pane. |
Finish | Sets the transformer parameters. The transformer will use these parameters when you run the workspace. |
Cancel | Closes the wizard pane and resets the parameters if they have not yet been saved. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Transformer Categories
FME Licensing Level
FME Professional edition and above
Transformer History
This transformer was previously named the ServerJobSubmitter.
Search FME Knowledge Center
Search for samples and information about this transformer on the FME Knowledge Center.
Tags Keywords: ServerJobSubmitter