A DiveTab dive page is defined by using a dive-page tag with optional tags between an open { and close } brace.
|
Tag |
Examples |
Status |
Notes |
|---|---|---|---|
|
dive-page |
dive-page { ... } |
Required |
Defines the block for this dive page instance. |
| available-columns |
available-columns { text column = "Cases Y-0" text column = "Cases Y-1" text column = "Cases Y-2" ... } |
Optional |
Indicates summary values presented to the DiveTab user as a display option in the They do not appear in the default display of the page. |
| available-dimension |
dive-page id = "dives" { title "Dive Page" cplan "/cplans/demo.cplan" available-dimension "Sales Region" ... } |
Optional |
Indicates dimensions presented to the DiveTab user as a display option in the They do not appear in the default display of the page. |
|
column |
text "Cost ($)" column = "Cost" text column = "Vehicles Sold"
|
Optional |
Defines columns in-line. Specify a heading and an individual summary column. |
| column-set |
column-set id = "cs-viewall" column-set id = "YearInfo" |
Optional |
Specifies a previously defined set of columns in a definitions block. |
|
cplan |
cplan "/cplans/sales.cplan" filter `value("Resp Salesperson") = "George"` } |
Required |
Indicates the data source. Can include filters and calculations. |
|
dimension |
dimension "Distribution Supplier" text "Account" column = "Customer" } |
Optional |
Specifies the dimensions to display on the page. These dimensions can be adjusted by the DiveTab user by using the context menu in the client. |
| dimcount-dimension |
dimcount-dimension "Product Family" dimcount-dimension "SIC Description" { text "SIC Desc" column = "SIC Description" } |
Optional |
Appears as a dive option in the value context menu by default. The DimCount dimensions can also be switched with dimensions in the client. |
| filter |
cplan "/cplans/basic.cplan" { filter `value("Resp Team") = "Smith"` } |
Optional |
Filters the displayed data for the indicated value. |
|
id |
dive-page id = "Supplier" |
Optional |
Gives the page an identifier. Required to reference attributes elsewhere in the script. Dive pages in the pages block require the id tag; dive pages in the sections block do not. |
| jump |
text column = "Order Count" { link { page id = "TWO" { jump "Order Number" } } } |
Optional | Defines a link that jumps from one page to another based on a common dimension that might or might not be part of the data displayed for the DiveTab user. Dives on the source page are used as filters on the target page. |
| link |
text "Customer" 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 in the dive page that displays in the client. |
|
parameter |
parameter “Product Brand” |
Optional |
Accepts the passed value. |
|
preload |
preload = true |
Optional |
Specifies 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-dimension |
quickview-dimension "Sales Region" quickview-dimension "Salesperson" { text "Sales Rep" column = "Salesperson" } |
Optional | Specifies dimensions to appear as QuickViews. NOTE: QuickViews can also be included using a quickview-set. |
| quickview-set |
quickview-set { cplan "/cplans/demo.cplan" dimension-quickview "Sales Region" dimension-quickview "Product Family" } |
Optional |
Specifies dimensions to appear as QuickViews. NOTE: QuickViews can also be included using a quickview-dimension. |
|
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 what the DiveTab user sees as the column heading in the client. |
|
title |
title = "Supplier Dive Page" |
Required |
Specifies text that appears in the title bar when the page displays. |
| value-format |
value-format "$###,###,###.00" value-format "#.00 |
Optional |
Formats the data presentation. |
See also: