Diver Portlet Options

Available options depend on your license.

Standard License

Example of an edit diver portlet dialog box.

Option	Description
Marker	Specifies the marker or Spectre Dive file that provides the data for the portlet.
(Marker) Change	Opens the Select Marker dialog box, which you can use to choose a different marker or Spectre Dive file. When you create a Diver portlet, the Select Marker dialog box opens automatically.
Dimensions	Specifies the dimensions that are available for diving in the portlet. The initial list of dimensions shown defaults to those dimension columns displayed in the marker’s final dive window.
(Dimensions) Change	Opens the Select Dimension dialog box, which you can use to make more dimensions available for diving in the portlet.
Show Totals	Adds a row labeled Totals that shows the total for every summary column in the portlet.
Show Odd Row Coloring	Specifies that the row background color changes for each row. Odd rows use the `portletMeasuresOddRowColor` and even rows default to the page background color (`windowBackgroundColor`) specified in the underlying skin.
Enable Quick Search	Adds a search box to the top of the portlet. Use this to find key data in a portlet with hundreds or thousands of rows of data.
Dimension Column Width	Sets the width of the dimension columns, in pixels. The default is auto, which matches the width to the dimension text.
Column, Type, Click Actions	Lists the data columns displayed in the diver portlet, their type, and any click actions associated with each column.
Add Text	Lists the data columns available for display in the diver portlet. You can select columns from this list to add to the portlet display.
Add Indicator	Selects and configures an indicator that can be used to indicate data changes over time or compare the data to benchmarks. You can add row-scoped click actions to an indicator from the Add Indicator Column dialog box.
Edit	Opens the Edit Text Column dialog for the selected column, which allows you to edit properties and add row-scoped click actions. This option is only available when a row in the Column, Type, Click Actions section is selected.
Remove	Deletes the selected column. This option is available only when a row in the Column, Type, Click Actions table is selected.
Click Actions	Opens the Add Click Action dialog box, which you can use to add link-scoped click actions to the portlet.

Measure Factory License

NOTE: The diver portlet displays dimension data in a tabular format. There are two preexisting column groups:

Initial Dimensions—Display as columns in the tabular display.

Available Dimensions—Do not appear on the initial tabular display, but they are available in a context menu for diving.

Option

Description

Project/ Filename

Specifies the project that provides the data for the portlet.

Dimensions

Specifies the initial dimensions that are used as a data source.

Available on the Select dimensions page. Opens a context menu that you can use to sort the list of available dimensions. Options are Sort by category, Sort by type, and Sort by name.

Returns to the Select a data source page, which you can use to select a different project.

Icon that looks like four squares arranged two by two.

Opens the Dimension settings page, which you can use to add or delete dimensions, edit column settings for existing dimension columns, or change the order of the lists.

Dimension settings—Accessible from the main page by clicking the Change icon located to the right of the Dimensions box.

Add a column

Opens the Select dimensions page, which you can use to add dimensions to the Available Dimensions column group. NOTE: You can use a drag-and-drop operation to move dimensions from Available Dimensions to the Initial Dimensions column group.

Add a column group

Adds a column group called Stacked.

Dimension settings for a specific dimension—Accessible by placing the pointer on a dimension listed on the Dimension settings page, and clicking the adjacent Edit this column icon.

Available options depend on the type of dimension.

Dimension

The selected dimension. This option cannot be changed in this dialog box.

Value

Specifies a measure or summary value to use as a column.

Auxiliary Measure Value

Specifies a baseline or goal value that is defined in the measure factory.

Opens the time series mode settings box. Options are Basic and Advanced.

Basic time series settings

Basic features are as follows:

Date Range

Specifies the time range. Options are:

Year to Date (The first day of the year returns 0)
Year to Complete Month (The first month of the year returns data for all of last year)
Month to Date (The first day of the month returns 0)
Week to Date (The first day of the week returns 0)
Complete Year
Complete Month
Complete Week
Complete Day
Rolling Year by Month (the last 12 complete months)
Year
Future Months

Time period

Specifies the time period. Options are:

All
Current
Previous
Current Versus Previous
Current Versus Previous (%)
Previous Year
Current Versus Previous Year
Current Versus Previous Year (%)

Advanced time series settings

Advanced features allow further customization of the time period:

To Date

Uses the specified time range and offset values to define the time series. The default is the current Year to complete Day. Other options are Year to complete Month, Year to complete Quarter, Week to complete Day, Month to complete Day, and Quarter to complete Day.

The offset value can adjust the time series by the specified time period. For example, setting the Time Range to Year to complete Day, with an offset of -1 Year, is the equivalent of last year to complete day. Available options for the offset time period are those time periods that are larger than or equal to the first time range.

Relative

Available in advanced mode. Uses the specified complete time range and offset values to define the time series. The default is 1 Year, which is the current complete year. Other time period options are Day, Week, Month, and Quarter.

The offset value can adjust the time series by the specified time period. For example, setting the Time Range to 1 Year, with an offset of -1 Year, is the equivalent of the year before the current complete year. Available options for the offset time period are those time periods that are larger than or equal to the specified time range.

Absolute

Available in advanced mode. Uses the specified time range and offset values to define the time series. The default is Month 1 of the current year. The other time period option is Quarter. This option supports custom calendars.

The offset value can adjust the time series by the specified number of years.

Label Format

Specifies the format for the numeric data that appears in the label. The default, Automatic, uses the format specified in the marker.

Title

Specifies the column label. The default, Automatic, uses the dimension name.

Size

Specifies the column width. The default, Automatic, uses the length of the dimension name as a guideline. This option retains the set width if the dimension changes.

Font

Specifies the font used in the column label.

NOTE: To add an indicator column, on the Edit Diver Portlet main page, click Add a column, and then follow the instructions on the indicator creation wizard.

Miscellaneous settings

Option	Description
Fixed Columns	Specifies the number of columns, starting from the left, that are fixed in place if a horizontal scroll bar is needed. If any columns are stacked, this setting indicates the number of stacks, not actual columns. The default is 0.
Default Item Height	Defines the minimum row height, in pixels. The default Auto, is defined as 20. If the tallest item is shorter than or equal to the Default Item Height, the defined value is used. If the tallest item is taller than the Default Item Height, the row height adjusts to display the entire item.
Show Totals	Adds a row labeled Totals that shows the total for every summary column in the portlet.
Show Titles	Specifies that the column headings shown in the Column, Type, Stack table on this dialog box appear as column headings on the measures portlet display. This option is selected by default.
Show Odd Row Coloring	Specifies that the row background color shifts for each row. Odd rows use the `portletMeasuresOddRowColor` and even rows default to the page background color (`windowBackgroundColor`) specified in the underlying skin.
Enable Quick Search	Adds a search window to the portlet. Use this to find key data in a portlet with hundreds or thousands of rows of data.
Blank Window Text	Enables you to enter a statement in the text box that displays when the window underlying the portlet is blank. The statement displays instead of standard error messages. Selecting the check box and leaving the text box blank makes the portlet invisible when the window is blank. You can use HTML and custom macros in this statement.

Display settings

Option	Description
# Items	Specifies the number of items that display on the portlet. For example, setting this option to 5 produces a diver portlet with five rows showing the top five items based on the sort value. All items display by default.
Filter	Specifies a Spectre calculation that is used to filter the data that displays. The default is None. NOTE: The filter expression is a Spectre calc expression and is applied at the detail (record) level before the window is created.
Show Others	If # Items is selected, this option displays the sum of the remaining items. For example setting # Items to 5, and then selecting this option produces a portlet with the top five items plus a sixth row showing the sum of the remaining items.
Hide Null Values	If # Items is selected, this option does not display items with values that are all null. NOTE: This does not hide null dimension values if there are any non-null numeric values.
Sort By	Specifies the initial column on which to sort. The default is No sort.
Sort Up Sort Down	Specifies the sort order.