Once a workspace is published to an FME Server repository, the workspace can be run. This can be done by constructing and sending a GET request to the URL, as defined by the REST API Specifications document. Normally users create their own workspaces, but for this example we use a sample workspace that is included with the default installation of FME Server.
Some workspaces have published parameters. Some published parameters have default values, but others need to be explicitly set before running the workspace.
To Get a List of Published Parameters Available for a Workspace
httpRequest.open("GET", "/fmerest/repositories/"+repositoryName+"/"+workspaceName+"/parameters.json?token="+token_, true);
httpRequest.onreadystatechange = function()
{
if (httpRequest.readyState == 4)
{
if (httpRequest.status == 200)
{
var reply = eval("(" + httpRequest.responseText + ")");
if (typeof(reply.serviceResponse.parameters.parameter) != 'undefined')
{
var parameter = reply.serviceResponse.parameters.parameter;
for (var i in parameter)
{
println(parameter[i].description + " ("
+ parameter[i].name + ")");
}
}
else
{
println("No Parameters Found");
}
}
else
{
println("Error");
}
}
}
httpRequest.send(null);
To set a published parameter - in this case MAXY - add it to the parameter to be sent:
parameter += "&MAXY=50";
Note: Values for published parameters must always be passed as a string, regardless of what they actually represent.
There are also directives which are always available from the FME Server. A list of Transformation Manager directives can be found in Transformation Manager Directives. The following example sets a high value for the priority of a job in order to tell the FME Server to execute it before other tasks.
parameter += "&tm_priority=50";
The transformation result has a number of methods for obtaining different parts of information from the FME Server response. The following example parses and displays a few important points from the string that was received from the server. In certain scenarios, clients may want to do their own parsing on this string instead of relying on the provided methods.
httpRequest.open("POST", "/fmerest/repositories/"+repositoryName+"/"+workspaceName+"/run.json?token="+token_, true);
httpRequest.setRequestHeader("Content-type","application/x-www-form-urlencoded");
var param = "";
httpRequest.setRequestHeader("Content-length", param.length);
httpRequest.setRequestHeader("Connection", "close");
httpRequest.onreadystatechange = function()
{
if (httpRequest.readyState == 4)
{
if (httpRequest.status == 200)
{
// generate an output message based on the response received
var reply = eval("(" + httpRequest.responseText + ")");
var result = reply.serviceResponse.fmeTransformationResult;
var output = "Job status: " + result.fmeServerResponse.jobStatus + "\n";
output+= "FME transformation result:\n";
output+= "Request: " + result.fmeServerResponse.request + "\n";
output+= "Reply message: " + result.fmeServerResponse.result + "\n";
println(output);
}
else
{
println("Error");
}
}
}
httpRequest.send(param);