Job Submitter Service

The Job Submitter service accepts and runs workspace job requests.

The Job Submitter service works with any workspace.

This service is requested using a URL or a form. For example,

http://Host/fmejobsubmitter/Repository/workspace.fmw?parameters

The resulting web page indicates whether the job submission was successful. If the job was submitted successfully, the FME Flow transformation results are shown.

Alternatively, the job submitter service can be run from the Web User Interface.

Service Specific Request Parameters

Name	Value	Description
opt_responseformat	xml | json Default: xml	The language of the response. The text must be all lowercase.
opt_geturl	The URL to a dataset	The URL of the source dataset to be used for transformation.
opt_showresult	true | false	Whether the XML/JSON responses include the FME transformation result. The default value is true if this parameter is not present.
opt_servicemode	sync | async	Toggles between synchronous and asynchronous modes of the service. When jobs are submitted asynchronously (async), the response of submission success or failure is returned immediately. When set to synchronous (sync), the response is not returned until the job completes.
opt_requesteremail	comma-separated email addresses	Addresses to which notification email messages are sent.

Job Directives and Notification Directives

This service supports Job Directives and Notification Directives.

Using Remote Data During a Request

Using data from HTTP POST body as Reader dataset

This web service can receive data and override source dataset via HTTP POST. The content of the POST request body will be saved to a temporary file which will be used as the Reader dataset of the workspace. If there is more than one reader in the workspace, then you will need to indicate which reader will use the temporary file. You indicate your choice when publishing the workspace by editing the service registration.

Using data from HTTP GET as Reader dataset

This web service can receive data and override Reader dataset via HTTP GET. The dataset should be specified as a URL and passed to service by 'opt_geturl' parameter. Both HTTP and FTP URLs are supported. If there is more than one reader in the workspace, then you will need to indicate which reader will use the temporary file. You indicate your choice when publishing the workspace by editing the service registration.

For example here is a service request that uses a remote KMZ dataset:

http://localhost/fmejobsubmitter/Test/Viewer.fmw?opt_geturl=http://data.vancouver.ca/download/kml/elementary_school_boundaries.kmz

Response Elements

If the response format is specified as XML or JSON, a service response may contain the elements shown in the following table.

Element	Child Elements	Value	Description
statusInfo	message	message string	service failure message
	status	success | failure	service status
	mode	sync | async	service mode
fmeTransformationResult	fmeServerResponse	FME Flow response properties	FME Flow response
	fmeEngineResponse	FME Engine response properties	FME Engine response
email	none	Email addresses	Requesters’ email addresses
jobID	none	job ID	The current job identifier

Enabling E-Mail Notifications

The job submitter service can send email messages to notify you when a job completes successfully or unsucessfully.

For more information, see Configuring FME Flow to Send Email Notifications.

See Also