Creating an Active Technologies Dashboard

In this section:

This topic describes the WebFOCUS syntax used to:


Top of page

x
Positioning and Sizing Components on an Active Technologies Dashboard

An active dashboard for Adobe Flash Player or for PDF uses pixels as the unit of measurement by default, while tools such as Document Composer and InfoAssist use points as the unit of measurement.

Both Document Composer and InfoAssist provide a WebFOCUS setting so that the design-time and run-time positioning and sizing of components correspond to each other. The setting is ACTIVE_UNITS=PTS, which changes the unit of measurement to points. As a result, some components on an existing active dashboard for Adobe Flash Player or for PDF may appear to overlap at design time in Document Composer, while they appear correctly positioned and sized at run time.

In the Document Composer Text Editor, you can view the WebFOCUS source code for the setting. The syntax is

ACTIVE_UNITS={PTS|PX}

where:

PTS

Sets the active unit of measurement to points. In Document Composer and InfoAssist, points are used for the positioning and sizing of components on an active dashboard for Adobe Flash Player or for PDF. With this setting, the components on an active dashboard have the same position and size at run time as they have at design time (WYSIWYG).

PX

Sets the active unit of measurement to pixels. By default, pixels are used for the positioning and sizing of components on an active dashboard for Adobe Flash Player or for PDF. With this setting, the components on an active dashboard have a different position and size at run time as they have at design time. This is the default value if no other value is set. It is provided for backward compatibility.

The following is an example of the WebFOCUS code for an active dashboard for Adobe Flash Player, with the ACTIVE_UNITS setting shown in bold.

SECTION=section1, LAYOUT=ON, METADATA='0.5^0.5^0.5^0.5^4',
MERGE=OFF, ORIENTATION=PORTRAIT, PAGESIZE=Letter, ACTIVE_UNITS=PTS, $

Top of page

x
Sizing a Grid Component With Respect to Its Container

You can use the following WebFOCUS StyleSheet setting to contain a grid component inside its container on an active dashboard. You must include this setting in the grid component (that is, in the TABLE FILE procedure for the report) inside an active dashboard that you create using COMPOUND syntax.

The WebFOCUS StyleSheet syntax is

ARREPORTSIZE={FLOWING|DIMENSION}

where:

FLOWING

Specifies that the size of the grid component (the active report) will dynamically change as needed and will override the size settings for the grid component. This is the default value.

Note: If values for DIMENSION are set in the TABLE FILE procedure for the report, the output formats FLEX and APDF will respect the size set by these values.

DIMENSION

Specifies that the dimensions (height and width) set for the grid component in the active dashboard will be respected. The size of the grid component will not change dynamically, but the grid will be contained inside the container when used in a COMPOUND active dashboard procedure. If the report does not fit inside the container, scroll bars will be added automatically around the report.


Top of page

x
Controlling the Unit Calculation

How to:

WebFOCUS performs an internal calculation on the values expressed in the unit of measurement that you specify for components on an active dashboard. This calculation affects certain design features, such as component position and size.

A common way to specify the unit of measurement is to use the UNITS attribute in a WebFOCUS StyleSheet. For more information on the UNITS attribute, see the applicable topics in the Creating Reports With WebFOCUS Language manual.

Using the SET ARUNITCALC command, you can control the calculation that is performed so that you achieve the desired result.



x
Syntax: How to Control the Unit Calculation

The syntax is

SET ARUNITCALC = {OLD|NEW}

where:

OLD
Applies the current unit calculation so that current behavior is preserved. This value supports existing active dashboards whose components are precisely positioned and sized using the WebFOCUS StyleSheet UNITS attribute. OLD is the default value.
NEW
Applies an updated unit calculation that complies with the web standard for screen display. We recommend that you use this value when you develop a new active dashboard.

Top of page

x
Hiding a Report Object on an Active Technologies Dashboard

How to:

You may have the need to hide an active report object on an active dashboard, for example, when you want to display non-data related objects in the first tab of the dashboard and place report and chart objects in the subsequent tabs. You can hide the first report object using HIDDEN=ON syntax in your WebFOCUS code.

The data from the hidden report is still available for use in the global filter or other filter control.



x
Syntax: How to Hide a Report Object on an Active Technologies Dashboard
HIDDEN={ON|OFF}

where:

ON

Hides the active report object on the active dashboard.

OFF

Displays the active report object on the active dashboard. This is the default value.



Example: Hiding a Report Object on an Active Technologies Dashboard

The following sample COMPONENT declaration in the COMPOUND LAYOUT code hides the entire active report object, component R0, on the active dashboard. You can still use the data from the hidden report in the global filter or other filter control.

COMPONENT=R0, TYPE=REPORT, POSITION=(0 0), HIDDEN=ON,$

Top of page

x
Configuring Active Technologies Form Controls With WebFOCUS Syntax

In this section:

In Document Composer and InfoAssist, you can add one or more active form controls to an active dashboard in order to create complex filter relationships among report and chart components. An active form control is available for an active dashboard in HTML and for an active dashboard for Adobe Flash Player and for PDF.

The following are the types of active form controls that you can use to apply filters to an active dashboard:

This topic describes the WebFOCUS code that supports the implementation of the preceding active form controls.



x
WebFOCUS Code

The syntax for OBJECT within a PAGELAYOUT grouping in a COMPOUND LAYOUT request is

OBJECT={LIST|COMBOBOX|TEXTINPUT|CHECKBOX|RADIOBUTTON}, NAME=’object_name',
ARDATA_REPORT='{name_of_source_report|cache_component_name}',
ARDATA_COLUMN='{column_name|@@COLUMNS|@@BYS|@@MEASURES}',
ARFILTER_TARGET=’target_report_name1,target_report_name2,...',
ARFILTER_CONDITION='{EQ|NE|LT|LE|GT|GE}', ARFILTER_SHOWALL={ON|OFF},
ARFILTER_PARENT=’name_of_parent_object', ARDATA_FILTERONLY={ON|OFF},
ARFILTER_MULTIPLE={ON|OFF}, ARFILTER_ACTIVE={ONLOAD|'"alpha_value"'|'numeric_value'},
ARFILTER_ONCHANGE={ON|OFF}, ARFILTER_SORT='{ASCENDING|DESCENDING}',
POSITION=(left top), DIMENSION=(width height), SIZE=font_size,
COLOR=font_color, BACKCOLOR=background_color, $

