Column Set Tags

Column set tags are used to define reusable sets of columns in a definitions block. Column-set blocks can include expand-set blocks. Expansion columns are an option for tabular page types. Note that there are different types of "columns": text, bullet, alert, and image. A column set block is defined using a column-set tag with additional tags between an open { and close } brace.

Tag

Examples

 Status

Notes
column-set

column-set id = "monthly_columns" {

...

}

Required Defines the column-set block. When specified, the id names the block so that it can be referenced elsewhere in the script.
alert

alert {

alert-style "triangle"

value column = "$(summary) YTD Y-0 % Diff"

low-threshold -10

high-threshold 10

middle-color "transparent"

width 30

}

Optional

Defines an alert style column. Note the additional sub-attributes:

  • alert-style
  • high-color
  • high-threshold
  • low-color
  • low-threshold
  • middle-color
  • value
bullet

row {

bullet column = "Units" {

bar-color "#888888"

}

}

Optional

Defines a bullet style column. Note the additional sub-attributes:

  • bar-color
  • bar-end-style
  • bar-style
  • scale-format
  • scale-increment
  • scale-maximum
  • scale-minimum
  • show-scale
  • threshold
  • value
  • value2

column

text "Sold" column = "Vehicles Sold"

Required

Specifies the data column from the cPlan. Note the sub-attributes for an in-line column:

  • background-color
  • column-expand
  • justification
  • link (ref, parm, dimension, condition)
  • style
  • title
  • width
expand

expand-set id = "ex-cases-r12" {

pass-parameter "summary" "Cases"

}

Optional Names a set of expansion columns defined in a definitions block. Expansion sets can only be used in tabular pages.
id

column-set id = "Quarters and Months"

Optional

Gives the block an identifier that can be referenced in other blocks.

image

layout {

image {

path "/divetab/images/icon.png"

}

}

Optional

Defines an image style column. Note the additional sub-attributes:

  • high-image
  • high-threshold
  • image
  • image-size
  • low-image
  • low-threshold
  • middle-image
  • value
link

report-page id = "rp-respteam" {

title "Units by Salesperson"

cplan "/cplans/basic_101.cplan"

dimension "Resp Team"

text column = "Cases" {

link {

page id = "productgrp"

}

}

}

Optional

Specifies the column link. Note the sub-attributes:

  • condition (column)
  • dimension
  • parameters (name, value)
  • reference

The reference types are:

  • diveport (url, page)
  • document (path, repository)
  • map ( (adrs column)
  • page (id, jump column)
  • web-page (url)

pass-parameter

pass-parameter "summary" "Profit"

Optional

Sends the indicated value for the named parameter.

NOTE : You can only pass hard-coded strings—expressions are not supported.

take-parameter

take-parameter "summary"

Optional

Accepts the passed value for the named parameter.
text

text column = "Cases"

text "Q1" column = "$(summary) Q1"

text "Last YTD" column = "$(summary) YTD Y-1" {

value-format "#,###.00"

}

text "Cases LYTD" column = "Cases YTD Y-1" {

value-format "#,###.00"

width 100

}

Optional

Defines a text style column. Note the additional sub-attributes:

  • high color
  • high-threshold
  • low-color
  • low-threshold
  • text-color
  • threshold-value
  • value
  • value-format
  • width

See also: