This section describes the web services included in the test harness BPEL composite, including:
This section describes the general services of the test harness composite, including:
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.
Element: LoadMeterIndexRequest
Element: LoadMeterIndexResult
Fault with similar mapping to SGG/OUAF faults:
Typically, the faultCode, faultString, faultActor, and detail/text elements will be populated.
This web service returns the audit log for the entire session.
Element: ViewAuditTrailRequest
Element: ViewAuditTrailResult
An Entry consisting of a timestamp and an Operation. Each entry may have an associated meter object showing the latest update.
This section describes the locate meter web services of the test harness composite, including:
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.
Element: FindMetersRequest
Element: FindMetersResult
Zero or more meter objects can be returned from the search
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.
This web service queries whether a particular meter is defined in the data store.
Element: IsMeterDefinedRequest
Element: IsMeterDefinedResult
Whether or not the provided ID is part of the index.
See
UtilityFault
. Thrown when meter id is not found.
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.
Element: GetMeterRequest
Element: GetMeterResult
The meter object requested by the ID.
See
UtilityFault
. Thrown when meter id is not found.
This web service retrieves the set of meters with the specified group name
Element: GetGroupMetersRequest
Element: GetGroupMetersResult
The set of meters with the provided group name.
See
UtilityFault
. Thrown only in unusual circumstances.
Meter Administration Services
This section describes the meter administration services of the test harness composite, including:
This web service adds a set of meters to the in-memory data store. This will not permanently add it to the control file.
Element: AddMetersRequest
Element: AddMetersResult
Whether or not each meter was added to the index.
This web service removes a meter from the in-memory data store. This will not permanently remove it from the control file.
Element: RemoveMeterRequest
SElement: RemoveMeterResult
Whether or not the meter was removed from the index.
See
UtilityFault
. Thrown when meter id is not found.
This web service adds a new channel to a single meter.
Element: AddMeterChannelRequest
Element: AddMeterChannelResult
Whether or not the channel was added to the index.
See
UtilityFault
. Thrown when meter id is not found.
This web service removes a Channel from a meter.
SElement: RemoveMeterChannelRequest
These three parameters are combined to locate a unique channel
Element: RemoveMeterChannelResult
Whether or not the channel was removed from the meter.
See
UtilityFault
. Thrown when meter id is not found.
This web service generates a scalar reading for each channel of a given meter.
Element: ReadScalarMeterRequest
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:
This web service queries the device status of a meter. The OutageEventType is used by DeviceStatusCheck. The possible values of a deviceStatusType are:
•
|
Instantaneous - The meter responds immediately to the status check
|
•
|
SlowResponse - An EndpointFailure with a FailureReason of "ErrorResponse" will be returned from the Test Harness
|
•
|
NoResponse - An EndpointFailure with a FailureReason of "NoResponse" will be returned from the Test Harness
|
•
|
Unknown - An EndpointFailure with a FailureReason of "Unspecified" will be returned from the Test Harness
|
Element: GetDeviceStatusRequest
Element: GetDeviceStatusResult
The value of the device status for the requested meter.
See
UtilityFault
. Thrown when meter id is not found.
This web service updates the device status for a given meter. The possible values of a deviceStatusType are:
•
|
Instantaneous - The meter responds immediately to the status check.
|
•
|
SlowResponse - An EndpointFailure with a FailureReason of "ErrorResponse" will be returned from the Test Harness.
|
•
|
NoResponse - An EndpointFailure with a FailureReason of "NoResponse" will be returned from the Test Harness.
|
•
|
Unknown - An EndpointFailure with a FailureReason of "Unspecified" will be returned from the Test Harness.
|
Element: SetDeviceStatusRequest
Element: SetDeviceStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
See
UtilityFault
. Thrown when meter id is not found.
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:
Element: GetConnectionStatusRequest
GetConnectionStatusOutput
Element: GetConnectionStatusResult
SThe connection status of the requested meter.
See
UtilityFault
. Thrown when meter id is not found.
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:
Element: SetConnectionStatusRequest
SetConnectionStatusOutput
Element: SetConnectionStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
See
UtilityFault
. Thrown when meter id is not found.
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.
Element: IsCommissionedRequest
Element: IsCommissionedResult
The value of the Commissioned status attribute for the requested meter.
See
UtilityFault
. Thrown when meter id is not found.
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.
Element: SetCommissionedRequest
Element: SetCommissionedResult
The boolean response indicates the success or failure of the update (not the current field status).
See
UtilityFault
. Thrown when meter id is not found.
This web service queries the status of the property controlling the overall execution of the command. The possible values of execution status are:
•
|
Success - The command should complete successfully
|
•
|
ResponseTimeout - The asynchronous response will never arrive
|
•
|
SyncOperationFail - A simulated fault will occur in the during the initial request
|
•
|
AsyncOperationFailure - A simulated fault will occur in the asynchronous response
|
Element: GetExecutionStatusRequest
Element: GetExecutionStatusResult
The value of the ExecutionStatus attribute for the requested meter.
See
UtilityFault
. Thrown when meter id is not found.
This web service updates the property controlling the overall completion of the command. The possible values of execution status are:
•
|
Success - The command should complete successfully
|
•
|
ResponseTimeout - The asynchronous response will never arrive
|
•
|
SyncOperationFail - A simulated fault will occur in the during the initial request
|
•
|
AsyncOperationFailure - A simulated fault will occur in the asynchronous response
|
Element: SetExecutionStatusRequest
Element: SetExecutionStatusResult
The boolean response indicates the success or failure of the update (not the current field status).
See
UtilityFault
. Thrown when meter id is not found.