Page History

...

byte[] getTimeSeriesBytes(String clientId, String id, String taskId, Date startTime,
		Date timeZero, Date endTime, String[] parameterIds, String[] locationIds, 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.
• id: Reference to the ID of a TimeSeries element in the service configuration file.
• taskId: <id not required however can not be null>
• startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
• timeZero: Forecast time zero.
• endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
• parameterIds: Subset of parmater IDs for which to retrieve timeseries.
• locationIds: Subset of location IDs for which to retrieve timeseries.
• ensembleId: Id of the ensemble, can be null.
• ensembleMemberIndex Ensemble member index for this time series. (Only if configured)
• returns: Content of the binary file that can be exported together with the PITimeseries XML files.

...

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

...

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

...

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

...

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

...

void putTimeSeriesBinary(String clientId, String taskId, String id, String piTimeSeriesXmlContent,
                 byte[] byteTimeSeriesContent, 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>
• returns: Unique task id.

String runTask(String clientId, String taskId, String workflowId, Date startTime, Date timeZero,
          Date endTime, String coldStateId, String scenarioId, String userId, String description);

• clientId: <not required>
• taskId: Id obtained by running method #runTask
• @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
• @param userId Id of user running task.
• @param description Description
• @return Returns the TaskRun id

Setting up PI Service Client

...