Skip to Content

Wiki source code of 08. Report Viewer

Last modified by Jeff Nicholson on 06/11/2025, 14:24
Hide last authors
Jeff Nicholson 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Report Viewer provides users with a simplified interface to view, drill down, filter and print reports.
6
7 The Report Viewer functionality is a restricted ‘view only’ licence feature. Full users can access published reports through the Report Viewer interface without any additional licences. Please contact the system administrator for more information.
8
9 = Accessing Report Viewer =
10
11 Report viewer is accessed via the external URL generated when exporting a report, or by the **Viewer** link in the [[Portal>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome||anchor="Portal"]] page that can be specified in the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]]. Please refer to the [[Selected Reports>>doc:Technical Documentation.CXAIR.User Guide.3\. Report Administration.WebHome||anchor="Selected Reports"]] section of the [[Report Administration>>doc:Technical Documentation.CXAIR.User Guide.3\. Report Administration.WebHome]] chapter for more information concerning the creation of links.
12
13 When the Login screen is accessed, populate the **Username** and **Password** fields with the relevant credentials and click **Login** to access the solution.
14
15 To reset a password, populate the **Username** field and click **Forgot Password?**. A reset password email will be sent to the associated email address.
16
17 A user can only be logged into a single session at a time.
18
19 = Navigation =
20
21 Upon logging in, the home screen will be presented. All folders and reports available to the user are displayed as tiles with a preview of the report, if generated, an icon to indicate the area of functionality, a description if specified and a **Last Updated** heading.
22
23 Enable the **Only Display Favourites** option to restrict the view to the reports that have been previously favorited. Favourite reports by clicking the **Favourite** icon located on the report preview image.
24
25 Use the search bar at the top of the page to filter reports via a dynamic search that will update the results as the search term is typed. Clicking **View** will open the relevant folder or report.
26
27 The following icons are used for navigation are available at the top of the screen:
28
29 (% border="1" cellspacing="0" class="MsoTableGrid" style="border-collapse:collapse; border:1pt solid windowtext; width:1024px" %)
30 |(% style="background-color:#ed7d31; background:#ed7d31; border-style:solid; border-width:1pt; width:73px" width="66" %)(((
31 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
32 (% style="color:white" %)Icon
33 )))|(% style="background-color:#ed7d31; background:#ed7d31; border-bottom-style:solid; border-bottom-width:1pt; border-left:1pt solid; border-right-style:solid; border-right-width:1pt; border-top-style:solid; border-top-width:1pt; width:950px" width="500" %)(((
34 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
35 (% style="color:white" %)Description
36 )))
37 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
38 (% style="text-align:center" %)
39 [[image:home.png||height="23" width="30"]]
40
41
42 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
43 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
44 **Home**
45 Return to the home screen.
46 )))
47 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
48 (% style="text-align:center" %)
49 [[image:icon_return_to_report.png||alt="undo.png" height="34" width="30"]]
50
51
52 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
53 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
54 **Return to Report**
55 Return to the original report after drilling on a value.
56 )))
57 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
58 (% style="text-align:center" %)
59 [[image:First.png||height="36" width="30"]]
60
61
62 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
63 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
64 **First**
65 Return to the first report in the current folder.
66 )))
67 (% style="height:57.1pt" %)|(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
68 (% style="text-align:center" %)
69 [[image:previous.png||height="39" width="30"]]
70
71
72 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
73 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
74 (% style="height:57.1pt" %)**Previous**(%%)
75 (% style="height:57.1pt" %)Return to the previous report in the current folder.
76 )))
77 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
78 (% style="text-align:center" %)
79 [[image:next.png||height="39" width="30"]]
80
81
82 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
83 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
84 **Next**
85 Proceed to the next report in the current folder.
86 )))
87 (% style="height:47.2pt" %)|(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
88 (% style="text-align:center" %)
89 [[image:last.png||height="36" width="30"]]
90
91
92 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
93 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
94 (% style="height:47.2pt" %)**Last**(%%)
95 (% style="height:47.2pt" %)Proceed to the last report in the current folder.
96 )))
97 (% style="height:47.2pt" %)|(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
98 (% style="text-align:center" %)
99 [[image:reload1.png||height="30" width="30"]]
100
101
102 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
103 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
104 (% style="height:47.2pt" %)**Reload**(%%)
105 (% style="height:47.2pt" %)Reload the report.
106 )))
107 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
108 (% style="text-align:center" %)
109 [[image:back to folder.png||height="25" width="30"]]
110
111
112 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
113 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
114 **Back to Folder**
115 Return to the previous folder view.
116 )))
117 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
118 (% style="text-align:center" %)
119 [[image:comment.png||height="28" width="30"]]
120
121
122 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
123 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
124 **Comment**
125 Add and view the report [[Commentary>>doc:Technical Documentation.CXAIR.User Guide.3\. Report Administration.WebHome||anchor="Commentary"]].
126 )))
127 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
128 (% style="text-align:center" %)
129 [[image:export.png||height="25" width="30"]]
130 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
131 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
132 **Export**
133 Export the current report, subject to user permissions.
134 )))
135 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
136 (% style="text-align:center" %)
137 [[image:report_viewer_prefs.png||alt="export.png" height="25" width="30"]]
138
139
140 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
141 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
142 **{{id name="Preferences"/}}Preferences**
143 Opens the Preferences window for the current user, where the **Real Name** and associated **Email **address can be entered in the relevant textbox. Click **Set Password **to update the password.
144 )))
145 |(% style="background-color:#3f9ad9; background:#3f9ad9; border-style:none solid solid; border-top-color:initial; border-width:1pt; width:73px" width="66" %)(((
146 (% style="text-align:center" %)
147 [[image:log out.png||height="30" width="30"]]
148
149
150 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:950px" width="500" %)(((
151 (% style="margin-bottom:12.0pt; padding:0cm 5.4pt 0cm 5.4pt" %)
152 **Log Out**
153 End the current session and return to the login screen.
154 )))
155
156 = Filters =
157
158 There are two types of filters:
159
160 * Filter Panel Filters - these are accessed as described below.
161 * Embedded Page Filters - these can exist in the actual report and does not require the filter panel to be used.
162
163 To access the filter panel, click the **>>** icon located at the top-left of the report. Use the provided options to manipulate the range of data and click **Filter** to apply the changes. To return the default view of the report, click **Clear Filters**.
164
165 If your user profile is allowed to save filter values you will also see a **Save Filter** button in the filter panel. To use this, set the filters accordingly and click the **Filter** button to filter the data. Then click the **Save** **Filter** button to save the report with the filter values in place. This is only saved for your user and not all users.
166
167 Please refer to the [[Filters>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2b\. Filters.WebHome]] chapter for more information concerning the creation and use of report filters.
168
169 = Query Bar =
170
171 If enabled by the system administrator, the query bar is available when viewing the underlying data for a report or a saved query. The original syntax used to derive the rows is displayed below. Please refer to the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] chapter for more information regarding the querying functions and syntax.
172
173 = Selecting Unique Column Values =
174
175 To select one or more unique values from a column, first click the relevant column heading. This will display a dialog box containing the unique column values.
176
177 To display the record count for each unique value, click the **Show Counts** button. If the current search or filter restricts the values that are displayed in the unique column count, click **Show Others** to display all values restricted by the search.
178
179 Click the **…** button to manually enter values or select the required values from the list and click **Apply** to complete the process.
180
181 = Display Fields =
182
183 If enabled by the system administrator (using the **Show Report Options** checkbox), it is possible to remove or change the order of the columns displayed when viewing the underlying data for a report or a saved query. Click the **Cog** icon then click **Display Fields** to reveal these options.
184
185 Move fields between the **Available** and **Selected** boxes using the left and right arrows and use the up and down arrows to order the selected fields. Click **Apply** to save the changes or **Close** to discard any changes made. Changes do not persist when the report is re-loaded unless you use the **Set as Default** option.
186
187 = Add Reports to Viewer =
188
189 On Load Screen, find the current CXAir Viewer link, and click on the text to open a dialog box. Click on the Reports Tab and de-select CXAir Viewer in the search options. Findthe folder that you want to add, click on the selection box in front of the folder name. Repeat this for all folders you want to add. Click back to the Selected Reports tab and click on the button 'Update External URL' and then close the load screen. Check on Viewer and the new folder should be showing with the new reports inside.
190
191 To add previews of the reports, open the report and take a screen shot. Open load screen and open the cog menu next to the report. Select 'Upload Report Preview' then on Selct File, find your screenshot and click on close. Go into Viewer to check that it has been saved correctly.