Operation: reporting::measureGetInfo


General Description

Gets detailed information about the reporting measure.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.f.manageDashboards -- -- db.[default_db].h_data_measures.browse
db.[default_db].h_data_samples.browse

Request Message

Input Parameters

The measureGetInfo method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
measureId xs:unsignedInt required once The unique identifier for the measure that you want to get information for
returnMeasureValue xs:boolean optional
default=false
Set this to 'true' if you want to return the value of the measure
returnMeasureTrendData xs:boolean optional
default=false
Set this to 'true' if you want to return the scorecard/sparkline trend data for the measure

Input Data


Response Message

Output Parameters

Name Type Attributes Description
application appNameType optional
default=com.hornbill.core
Specify the name of the application this measure relates to. If not specified then the "com.hornbill.core" is assumed.
title xs:string required once The name of the measure you want to create. The name of the measure must be unique within the specified application
description xs:string optional A textual description explaining the purpose and meaning of the measure. This should be detailed enough that a business user will be able make in informed decision about the measure when selecting it for inclusion in a dashboard
status measureStatusType required once The current status of this measure.
statusError xs:string optional If the 'status' is set to 'error' then this returns a description of the problem encountered by the sampling engine
measureFrequency measureFrequencyType optional can be any one of the following - hourly, daily, weekly, monthly, quarterly_1, quarterly_2, quarterly_3, annually. For quarterly periods the there are three options indicating the quarterly boundaries. quarterly_1 means each quarter starts on Jan, April, July and October. quarterly_2 means each quarter starts on February, May, August and November. quarterly_3 means each quarter starts on March, June, September and December.
maxSamplesToKeep xs:unsignedInt optional Specify how many samples to keep for reporting. Each time a measure is taken it creates a sample, so for example, if your measure frequency was set as monthly and you wanted to keep 36 months (3 years) worth of sample data, set this value to 36.
queryValueType measureValueUnitType optional The type of measure to take which can be one of count, sum, average, floor, ceiling or percentage.
targetWarningValue xs:decimal optional The value at which to indicate a warning condition on the measure.
targetBreachValue xs:decimal optional The value at which to indicate a breach condition on the measure.
targetHighIsGood xs:boolean optional If this is set to 'true' then a value above or equal to the "targetWarningValue/targetBreachValue" value is good, if set to "false" then a value below or equal to the "targetWarningValue/targetBreachValue" value is good.
queryTableName simpleIdType optional The name of the table that contains the source data to be measured. You can only select tables that have a date/time column that can be used for date ranging.
queryTableKeyColumn simpleIdType optional The name of the column to use as the unique identifier for records in the query table. If not specified, the tables primary key is used.
queryDataRangingColumn simpleIdType optional The name of the column that is used to range sample of data used to obtain the measure. Under normal use the system will sample the data based on and appropriate date range specified in this column. This behaviour is altered slightly if the queryDataRangingColumn2 is specified with a different column - see explanation for the queryDataRangingColumn2 parameter for more details. This column must contain a usable date/time value in order for the measure to be successful. This column should also be indexed to ensure that system performance is not impaired.
queryDataRangingColumn2 simpleIdType optional If specified this allows you to define a date range where the upper and lower bounds are taken from different columns. A typical use case might be you want to get a count the number of mail messages received in a month that were replied to. If the table contained two columns called receivedDate and repliedToDate then you can specify the receivedDate in the queryDataRangingColumn column and the repliedToDate in the queryDataRangingColumn2 parameter. This column should also be indexed to ensure that system performance is not impaired.
queryFilter xs:string optional You can provide additional SQL filter criteria to further refine the sample data set beyond the date range. You can include any valid SQL statements suitable for inclusion a standard SQL 'WHERE' clause.
queryPercentFilter xs:string optional When defining a "percent" measure you need to specify a filter here to establish the subset of records that identify the percentage. The date range and the queryFilter are combined to determine the record set being sampled, and this record set provides the total count of records in the sample. This filter is further applied to that record set to get the sample value as a percentage.
queryValueColumn simpleIdType optional The name of the column that is used the read the value of the measure being taken. This must be specified for all measureQueryTypes except "count". The column specified must contain a usable numeric value in order for the measure to be meaningful. Specifying non-numeric column here will lead to unpredictable meaningless results.
querySaveDataColumns xs:string optional You can specify one or more columns in the query table that you want to save as drill-down data for each sample. Drill down data is saved for every record that is considered in a sample. You specify more than one column by using a comma separator
scorecardLimit xs:unsignedInt optional
default=12
You can specify the maximum number of samples to show on the scorecard
sparkLineLimit xs:unsignedInt optional
default=12
You can specify the maximum number of sample points to show on the trend sparkline
yearlyMonthStart xs:unsignedInt optional
default=0
You can specify the number of months past January that the yearly periods start.
yearlyDayStart xs:unsignedInt optional
default=0
You can specify the number of days past the 1st of the month that the yearly periods start.
actual xs:decimal optional The most recent measured value. The input param "returnMeasureValue" must be set to "true" in order for this value to be returned
difference xs:decimal optional The difference (or movement) of the most recent measured value from the previously measured value. The input param "returnMeasureValue" must be set to "true" in order for this value to be returned
trendValue measureTrendValueType optional
minOccurs=0
maxOccurs=unbounded
The series of previous values generally used to visualise a trend of this measure over time. The input param "returnMeasureTrendData" must be set to "true" in order for these values to be returned

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by Esp.demo.ServerService, 8.0.0.3162.)