Chapter 3. Tools

Table of Contents

Data
Datepicker
Grid
Parameter
Report
Report List
Slider
Table
General
Blank
Button
Cardnav
Form
Freetext
HTML
Image
Label
Rectangle

Adding tools into a view enables you to customize the view components and display exactly what you need in the dashboard. Customizing the tools is implemented by drag and drop and easy settings, which enhances the efficiency and convenience of data analysis.

Follow the steps below to add a tool into a view:

  1. Open a dashboard and click the Edit button on the top panel. The dashboard turns into the Edit mode.

  2. Click the Cards tab on the left panel. The Cards explorer displays.

  3. Double-click the desired card where you want to place the tool. The card displays on the right panel.

  4. Click the Tools tab. Select from the General, Data and Todo categories. Drag the desired tool and drop it on the right panel. A view which contains the tool will be automatically created.

  5. Double-click the tool area and set the properties. You can set the view name, tool category, visibility state (visible or hidden), and Z Index. Z Index controls the position of a view moving behind or in front of other views. This could be a negative number or a positive number. When all views have a Z Index with Auto option selected, what makes them behind or in front of other views depends on the order in which the views are added to the dashboard. However, in some cases you have to manually set the Z Index to a positive number. For example, an Html view used to present a custom menu on a master card would normally stay behind all other views. But when you activate a sub menu, this should show in front of any other views, otherwise it may be partially hidden. Setting the Z Index to a positive value number would achieve this.

    Read on for more details on how to set each type of tool.

  6. You can preview the output of your settings on the right pane, which is adjustable by drag and drop. Click Apply and your changes will take effect.

Data

Datepicker

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the Datepicker after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the Datepicker into the desired output format, including HTML, PDF, XLSX and CSV. You can choose from the following output targets: Browser, Repository and Mail. You can also specify the render details, including page size and orientation (portrait or landscape).

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximize or restore the Datepicker in browser.

Data

  • URL: Upon your selection of Source, the related URL will automatically appear.

  • Source: Select from universe, view and embedded. A window will pop up, showing the tables under universe, view options, or schemas under embedded.

  • Parameters: After Source and URL are set, parameters will display (if any).

Type

  • Type:

    • single: This displays a single date.

    • range: This displays a range from one date to another date.

  • Label1: The label is customizable. The default label name is From. If you want to display a single date, only Label1 is necessary.

  • Label2: The label is customizable. The default label name is To. If you want to display a date range, both Label1 and Label2 are necessary.

  • Display:

    • pop-up: This will display a field and a calendar button in the Run mode. Click the button, and a calendar combo box will pop up.

    • inline: This will display a calendar combo box directly in the Run mode.

  • Mode:

    • time picker: This displays a calendar combo box and a slider with hours, minutes and seconds for you to choose the exact time.

    • date picker: This displays a calendar combo box for you to choose the date.

    • month picker: This displays two dropdown lists with months and years for you to choose the month in a year.

    • year picker: This displays a dropdown list with years for your selection.

  • Column: Specify a column from which the Datepicker will read data.

  • Min Date: Specify the minimum value for the date selection.

  • Max Date: Specify the maximum value for the date selection.

  • Date Format: Select one of the following date formats.

    • yy-mm-dd: e.g. 2012-06-01

    • D, dd M y: e.g. Fri, 01 Jun 12

    • D, d M y: e.g. Fri, 1 Jun 12

    • DD, dd-M-y: e.g. Friday, 01-Jun-12

    • D, d M yy: e.g. Fri, 1 Jun 2012

Filter

  • Add: In the Add Filter window, you can specify the field name, filter type and condition, as well as edit or delete the views. Refer to Table 3.1, “Filter Types”.

Table 3.1. Filter Types

Filter TypeDescription
less-thanThis will show the records which are less than the value in the Condition field.
more-thanThis will show the records which are more than the value in the Condition field.
equalThis will show the records which are equal to the value in the Condition field.
equal-nullThis will not show any records.
not-less-thanThis will show the records which are not less than the value in the Condition field.
not-more-thanThis will show the records which are not more than the value in the Condition field.
not-equalThis will show the records which are not equal to the value in the Condition field.
not-equal-nullThis will show all the records which are not null records.
less-than-or-equalThis will show the records which are less than or equal to the value in the Condition field.
more-than-or-equalThis will show the records which are more than or equal to the value in the Condition field.
in-datasetClick the checkbox near the Condition field. Select a view and column, or a universe and table. Upon your selections, the filter condition details will automatically display in the Condition field. Click OK and click Apply. Records in the dataset will display.
not-in-datasetClick the checkbox near the Condition field. Select a view and column, or a universe and table. Upon your selections, the filter condition details will automatically display in the Condition field. Click OK and click Apply. Records not in the dataset will display.

Grid

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the grid after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the grid into the desired output format, including HTML, PDF, XLSX and CSV. You can choose from the following output targets: Browser, Repository and Mail. You can also specify the render details, including page size and orientation (portrait or landscape).

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximize or restore the grid in browser.

Data

  • URL: Upon your selection of Source, the related URL will automatically appear.

  • Source: Select from universe, view and embedded. A window will pop up, showing the grids under universe, view options, or schemas under embedded.

  • Parameters: After Source and URL are set, parameters will display (if any).

Type

  • Single Select / Multiple Select: Set whether the user can have single selection or multiple selections in the Run mode.

  • Type: Select from the following options.

    • Grid: Display the grid directly.

    • Select: Display the grid as a drop down list.

    • Checkbox: Display the grid as check boxes.

    • Radio: Display the grid as radio buttons.

  • Count: Set the count of rows in the grid.

  • Direction: Select from the following options.

    • Down: Display the grid using the down then across direction.

    • Across: Display the grid using the across then down direction.

  • Column: Select the column from where the grid will read data.

