The Data Download Service provides users with the output from a workspace as a downloadable zip file. Typically the service allows users to specify the data layers, format and coordinate system for the download.
This service is requested using a URL or a form. For example:
http://<host>/fmedatadownload/<repository>/<workspace>.fmw?<parameters>
A web page opens with a link to a zip file containing the results of the workspace translation. In addition, an email can be sent with a link to the zip file.
This service works with any workspace that writes single or multiple files. No published parameters are required.
Note: You may want to publish some parameters from your workspace to control the translation from the URL or form request. For example, feature types to read, output coordinate system, and format (generic writer) are commonly published parameters when using this service.
Service Specific Request Parameters
|
Name |
Value |
Description |
|---|---|---|
|
opt_responseformat |
xml | json |
Defines 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 | It indicates whether the XML/JSON responses from these three services include the FME transformation result. The default value is true if this parameter is not present. |
| opt_servicemode | sync | async | Toggle between synchronous and asynchronous modes of the service. |
| opt_requesteremail | comma-separated e-mail addresses | Addresses to which the notification e-mail messages are sent. |
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.
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://<host>/fmedatadownload/Test/Viewer.fmw?opt_geturl=http://data.vancouver.ca/download/kml/elementary_school_boundaries.kmz
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 Server response properties |
FME Server response |
|
fmeEngineResponse |
FME Engine response properties |
FME Engine response |
|
|
|
none |
Email addresses |
Requesters’ e-mail addresses |
|
url |
none |
URL string |
URL used to download the result dataset (ZIP) |
|
jobID |
none |
job ID |
The current job identifier |