Central Page Tags

The tags to develop a DiveTab central page depend on many factors including what you are trying to accomplish and where the information is displayed on the screen. A central page is defined using a central-page tag with additional tags between an open { and close } brace. A central page is accessed from other pages, so it must be contained within a pages block within the data-area block. Once a central page is defined, dimensions in common automatically link to it.

Tag

Examples

Status

Notes

central-page

central-page {

...

}

Required

Defines the block for this central page instance.

cplan

cplan "/cplans/sales.cplan"

cplan "/cplans/sales.cplan" {

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

}

Required

Indicates the data sources. Can include a filter with an expression and parameters.

dimension

dimension "Supplier"

dimension "Company" enable-subset = TRUE

Required

Specifies the dimension. Subset functionality is declared per dimension.

elements

elements {

<element>

<element>

}

Optional

Lists individual elements.

<element>

Multiple tags to define vertical and horizontal spacing, layout, bar, line and pie charts, grids, rows, links, images, and tables.

Optional

Determines the format and layout for central and overview pages.

enable-subset enable-subset = true Optional

Toggles subset functionality on or off for the page.

id

report-page id = "Supplier Report"

Optional

Gives the page an identifier and aids in documenting the script. Required to reference an attribute elsewhere in the script.

Central pages do not use an id, but they can contain links to other data pages, which require an id.

layout

layout orientation = "portrait" {

<element>

<element>

}

Optional

Sets up the portrait or landscape layout of the screen and starts the presentation details for the page.

The default is landscape.

no-preload

no-preload = true

Optional

Turns off the default syncing for the central page so the data is not cached.

parameter

parameter "Product Brand"

Optional

Accepts the passed value.

percent

percent = 50

percent = 85

Optional

Identifies the percentage of the display layout allocated for the element.

NOTE: The total percentage of the display layout elements within a vsplit or an hsplit must equal 100.

quickview-set

quickview-set {

cplan "/cplans/demo_drl.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.

Can include default values.

screen

screen {

...

}

Optional

Starts the configuration for a screen. Multiple screen blocks can be defined in each tab block.

tab

tab "Filtered" filtered = true {

...

}

tab "Monthly Sales" {

...

}

Optional

Specifies a name for the tab and opens the code block to define the data for a screen. The name is displayed for the user when multiple tabs are specified for one page. Each tab block can also contain one or more screen blocks.

The filtered Boolean enables use of parameters.

NOTE: Filtered page tabs are displayed before non-filtered tabs. In a situation where a missing filter hides all tabs, the central page displays the filtered tabs (unfiltered).

See also: