Excel Add-in Selection
  • 06 Sep 2024
  • 8 Minutes to read
  • Contributors
  • Dark
    Light

Excel Add-in Selection

  • Dark
    Light

Article summary

This section is about the Excel Add-in Sheet Selection, Workbook Selection, and Pagers; how to configure, edit, and reset them; and how to use Dynamic Selections directly from your Excel application with the Board Add-in.

contents/assets/images/excel.addin.selection.buttons.png

  • Sheet Selection. Creates a Select only on the current Sheet opened

  • Workbook Selection. Creates a Select on the whole Workbook, meaning the Select will apply to all the Sheets created in the Workbook

  • Dynamic Selections. Allows a dynamic selection based on the current period or based on data contained in Cubes

  • Pagers. Allows users to easily apply a Sheet Selection based on a single member of a given Entity

  • Select Settings. Additional settings for the Select

To configure a selection, click on the menu button for "Sheet Selection" or "Workbook Selection" and a popup window will appear.

The popup window consists of Data model tabs and a chart of Entities within each tab.

contents/assets/images/excel.addin.selection.window.nav.update.png

Below is what you see in the Selection window:

  1. Data model tabs. A tab for each Data model used in the Sheet for Sheet Selections or the Workbook for Workbook Selections is displayed at the top

  2. Left and right arrows. Below the tabs, you will see green left and right arrows to initiate an undo or redo

    • Left arrow. Undo Select action

    • Right arrow. Redo Select action

  3. Search bar. Search for an Entity in the list below

  4. Entity table. In the Entity table, you can select the Entities and their members to configure a selection

    • Entity. Lists the available Entities of the selected Data model. When you make a select on a particular Entity, a green checkmark will appear to the left of the Entity name in this column

    • Total. Reports the number of members the Entity has in total

    • Selected. Reports the number of members selected on that Entity if selected. If the Entity is not selected, the default is to show the same number as the Total column

    • % Selected. Show the percentage of the members selected for each Entity in number and bar format. If the Entity is not selected, the default is show the "% Selected" at 100%

    • Select Options. On the right of the "% Selected" column are three symbols to provide specific Select actions

      • Focus. Allows you to reset the selection in the hierarchy, while the contents of the selected Entity remain fixed. Read the Focus function for more details
         contents/assets/images/excel.addin.selection.focus.PNG

      • Dynamic. Allows a dynamic selection based on the current period or based on data contained in Cubes. As the period and data changes over time, the selection will adapt accordingly. The function behaves differently depending on whether the Entity to which it is applied is a Time Entity or a Non-Time Entity. Read about how to configure a Dynamic Entity selection


        contents/assets/images/excel.addin.selection.dynamic.PNG

      • Reset. Resets the Entity selection
         contents/assets/images/excel.addin.selection.reset.PNG

  5. Graphical View. View the Entities in graphical view. Select the Entity you want to apply a select on in the same way you would in the regular view. You cannot use the "Focus" or "Dynamic" selection features in this view

  6. Reset All. Resets any selections made to current Data model tab open

  7. Copy/Paste Select. Copies a selection made or pastes the selection. When pasting a selection, the selection can only be pasted within the same Data model. If you are working with multiple Data models, you can switch Data models by selecting the correct Data model tab for the selection above the Entity table (refer to number 1 in this list and image).

How to make a Selection

To make a selection, proceed as follows:

  1. Open the Selection window (for Sheet or Workbook)

  2. Select the correct Data model tab in which you would like to apply a selection

  3. Make a selection: either a selection, a focus selection, or a Dynamic selection.

    • Selection. Click on the Entity name in which you would like to apply a selection. When hovering over the name, the cell will highlight in yellow. A new popup window will appear. Choose all the members you would like to select or exclude and then click "Select" to select and "Exclude" to exclude

      The Entities available to a user to select in the Selection window can be regulated in the Select settings.

  4. Click OK to apply the selection.

contents/assets/images/excel.addin.make.selection.gif

If Workbook selections and Sheet selections are made on the same Entity, the Sheet selection is prioritized.

How to make Dynamic selections

Non-time Entities

To apply a Dynamic selection to Non-Time Entities, proceed as follows:

  1. Click on the Dynamic selection icon corresponding with the Entity in which you would like to apply it. Another popup window appears

  2. Select the checkbox to the left of the dropdown menu

  3. Choose the desired Cube you'd like to apply the Dynamic selection on. A selection based on all Entity members that have non-0 value on the chosen Cube will be applied

  4. Click OK to apply.
     contents/assets/images/addin.dynamic.select.png

When a Dynamic selection is made, the center of the Dynamic selection icon will be filled in with blue like the image shows below. 
 contents/assets/images/excel.addin.dynamic.select.applied.PNG

Read more about Dynamic Selections here.

Time Entities

