Page History

...

• clientId: <id not required>
• returns: Default Locations.xml file from the OC configuration. Note file is not is PI_Locations XSD format.

String getClientConfigFile(String clientId, String fileExtension);

...

The Pi Service configuration files are located in the directory 'PiServiceConfigFiles' of the region configuration. These files link the IDs know by the client applications to FEWS data, such as TimeSeries, States, ModuleDataSets and ModuleParameterSets.

A Pi Service file has five sections:

1. General: Contains general configuration, such as import and export locations. Id mapping information for mapping client location/parameter ids to FEWS location/parameter ids.
2. TimeSeries: Contains the mapping of client timeseries ids to the FEWS timeseries sets. Also some extra export options.
3. ModuleDataSet: Contains the mapping of client moduleDataSet ids to the FEWS moduleInstance descriptor ids.
4. ModuleParameterSet: Contains the mapping of client moduleParameterSet ids to the FEWS moduleInstance descriptor ids.
5. ModuleState: Contains the mapping of client moduleState ids to the FEWS moduleInstance descriptor ids.

If a client application requires an application specific configuration file then this file must be configured in the directory ' PiClientConfigFiles' of the region configuration. This file is free format (text) and can be obtained from the API by calling \[#getClientConfigFile\]

.

Example code

Appendix

FewsPiService API

...