Report Page Tags

A DiveTab report page is defined using a report-page tag, with related tags between an open, {, and close, }, brace.

Tag

Examples

Status

Notes

report-page

report-page {

...

}

Required

Defines the block for this report page instance.

alert

alert "Alert" {

value column = "Cost"

low-threshold 0

high-threshold 10000

}

alert {

title "TriangleAlert"

value column = "Cases YTD"

high-threshold 10000

low-threshold 5000

alert-style "triangle"

}

Optional

Defines an alert based on the named column and thresholds.

bullet

bullet column = "Cost" {

title "Bullet Column"

bar-color "#6B1244"

}

bullet column = "Cost" {

title "GP$"

bar-color "#6B1244"

background-color "#117F77"

threshold column = "Net Sales"

value2 column = "Discount"

width 200

}

Optional

Defines a bullet column based on the named column, bar color, and thresholds.

Color is written in hexadecimal code format.

column

text "Cost" column = "Cost"

text column = "Vehicles Sold"

text column = "Revenue"

Optional

Names an element in the cPlan or a column-set.

column-set column-set id = "cs-viewall" Optional

Names a previously defined set of columns in a definitions block.

cplan

cplan "/cplans/sales.cplan"

Required

Indicates the data source. Can include filters and calculations.

dimension

dimension "Product Type"
dimension "Customer"

Optional

Names the dimensions to display on the page. There can be one to many dimensions.

NOTE: The fixed columns (columns that remain on the screen and do not scroll horizontally) are limited to half the iPad screen width.

filter

cplan "/cplans/basic.cplan" {

filter `value ("Resp Team") = "Smith"`

}

Optional

Filters the displayed data for the indicated value.

id

report-page id = "Product Brands"

 

Optional

Defines an identifier for the page. Required to link from other pages in a pages block. Report pages in the pages block require the id tag; report pages in the sections block do not.

Required to define and access sets of columns, but usage is optional.

large-text-display

text "Message" column = "note" {

large-text-display

...

}

Optional

Formats a note to hide the majority of the text.

link

text column = "Customer Count" {

link {

page id = "rp-customer"

}

}

Optional

Creates a shortcut to the named page from the column.

NOTE: Links can be created to a data page, web page, or to a document in a repository.

no-grid-lines no-grid-lines Optional Suppresses the appearance of grid lines when displayed in DiveTab.
no-subtotals no-subtotals Optional Suppresses subtotal rows when displayed in DiveTab.
no-totals no-totals Optional Suppresses the totals row when displayed in DiveTab.

parameter

parameter "Product Brand"

parameter "Resp Team"

Optional

Accepts the passed value. There can be zero to one parameters.

preload

preload = true

Optional

Indicates if data is to be cached when the application is synced.

When this tag is not present, the default is to not cache the data.

NOTE: Pages that include QuickViews cannot be preloaded.

quickview-set

quickview-set {

cplan "/cplans/demo.cplan"

dimension-quickview "Sales Region"

dimension-quickview "Product Family"

}

quickview-set {

cplan "/cplans/data.cplan"

dimension-quickview "Dimension A" {

default-values "Some Value"

}

dimension-quickview "Dimension B" all-values = false {

default-values "2016/10/19"

}

dimension-quickview "Dimension C" {

default-values "Multiple" "Values"

}

}

Optional

Names dimensions for QuickViews.

sort-column

sort-column "Year"

sort-column "Cases YTD" reverse = true

Optional

Specifies a column to sort on.
text text "Cost in Dollars" column = "Cost" Optional Specifies the label for the column heading in DiveTab.

title

title= "Product Brands"

Required

Appears in the title bar when the page is displayed.

value-format

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

value-format "#.00"

Optional Formats the data presentation.

See also: