Page History

...

• 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.

Setter methods

void putLogMessage(String clientId, String piDiagnosticsXmlContent);

• clientId: <id only used as description>
• piDiagnosticsXmlContent: String containing the log messages in the format defined by the PI Diag XSD

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

• <unsupported>

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

• <unsupported>

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

• <unsupported>

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.
• ensembleId: Id of the ensemble
• ensembleMemberIndex: Ensemble member index for this time series. NULL if this is not an ensemble.

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.

Setting up PI Service Client

...