Filter

  • Add: In the Add Filter window, you can specify the field name, filter type and condition, as well as edit or delete the filters. Refer to Table 3.1, “Filter Types”.

Parameter

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the report after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the report into the desired output format, including HTML and Simple HTML. You can choose from the following output targets: browser, mail, printer and userhome.

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximise or restore the report in browser.

Show Submit Button: Selecting this option means you can submit parameter values to dashboard, which in turn can be used by different views. For example, a Report view may require a parameter to display a report, and this parameter can be supplied at run time via the Parameter view. This option enables all form elements to be submitted together, otherwise submission is automatic on a per form element basis. For example, pressing Enter in the text field will submit only the text field.

Parameters: A list of parameters (if any) will show in the Parameter list. These parameters are required by various dashboards to show their content. The designer can choose some parameters or all of them to be presented as form elements on the form.

Report

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the report after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the report into the desired output format, including HTML and Simple HTML. You can choose from the following output targets: browser, mail, printer and userhome.

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximise or restore the report in browser.

Type

  • RML: Click Choose from repository... to set the RML file path, or type manually in the RML field.

  • Scrolling: If this option is selected, horizontal and vertical scroll bars will automatically display around the report view if they are required.

  • Paged: If this option is selected, there will be a page navigator when the report is broken up into pages.

  • Streamed: If this option is selected, the report will be one continuous page. This is opposite to the Paged option.

  • Parameters: Parameters will get loaded automatically (if any).

Report List

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the Report List after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximise or restore the report list window in browser.

Type

  • Heading: Type the heading for each report.

  • Tags: Type the tag for each report.

  • Show Preview: Enable you to preview the report in the designing process.

  • Output: You have the option to render the report list into the following formats: PDF, DOCX, CSV, EXCEL, and PRINT.

  • Report: Upon your clicking of the Refresh Reports button, parameters and values will be automatically loaded (if any).

Slider

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the slider after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the slider into the desired output format, including HTML, PDF, XLSX and CSV. You can choose from the following output targets: Browser, Repository and Mail. You can also specify the render details, including page size and orientation (portrait or landscape).

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximise or restore the slider in browser.

Data

  • URL: Upon your selection of Source, the related URL will automatically appear.

  • Source: Select from universe, view and embedded. A window will pop up, showing the tables under universe, view options, or schemas under embedded.

  • Parameters: After Source and URL are set, parameters will display (if any).

Type

  • Type:

    • date: Select this option to read data from a date column. Between the two ends of the Slider, the dates will display individually.

    • date-range: Select this option to read data from a date column. Between the two ends of the Slider, the dates will display as a range.

    • numerical: Select this option to read data from a numerical column. Between the two ends of the Slider, numericals will display individually.

    • numerical-range: Select this option to read data from a numerical column. Between the two ends of the Slider, numericals will display as a range.

  • Horizontal / Vertical: Select the direction of the Slider.

  • Label: Create a label name for the Slider.

  • Wrap Label Text: If this option is select, the label text will automatically wrap. Otherwise, the label text will not wrap but overlap.

  • Label Step: Set the label step for the Slider. For example, if the step equals to 1, there will be a label for every value. If the step equals to 3, there will be a label for every three values.

  • Show Tooltips: If this option is selected, a tooltip will display when a label is selected, and vice versa.

  • Column: Select a column from which the Slider will read data. The data type in the column must be consistent with the type of the Slider. For example, if you choose Slider > Type > Date, it is necessary to choose a column which contains date values.

  • Date Format: Select one of the following date formats.

    • yy-mm-dd: e.g. 2012-06-01

    • D, dd M y: e.g. Fri, 01 Jun 12

    • D, d M y: e.g. Fri, 1 Jun 12

    • DD, dd-M-y: e.g. Friday, 01-Jun-12

    • D, d M yy: e.g. Fri, 1 Jun 2012

Filter

  • Add: In the Add Filter window, you can specify the field name, filter type and condition, as well as edit or delete filters. Refer to Table 3.1, “Filter Types”.

Table

Actionbar

  • Show action bar: Fill in the title of the action bar, which will display above the table after you apply the changes. In the Run mode, actions can be activated by a few clicks.

  • Show info button: Fill in text and customize the format, which will display in the Run mode. Upon your click, the text you have entered will display in a text field, which can provide additional information and guide the user to proceed.

  • Show render button: A render button will display in the Run mode, which allows you to render the table into the desired output format, including HTML, PDF, XLSX and CSV. You can choose from the following output targets: Browser, Repository and Mail. You can also specify the render details, including page size and orientation (portrait or landscape).

  • Show filter button: A filter button will display in the Run mode. Upon your click, a filter editor will open.

  • Show maximise button: A maximise button will display in the Run mode, allowing you to maximise or restore the table in browser.

Data

  • URL: Upon your selection of Source, the related URL will automatically appear.

  • Source: Select from universe, view and embedded. A window will pop up, showing the tables under universe, view options, or schemas under embedded.

  • Parameters: After Source and URL are set, parameters will display (if any).

Type

  • Page Size: Set the maximum number of columns that will display on one page.

  • Single Select / Multiple Select: Set whether the user can have single selection or multiple selections in the Run mode.

  • Checkbox Selection: If this option is enabled, you can either select Left Column or Right Column to display the checkboxes at the left or right side of table columns.

  • Choose columns: After Data > Source is set, columns under that source will automatically display. Click Choose columns, and the Column Chooser window will display. Make your selections and click OK.

Filter

  • Add: In the Add Filter window, you can specify the field name, filter type and condition, as well as edit or delete filters. Refer to Table 3.1, “Filter Types”.