Measures Component Tags

Defines the block for a measures component. The block and possible attributes:

measures {

dimensions {

<first dimension>

<second dimension>

...

}

<first column>

<second column>

...

<click actions list (optional)>

}

Indicates the dimension name. Could also be specified as:

dimension "$(DIMENSION_1)"

to indicate the first user-chosen dimension or

dimension "$(DIMENSION_2)"

to indicate the second dimension, and so on.

TIP: The order of the dimensions is the order in which to dive to create the initial window.

Defines an expression for a filter and the context—use summary for a window-level filter or record for a dive-level filter.

Two functions are available:

mf_value refers to a Measure Factory measure, with options to include date roll up or a time series.

Details

Columns not already included in the portlet can be referred to in an mf_value function. They will be automatically added to the dive and can be filtered on.

This takes one to six arguments.

The first argument is the measure name. If only one argument is provided and that measure is only referred to once in the corresponding portlet, DivePort uses that measure plus whatever roll up or variation is present in the portlet.

If two arguments are provided, the second argument is used as the date-rollup-variation (such as c or p).

If three arguments are provided, the second and third arguments are respectively used as the range and variation for a basic time-series.

If four or more arguments are provided, they are used an advanced time series.

The format is:

mf_value(meas_name : string, time_series_type : string, period : string, adv_arg : integer or string, offset_period : string, offset_number: integer)

value_by_id can be used if value tags have an optional id attribute that is assigned a string. The filter function can use value_by_id("id_string") to refer to columns within the same stamp component. The context of the filter must be set to "summary" because measure factory columns only exist in the summary window.

If you are not worried about changing your column order, it is better and less error-prone to specify the number of the column that you want to sort by. For example, "sort-by-column 2" sorts by the 2nd column in the measures component. This only works for non-dimension columns.

The example given here sorts the table by $(MEASURE_1) because it is the 2nd column.

To either the sort-by or sort-by-column tags, you can add direction="up" to switch the sort direction to up. If you use direction="down" or omit the direction attribute, the sort direction is down.

Examples:

sort-by "$(MEASURE_1)" direction="up" {

aux-measure "Target"

}

sort-by-column 2 direction="down"

Other measure columns can be added. The type options are:

• text
• indicator

The general structure for a measure column definition is:

column <name> type="<type>" {

aux-measure "<name>"

label "<label for this column>"

width <integer pixels>

display-type "<indicator type>"

}

Details can be found in the following table entries.

Names the indicator type. Options are:

• horizontal-bullet
• plusminus
• vertical-plusminus
• vertical-slider
• racetrack
• alert
• rectangle
• slope
• slider
• slider-light
• text

• left
• right
• center

Defines the measure value as a basic time series column.

range can be:

• ytdtd (year to date)
• ytd (year to complete month)
• qtd (quarter to date)
• mtd (month to date)
• wtd (week to date)
• cy (complete year)
• cq (complete quarter)
• cm (complete month)
• cw (complete week)
• cd (complete day)
• rm12 (rolling 12 months, also known as rolling year by month)
• y (partial year)
• fm (future months)
• qv (a time range determined by the Time Range QuickView)

variation can be:

• c (current)
• p (previous)
• py (previous year)
• cvp (current versus previous)
• cvpy (current versus previous year)
• cvp-pct (current versus previous percent)
• cvpy-pct (current versus previous year percent)

Defines the measure value as a relative-time series column.

The relative-time-series block has four required child tags:

• period "<y, q, m, w, or d>"—the length of time to cover

  • y (year)
  • q (quarter)
  • m (month)
  • w (week)
  • d (day)
• number-of-periods <#>—a positive number of periods

• offset-period "<y, q, m, w, or d>"—the period by which to offset the time range. Must be longer than or equal to the period. For 0 offset, choose "y".

  • "y" (year)—for example 'offset by -2 years'
  • "q" (quarter)—available when period is quarter, month, week, or day
  • "m" (month)—available when period is month, week, or day
  • "w" (week)—available when period is week or day
  • "d" (day)—available only when period is day
• offset-number <#>—number of periods (see offset-period) by which to offset the time range. For no offset, use 0. Negative and positive numbers are permitted, but they might not be appropriate depending on the other settings.

For example, period "y" and number-of-periods 5 and offset-number -1 and offset-period "y" gives 5 complete years ending with the year before the last complete year.

A value attribute that defines the measure value as a comparison-time series column.

A comparison-time-series takes two other (non-comparison) time series as its arguments and calculates the difference between them.

NOTE: Typically, the from and to time series are the same type, but that is not a requirement.