where:

OBJECT={LIST|COMBOBOX|TEXTINPUT|CHECKBOX|RADIOBUTTON}

Is the type of active form control. The available values are:

  • LIST adds a list box.
  • COMBOBOX adds a drop-down list.
  • TEXTINPUT adds a text input field. This field is case-sensitive. The value that is typed in the field at run time must match the exact case of the value that is stored in the database.
  • CHECKBOX adds a check box.
  • RADIOBUTTON adds a radio button.
NAME='object_name'

Is the name of the active form control.

ARDATA_REPORT='{name_of _source_report|cache_component_name}'

Is one of the following:

  • The name of the source report that contains the data that populates the active form control with selection values from which you choose at run time. This property is required for the LIST, COMBOBOX, CHECKBOX, and RADIOBUTTON controls. This property is optional for the TEXTINPUT control.
  • The name of the cache file specified on the COMPONENT declaration of a compound layout report. The ARDATA_REPORT property with the name of the cache file is required by every other component on the active dashboard to enable single cache file processing when the active cache option is used. For more information on this feature, see Using a Single Cache File in an Active Technologies Dashboard .
ARDATA_COLUMN='{column_name|@@COLUMNS|@@BYS|@@MEASURES}'

Indicates how the selection values are populated. The following are the available options.

  • The column_name is the name of the specific column in the source report that populates the data selection values in the LIST, COMBOBOX, CHECKBOX, and RADIOBUTTON controls.

    For the TEXTINPUT control, this property is the column to which the filter condition is applied. There is no initial data value for the TEXTINPUT control at run time. It remains blank until the user supplies a value.

    This property is required. The column must exist in both the source report and target report.

    The active form controls do not support the use of ACROSS sort columns in active reports or charts. You cannot use ACROSS sort columns to populate the data selection values and apply filters.

  • Specifying @@COLUMNS, @@BYS, or @@MEASURES enables you to use a check box control to display a list of column names from a source report. At run time, end users can choose the columns to show or hide in a target report or chart on an active dashboard.
    • @@COLUMNS displays a list of all the columns in the source report.
    • @@BYS displays a list of all the sort columns in the source report, specified using a BY command.
    • @@MEASURES displays a list of all the measure columns in the source report, specified using a PRINT or SUM command.

    For more information on using the @@COLUMNS, @@BYS, and @@MEASURES options, see Using an Active Technologies Form Control to Show or Hide Columns in a Report or Chart.

ARFILTER_TARGET=’target_report_name1,target_report_name2,...’

Is the name of the target report or target chart component that is filtered by the active form control. You can specify one or more target report or target chart components. To specify multiple target components, provide a list of report or chart component names, separating each name with a comma (,).

This property is required.

ARFILTER_CONDITION='{EQ|NE|LT|LE|GT|GE}'

Is the filter condition that is used. The available values are:

  • EQ is equal to. This is the default value.
  • NE is not equal to.
  • LT is less than.
  • LE is less than or equal to.
  • GT is greater than.
  • GE is greater than or equal to.
ARFILTER_SHOWALL={ON|OFF}

Specifies whether or not to show the string value "[ALL]" in the list of data selection values for the active form control. The default value is ON, which displays the string value "[ALL]" in the list of data selection values. At run time, selecting this value from the control displays all the data in the report. Set this property to OFF to suppress the string value "[ALL]" in the active form control.

This property is optional for the LIST, COMBOBOX, CHECKBOX, and RADIOBUTTON controls.

This property does not apply to the TEXTINPUT control. For the TEXTINPUT control, removing the value supplied in the text input field removes the filter and displays all the values in the target reports and charts.

ARFILTER_PARENT=’name_of_parent_object'

Is the name of the parent active form control using the NAME property to create a nested (parent/child) filter relationship between active form controls.

This is a user-specified property. There is no default value.

ARDATA_FILTERONLY={ON|OFF}

Is a property that is used internally by Developer Studio.

The default value is ON for chained active form controls. The source report for a control can also be a target report for another control that applies a filter to the report. This property allows you to decide whether or not to filter the data in a control populated by a report that is filtered by another control. When this property is set to OFF, all the values for the column in the report are displayed as the data selection values for the control. When this property is set to ON, only the values after a filter has been applied are available as the data selection values.

ARFILTER_MULTIPLE={ON|OFF}

Is an optional property for the LIST and CHECKBOX controls. When this property is set to ON, you can select multiple values from a LIST or CHECKBOX control at run time. With a list box, hold down the Shift key to select multiple values in sequence, or hold down the Ctrl key to select multiple values that are not in the order listed at run time. With check boxes, you can simply check or uncheck multiple check boxes at run time.

The default value is OFF.

This property does not apply to the COMBOBOX, RADIOBUTTON, or TEXTINPUT control, because those controls allow only single-value selection at run time.

ARFILTER_ACTIVE={ONLOAD|'"alpha_value"'|'numeric_value'}

Is an optional property for an active form control. It sets the default filter value in an active form control and at run time automatically applies the filter to the data in the report and chart objects on an active dashboard.

  • ONLOAD works as follows.
    • In the COMPOUND LAYOUT code for an active form control, ARFILTER_ACTIVE=ONLOAD is not set, and ARFILTER_SHOWALL=OFF.

      When you are using InfoAssist, you can create a report for an active dashboard with an active form control. Deselect the Include All check box (ARFILTER_SHOWALL=OFF) in the Active Dashboard Properties dialog box.

      For example, ARFILTER_SHOWALL=OFF is included in the following code for a drop-down list (COMBOBOX) on an active dashboard. ARFILTER_ACTIVE=ONLOAD is not set.

      OBJECT=COMBOBOX, NAME='combobox1', POSITION=(2.604 1.042),
         DIMENSION=(2.292 0.229), ARFILTER_NAME='combobox1',
         ARDATA_REPORT='report1', ARDATA_COLUMN='ST',
         ARFILTER_TARGET='report1', ARFILTER_SHOWALL=OFF, $

      In the output, the drop-down list displays the default value CA (the first value in the list) for the State column. However, on the first execution, the data in the tabular report is not filtered by CA. Instead, the tabular report displays all the data, as shown in the following image.

      Note on default behavior:

      If ARFILTER_ACTIVE is not explicitly set by default, an active form control on a dashboard does not work as intended at initial run time. On the first execution, all data is returned to the report and chart objects on the dashboard, regardless of the value that is displayed in the active form control. In addition, the report data does not necessarily correspond to the value displayed in the active form control. On subsequent executions, the report data is filtered by the value selected in the active form control.

    • In the COMPOUND LAYOUT code for an active form control, ARFILTER_ACTIVE=ONLOAD and ARFILTER_SHOWALL=OFF.

      When ARFILTER_ACTIVE=ONLOAD is set, the report data at run time is filtered by the first selection value in the particular active form control that is set.

      For example, ARFILTER_ACTIVE=ONLOAD and ARFILTER_SHOWALL=OFF are included in the following code for a drop-down list (COMBOBOX) on an active dashboard:

      OBJECT=COMBOBOX, NAME='combobox1', POSITION=(2.604 1.042),
        DIMENSION=(2.292 0.229), ARFILTER_NAME='combobox1',
        ARDATA_REPORT='report1', ARDATA_COLUMN='ST',
        ARFILTER_TARGET='report1', ARFILTER_SHOWALL=OFF,
        ARFILTER_ACTIVE=ONLOAD, $ 

      In the output, the drop-down list displays the default value CA (the first value in the list) for the State column. The data in the tabular report is filtered by CA, as shown in the following image.

  • In the COMPOUND LAYOUT code for an active form control, ARFILTER_ACTIVE='"alpha_value"'.

    An alpha_value is the default filter value that you specify for display in an active form control for an alphabetic column. All data in the report and chart objects on the dashboard is automatically filtered at run time, based on the alpha_value.

    For example, ARFILTER_ACTIVE='"IL"' and ARFILTER_SHOWALL=ON are included in the following code for a drop-down list (COMBOBOX) on an active dashboard:

    OBJECT=COMBOBOX, NAME='combobox1', POSITION=(2.604 1.042),
      DIMENSION=(2.292 0.229), ARFILTER_NAME='combobox1',
      ARDATA_REPORT='report1', ARDATA_COLUMN='ST',
      ARFILTER_TARGET='report1', ARFILTER_SHOWALL=ON,
      ARFILTER_ACTIVE='"IL"', $

    In the output, the drop-down list displays the default value IL for the State column. The data in the tabular report is filtered by IL, as shown in the following image.

    You can specify more than one default value when ARFILTER_MULTIPLE is set to ON for a list control or check box control.

    If you specify more than one alpha_value, use the syntax:

    '"alpha_value1","alpha_value2",...'
  • In the COMPOUND LAYOUT code for an active form control, ARFILTER_ACTIVE='numeric_value'.

    A numeric_value is the default filter value that you specify for display in an active form control for a numeric column. All data in the report and chart objects on the dashboard is automatically filtered at run time, based on the numeric_value.

    You can specify more than one default value when ARFILTER_MULTIPLE is set to ON for a list control or check box control.

    If you specify more than one numeric_value, use the syntax:

    'numeric_value1,numeric_value2,...'
ARFILTER_ONCHANGE={ON|OFF}

Controls the filtering of an active report or chart on an active dashboard based on the values in chained active form controls. The setting ON filters the target active report or chart on a dashboard with the initial value in a child active form control when the value of the parent active form control changes.

For more information on the use of this property, see Filtering an Active Technologies Report on a Dashboard Using Chained Form Controls.

ARFILTER_SORT='{ASCENDING|DESCENDING}'

Controls the sort order of the filter values in an active form control on an active dashboard.

  • The setting ASCENDING sorts the filter values from low to high. This is the default setting.
  • The setting DESCENDING sorts the filter values from high to low.
POSITION=(left top)

Is the position of the active form control on the active dashboard.

  • The value left indicates the position of the active form control from the left edge of the active dashboard, in the units of measurement set for the dashboard (for example, inches, centimeters, or points). You can set the units of measurement for a dashboard using the UNITS keyword in your WebFOCUS code or using a graphical tool, such as InfoAssist. For more information, see the applicable reporting language and reporting tools manuals.
  • The value top indicates the position of the active form control from the top edge of the active dashboard, in the units of measurement set for the dashboard.
DIMENSION=(width height)

Is the size of the active form control on the active dashboard.

  • The value width is the width of the active form control on the active dashboard, in the units of measurement set.
  • The value height is the height of the active form control on the active dashboard, in the units of measurement set.
SIZE=font_size

Is the size of the font used to display the values in the active form control, for example, 12.

COLOR=font_color

Is the color of the font used to display the values in the active form control, for example, BLACK.

BACKCOLOR=background_color

Is the background color for the active form control. WHITE is the default value. A valid value is either a preset color name in single quotation marks, for example, 'ORANGE', or the RGB (red green blue) numeric values, for example, RGB(255 252 204), which is pale yellow.



x
Example: Adding a Sample Drop-Down List

The following image shows a partial active dashboard with a single tabular active report and a drop-down list (COMBOBOX). The drop-down list is positioned to the right of the active report. The drop-down list allows you to filter data in the tabular report on the value of the STATE column in the procedure. The data selection value All is provided in the drop-down list. When selected, All displays all the data in the report.

The WebFOCUS code for the drop-down list is as follows.

OBJECT=COMBOBOX, NAME='combobox1',
POSITION=(6.010 2.167), DIMENSION=(1.667 0.208),
ARDATA_REPORT='report1', ARDATA_COLUMN='STATE',
ARFILTER_TARGET='report1', ARFILTER_CONDITION='EQ',
ARFILTER_SHOWALL=ON,  $


x
Usage Notes for Active Technologies Form Controls

The following apply when you are designing an active form control.



x
Font Support

Active Technologies do not support the FONT attribute in the syntax for an OBJECT. You cannot change the type of font used to display the values in an active form control.



x
Filtering Data With Subtotals and Grand Totals

You can use the WebFOCUS SUBTOTAL command to generate subtotals and grand totals for columns on an active report in an active dashboard. If the active dashboard also contains an active form control for filtering the data in the report, and you have the option to select All from the active form control, the grand total is displayed in the report output. However, if you select a value other than All from the active form control, data is filtered in the body of the report based on the selected value, but the grand total is not displayed in the result.



x
Syntax: How to Filter Data With Subtotals and Grand Totals

To update and retain subtotals and grand totals for both filtered data and unfiltered data when you have an active form control on an active dashboard, use WebFOCUS StyleSheet code similar to the following instead of SUBTOTAL

TYPE=REPORT,
     COLUMN=N[column_position],
     CALCULATION=SUM,
     CALC-LOCATION=BOTTOM,
$

where:

column_position

Is a numeric value that represents the position of the column on the active report. For example, N5 represents the fifth column on the report.

The report output includes Filtered Sum and Total Sum for the column specified in the WebFOCUS StyleSheet code. The Filtered Sum shows the section subtotal as well as a percentage of the Total Sum. The Total Sum represents the grand total that was removed when SUBTOTAL was used to generate the report.

For details on the WebFOCUS syntax for generating subtotals and grand totals, see the Creating Reports With WebFOCUS Language manual.


Top of page

x
Filtering an Active Technologies Report on a Dashboard Using Chained Form Controls

How to:

You can use the ARFILTER_ONCHANGE = ON property in a compound layout report to filter a target active report or chart on an active dashboard with the values selected in chained active form controls. When the value of the first active form control in a chain changes, the report or chart is filtered with the initial value in the second and subsequent active form controls in the chain.



x
Syntax: How to Filter an Active Technologies Report on a Dashboard Using Chained Form Controls

Add the following syntax to an OBJECT in a compound layout report

ARFILTER_ONCHANGE = {ON|OFF}

where:

ON
Filters a target active report or chart on a dashboard with the initial value in a child active form control when the value of the parent active form control changes.
OFF
In the output of an active report or chart on a dashboard, displays data for all the possible filter values in a child active form control when the value of the parent active form control changes, whether or not the value All is displayed in the child control. Does not perform filtering of the active report or chart based on the initial value in the child active form control. This is the default setting.


Example: Filtering an Active Technologies Report on a Dashboard Using Chained Form Controls

The first active form control on the following sample active dashboard prompts the end user for the value of the region, and the second active form control prompts for the value of the state within the selected region. The second active form control is chained to the first active form control. The active report filters the data using the initial values in the active form controls, Midwest and IL.

If the end user selects the value Northeast from the first active form control, the active report filters the data on the initial value of the second active form control, which is CT, as shown in the following image.

In the compound layout report that generates this output, the property ARFILTER_ONCHANGE for the first and second active form control is set to ON. The active form controls for the region and the state contain all possible filter values.

Chained_Filtering.fex

The compound layout report is as follows.

Note: The following sample procedure was formatted for PDF display. To use this example in your own application, you must adjust the line breaks and spacing to comply with valid COMPOUND LAYOUT syntax. For example, you can format the SECTION, PAGELAYOUT, COMPONENT, and OBJECT declaration each as a single, word-wrapped line. Alternatively, you can split a single declaration across lines, ending each line with a comma and terminating the declaration with a dollar sign. For more information on COMPOUND LAYOUT syntax, see the topic Creating a Compound Report, in Chapter 10, Linking a Report to Other Resources, of the Creating Reports With WebFOCUS Language manual.

SET HTMLARCHIVE=ON 
COMPOUND LAYOUT PCHOLD FORMAT AHTML 
UNITS=IN, $
SECTION=section1, LAYOUT=ON, METADATA='prop_with_names^Margins_Left=0.5
   ^Margins_Top=0.5^Margins_Right=0.5^Margins_Bottom=0.5^thumbnailscale=1', 
   MERGE=OFF, ORIENTATION=PORTRAIT, PAGESIZE=Letter, SHOW_GLOBALFILTER=OFF,
   ARGRAPHENGINE=JSCHART, ACTIVE_UNITS=PTS, $
PAGELAYOUT=1, NAME='Page layout 1', text='Page layout 1', TOC-LEVEL=1,
   BOTTOMMARGIN=0.5, TOPMARGIN=0.5, METADATA='BOTTOMMARGIN=0.5,TOPMARGIN=0.5,
   LEFTMARGIN=0,RIGHTMARGIN=0,', $ 
COMPONENT='report1', TEXT='report1',
   TOC-LEVEL=2, POSITION=(0.624 2.144), DIMENSION=(7.293 3.331),
   ARREPORTSIZE=DIMENSION, METADATA='Z-INDEX: 1; POSITION: absolute;
   WIDTH: 7.293in; HEIGHT: 3.331in; TOP: 1.144in; LEFT: 0.624in', $
OBJECT=COMBOBOX, NAME='combobox1', POSITION=(0.625 0.625),
   DIMENSION=(1.542 0.880), ARFILTER_ONCHANGE=ON, ARFILTER_NAME='combobox1',
   ARDATA_REPORT='report1', ARDATA_COLUMN='REGION', ARFILTER_TARGET='report1',
   ARFILTER_CONDITION='EQ', ARFILTER_ACTIVE=ONLOAD,  $
OBJECT=LIST, NAME='list1', POSITION=(2.375 0.625),
   DIMENSION=(1.375 1.188), ARFILTER_ONCHANGE=ON, ARFILTER_NAME='list1',
   ARDATA_REPORT='report1', ARDATA_COLUMN='ST', ARFILTER_TARGET='report1',
   ARFILTER_CONDITION='EQ', ARFILTER_ACTIVE=ONLOAD,
   ARFILTER_PARENT='combobox1',  $
END
 
          
SET COMPONENT='report1' 
-*component_type report 
TABLE FILE GGSALES 
SUM
     GGSALES.SALES01.BUDDOLLARS
     GGSALES.SALES01.DOLLARS
     GGSALES.SALES01.UNITS 
