Last modified by Ian Covey on 06/11/2025, 14:24

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 (% class="lead" %)
6 Learn how to create a basic Pages report, to better understand the functionality of the Pages interface and the relationship between Pages, Layers and Components.
7
8 Pages allows you to quickly create powerful interactive, reporting dashboards using an intuitive drag-and-drop interface. This guide will help you get up and running with that interface.
9
10 Covering the considerations that you’ll have to make, and the functionality that you’ll need to use, to create a basic Pages report.
11
12 To create a basic Pages report, you need to:
13
14 1. Set up your Pages workspace.
15 1. Add reporting components.
16 1. Resize and reposition components on the report’s workspace.
17 1. Save and share your report.
18
19
20 = Who can create a Pages report? =
21
22 If you want to create a Pages report, your CXAir user must have been granted the Pages user functionality permission or have been added to a CXAir user group that has been granted the permission.
23
24
25 = Setting up your workspace =
26
27 Think of your workspace as the digital representation of a single page in a physical report. But because it’s digital, it also allows you to add some clever interactive.
28
29 So, when creating a Pages report, the first step should always be ensuring that the workspace looks and behaves how you want it to do.
30
31 In practical terms this means setting the options for:
32
33 * The whole Report.
34 * Each individual Page.
35
36 (% class="box" %)
37 (((
38 You should always configure your report before adding any components as changing some of the following settings resets the report – removing all components that have been added. This guide covers the commonly used options that you’ll need to define when creating a basic Pages report. While there are additional options, we’ll ignore them for the purpose of this guide.
39 )))
40
41 [[Learn more about the Structure of a Pages Report>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.01\. The Structure of a Pages Report.WebHome]] >
42
43
44
45 == Setting Report options ==
46
47 The Report options allow you to set the size of every page in your report, what elements appear on those pages and how the workspace behaves.
48
49 To set the Report options:
50
51 1. Click anywhere on the workspace. This displays the Report Style icon on the Dynamic Toolbar.
52 1. Click the Report Style icon to display the Report Style pop-up dialog box.
53
54 These are the essential options you should consider setting:
55
56 **Page Size**
57
58 Though Pages enables you to share reports electronically, you might also need to save and share these reports as PDFs – either to take a snapshot of a moment in time or to share the report with those unable to access CXAir.
59
60 Ensuring that your workspace is the same size as the popular paper sizes, makes the saving process seamless.
61
62 The Page Size option allows you to select from a common set of paper sizes (for example, A4) and monitor display sizes.
63
64 **Cell Size**
65
66 This sets the size of the grid cells on your workspace.
67
68 By default, components ‘snap’ to grid cells. This makes it easier for you to position and align the components on your report.
69
70 Setting the cell size to “Small” give you greater control over the position of components on your workspace.
71
72 **Show Header & Footer**
73
74 This option allows you to add a text component to the top and bottom of every page in your report. The text and images that you add to one these areas are duplicated across all other pages.
75
76 Selecting “Yes” to show headers and footers makes it easy for you to add titles, logos and copyrights to your reports but removes the flexibility of having different information of different pages.
77
78
79 == Setting Page options ==
80
81 The Page options allow you define how your page will look and feel and how it will interact with the data used by the components you add to the page.
82
83 (% class="box" %)
84 (((
85 Page options can be set for each individual page in your report and will only affect that page.
86 )))
87
88 To access the Page configuration options:
89
90 1. Click the Page title in the Report Structure Panel. This displays the Page Style icon on the Dynamic Toolbar.
91 1. Click the Page Style icon to display the Page Style pop-up window.
92
93 These are the essential options you should consider setting:
94
95 **Orientation**
96
97 This allows you to set the orientation of each page in your report.
98
99 By default, this is set to portrait, making your workspace taller than it is wide.
100
101 Setting this to “Landscape” makes the report wider than it is tall, reflecting both the dimensions of a monitor and of the layout common in static reports created in PowerPoint.
102
103 **Background Colour**
104
105 Clicking this field displays a colour picker, that enables you to select a colour that will be applied to the background of this page in your report.
106
107 When selecting a colour, keep in mind readability (not just text by chart lines and columns, and gauge areas) and also whether to document is likely to be printed.
108
109 **Auto Refresh**
110
111 By default, data in a Pages report is ‘frozen’ – components display the latest data at the moment the report is opened.
112
113 If your report includes data that’s frequently updated, or the report will be displayed on screen for long periods, you can specify frequency (in seconds) with which the data is automatically refreshed.
114
115
116 = Adding Reporting Components =
117
118 Once you’ve set up your workspace, you can begin building your report by adding components to it.
119
120 As we’re only creating a basic Pages report, we’ll focus on adding the 5 components that display data in your report:
121
122 * Crosstab
123 * Chart
124 * Gauge
125 * Saved Query
126 * Venn
127
128 To add a component:
129
130 1. Click the icon on the Dynamic Toolbar for the report component that you want to add, then drag it onto the Workspace.
131
132 (% style="margin-left:36.0pt" %)
133 This displays a green outline, indicating the position of component when you drop it onto the workspace.
134
135
136 The next step changes depending on the type of component that you’ve just dragged onto the workspace.
137
138 == Adding a Crosstab ==
139
140 Dragging the Crosstab icon onto the workspace displays a small pop-up menu giving you the option to choose whether to:
141
142 * **Create New –** this gives you access to CXAir’s crosstab builder functionality enabling you to select the row & columns, the measures and conditions, the layouts and drill functionality for a new instance of a crosstab.
143 * **Load Existing –** this option allows you to add an existing saved crosstab (that uses the currently selected Index) to your workspace. This creates a new version of the selected. Any changes made to the crosstab only affect the instance added to your Pages report.
144 * **Link Existing –** like Load Existing, this option allows you to select a previously built crosstab to you report. However, any changes you make to the crosstab in the Pages report are reflected back in the saved version.
145
146 Click the **Save Crosstab** button to add the crosstab to the workspace.
147
148 [[Learn more about Crosstabs>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.03\. Crosstabs.WebHome]] >
149
150
151 == Adding a Chart ==
152
153 Dragging the Chart icon onto the workspace displays a small pop-up menu giving you the option to choose whether to Create New, Load Existing or Link Existing.
154
155 * **Create New –** this gives you access to CXAir’s chart builder functionality enabling you to select the row & columns, the measures and conditions, the layouts and drill functionality for a new instance of a chart.
156 * **Load Existing –** this option allows you to add an existing saved chart (that uses the currently selected Index) to your workspace. This creates a new version of the selected. Any changes made to the chart only affect the instance added to your Pages report.
157 * **Link Existing –** like Load Existing, this option allows you to select a previously built chart to you report. However, any changes you make to the chart in the Pages report are reflected back in the saved version.
158
159 Click the **Save Chart** button to add the chart to the workspace.
160
161 [[Learn more about Charts>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.2ci\. Charting.WebHome]] >
162
163
164 == Adding a Guage ==
165
166 Dragging the Guage icon onto the workspace displays CXAir’s gauge builder, enabling you to select the rows, measures and conditions used, the layouts and drill functionality and the type of gauge.
167
168 Click the **Save Gauge** to add the gauge to the workspace.
169
170
171 == Adding a Query ==
172
173 Dragging the Query icon onto the workspace displays the Saved Query dialog. This allows you to select and configure a previously saved CXAir query.
174
175 Click the **…** button next to the Saved Query field to display a list of all the saved queries.
176
177 (% class="box" %)
178 (((
179 Only saved queries built using the currently selected index are shown.
180 )))
181
182 Click on the name of the saved query you want to use to select it.
183
184 Click the **Apply** button.
185
186 [[Learn more about Queries>>doc:Technical Documentation.CXAIR.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Query.WebHome]] >
187
188
189 == Adding a Venn ==
190
191 Dragging the Venn icon onto the workspace displays the Venn Report dialog.
192
193 Click the **…** button to the Venn Report field to display a list of all the saved Venn reports.
194
195 (% class="box" %)
196 (((
197 Only Venn reports built using the currently selected index are shown.
198 )))
199
200 Click on the name of the Venn report you want to use to select it.
201
202 Click the **Apply** button.
203
204 [[Learn more about Venns>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2d\. Venn Diagrams.WebHome]] >
205
206
207
208 = Resizing & Repositioning Components =
209
210 By default, when a new component is added to the workspace it appears as a small square. But to make sure it fits with the position of other components, it gives the correct visual priority and that its contents are readable, you’ll most likely want to resize and reposition the component.
211
212
213 == Resizing components ==
214
215 To resize a component:
216
217 Hover over the component to displays the component’s 8 resizing drag handles. These allow you to resize a component horizontally, vertically, and diagonally by clicking then dragging the appropriate handle.
218
219 Clicking the component displays additional layout options on the Dynamic Toolbar:
220
221 (% border="1" cellspacing="0" class="MsoTableGrid" style="border-collapse:collapse; border:solid windowtext 1.0pt" %)
222 |(% style="background-color:#f2f2f2; background:#f2f2f2; border-color:#000000; border-style:solid; border-width:1pt; width:84.8pt" width="113" %)(((
223 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
224 (% style="color:black; line-height:normal" %)**Component**
225 )))|(% style="background-color:#f2f2f2; background:#f2f2f2; border-color:#000000; border-style:solid; border-width:1pt; width:92.15pt" width="123" %)(((
226 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
227 (% style="color:black; line-height:normal" %)**Layout Option**
228 )))|(% style="background-color:#f2f2f2; background:#f2f2f2; border-color:#000000; border-style:solid; border-width:1pt; width:273.85pt" width="365" %)(((
229 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
230 (% style="color:black; line-height:normal" %)**What it does**
231 )))
232 |(% rowspan="4" style="border-style:solid; border-top:none; border-width:1.0pt; width:84.8pt" width="113" %)(((
233 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
234 (% style="line-height:normal" %)Crosstab
235
236 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
237 (% style="line-height:normal" %)Query
238 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:92.15pt" width="123" %)(((
239 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
240 (% style="line-height:normal" %)Fit to container
241 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:273.85pt" width="365" %)(((
242 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
243 (% style="line-height:normal" %)Resizes the component, in Run mode, to ensure it fits the smallest dimension, either the width or the height, of the container’s defined space, set in Edit mode.
244 )))
245 |(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:92.15pt" width="123" %)(((
246 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
247 (% style="line-height:normal" %)Fit Width
248 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:273.85pt" width="365" %)(((
249 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
250 (% style="line-height:normal" %)Resizes the component, in Run mode, to ensure it fits in the width of the container’s defined space, set in Edit mode.
251
252 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
253 (% style="line-height:normal" %)This may add a vertical scroll bar to the component in Run mode.
254 )))
255 |(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:92.15pt" width="123" %)(((
256 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
257 (% style="line-height:normal" %)Fit Height
258 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:273.85pt" width="365" %)(((
259 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
260 (% style="line-height:normal" %)Resizes the component, in Run mode, to ensure it fits in the height of the container’s defined space, set in Edit mode.
261
262 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
263 (% style="line-height:normal" %)This may add a horizontal scroll bar to the component in Run mode.
264 )))
265 |(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:92.15pt" width="123" %)(((
266 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
267 (% style="line-height:normal" %)Original Size
268 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:273.85pt" width="365" %)(((
269 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
270 (% style="line-height:normal" %)The component is not resized to fit the containers defined space.
271
272 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
273 (% style="line-height:normal" %)This may add both a vertical and a horizontal scroll bar to the component in Run mode.
274 )))
275 |(% style="border-style:solid; border-top:none; border-width:1.0pt; width:84.8pt" width="113" %)(((
276 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
277 (% style="line-height:normal" %)Chart
278
279 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
280 (% style="line-height:normal" %)Gauge
281
282 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
283 (% style="line-height:normal" %)Venn
284 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:92.15pt" width="123" %)(((
285 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
286 (% style="line-height:normal" %)Fill Page
287 )))|(% style="border-bottom:solid windowtext 1.0pt; border-left:none; border-right:solid windowtext 1.0pt; border-top:none; width:273.85pt" width="365" %)(((
288 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
289 (% style="line-height:normal" %)Resizes the selected component so that it covers the entire page of your report.
290
291 (% style="margin-top:3.0pt; margin-right:0cm; margin-bottom:3.0pt; margin-left:0cm; padding:0cm 5.4pt 0cm 5.4pt" %)
292 (% style="line-height:normal" %)Keep the order in which components are stacked on the report, as selecting this option may cover other components, preventing them from being displayed.
293 )))
294
295 === ===
296
297 == Repositioning components ==
298
299 To reposition a component:
300
301 Click anywhere in the centre of the component then drag it.
302
303 As you begin to drag the component, the new position of the component is illustrated with a green outline.
304
305 (% class="box" %)
306 (((
307 You can move components so that they overlay each other. This is useful when designing the look & feel of your report, however, be aware that overlaying components can cause readability and interactivity issues.
308 )))
309
310
311 == Removing a component from the workspace ==
312
313 If you want to remove a component from the workspace, you have two options:
314
315 * Removing it from the workspace, but to save it for use elsewhere in the report.
316 * Removing it permanently from the report.
317
318 (% class="box" %)
319 (((
320 Containers and Placeholders can only be permanently removed from the report.
321 )))
322
323 To remove the component from the workspace, but to save it for use elsewhere in the report:
324
325 1. Click the component on the workspace then click the Remove From Page icon on the Dynamic toolbar.
326
327 This adds the component to the Report Structure Panel under a new section – Unused.
328
329 To permanently remove the component from the workspace, and from the report:
330
331 1. Click the component on the workspace then click the **Remove From Report** icon on the Dynamic Toolbar.
332
333 (% class="box" %)
334 (((
335 If you’ve added components to a Container component, removing the Container from the workspace does not completely remove its contents from the report. Instead, the contents are saved to the Unused section in the Report Structure Panel.
336 )))
337
338
339 = Saving and Sharing Your Report =
340
341 Once you’re happy with the report you’ve built, saving it in a Public Reports folder will share the report with anyone who has permissions to access that folder.
342
343 To save your report:
344
345 1. Click the **Save** icon on the top tool bar. This displays the Save Report dialog.
346 1. Enter a **name** and a **description** of your report in the appropriate fields.
347 1. By default, the report will be saved to your My Reports folder. If required, select a location to save the report by clicking the name of the available folders displayed in the bottom half of the dialog.
348 1. Click the **Save** button.
349 1. Click the **OK** button.