Web Services
This section describes the web services included in the test harness BPEL composite, including:
General Services
This section describes the general services of the test harness composite, including:
LoadMeterIndex
This web service loads the data store from the internal file. By default, if the store is already in memory, it will NOT reload. This behavior can be overridden with the forceReload parameter.
Input
LoadMeterIndexInput
Part: payload
Element: LoadMeterIndexRequest
Output
LoadMeterIndexOutput
Part: payload
Element: LoadMeterIndexResult
Fault
UtilityFault
Fault with similar mapping to SGG/OUAF faults:
Typically, the faultCode, faultString, faultActor, and detail/text elements will be populated.
ViewAuditTrail
This web service returns the audit log for the entire session.
Input
ViewAuditTrailInput
Part: payload
Element: ViewAuditTrailRequest
Output
ViewAuditTrailOutput
Part: payload
Element: ViewAuditTrailResult
An Entry consisting of a timestamp and an Operation. Each entry may have an associated meter object showing the latest update.
Fault
See UtilityFault .
Locate Meter Services
This section describes the locate meter web services of the test harness composite, including:
FindMeters
This web service queries the data store for one or more meters. The difference between GetMeter and FindMeters is GetMeter can return at most one meter and it must match the provided ID exactly. GetMeter will throw an error if the ID is not found. FindMeters can return more than one meter (when using the regex) and will not throw an error when the ID does not match any of the meters in the index.
Input
FindMetersInput
Part: payload
Element: FindMetersRequest
Output
FindMetersOutput
Part: payload
Element: FindMetersResult
Zero or more meter objects can be returned from the search
Fault
See UtilityFault . Unlike other methods, FindMeters does not throw an exception if the meter is not found. As such, it can be used to test for the existence of a Meter prior to querying for it.
IsMeterDefined
This web service queries whether a particular meter is defined in the data store.
Input
IsMeterDefinedInput
Part: payload
Element: IsMeterDefinedRequest
Output
IsMeterDefinedOutput
Part: payload
Element: IsMeterDefinedResult
Whether or not the provided ID is part of the index.
Fault
See UtilityFault . Thrown when meter id is not found.
GetMeter
This web service returns all the attributes of a single meter from the in-memory data store. The difference between GetMeter and FindMeters is GetMeter can return at most one meter and it must match the provided ID exactly. GetMeter will throw an error if the ID is not found. FindMeters can return more than one meter (when using the regex) and will not throw an error when the ID does not match any of the meters in the index.
Input
GetMeterInput
Part: payload
Element: GetMeterRequest
Output
GetMeterOutput
Part: payload
Element: GetMeterResult
The meter object requested by the ID.
Fault
See UtilityFault . Thrown when meter id is not found.
GetGroupMeters
This web service retrieves the set of meters with the specified group name
Input
GetGroupMetersInput
Part: payload
Element: GetGroupMetersRequest
Output
GetGroupMetersOutput
Part: payload
Element: GetGroupMetersResult
The set of meters with the provided group name.
Fault
See UtilityFault . Thrown only in unusual circumstances.
Meter Administration Services
This section describes the meter administration services of the test harness composite, including:
AddMeters
This web service adds a set of meters to the in-memory data store. This will not permanently add it to the control file.
Input
AddMetersInput
Part: payload
Element: AddMetersRequest
Output
AddMetersOutput
Part: payload
Element: AddMetersResult
Whether or not each meter was added to the index.
Fault
See UtilityFault
RemoveMeter
This web service removes a meter from the in-memory data store. This will not permanently remove it from the control file.
Input
RemoveMeterInput
Part: payload
Element: RemoveMeterRequest
Output
RemoveMeterOutput
Part: payload
SElement: RemoveMeterResult
Whether or not the meter was removed from the index.
Fault
See UtilityFault . Thrown when meter id is not found.
AddMeterChannel
This web service adds a new channel to a single meter.
Input
AddMeterChannelInput
Part: payload
Element: AddMeterChannelRequest
Output
AddMeterChannelOutput
Part: payload
Element: AddMeterChannelResult
Whether or not the channel was added to the index.
Fault
See UtilityFault . Thrown when meter id is not found.
RemoveMeterChannel
This web service removes a Channel from a meter.
Input
RemoveMeterChannelInput
Part: payload
SElement: RemoveMeterChannelRequest
These three parameters are combined to locate a unique channel
Output
RemoveMeterChannelOutput
Part: payload
Element: RemoveMeterChannelResult
Whether or not the channel was removed from the meter.
Fault
See UtilityFault . Thrown when meter id is not found.
ReadScalarMeter
This web service generates a scalar reading for each channel of a given meter.
Input
ReadScalarMeterInput
Part: payload
Element: ReadScalarMeterRequest
Output
ReadScalarMeterOutput
Part: payload
Element: ReadScalarMeterResult
Zero or more scalar readings for the given meter.
Meter Attribute Administration Services
This section describes the meter administration services of the test harness composite, including:
GetDeviceStatus
This web service queries the device status of a meter. The OutageEventType is used by DeviceStatusCheck. The possible values of a deviceStatusType are:
Input
GetDeviceStatusInput
Part: payload
Element: GetDeviceStatusRequest
Output
GetDeviceStatusOutput
Part: payload
Element: GetDeviceStatusResult
The value of the device status for the requested meter.
Fault
See UtilityFault . Thrown when meter id is not found.
SetDeviceStatus
This web service updates the device status for a given meter. The possible values of a deviceStatusType are:
Input
SetDeviceStatusInput
Part: payload
Element: SetDeviceStatusRequest
Output
SetDeviceStatusOutput
Part: payload
Element: SetDeviceStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault
See UtilityFault . Thrown when meter id is not found.
GetConnectionStatus
This web service queries whether the given meter is connected or disconnected. This method is used by the Connect/Disconnect service. The values for connectionStatusType are:
Input
GetConnectionStatusInput
Part: payload
Element: GetConnectionStatusRequest
Output
GetConnectionStatusOutput
Part: payload
Element: GetConnectionStatusResult
SThe connection status of the requested meter.
Fault
See UtilityFault . Thrown when meter id is not found.
SetConnectionStatus
This web service updates the load action code for a given meter. This method is used by the Connect/Disconnect service. The values for connectionStatusType are:
Input
SetConnectionStatusInput
Part: payload
Element: SetConnectionStatusRequest
Output
SetConnectionStatusOutput
Part: payload
Element: SetConnectionStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault
See UtilityFault . Thrown when meter id is not found.
IsCommissioned
This web service queries the commissioning status for a given meter. This service is used by the Commission/Decommission process. The commissioning attribute can be true or false.
Input
IsCommissionedInput
Part: payload
Element: IsCommissionedRequest
Output
IsCommissionedOutput
Part: payload
Element: IsCommissionedResult
The value of the Commissioned status attribute for the requested meter.
Fault
See UtilityFault . Thrown when meter id is not found.
SetCommissioned
This web service updates the commissioning status for a given meter. This service is used by the Commission/Decommission process. The commissioning attribute can be true or false.
Input
SetCommissionedInput
Part: payload
Element: SetCommissionedRequest
Output
SetCommissionedOutput
Part: payload
Element: SetCommissionedResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault
See UtilityFault . Thrown when meter id is not found.
GetExecutionStatus
This web service queries the status of the property controlling the overall execution of the command. The possible values of execution status are:
Input
GetExecutionStatusInput
Part: payload
Element: GetExecutionStatusRequest
Output
GetExecutionStatusOutput
Part: payload
Element: GetExecutionStatusResult
The value of the ExecutionStatus attribute for the requested meter.
Fault
See UtilityFault . Thrown when meter id is not found.
SetExecutionStatus
This web service updates the property controlling the overall completion of the command. The possible values of execution status are:
Input
SetExecutionStatusInput
Part: payload
Element: SetExecutionStatusRequest
Output
SetExecutionStatusOutput
Part: payload
Element: SetExecutionStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
Fault
See UtilityFault . Thrown when meter id is not found.