To apply a Dynamic selection to Time Entities, proceed as follows:

  1. Click on the Dynamic selection icon corresponding with the Entity in which you would like to apply it. Another popup window appears
     contents/assets/images/excel.addin.dynamic.time.current.png

  2. Select the checkbox labeled "Enable Dynamic Selection" to enable. The following options are available:

    • Current date (default). Selects the time period (day/weekday/week/month/quarter/fiscal year/year) based on the system date

    • Based on Cube. Selects the time period based on the contents of a Cube, called driver Cube.
       contents/assets/images/excel.addin.dynamic.time.based.on.cube.png

      When "Based on Cube" is enabled, a Cube must be chosen in the dropdown menu and the following related configuration options become available:

      • Latest Period (default). Selects the latest available period with values in the Cube

    • Options. For both "Current Date" and "Based On Cube", the following options are available:

      • Period (default). Selects only the period returned in the Latest Period
         contents/assets/images/excel.addin.dynamic.time.period.png

      • Year to date. Selects all the previous periods of the year the latest period is part of, including the period returned in Latest Period
         contents/assets/images/excel.addin.dynamic.time.year-to-date.png

        For both the "Period" and "Year to date" options the following optional settings are available:

        • Previous period. Selects the period prior to the latest period with values in the Cube.
          For example, if you're configuring the selection on the Month Entity based on a Cube whose latest data pertain to July 2021, the June-2021 member will be selected.

        • Offset. Shifts the selection by "n" periods, where "n" is an integer number.
          When the offset value is positive, the selection will be shifted forward in time. When the offset value is negative, the selection will be shifted back in time

  3. Click OK to apply

Read more about Dynamic Selections here.

How to use Pagers

Pagers can be used in Excel Add-in similarly to how they are used in the Board Platform, providing a quick access to the Select function on a single Entity member, directly from an Excel Worksheet: typically, it's configured on an Entity whose members are the likely selection filters a user may want to apply to a dashboard. Pagers allow users to easily apply a Sheet Selection based on a single member of a given Entity: when you select a member, all all other Objects on the Sheet are immediately updated in order to show only data relating to the selected member.

To use Pagers, proceed as follows:

  1. Click on the Pagers button in the top menu of the Board Add-in. A side panel to the right of the Excel Sheet with the header "Pagers" appears
     contents/assets/images/excel.add-in.pager.button.png

  2. Click the button "New Pager".
     contents/assets/images/excel.add-in.pagers.png
    A popup window appears and the following options are available:

    • Database. Lists the available Data models. Choose the one you want to choose an Entity to associate with a Pager

    • Entity. Lists the available Entities of the chosen Data model. Choose one to apply to a Pager

      • No All. If enabled, forces a Pager to have at least one item selected at any time. If no default member is defined, the member that occurs first in alphabetical or numerical order is automatically selected based on its code or description

    • Period. Only available for Time Entities are the following options:

      • Current period. Sets the current time period (day/weekday/week/month/quarter/fiscal year/year) as default, based on the system date.
        For example, if you're configuring the selection on the Month Entity and the current date is January 7, 2022, the "January 2022" member will be selected.

      • Previous period. Sets the time period prior to the current one (day/weekday/week/month/quarter/fiscal year/year) as default, based on the system date.
        For example, if you're configuring the selection on the Month Entity and the current date is January 7, 2022, the "December 2021" member will be selected.

      • Last period. Sets the last time period (day/weekday/week/month/quarter/fiscal year/year) in the Time Entity as default.
        For example, if you're configuring the selection on the Month Entity and the last member in it is "December 2022", that member will be selected by default

  3. Click OK and the Pager will appear in the right-hand panel along with 2 buttons:

    • New Pager. Add a new Pager

    • Apply. Apply the Pager selection, as described in the next step

  4. Select an Entity from the dropdown menu of the Pager and click "Apply" to apply it to the Sheet.
     contents/assets/images/excel.add-in.pager.apply.png

The Pager has 3 icons to the right of of the dropdown menu, which are as follows

  • Reset. Resets the current Pager selection, if one exists

  • Remove  contents/assets/images/addin-pager.remove.png. Deletes the Pager

  • Edit  contents/assets/images/add-in.pager-edit.png. Edits the current configuration of the Pager

Read more about Pagers here.

Select Settings 

Select Settings offers Power Users and Developers the ability to manage the visibility of Entities in the Select window. Select Settings offers are only accessible by Power Users and Developers.

To restrict the visibility of Entities available for an end user when making a Select, proceed as follows:

  1. Click on "Select Settings" and the Select Options window opens which displays a restricted list of Entities showing only Entities which are relevant in that Sheet (i.e. in other words the Select Window can now be configured like a list of Selectors for end users)

  2. Select the Entities you would like to be visible to the end user, excluding the ones you would like to hide, in both the Sheet tab and the Workbook tab, depending on your desired configurations

  3. Click "OK" to save the visibility configurations

These visibility settings are only applied if an end user (Lite and User license) connects to the workbook. To learn more, read the About Select settings section.
 contents/assets/images/select.options.addin.png

Select settings are saved at the "Sheet" level for each Data model in use.
If these settings are activated, the dynamic selection options and the "Graphical view" representation are disabled in the Select window for the end users.


Was this article helpful?