Global Type: measureListItemType


General Description

This type is used when returning a list of defined measures.

Name Type Attributes Description
measureId xs:unsignedInt required once The unique identifier of the measure.
application appNameType optional The application this measure is associated with. This is only provided if there is no application filter applied
title xs:string required once Specify the name of the measure.
status measureStatusType required once The current statis of this measure. If the status is 'error' then a descriptive error is provided in the statusError property.
statusError xs:string required once If the status is set ot 'error' then this provides a description of the error that was encountered.
actual xs:decimal optional The latest value for this measure. If the value is NULL then this element will not be present
difference xs:decimal required once The change in value of "actual" from the previous value, this shows the last movement of the value.
unitType measureValueUnitType required once The type of meaning the value of the measure has.
measureFrequency measureFrequencyType required once Frequency at which the measure is taken.
highIsGood xs:boolean required once If this is set to 'true' then a value above or equal to the "threshold" value is good, if set to "false" then a value below or equal to the "threshold" value is good.
targetWarning xs:decimal optional A measure can set a target warning level in order to visualize good/warning status of the measure.
targetBreach xs:decimal optional A measure can set a breach threshold in order to visualize good/bad status of the measure.
lastSampleTime xs:dateTime required once This is the date/time of the last sample taken.
trendValue measureTrendValueType optional
minOccurs=0
maxOccurs=unbounded
The latest values for this measure, ordered in cronological order with the newest value appearing first
scorecardLimit xs:unsignedInt required once The maximum number of values to show when displaying a scorecard.
sparklineLimit xs:unsignedInt required once The maximum number of points to use when sparkline.
createdOn xs:dateTime required once The date/time the measure was first created.
createdBy xs:string required once Who created the measure.
updatedOn xs:dateTime required once The date/time the measure was last changed.
updatedBy xs:string required once Who last updated the measure.

<xs:complexType name="measureListItemType">
<xs:annotation>
<xs:documentation>
<![CDATA[This type is used when returning a list of defined measures.]]>
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="measureId" type="xs:unsignedInt">
<xs:annotation>
<xs:documentation>
<![CDATA[The unique identifier of the measure.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="application" type="appNameType" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The application this measure is associated with. This is only provided if there is no application filter applied]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="xs:string">
<xs:annotation>
<xs:documentation>
<![CDATA[Specify the name of the measure.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="measureStatusType">
<xs:annotation>
<xs:documentation>
<![CDATA[The current statis of this measure. If the status is 'error' then a descriptive error is provided in the statusError property.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusError" type="xs:string">
<xs:annotation>
<xs:documentation>
<![CDATA[If the status is set ot 'error' then this provides a description of the error that was encountered.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="actual" type="xs:decimal" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[
The latest value for this measure. If the value is NULL then this element will not be present
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="difference" type="xs:decimal">
<xs:annotation>
<xs:documentation>
<![CDATA[
The change in value of "actual" from the previous value, this shows the last movement of the value.
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="unitType" type="measureValueUnitType">
<xs:annotation>
<xs:documentation>
<![CDATA[
The type of meaning the value of the measure has.
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="measureFrequency" type="measureFrequencyType">
<xs:annotation>
<xs:documentation>
<![CDATA[
Frequency at which the measure is taken.
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="highIsGood" type="xs:boolean">
<xs:annotation>
<xs:documentation>
<![CDATA[If this is set to 'true' then a value above or equal to the "threshold" value is good, if set to "false" then a value below or equal to the "threshold" value is good. ]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="targetWarning" type="xs:decimal" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[
A measure can set a target warning level in order to visualize good/warning status of the measure.
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="targetBreach" type="xs:decimal" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[
A measure can set a breach threshold in order to visualize good/bad status of the measure.
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastSampleTime" type="xs:dateTime">
<xs:annotation>
<xs:documentation>
<![CDATA[This is the date/time of the last sample taken. ]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="trendValue" type="measureTrendValueType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
<![CDATA[
The latest values for this measure, ordered in cronological order with the newest value appearing first
]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="scorecardLimit" type="xs:unsignedInt">
<xs:annotation>
<xs:documentation>
<![CDATA[The maximum number of values to show when displaying a scorecard.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sparklineLimit" type="xs:unsignedInt">
<xs:annotation>
<xs:documentation>
<![CDATA[The maximum number of points to use when sparkline.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="createdOn" type="xs:dateTime">
<xs:annotation>
<xs:documentation>
<![CDATA[The date/time the measure was first created.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="createdBy" type="xs:string">
<xs:annotation>
<xs:documentation>
<![CDATA[Who created the measure.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="updatedOn" type="xs:dateTime">
<xs:annotation>
<xs:documentation>
<![CDATA[The date/time the measure was last changed.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="updatedBy" type="xs:string">
<xs:annotation>
<xs:documentation>
<![CDATA[Who last updated the measure.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
Powered by Hornbill, for more information click here. (page served by Esp.hornbill.ServerService, 8.0.0.3141.)