Ad Hoc Page Tags

A DiveTab ad hoc page is defined by using an ad-hoc-page tag with optional tags between an open { and close } brace.

Tag

Examples

Status

Notes

ad-hoc-page

ad-hoc-page {

...

}

Required

Defines the block for this ad hoc page instance.

available-columns

ad-hoc-page {

...

available-columns {

text column = "Cost"

}

}

Optional Indicates dimensions presented to the DiveTab user from the Edit option. The available-columns tag can include text, alert, and bullet columns.
available-dimension

ad-hoc-page id = "ad-hoc-dives" {

title "Ad Hoc Page"

cplan "/cplans/demo_drl.cplan"

available-dimension "Sales Region" {

text "Region" column = "Sales Region"

}

available-dimension "Product Family"

...

}

Optional

Indicates dimensions presented to the user from the Edit option. Does not appear in the default display of the page.

column

text "Cost" column = "Cost"

text column = "Vehicles Sold"


Optional

Defines columns in-line. For example, specify a heading and an individual summary column.

column-set

column-set id = "cs-viewall"

column-set id = "YearInfo"

Optional

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

cplan

cplan "/cplans/sales.cplan"
cplan "/cplans/sales.cplan" {

filter `value("Resp Salesperson") = "George"`

}

Required

Indicates the data source. Can include filters and calculations.

dimension

dimension "Distribution Supplier"

dimension "Customer" {

text "Account" column = "Customer"

}

Optional

Names the dimensions to display on the page. These can be adjusted by the user by using the Edit function in the client.

dimcount-dimension

dimcount-dimension "Product Family"

dimcount-dimension "SIC Description" {

text "SIC Desc" column = "SIC Description"

}

Optional Creates dive dimensions for the DiveTab user. Appears as DimCounts by default. They are also seeded in the dive dimension list of the Edit dialog box. These can be adjusted by the user by using the Edit function in the client.

expand-dimcounts

expand-dimcounts Optional Displays the page with the dive dimensions expanded. The default is to display with dive dimension columns collapsed.
filter

cplan "/cplans/basic.cplan" {

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

}

Optional

Filters the displayed data for the indicated value.

id

ad-hoc-page id = "Supplier Ad Hoc Page"

Optional

Defines an identifier for the page. Required to reference attributes elsewhere in the script.

Ad hoc pages in the pages block require the id tag; ad hoc 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, a web page, or a document in a repository.

no-grid-lines no-grid-lines Optional Suppresses the appearance of grid lines in the ad hoc page displayed in the client.

parameter

parameter “Product Brand”

Optional

Accepts the passed value.

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-dimension

quickview-dimension "Sales Region"

quickview-dimension "Salesperson" {

text "Sales Rep" column = "Salesperson"

}

Optional Specifies dimensions to appear as QuickViews in the initial page. They can be adjusted by the user by using the Edit function in the client.

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 = "Supplier Access Page"

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: