Page History

...

byte[] getTimeSeriesBytes(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime, String[] parameterIds, String[] locationIds, String
 ensembleId,
               String ensembleId, int ensembleMemberIndex);

...

void putModuleDataSet(String clientId, String taskId, String id, byte[] byteModuleDataSetContent,
               Date validityStartTime, Date validityEndTime, String ensembleId, int ensembleMemberIndex);

• <unsupportednot implemented>

void putModuleParameterSet(String clientId, String id, String taskId, String piParameterSetXmlContent,
               Date validityStartTime, Date validityEndTime, String ensembleId, int ensembleMemberIndex);

• <unsupportednot implemented>

void putState(String clientId, String taskId, String piStateXmlContent, String byteStateFileName,
                byte[] byteStateContent, String ensembleId, int ensembleMemberIndex);

• <unsupportednot implemented>

void putTimeSeries(String clientId, String taskId, String id, String piTimeSeriesXmlContent,
                String ensembleId, int ensembleMemberIndex);

...

• clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
• taskId: <id not required>
• id: Reference to the ID of a TimeSeries element in the service configuration file.
• piTimeSeriesXmlContent: Time Series content in the form of a Pi timeseries xml file.
• byteTimeSeriesContent: TimeSeries data content in the form of a byte array.
• ensembleId: Id of the ensemble
• ensembleMemberIndex: Ensemble member index for this time series. NULL if this is not an ensemble.

Run methods

String createTask(String clientId);

...

• clientId: <not required>
• taskId: Id obtained by running calling method #runTask #createTask
• @param workflowId Workflow Id
• @param startTime start date/time of run - NULL if the configured default is to be used
• @param timeZero Forecast time zero.
• @param endTime end date/time of run - NULL if the configured default is to be used
• @param coldStateId String identifying the cold state to use - NULL if a cold state start is not forced
• : Id of workflow to run by task.
• startTime: <not required>
• timeZero: <not required>
• endTime: <not required>
• coldStateId: <not implemented>
• userId: @param userId Id of user running task.
• @param description: Description@return Returns the TaskRun id
• returns: TaskRun id

void cancelTask(String clientId, String taskId);

<not implemented>

boolean waitForTask(String clientId, String taskId, int waitMillis);

• clientId: <not required>
• taskId: Id of task run. Returned by callingmethod #runTask.
• waitMillis: Wait time in milli seconds.
• returns: TRUE if task run completes successfully, else FALSE

Setting up PI Service Client

...