BY  LOWEST GGSALES.SALES01.REGION 
BY  LOWEST GGSALES.SALES01.ST 
ON TABLE SET PAGE-NUM NOLEAD 
ON TABLE NOTOTAL
ON TABLE PCHOLD FORMAT AHTML 
ON TABLE SET HTMLCSS ON 
ON TABLE SET STYLE * 
INCLUDE=ENInformationBuilders_Medium1.sty,
$ 
TYPE=REPORT,
   LINES-PER-PAGE=20,
$ 
ENDSTYLE 
END 
COMPOUND END

To display data in the target report for all the possible filter values in the second active form control, change the ARFILTER_ONCHANGE property to OFF in the OBJECT code in the preceding procedure, as follows.

OBJECT=COMBOBOX, NAME='combobox1', POSITION=(0.625 0.625),
   DIMENSION=(1.542 0.188), ARFILTER_ONCHANGE=OFF, ARFILTER_NAME='combobox1',
   ARDATA_REPORT='report1', ARDATA_COLUMN='REGION', ARFILTER_TARGET='report1',
   ARFILTER_CONDITION='EQ', ARFILTER_ACTIVE=ONLOAD,  $
OBJECT=LIST, NAME='list1', POSITION=(2.375 0.625),
   DIMENSION=(1.375 1.188), ARFILTER_ONCHANGE=OFF, ARFILTER_NAME='list1',
   ARDATA_REPORT='report1', ARDATA_COLUMN='ST', ARFILTER_TARGET='report1',
   ARFILTER_CONDITION='EQ', ARFILTER_ACTIVE=ONLOAD,
   ARFILTER_PARENT='combobox1',  $

The data that populates the list box for the second active form control, and the data in the target report, is not filtered by the initial value in the child active form control. The value is not selected in the second active form control, and the target report displays data for all the possible filter values. This results in behavior similar to having the value All in the second active form control in a chain.

The target report shown in the following image is filtered only by the parent active form control in the chain.


Top of page

x
Using an Active Technologies Form Control to Show or Hide Columns in a Report or Chart

How to:

You can use a check box control (OBJECT=CHECKBOX) to display a list of column names from a source report specified in the ARDATA_REPORT property. At run time, end users can check the name of each column that they want to show in a report or chart on an active dashboard, and uncheck the name of each column that they want to hide. All reports and charts that are specified in the ARFILTER_TARGET property and that contain columns from the list are updated with the choice of columns as end users check and uncheck names.

The following is a list of column names in a sample check box control.

When you run an active dashboard for the first time, a NOPRINT or hidden column in a report or chart component on the dashboard is not displayed in the report or chart output. If that report or chart component is the source report for a check box control, the NOPRINT or hidden column is unchecked (deselected) in the corresponding check box by default.

A check box for all other columns in the source report is initially checked (selected) by default.

The list of column names in a check box control uses the field name or title specified in the Master File for the data source. If the source report uses an AS phrase to specify the column title, that title is used in the list.

This feature applies to an active dashboard with the AHTML output format. It does not support the use of ACROSS column names.



x
Syntax: How to Use an Active Technologies Form Control to Show or Hide Columns in a Report or Chart

The syntax is

COMPOUND LAYOUT PCHOLD FORMAT AHTML
.
.
.
OBJECT=CHECKBOX,. . .
ARDATA_REPORT='name_of_source_report',
ARDATA_COLUMN='{@@COLUMNS|@@BYS|@@MEASURES}',
ARFILTER_TARGET='target_report_name1,target_report_name2,...',
.
.
.

where:

COMPOUND LAYOUT PCHOLD FORMAT AHTML

Indicates the supported output format for an active dashboard. The use of a check box control to show or hide columns in a report is available for a compound layout report with the AHTML output format.

OBJECT=CHECKBOX

Adds a check box control to an active dashboard.

ARDATA_REPORT='name_of_source_report'

Is the name of the source report that contains the column names that populate the check box control on an active dashboard.

This property is required for the check box control as described in this feature.

ARDATA_COLUMN='{@@COLUMNS|@@BYS|@@MEASURES}'

Indicates which set of column names is included in the check box control on an active dashboard. The available options are:

  • @@COLUMNS displays a list of all the columns in the source report.
  • @@BYS displays a list of all the sort columns in the source report, specified using a BY command.
  • @@MEASURES displays a list of all the measure columns in the source report, specified using a PRINT or SUM command.

This property is required for the check box control as described in this feature.

ARFILTER_TARGET='target_report_name1,target_report_name2,...'

Is the name of the target report or chart that is updated by the choice of column names made in the check box control. You can update multiple reports and charts with the end user choices. To update multiple components, provide a list of component names, separating each name with a comma (,).

This property is required for the check box control as described in this feature.

For more information on OBJECT syntax, see WebFOCUS Code.



Example: Using a Check Box Control to Show or Hide Columns in a Report and Chart

The following sample code creates three check box controls, each with a set of column names used to show or hide columns in a report and chart on an active dashboard.

All three types of check box controls are shown for the purpose of illustration. In a real application, you would typically include the first set only (all columns in the source report), the second set only (all BY columns in the source report), the third set only (all measure columns in the source report), or any combination of these sets.

COMPOUND LAYOUT PCHOLD FORMAT AHTML 
UNITS=IN,SHOW_GLOBALFILTER=OFF, $ 
SECTION=section1, LAYOUT=ON, ORIENTATION=PORTRAIT, PAGESIZE=Letter, $ 
PAGELAYOUT=1, NAME='Page layout 1', text='Page layout 1', $ 
COMPONENT='report1', TEXT='report1', POSITION=(0.5 3),
   DIMENSION=(12 2), $ 
COMPONENT='graph1', TEXT='graph1', POSITION=(0.5 7.5),
   DIMENSION=(12 6), $ 
OBJECT=CHECKBOX, NAME='object1',COLOR=RGB(53 78 109), FONT='ARIAL',
   ARFILTER_TARGET='report1,graph1', ARDATA_COLUMN='@@COLUMNS',
   ARDATA_REPORT='report1', POSITION=(.5 .5), DIMENSION=(2.5 2), $ 
OBJECT=CHECKBOX, NAME='object2',COLOR=RGB(53 78 109), FONT='ARIAL',
   ARFILTER_TARGET='report1,graph1', ARDATA_COLUMN='@@BYS',
   ARDATA_REPORT='report1', POSITION=(4.5 .5), DIMENSION=(2 2), $ 
OBJECT=CHECKBOX, NAME='object3',COLOR=RGB(53 78 109), FONT='ARIAL',
   ARFILTER_TARGET='report1,graph1', ARDATA_COLUMN='@@MEASURES',
   ARDATA_REPORT='report1', POSITION=(7.5 .5), DIMENSION=(2 2), $ 
END 
SET COMPONENT='report1' 
TABLE FILE CENTURYSALES 
SUM LINEPRICE AS 'Revenue' 
PROFIT NOPRINT 
COSTOFGOODSSOLD 
QUANTITY NOPRINT 
BY REGION 
BY STATE 
BY CITY 
BY PRODUCTTYPE 
BY PRODUCTCATEGORY 
WHERE CENTURYSALES.ORDERS.YEAR EQ '2006'; 
WHERE CENTURYSALES.STORESEG.COUNTRY EQ 'United States'; 
WHERE CENTURYSALES.STORESEG.REGION EQ 'Middle Atlantic' OR
   'Pacific' OR 'South Atlantic' OR 'New England' OR
   'East North Central' OR 'West South Central'; 
WHERE CENTURYSALES.PRODSEG.PRODUCTCATEGORY EQ 'Audio Systems'
   OR 'DVD' OR 'DVD Camcorders' OR 'Digital Cameras' OR
   'Organizers' OR 'TV'; 
WHERE RECORDLIMIT EQ 200; 
ON TABLE SET ARGRAPHENGINE JSCHART 
ON TABLE PCHOLD FORMAT AHTML 
ON TABLE SET STYLE * 
INCLUDE = ENInformationBuilders_Medium1, $ 
TYPE=REPORT, LINES-PER-PAGE=10, $ 
TYPE=REPORT, COLUMN=N4, HIDE=ON, $ 
TYPE=REPORT, COLUMN=N5, HIDE=ON, $ 
ENDSTYLE 
END 
SET COMPONENT='graph1' 
GRAPH FILE CENTURYSALES 
SUM LINEPRICE AS 'Revenue' 
PROFIT NOPRINT 
COSTOFGOODSSOLD 
QUANTITY NOPRINT 
BY REGION NOPRINT 
BY STATE NOPRINT 
BY CITY 
BY PRODUCTTYPE 
BY PRODUCTCATEGORY 
WHERE CENTURYSALES.ORDERS.YEAR EQ '2006'; 
WHERE CENTURYSALES.STORESEG.COUNTRY EQ 'United States'; 
WHERE CENTURYSALES.STORESEG.REGION EQ 'Middle Atlantic' OR
   'Pacific' OR 'South Atlantic' OR 'New England' OR
   'East North Central' OR 'West South Central'; 
WHERE CENTURYSALES.PRODSEG.PRODUCTCATEGORY EQ 'Audio Systems'
   OR 'DVD' OR 'DVD Camcorders' OR 'Digital Cameras' OR
   'Organizers' OR 'TV'; 
WHERE RECORDLIMIT EQ 200; 
ON GRAPH SET ARGRAPHENGINE JSCHART 
ON GRAPH PCHOLD FORMAT AHTML 
ON GRAPH SET LOOKGRAPH VLINE 
ON TABLE SET STYLE * 
INCLUDE = ENInformationBuilders_Medium1, $ 
TYPE=REPORT, LINES-PER-PAGE=20, $ 
TYPE=REPORT, COLUMN=N4, HIDE=ON, $ 
TYPE=REPORT, COLUMN=N5, HIDE=ON, $ 
ENDSTYLE 
END 
COMPOUND END

When you run the compound layout report, the following output is displayed.

On the sample active dashboard:

Notice that a check box in the first and third set of column names displays the column title Revenue, as specified by the AS phrase in the source report (SUM LINEPRICE AS 'Revenue').

The check boxes for Product Type, Product Category, PROFIT, and QUANTITY are initially deselected because these columns are hidden in the source report.

Note: Product Type and Product Category are hidden using the HIDE=ON WebFOCUS StyleSheet setting to preserve the column titles specified in the Master File, whereas PROFIT and QUANTITY are NOPRINT columns in the source report, resulting in the display of the actual field names.

You can now make a choice of columns to display in the target report and chart specified in the following property:

ARFILTER_TARGET='report1,graph1'

For example, to hide the column City in the target report and chart, deselect the check box for City in the full set of column names. The column City is removed from the report and chart on the active dashboard.

To show the column Product Type in the target report and chart, select the check box for Product Type in the full set of column names. The column Product Type is now shown in the report and chart on the active dashboard.

The updated report and chart reflecting your choices are shown in the following image.


Top of page

x
Creating a Heading Area With Controls Using the Dashboard Bar

In this section:

How to:

You can create a heading area for an active dashboard by adding a page layout for the dashboard bar (PAGELAYOUT=DASHBOARDBAR). On the page for the dashboard bar, you can insert Active Technologies form controls, reports, and charts that are always displayed above the dashboard tabs.

This feature is available for a compound layout report with the AHTML, FLEX, or APDF output format.

You can create a maximum of one page layout for the dashboard bar. Though you can place multiple components on the full page, we recommend that you avoid large reports and charts. If the page for the dashboard bar contains large reports and charts, it may fill up the entire visible area of the browser or monitor, and the heading area for the dashboard may appear bigger than the dashboard itself. This effect reduces the usability of the dashboard.



x
Design Requirements

To create a heading area for an active dashboard, you must have one report component inside the page layout for the dashboard bar. You can optionally hide this report component. For more information on this feature, see Hiding a Report Object on an Active Technologies Dashboard.

By default, Document Composer generates the syntax for an empty report when you create an active dashboard.



x
Syntax: How to Create a Heading Area With Controls Using the Dashboard Bar

The following syntax shows the PAGELAYOUT definition for DASHBOARDBAR in a section in a compound layout report. It includes a required report component, which in turn can be followed by other components and objects.

For details on the syntax used in Document Composer to create a compound layout report, see the Creating Reports With WebFOCUS Language manual.

Use the following syntax

COMPOUND LAYOUT PCHOLD FORMAT output_format 
SECTION=section_name, LAYOUT=ON, MERGE={AUTO|OFF},
   ARGRAPHENGINE=chart_engine...,$
PAGELAYOUT=DASHBOARDBAR,$
COMPONENT=component_name, TYPE=REPORT, POSITION=(x y),
   HIDDEN={ON|OFF}...,$
.
.
.
END
COMPOUND END

where:

output_format

Is AHTML, FLEX, or APDF.

section_name

Is a unique identifier for the section. It can be up to 16 characters long.

LAYOUT=ON

Specifies that the section uses a complex layout. LAYOUT=ON is the only available option at this time.

MERGE={AUTO|OFF}

Enables you to choose one of two options supported by the Active Technologies output formats. The default value is OFF. For more information on the use of this attribute, see Adding Active Technologies Form Controls and Establishing Relationships and Controlling the Display of the Global Filter Icon and Dashboard Bar.

chart_engine

Is any chart engine, for example, JSCHART.

PAGELAYOUT=DASHBOARDBAR

Must be DASHBOARDBAR.

component_name

Is a unique identifier for the report component that is required inside the page layout. It is the name of a report that appears later in the request. The component name can be up to 16 characters long.

TYPE=REPORT

Is the type of component. REPORT is the only supported value.

x y

Is the (x y) coordinate on the page where the upper-left corner of the component is placed. All coordinates are in current UNITs (the default value is inches), and (0 0) is the upper-left corner of the physical page.

HIDDEN={ON|OFF}

Either hides the active report component on the active dashboard (ON), or displays the active report component on the active dashboard (OFF). The default value is OFF.

Note: In the preceding syntax, ellipses (...) indicate that you can include other valid attributes.



Example: Creating a Heading Area With Controls Using the Dashboard Bar

The following code creates a heading area for an active dashboard.

For details on the syntax used to create the dashboard with a drop-down list (COMBOBOX), see Configuring Active Technologies Form Controls With WebFOCUS Syntax.

COMPOUND LAYOUT PCHOLD FORMAT AHTML 
SECTION=S1, LAYOUT=ON, MERGE=OFF, ARGRAPHENGINE=JSCHART,
   ARSTYLESET=bipsilver, ARICONSET=WHITE,$ 
PAGELAYOUT=DASHBOARDBAR,$
COMPONENT=R0, TYPE=REPORT, POSITION=(3 1), DIMENSION=(3 2),$ 
COMPONENT=G0, TYPE=REPORT, POSITION=(7 1), DIMENSION=(4 3),$
OBJECT=STRING, NAME=Text_1, POSITION=(0.2 0.2), TEXT='Regional Sales',
   FONT='ARIAL', SIZE=20, COLOR=RGB(0 72 132), WRAP=OFF,
   DIMENSION=(4.270833 0.71875),$
OBJECT=COMBOBOX, NAME='object6', COLOR='blue', SIZE=12, FONT=ARIAL,
   ARFILTER_SHOWALL=OFF, ARFILTER_TARGET='R1,R2,G0',
   ARDATA_COLUMN=REGION, ARDATA_REPORT=R0, ARFILTER_CONDITION=EQ,
   POSITION=(0.2 1), DIMENSION=(2 .5), ARFILTER_ACTIVE=ONLOAD,$
PAGELAYOUT=1, TEXT=layout 1, BACKCOLOR=RGB(0 72 132),$
COMPONENT=R1, TYPE=REPORT, POSITION=(.5 .5), DIMENSION=(4.2 4),$
PAGELAYOUT=2, TEXT=layout 2, BACKCOLOR='aqua',$
COMPONENT=R2, TYPE=REPORT, POSITION=(.5 .5), DIMENSION=(6.3 4),$
END
SET COMPONENT=R0
TABLE FILE GGSALES
SUM DOLLARS
BY REGION
ON TABLE SET STYLE *
INCLUDE = ENInformationBuilders_Medium1,$
ENDSTYLE
END
SET COMPONENT=G0
GRAPH FILE GGSALES
SUM DOLLARS
BY REGION
BY CATEGORY
ON GRAPH SET LOOKGRAPH PIE
ON GRAPH PCHOLD FORMAT AHTML
ON TABLE SET STYLE *
INCLUDE = ENInformationBuilders_Medium1,$
TYPE=REPORT,
     COLUMN=N1,
     HIDE=ON,
$
ENDSTYLE
END
SET COMPONENT=R1
TABLE FILE GGSALES
SUM UNITS BUDUNITS
BY REGION
BY ST
BY CATEGORY
BY PRODUCT
ON TABLE SET STYLE *
INCLUDE = ENInformationBuilders_Medium1,$
TYPE=REPORT,
     LINES-PER-PAGE=10,
$
ENDSTYLE
END
SET COMPONENT=R2
TABLE FILE GGSALES
SUM BUDDOLLARS DOLLARS
BY REGION
BY CATEGORY
BY PRODUCT
ON TABLE SET STYLE *
INCLUDE = ENInformationBuilders_Medium1,$
ENDSTYLE
END 
COMPOUND END

When you run the compound layout report, the output that is generated is shown in the images that follow.

The heading area for the active dashboard is at the top of the window. A tabular active report on the dashboard is in the lower half of the window, on a navy background.

The heading area for the active dashboard contains an active chart, a tabular active report, and a drop-down list for filtering the data on the dashboard.

The filter from the drop-down list is applied to the components associated with this active form control, namely, the active chart at the top and the tabular active report in the lower half of the window.

The heading area for the active dashboard remains above all the tabs on the dashboard. As shown in the following image, the filter from the drop-down list in the heading area is also applied to the tabular active report on the second tab of the dashboard to broaden the scope of data analysis.


Top of page

x
Formatting a Text String

In this section:

When you create an active dashboard in Document Composer or InfoAssist, you can format a text string using one of the following:



x
Using HTML Markup Tags

Several text formatting markup tags for a text object are supported when you create an active dashboard in Document Composer or InfoAssist.

The font tag supports three attributes:

The syntax is

<font face="font" size=n color="color_name_or_code">text</font>

where:

font

Is the name of the font.

n

Is the size of the font.

color_name_or_code

Is the color of the font, specified as either the name of the color or the HTML hexadecimal value of the color.

text

Is the text that you are formatting for display on the active dashboard. The following are the supported text styles:

  • Bold. The syntax is:
    <b>text</b>
  • Italic. The syntax is:
    <i>text</i>
  • Underline. The syntax is:
    <u>text</u>


Example: Applying HTML Markup Tags

Active Technologies support the following sample syntax:

OBJECT=STRING, NAME='text1', TEXT='<font face="TREBUCHET MS" size=20
color="red">Regional Sales<BR></font>', POSITION=(0.917 1.063), MARKUP=ON,
DIMENSION=(2.302 0.250), METADATA='', $


Example: Formatting a Text String With HTML Markup Tags

The following text strings are formatted with HTML markup tags to illustrate the options that are available.

The following image shows the preceding text strings in the upper left corner of a sample active dashboard.



x
Using WebFOCUS Compound Report Attributes

Several formatting attributes for a text string (OBJECT=STRING) are supported when you create an active dashboard in Document Composer or InfoAssist. The attributes include:

For details on the syntax used for formatting a text string with the preceding attributes, see the information on creating a compound report in the Creating Reports With WebFOCUS Language manual.

Currently, Active Technologies do not support the STYLE attribute in the syntax for OBJECT=STRING. When supported, the STYLE attribute applies styles such as bold or italic.



Example: Applying WebFOCUS Compound Report Attributes

Active Technologies support the following sample syntax:

OBJECT=STRING, NAME='text1', TEXT='Regional Sales',
POSITION=(1.115 0.83), MARKUP=ON, WRAP=ON, DIMENSION=(1.688 2.385),
METADATA='Z-INDEX: 1; POSITION: absolute; WIDTH: 1.688in;
WORD-WRAP: break-word; HEIGHT: 2.385in; TOP: 0.83in; LEFT: 1.115in',
FONT='Trebuchet MS', SIZE=20, COLOR='red', $


Example: Formatting a Text String With WebFOCUS Compound Report Attributes

The following text strings are formatted with different attribute values to illustrate the options that are available.

The following image shows the preceding text strings in the upper left corner of a sample active dashboard.


Top of page

x
Controlling the Display of the Global Filter Icon and Dashboard Bar

The following WebFOCUS syntax controls the display of the Global Filter icon and dashboard bar on an active dashboard.

SHOW_GLOBALFILTER={ON|OFF}

where:

ON

Displays the Global Filter icon and dashboard bar on an active dashboard. This is the default value.

OFF

Suppresses the display of the Global Filter icon and dashboard bar on an active dashboard when both of the following apply:

  • You have not set a coordinated field (MERGE=AUTO) option.
  • The dashboard does not have multiple PAGELAYOUTs.

By default, Document Composer and InfoAssist add the following syntax for the output formats AHTML, FLEX, and APDF.

SECTION=section1, LAYOUT=ON, SHOW_GLOBALFILTER=OFF,...$

Setting the MERGE=AUTO option or having multiple PAGELAYOUTs overwrites the preceding SHOW_GLOBALFILTER=OFF setting and displays the Global Filter icon and dashboard bar.


Top of page

x
Using a Single Cache File in an Active Technologies Dashboard

In this section:

By default, when you run a compound layout report that has multiple TABLE and GRAPH requests and uses the active cache option, a separate cache file for each request is created on the server, even though all requests may retrieve data from the same data source. When you develop a compound layout report with multiple requests and active cache, you can specify the use of a single cache file for all requests that access the same data source. This feature reduces the number of cache files created on the server for the active dashboard and the number of requests sent to the cache, thus reducing the load on the server.



x
Required Syntax

The following syntax is required to implement a single cache file.



x
Syntax: How to Set an Active Technologies Component to Use a Single Cache File

The SET syntax within a request is

ON {TABLE|GRAPH} SET PREVIEW {ON|OFF}

where:

ON
Prevents the report or chart from accessing the original cache file.
OFF
Will not access the single cache file. This is the default value.


x
Syntax: How to Specify a Single Cache File in an Active Technologies Report or Chart

The syntax within a WebFOCUS StyleSheet is

ON TABLE SET STYLE *
TYPE=REPORT, ARDATA_REPORT='cache_component_name'

where:

cache_component_name

Is the name of the cache file specified on the COMPONENT declaration of a compound layout report. The ARDATA_REPORT property with the name of the cache file is required by every other component on the active dashboard to enable single cache file processing when the active cache option is used.



Example: Using a Single Cache File in an Active Technologies Dashboard

In the example that follows, a syntax requirement is described above the code that applies.

The request to create a single cache file can be made in either a TABLE or GRAPH procedure.

COMPOUND LAYOUT PCHOLD FORMAT AHTML
section=s1, layout=on, SHOW_GLOBALFILTER=OFF,$ 
pagelayout=1, text=Revenue Report,$

You must include a component that names the single cache file. In this example, the name of the cache file is DASHBOARDCACHE. The component itself can use the active cache option.

component=DASHBOARDCACHE, type=report, hidden=ON,$
component=R1, type=report, position=(0.5 0.5), dimension=(8 8),$ 
END

You must set the component to the name of the cache file.

SET COMPONENT=DASHBOARDCACHE
TABLE FILE GGSALES 
PRINT * 
ON TABLE SET ARGRAPHENGINE JSCHART 
ON TABLE PCHOLD FORMAT AHTML
END 
SET COMPONENT=R1 
GRAPH FILE GGSALES 
SUM DOLLARS 
BY STCD

You must include the command ON TABLE (or GRAPH) SET PREVIEW ON in a report or chart component to prevent that component from accessing the original cache file.

ON GRAPH SET PREVIEW ON
ON GRAPH SET LOOKGRAPH VBAR 
ON GRAPH PCHOLD FORMAT AHTML 
ON GRAPH SET STYLE *

All other components on the active dashboard must refer to the cache component using the ARDATA_REPORT property.

TYPE=REPORT,ARDATA_REPORT=DASHBOARDCACHE,$ 
ENDSTYLE 
END 
COMPOUND END

WebFOCUS