Last modified by Aurelie Bertrand on 2025/07/22 14:38
Show last authors
1 (% class="box infomessage" %)
2 (((
3 🙋 This tutorial is intended for **advanced users**.
4
5 ⏱ It is designed to be followed independently in **1 hour**.
6 )))
7
8 ----
9
10 {{ddtoc/}}
11
12 ----
13
14 = Introduction =
15
16 In this tutorial, we are goint to discover how to create and apply an Alerter (or alerter format), using two examples.
17
18 The Alerter format is used to modify the display of data according to its value, using specific text, colors or icons. This makes it quick and easy to identify data requiring specific attention.
19
20 The dataset "retail" used in the tutorial corresponds to fictitious data from a retail company containing product information and data such as price, turnover, margin, etc.
21
22 This tutorial takes place in the Studio.
23 The steps of this tutorial are as follows:
24
25 * Creation of the data model based on the file retailen.xlsx
26 * Creation of tables showing turnover and margin data
27 * Creation of new alerter formats
28 * Application of alerter formats and vizualisation of results
29
30 = Prerequisites =
31
32 In order to complete this tutorial, you need to :
33
34 * have installed DigDash Enterprise version 2025R1 or higher;
35 * be a user with the**"Data model designer**" authorization group;
36 * download the Excel file [[retailen.xls>>attach:retailen.xls]].
37
38 (% class="box" %)
39 (((
40 ℹ The screenshots in this tutorial were produced using the Chrome browser. There may be slight differences depending on the browser.
41 )))
42
43 = Step 1: Create and configure the data model =
44
45 == Import the data source retailen.xls ==
46
47 Here we're going to import the data from the Excel file retailen.xls downloaded earlier. To do this:
48
49 1. Launch the Studio.
50 1. Click the **Models** tab.
51 1. Click the **New model** button.
52 1. In the **Create a new data model** box, select **All types **in the **Files **section; Then add and select the file //retailfr.en//.
53 1. Click **OK**.
54
55 The **Excel File **window appears. It offers data selection options and a preview of the data. Here we will configure the data model.
56
57 == Configure the data model ==
58
59 The elements in the first row of the table correspond to the heading of the data in each column. We are therefore going to use them as column headings. To do this, in the **Data selection** section, check the **First row as header** box.
60
61 === Filter product families ===
62
63 Here we are going to concentrate on the product families:
64
65 * Housing
66 * Deli
67 * Dessert
68 * Tickets
69
70 We are therefore going to filter the rows for which the **Product** **Family **field is equal to the above values. To do this, in the **Data selection** section :
71
72 1. Click the **Add...** button.
73 1. In the **Edit filter rule** box, select** Product Family**, then **match regular expression **and fill in **Housing|Deli|Dessert|Tickets**.
74 [[image:Rule_family_product_FR.png]]
75 1. Click** OK**.
76 ➡ The other members of the **Family **dimension are greyed out.
77 1. Click the **Next** button at the bottom right to open the **Advanced configuration** window.
78
79 === Create the measures Sales (Year - 1) and Sales ~(% Progression) ===
80
81 We are now going to create 2 new measures using the assistant: Sales (Year - 1) and Sales ~(% Growth) in order to obtain the change in revenue from one year to the next. To do this:
82
83 1. In the **Columns** tab, click the **New measure** button.
84 1. Click **Calculated measure**:
85 1*. For the measure **Sales (Year - 1)**, drag and drop the **Year - 1** function from the **Transformer **tab onto the** Sales** measure.
86 [[image:Sales_y-1_EN.png||alt="Sales-1" height="608" width="1073"]]
87 1*. For the measure **Sales ~(% Progression):**
88 1**. Drag and drop the **% Progression** function from the **General **tab onto the** Sales** measure.
89 1**. Define the progression between the **First measure**: //Sales (Year-1) //and the **Second measure**: //Sales.//
90 1**. Select the **Format **: //Percentage //and click **OK**.
91 [[image:Sales_progression_FR.png||alt="Sales progression"]]
92 ➡ The calculated measures are added to the list of columns.
93 1. In the** Properties** tab, enter **retailen** as name for the data model and then click **Finish **at the bottom right to save it.
94
95 Now that the data model retail is configured, we can create the charts based on this model.
96
97 = Step 2: Create the charts =
98
99 We are now going to create the charts in which we will use the alerters. They will be based on the data model //retailen//.
100
101 To create a chart (flow), in the **Flows** tab, click the **New {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}}** button and then select the desired flow.
102
103 (% style="line-height: 1.2; text-align: justify;" %)
104 == Table "Sales by Product family" ==
105
106 1. Create a new {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} and select **{{glossaryReference glossaryId="Glossary" entryId="Tableau croisé"}}Cross table{{/glossaryReference}}** as type.
107 1. Select the data model and enter the name **Sales by Product family**.
108 1. Drag and drop the dimension the **Family **onto the **Column 1** axis.
109 1. Place the measures **Sales**, **Sales (Year-1)** and **Sales ~(% Growth)** on the **Line 1** axis.
110 [[image:Salbes_by_family_FR.png||alt="Sales by family" height="532" width="1014"]]
111 1. Click the sort button for the **Column 1** axis and apply a descending sort to the measure **Sales**.
112 [[image:Sorting_sales_EN.png]]
113 1. Click **OK **to save.
114
115 (% style="line-height: 1.2; text-align: justify;" %)
116 == Table "Sales and margin for housing products" ==
117
118 1. Create a new {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} and select **Table** as type.
119 1. Select the data model **retailen **and enter the name **Sales and margin for housing products**.
120 1. Place the **Product **dimension on the **Column 1** axis.
121 1. Place the **Sales **and **Margin **measures on the** Column 2 **and **3** axes.
122 1. Filter the** Product Family **on the** **member **Housing**.
123 [[image:Sales_margin_housing_FR.png]]
124 1. Click **OK** to save and confirm saving the filter.
125 [[image:Saving_filters_EN.png||alt="Saving filter"]]
126
127 = Step 3: Create alerter formats =
128
129 We are now going to create the alerters or alerter formats that we will use in the tables we created earlier.
130
131 To create a new alerter :
132
133 1. Go to the **Managers **tab and select **Formats** to open the Format editor.[[image:Format_manager_EN.png||height="436" width="879"]](((
134 ➡ The **Format editor** opens and lists the available types and formats.
135 )))
136 1. Select the format type **Alerter** and click the **+** button.
137 [[image:Format_editor_+_EN.png||height="508" width="874"]]
138
139 == Create the alerter "_tutorial_progression" ==
140
141 We are going to create a first alerter to highlight the percentage increase of sales in the table "Sales by Product family":
142
143 * A red downward arrow for negative progession
144 * A grey equal sign for zero progression
145 * A green up arrow for positive progression
146
147 1. Create a new alerter with the name **_tutoriel_progression **and the role **(None)** (no role restriction).
148 [[image:Format_name_tuto_progression_EN.png||alt="Format name" height="165" width="367"]]
149 ➡ The new alerter is added to the list on the left.
150 1. In the **Language **field on the right, leave **Default**: the alert will apply by default to all languages.
151
152 (% class="box infomessage" %)
153 (((
154 💡 It is possible to select the language for which the alerter will be effective. In this way, we can disassociate a behaviour from the alerter format depending on the user's language.
155 )))
156
157 (% start="3" %)
158 1. Click the **+** button in the **Edit format...** section on the right to configure the different outputs:
159 1*. **Zero progression :**
160 1*1. For the **Input Type**, select //Value //and enter //0//.
161 1*1. For the **Output Type**, select //Colour + icon// with //Percent// **Format**.
162 1*1. Then select the grey equal sign as **//Image//**.
163 [[image:Zero_alerter_EN.png||alt="Zero output"]]
164 1*1. Click **OK**.
165 1*. **Negative progression :**
166 1*1. For the **Input Type**, select //Range//.
167 1*1. Then select //-infinite// for the **Minimum **and enter //0// for the **Maximum**.
168 1*1. For the **Output Type**, select //Colour + icon// with //Percent// **Format**.
169 1*1. Then select the red down arrow sign as **//Image//**.
170 [[image:Neg_alerter_EN.png]]
171 1*1. Click **OK**.
172 1*. **Positive progression :**
173 1*1. For the **Input Type**, select //Range//.
174 1*1. Then enter //0// for the **Minimum **and select //+infinite// for the **Maximum**.
175 1*1. For the **Output Type**, select //Colour + icon// with //Percent// **Format**.
176 1*1. Then select the green up arrow sign as **//Image//**.
177 [[image:Pos_alerter_EN.png||alt="Positive alerter"]]
178 1*1. Click **OK**.
179 ➡ The alerter items are listed.
180 [[image:1753169682786-137.png||alt="Alerter" height="448" width="1190"]]
181
182 (% class="box infomessage" %)
183 (((
184 💡You can create several layouts for your alerter.
185 Note also that the layout defined as **Default **will be used if no other layout applies to the data and that the order of priority for layouts is from top to bottom.
186 )))
187
188 == Create the alerter "_tutorial_margin" ==
189
190 We're going to create a second alerter to highlight the margin value for the table "Sales and margin for housing products".
191 Here, we're going to fill in the background of the data in green for any numerical value greater than or equal to 500. We will also add formatting to display data below the numerical value 480 in red:
192
193 1. Create a new alerter format with the name **_tutorial_margin **and the role **(None)** (no role restriction).
194 ➡ The new alert is added to the list on the left.
195 1. In the **Language **field on the right-hand side, leave **Default**: the alert will apply by default to all languages.
196 1. Click the **+** button in the **Format Editing** section on the right to create the different layouts:
197 1*. **Margin greater than 480 :**
198 1*1. For the **Input Type**, select //Value//.
199 1*1. Then enter //480// for the **Minimum **and select //+infinite// for the **Maximum**.
200 1*1. For the **Output Type**, select //Color// with //Number// as **Format**.
201 1*1. Then select the **Fill color** (green: #71c31f).
202 [[image:Alerter>480_EN.png||alt="Margin greater"]]
203 1*1. Click **OK**.
204 1*. **Margin less than 480 :**
205 1*1. For the **Input Type**, select.
206 1*1. Then**// //**select //-infinite// for the **Minimum **and enter //450// for the **Maximum**.
207 1*1. For the **Output Type**, select //Color// with //Number// as **Format**.
208 1*1. Then select the **Fill color** (red: #d95858).
209 [[image:Alerter<480_EN.png||alt="Margin less"]]
210 1*1. Click **OK**.
211 ➡ The alerter items are listed.
212 [[image:tutorial_margin_EN.png||alt="_tutorial_margin" height="515" width="926"]]
213
214 (% class="box infomessage" %)
215 (((
216 💡Using an alerter to change the background color is a classic format application.
217 You can also use alerter to change the output format according to the input data (for example, Percentage instead of Number).
218 )))
219
220 The creation of the alerters is now finished: click **OK** at the bottom right to save and close the **Format editor**.
221 We're now going to assign the alerters to the data.
222
223 = Step 4: Apply the alerter to the data =
224
225 It is possible to apply an alerter format to a flow or a data model.
226 It is generally recommended to apply an alerter format to the flow used to display the desired information.
227 Indeed, by applying a format to the data model, you will affect all the flows using this model. Similarly, if you edit an existing model by assigning an alerter or other format, then when the {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} is synchronized again, the data displayed will be modified.
228
229 Here we are going to apply the alerter formats to the Flows.
230
231 == Progression alerter ==
232
233 1. Open the table "Sales by Product family" from the **Flows **tab in the Studio.
234 1. Right-click the measure **Sales** **~(% Progression)**.
235 1. In the context menu that appears, click on **Apply a format** > **Alerter** > **_tutorial_progression (Alerter)**.
236 **[[image:Apply_alerter_progression_EN.png||alt="Apply alerter"]]**
237 \\➡ The display of the measure //Sales// //~(% Progression)// is modified.
238 [[image:Sales_progression_alerter_EN.png||alt="Display modified"]]
239 1. Select a year in the **Date** filter, for example 2017, to view the case of positive or negative progression.
240 [[image:Sales_progression_eg_EN.png]]
241
242 == Margin alerter ==
243
244 1. Open the t//able "Sales and margin for housing products" //from the **Flows **tab.
245 1. Right-click the measure **Margin**.
246 1. In the context menu that appears, click **Apply a format** > **Alerter** > **_tutorial_margin_tutorial (Alerter)**.[[image:Apply_alerter_margin_EN.png||alt="Apply alerter"]](((
247 ➡ The display of the //Margin// measurement is modified accordingly.
248 [[image:Sales_margin_eg_EN.png||alt="Margin alerter"]]
249
250 = Congratulations! =
251
252 You have successfully created and applied your first alerter formats.
253
254 Alerter formats allow more advanced formatting than a simple format or combination of colors and formats. You can display text in the user's language or display icons. It is possible to combine several alerters, as mentioned above.
255 Moreover, alerters can be applied to many types of charts, not just tables.
256
257 The possibilities are endless, and it's up to you to discover all their facets!
258
259
260 )))