About Window Dive References

Report palettes use window dive reference strings to specify the contents and type of window that display in the report palette. These strings can include a dive path and window attributes.

Syntax: diveref:<window_type>["<model_name>" {<filter>}.<dive_dimension>, <parent_name="value">, <_attribute_name="value">]

Where:

window_type: The window display type. Options are report and table.

model_name: The DiveLine path and filename for the cBase, model, or DivePlan to be used. If a DivePlan is used for the model_name, any named group in that DivePlan can be used as well.

filter: Optional. Data filter in the format {dimension="value"} For example: {Month="January"}.

dive_dimension: The dimension that represents the active dive.

parent_name: Optional. A list of dimension_name="value" pairs that define all dives that were performed in this session prior to the active one. Dimension pairs are separated by semicolons.

NOTE: Parent dimension_name="value" pairs can also exclude values. The syntax for an exclusion pair is <dimension_name>!="<value_to_exclude>" For example, Month!="01" creates a parent dive in the Month dimension that groups all Months except 01. These can be stacked.

attribute_name: Optional. A list of attribute_name="value" pairs used to identify attributes for the window. Attributes are:

  • _tab_type: Type of tabular display. Options are Tabular, CrossTab, MultiTab, and MultiCrossTab.
  • _across_dimension: The name of the horizontal dimension in a CrossPlot or CrossTab display.
  • _cross_column: The name of the column in a CrossPlot or CrossTab display.
  • _mult_keys: An array of dimension names in a MultiTab display. Syntax: {dimension1, dimension2, dimension3}
  • _mct_dimension: The name of the horizontal dimension in a MultiCrossTab display.
  • _mct_summaries: An array of summary names in a MultiCrossTab display. Syntax: {summary1, summary2, summary3}

  • _report_template: The name of the report template that you want to use.

  • _report_default: The name of the report style that you want to use.

You can use the following variables in a window dive reference string:

  • $<MacroName>
  • $<QVName>
  • $TEXT (represents the value of the item defined within the item cell or data tab)
diveref:table["\Home\cBase\sales.cbase"{Month="January"}.Salesperson, Sales Region="North"]
diveref:report["\Home\cBase\demo_drl.dvp".Salesperson, Month="2019/01"]
diveref:table["\Home\cBase\demo_drl.dvp".Salesperson, Month="Q1", Month!="02"]