About the Layout

The Layout Object defines a query on an existing multidimensional Data model. It specifies what (Cubes, Entities, and calculated fields) and how (the aggregation level) data should be retrieved from an existing Board Data model.

A Layout can be associated with a data visualization Object, such as a Data View, a Chart, a Gauge, and others, or it can be a step in a Procedure.

When using the Layout for a data visualization Object, you'll be able to simultaneously define a dataset and where to view it in the associated Object.

When a Layout is executed, the retrieved dataset is dynamically filtered by multiple layers of filters:

• the user security profile selection

• the Screen Select

• the Pagers and Selectors selections

• and the Layout Select.

First, the selection filters are applied, then the query is executed, and the data is retrieved from the Data model.

Read about the Select application sequence for more details.

Layout refresh

Whenever a Screen is opened, both in Design and Play mode, all Layouts associated with the Objects on the Screen are refreshed. This happens also when a Data entry action is performed and the "Refresh on Data entry" option is enabled under Screen Properties. If that option is disabled, only the Layout associated with the Object affected by the Data entry action is executed.

The "Refresh Screen" Procedure step and the "Refresh" button in the Top Menu also refreshes all Layouts.

Layout Editor

Depending on the Object the Layout is associated with, the Layout editor may have slightly different features and configurations available. These differences are highlighted in the documentation of each Object.

Here's a breakdown of the main elements of the Layout Editor interface:

1. Layout title. It's good practice to give your Layout a title, as this information is used in Substitution formulas and is showed in certain Objects

2. Data model. Shows the Data model on which the Layout is executed. In case the multiple Data models mode is enabled in the Screen Properties, a dropdown menu will allow you to select a Data model among those existing in the Platform

3. Data panel. The grey panel on the left contains all elements that can be used to define the Layout query. A tabbed menu on the top of the panel gives you access to the following sub-pages, showing:

   • Data. A list of available Cubes from the selected Data model

   • Entities: A list of available Entities from the selected Data model

   • More: A list of rules from the selected Data model, ranking functions, and an Algorithm placeholder

     You can configure the Layout query by dragging and dropping elements from the Data panel into the Data area, the Axes area, or the Object preview pane (if enabled). Dragging and dropping the Algorithm placeholder allows you to create a Data Block calculated with a formula based on other Data Blocks of the Layout.

4. The Data area. Here you can define the Data Blocks (or columns) of the Layout. It accepts Cubes, Algorithms, Rules, Ranking function, Entities, and Relationships

5. The Axes area. Here you can define the aggregation level of the Layout query and set the Entities that will be displayed in Rows, Columns, Categories, and/or Series, depending on the Object. You can also configure additional Axes-related properties

6. The Select area. Here you can define selections to apply only to the Layout you're configuring  

7. The Filter and sort area. Here you can add additional sorting and filtering settings based on Data Block values  

8. The Object settings area. Here you can customize Object layout settings. Read more about common Object settings in the paragraph below

9. The Overview area. Here you can see all of your configurations listed out on one page and if any issues are present in the Layout configuration  

10. The Object preview pane. Shows a preview of the Screen Object defined by the Layout. The preview will update every time the Layout configuration is changed. Click on "Preview" to open the Preview pane and the small X in the bottom right corner of the Preview pane to close it.   The "Auto-refresh" toggle on the right lets you turn on and off the automatic update of the Object preview. If activated, this option will refresh the Layout with each change made to the dataset

    If you're working with huge data sets, it is advisable to turn off the automatic refresh of the Object preview, by disabling the “Auto-refresh” toggle, in order to avoid slowdowns during the Layout configuration.

Object settings

From the Object settings subpage, you can configure additional Object Layout properties for each Screen Object. Object settings differ for each Object. The common Object settings found in Objects that require a Layout (except for the Tree Object) are the following:

• Dynamic Options. Dynamically define some format and interaction options which are always found in the Layout editor for every Object and are the following:

  • Visibility. If the Block value is zero (0), the Object disappears

  • Transparency. Any number between 0 and 100 determines the transparency rate of the Object. A lower value creates a higher transparency

  • Enabled. If the Block value is zero (0), the Object won't execute an action

    These behaviors can be inverted by checking the Inverse option. These behaviors can be combined. For those options to work properly, be sure to deselect the Hide zeroes property for the Data Block in the Block settings panel.

The Quick Layout is a feature found under Object settings only for Data Views and Chart Objects. Here, you can define the capabilities and/or restrictions of the Layout configurations for the end user in Play mode. Read about the Quick Layout to learn more.

Other interactive elements of the Layout editor

The icons in the top left corner of the Layout editor allow you to:

• Edit . Edit the Layout Editor name. This will display alongside the Data model after the hyphen (-)

• Open Data model  .  Open the Data model page to configure selected Data model or create a new one

• Search function . Located in the menu of the Data area in the table below, click on the magnifying glass icon to search the Data panel

The icon in the top right corner of the Layout editor allow you to:

• View. You can click on the double-sided arrow in the right corner to enlarge the window to full-screen, and back to the smaller window size by clicking the two arrows facing one another  in the same location

The icon in the bottom right corner of the Layout editor allow you to:

• Preview. Select this button to view a preview of the Object defined by your Layout

• Add  . Click to open a menu and add a Cube, Algorithm, Entity, Ranking function, or Rule to the Data area

• CANCEL. Cancel any changes

• APPLY. Apply changes without refreshing the Screen. This option will be available when you create at least one data block or edit an existing Layout

• SAVE. Clicking "SAVE" will apply changes, save changes, close out the Layout Editor, and refresh the Screen automatically to reflect any changes

The icons in the bottom left corner of the Layout editor allow you to:

• Copy Layout . Copy the configuration of the Layout.

• Paste Layout . Paste the configuration of the Layout

• Clear Layout . Clear the Layout configuration to start again

The "SOLVE ISSUES" button at the bottom right corner of the page will appear if the Layout has been configured incorrectly. Click on it to receive further information.