| Table of Contents |
|---|
Introduction
The Fews Workflow Runner service uses XFire, a java SOAP framework. This framework allows a client application to obtain a proxy instance to the FewsWebServiceRunner API. With this API the client can run workflows on the MC from the client code. The timeseries produced by the workflow run can read by the client application. Before a client application can access the FEWS system there is some configuration work that needs to be done.
| Warning |
|---|
Parallel processing functionality from 2017.01 (<multipleForecastingShells>true</multipleForecastingShells>) is currently not possible via this service. |
User's looking to use XFire on a new project, should use CXF instead. CXF is a continuation of the XFire project and is considered XFire 2.0. It has many new features, a ton of bug fixes, and is now JAX-WS compliant! XFire will continue to be maintained through bug fix releases, but most development will occur on CXF now. For more information see the XFire/Celtix merge FAQ and the CXF website.
...
Description of the methods provided by the Fews Workflow Runner Service API.
| Code Block |
|---|
TimeSeries[] runFewsWorkflow(String clientId, String workflowId, Date forecastStartDateTime,
Date forecastDateTime0, Date forecastEndDateTime, TimeSeries[] inputTimeSeries)
throws Exception;
|
...
The MC Service component is started up by the MC (TaskWebServiceRunner). The client application does not use this service directly. The only configuration required for this component is that the following line is added to the MC configuration file; fews.master.mc.conf.
| Code Block |
|---|
<webservice port="8899" sleeptime="15" timeout="600"/>
|
...
Step 2: Make a new FewsWebService.exe and FewsWebService.jpif file in the \bin directory. The FewsWebService.jpif must contain the following information.
| Code Block |
|---|
..\jre
-mx512m
-cp
$JARS_PATH$
nl.wldelft.fews.webservice.FewsWebServiceRunner
<path>/WebService.xml
|
...
Setting up a connection
| Code Block |
|---|
ObjectServiceFactory serviceFactory = new ObjectServiceFactory();
Service service = serviceFactory.create(FewsWebService.class);
XFireProxyFactory proxyFactory = new XFireProxyFactory();
//port Number must be equal to the number configured in the WebService.xml
int portNumber = 8100;
//localhost can be replaced by the ip address of the machine on which the WebService is running.
FewsWebService serviceProxy = (FewsWebService) proxyFactory.create(service, "http://localhost:" + portNumber + "/FewsWebService")
|
Running Workflows
| Code Block |
|---|
FewsWebService proxy = getProxy(); //See section "Setting up a connection"
TimeSeries[] inputArrays = getInputArrays(); //Get the timeseries required to run workflow.
//Run a workflow
try {
TimeSeries[] outputArrays = proxy.runFewsWorkflow("MyWebService", "workflowId", new Date(0), new Date(0), new Date(0), inputArrays);
} catch (Exception e){
// do something.
}
|
...