Query SetCards

The SetCard Designer can be found under "Administration > Documentation":

Query Set Card Designer in the Documentation Dropdown of the Administration ribbon

SetCards offer the functionality to export a Query into Excel, based on a user-defined layout model. This has the advantage that the content of the Excel documentation of queries can be adapted to the needs of the user even better.

If the Word documentation of Queries should be customized, then this must be done via the Settings Variants. The SetCards only affect the Excel documentation of Queries!

How to define a new SetCard?

In order to create a new SetCard open the SetCard Designer press “Create SetCard”, assign a name for the SetCard and press “create”. By default, the application will suggest a name for the SetCard in the following format: SetCard_[number]. Afterward, you can enter a description and save the SetCard by pressing “Save SetCard”.

The toolbar of the SetCard Designer:

Toolbar with Create, Save, Properties, Delete and Clear All buttons

Create, Save, Properties, Delete, Clear All

Properties of SetCards

In the properties dialog, you can rename the SetCard, select a font and font style and define a color scheme. The selected styles are applied to all items that are already added and all items that will be added.

Adding Categories and Properties

You can select a category via a dropdown. After selecting a category you can drag and drop the listed properties to the blue design area on the right. You can also add properties to the design area by double-clicking them. The added properties are automatically sorted by the corresponding categories.

Drag and Drop properties from the selection menu in the left to the design area in the right.

The following categories are available:

Query properties
Lists properties that relate directly to the Query itself like the description and the InfoProvider of the Query.

Variables
This category lists properties for all kinds of variables (characteristic variables, hierarchy variables, hierarchy node variables, text variables, formula variables) that are used in the Query.

Base Key Figures
This category contains properties of all Base Key Figures that are directly used in the Key Figure structure.

Calculated Key Figures
This category contains properties of all Calculated Key Figures that are directly used in the Key Figure structure.

Restricted Key Figures
This category contains properties of all Restricted Key Figures that are directly used in the Key Figure structure.

Key Figures (all types)
This category contains properties of all Base Key Figures, Restricted Key Figures and Calculated Key Figures that are used in the Key Figure structure.

Characteristics
This category contains properties of all drilldown characteristics, restrictions and free characteristics.

Free characteristics
This category enables the user to list all free characteristics and their properties.

Local Selections and Formulas
This category lists all formulas and selections in structures that represent more than a single Key Figure.

Filters
This category lists the properties of characteristics in the restrictions of the Query.

Hierarchies
This category lists reusable hierarchies of characteristics when they are used in the Query.

In order to quickly add the desired properties of a category, it is possible to select multiple properties for drag and drop. To do so you can hold shift to select a range of properties. Or you can hold control in order to select any properties individually. You can also press control and A to select all properties of a category.

Custom field (manual input)

With this property, it is possible to add as many fields to the SetCard as you need. After you added the field to the SetCard you can double click on it in order to rename it. This allows for a custom field which is added to the exported excel but need manual input and are not filled during the export.

Customizing your SetCard

By right-clicking on a category or property in the design area, you can choose different options to change colors, font styles or add and remove empty rows between categories. By drag and drop, you can also change the order of categories and properties on the design area. To remove items from the design area just drag and drop them to the left, outside of the design area or choose remove from the context menu. Clear all will remove all items from the design area. In order to rename the selected SetCard or change the font, you can choose “Edit properties” in the toolbar. You can also rename categories and properties by double-clicking them in the design area.

The context menu shows the available options

It is possible to adjust the width of the columns by going between two properties and dragging the cursor. This enables the user to give certain columns more or less space even before the export.

The following features are not yet supported and may be available in future releases:

Reusable Filters
Structures
Cell Definitions
Aggregations for local selections and formulas

Generating Query-SetCard documentations

In order to export a Query with the created SetCard, you have to select the Query in the entities tab and choose from context menu “Create documentation >xlsx file”. Then you can select a SetCard and start the export:

When the export is done, the created Excel file will open. The first sheet contains the actual SetCard with the designed layout.