0% found this document useful (0 votes)
14 views242 pages

Reporting User Guide

Uploaded by

Soohong Chun
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
14 views242 pages

Reporting User Guide

Uploaded by

Soohong Chun
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 242

Reporting

User Guide
AVEVA Solutions Limited

Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from
viruses.

1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data
created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in
contract, tort (including negligence) or otherwise.

1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's
claim is brought.

1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.

Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied
with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is
made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be incorporated into any third-party software, product, machine, or system without the prior written
permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms
and conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.

© Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall
not be liable for any breach or infringement of a third party's intellectual property rights where such breach results
from a user's modification of the AVEVA software or associated documentation.

AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or
logo belongs to its respective owner.
Report Designer User Guide

Revision Sheet

Date Version Comments / Remarks


September 2011 12.1.1 Issued
January 2012 Copyright added to all pages.
Report Designer User Guide
Reporting User Guide

Reporting User Guide

Contents Page

Reporting
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Report Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Sample Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Previews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Printing and Exporting Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Batch Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Default Display of Real Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Error Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3

Getting Started with Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1


Overall Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
New Report Definition / Report Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Open Report Definition / Report Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11

Report Editing Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1


Back up the Current Layout before Modification . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Manually Update Report Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Change Element Layout in a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

© Copyright 1974 to current year. i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Add or Modify Static Information in a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3


Delete Report Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Display Values from a Database (Bind Report Elements to Data). . . . . . . . . . . 4:6
Use Mail Merge in Report Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Change Formatting of Report Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Change Fonts and Colours of Report Elements . . . . . . . . . . . . . . . . . . . . . . . . . 4:9
Change or Apply Data Sorting to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:10
Change or Apply Data Filtering to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:11
Change or Apply Data Grouping to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . 4:12
Add Totals to a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:13
Create or Modify Watermarks of a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15
Add Page Numbers and System Information to a Report . . . . . . . . . . . . . . . . 4:17
Add Calculated Fields to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:20
Add Parameters to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:23
Add Arrays to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:26
Add Project Data to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:27

Create Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1


Basic Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Create a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Open an Existing Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2
Change Measurement Units for a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4
Change Page Settings for a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4
Save a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:7
Bind a Report to Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:7
Bind Report to Dabacon Project Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:8
Define Scope within PDMS Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17
Bind Report to Non-Dabacon Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:19
Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:22
Static Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23
Table Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:24
Master-Detail Report (Detail Report Bands). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:25
Multi-Column Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:26
Cross-Tab Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:28
Parameterised Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30
Chart with Static Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:32

© Copyright 1974 to current year. ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Chart with Dynamic Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36


Styles and Conditional Formatting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:40
Styles Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:40
Use of Odd and Even Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:43
Store and Restore Style Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:45
Conditionally Change a Control's Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:48
Conditionally Hide Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:51
Conditionally Change a Label's Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:55
Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:56
Add Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:57
Create Hyperlinks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:60
Add a Cross-Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:60
Miscellaneous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:62
Handle Events via Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:62
Show the Current Row Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:66
Count the Number of Records in a Report or a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:67
Cancel Printing If a Report Does Not Contain any Records. . . . . . . . . . . . . . . . . . . . . . . . 5:69
Limit the Number of Records per Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:70

Running Reports from outside of the Reporting . . . . . . . . . . . . . . . 6:1


PML Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Search Results Grid - Quick Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Run Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5

Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Component Tray. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Control and AVEVA Toolboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Design Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5
Designer Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6
Preview Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
HTML View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
Field List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
Formatting Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:8
Layout Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:9
Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:9
AVEVA Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:9
Property Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10

© Copyright 1974 to current year. iii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Report Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10


Smart Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:11
Zoom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13
Report Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13
Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13
Behaviour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:16
Data ............................................................. 7:16
Design ............................................................. 7:18
Misc ............................................................. 7:19
Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:20
Page Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:20
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:21
Report Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:22
Band Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:22
Manage Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:22
Detail Band. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:24
Group Header and Footer Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:27
Report Header and Footer Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:32
Page Header and Footer Bands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:34
Page Margin Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:37
Detail Report Bands (for Master-Detail Reports) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:39
Report Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:42
Label ............................................................. 7:44
Check Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:47
Rich Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:50
Picture Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:53
Panel ............................................................. 7:56
Table ............................................................. 7:58
Table Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:61
Table Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:62
Line ............................................................. 7:66
Shape ............................................................. 7:67
Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:70
Zip Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:76
Chart ............................................................. 7:78
Pivot Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:82
Page Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:85
Page Break. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:87
Cross-band Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:88

© Copyright 1974 to current year. iv 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Cross-band Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:90


Project Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:91
Preview Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:94
Print and Export Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:96

© Copyright 1974 to current year. v 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

© Copyright 1974 to current year. vi 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Introduction

1 Introduction

The Reporting User Guide guide contains information on how to create reports using
Reporting within the AVEVA Plant suites.
Reporting enables users to create new reports, bind them to data, and pass them to another
workstation for loading into another instance of the Reporting. In addition to report editing
capabilities, it allows the user to display print previews and to print reports and export
reports to files.

Note: Some features described may differ depending on the version of Reporting in use.
This depends on the application vendor.

1.1 Guide Structure


The Reporting User Guide consists of the following sections:
• Overview

© Copyright 1974 to current year. 1:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Introduction

• Getting Started with Reporting


• Report Editing Basics
• Create Reports
• Running Reports from outside of the Reporting
• Reference

© Copyright 1974 to current year. 1:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Overview

2 Overview

The Reporting add-in is an interactive visual report designer. Data from stored queries
shared across a project (Database Views), locally stored queries (User Views) and ad-hoc
queries (Data Source Wizard or the Search Grid) can be presented and formatted to meet
project and customer requirements.
This topic provides an overview of features which are particular to the version of Reporting
provided with AVEVA PDMS.

2.1 Report Formats


The Reporting supports two report file formats.

Layout Templates - Reportname.repx


These report files contain formatting, graphics and presentation. They contain no data
source and cannot be run. These report files may be used to distribute a common look and
feel for use in reports across a company and/or project.

Reports - Reportname.repv
These report files may contain formatting, graphics and presentation, and may have been
created from a Layout Template. However, in addition to layout, they also contain a data
source, and can be run. A .repv file may be saved as (File > Save As) a .repx file. For
example the user may want to save the formatting and layout of a report (.repv) but discard
its data source. Choosing this option displays a warning that the data source will be lost.
Reports contain a data source and are independent of user or project settings. Reports may
be shared across projects, as long as each project has the same element and attribute
structures defined in the report’s data source.
Refer to Create a New Report and Save a Report for details.

2.2 Sample Reports


A set of sample reports are included. These include both Layout Templates and Reports.
They are designed to work with the sample database. If you want to trial these reports on
your own project then select File > Open. From the drop-down select Browse and navigate
to the folder where the samples are located:
PDMS Installation Location\PDMSUI\dflts\data\reports
The user will now see the sample reports and may open and run them against your project.
You may also use the sample reports as the basis for your own custom reports, by opening

© Copyright 1974 to current year. 2:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Overview

a sample report, and then selecting File > Save As. You may rename and save the sample
report, and then modify it to meet your own project needs.
Refer to Open an Existing Report and Save a Report for details.

2.3 Data Sources


A data source is a way of defining the data that will be available for use in a report.
Clicking the Data source button in the Reporting opens the Data Source Wizard. This
wizard takes you through the steps required to create a new data source, copy an existing
data source, or edit the data source already defined for the current report (if there is one).
Refer to Bind Report to Dabacon Project Data for details.

2.4 Previews
Where a preview of a report is displayed in the Reporting, any data returned is limited to the
first 20 records. This preview will be cached and any changes to he underlying data will not
be shown until your run the report, or close and re-open the Reporting.

Note: If filters are added to a data source this may impact on the performance of previews.
Where previews are shown in a Quick Report all data is shown.

Refer to Preview Reports for details.

2.5 Printing and Exporting Reports


Report data may be published to AVEVA NET by clicking the Run Report button. The report
is executed and the full data set is retuned and displayed in a new window. This window
provides facilities for printing the report, exporting it in various file formats, and publishing
the report in PDF format, with data and associations if configured, to AVEVA NET. Refer to
Print and Export Reports or details.
For further details see the AVEVA Schematic Gateway Guide.

2.6 Batch Operation


A PML Object (PMLREPORT()) has been created which provides a programmatic means of
running pre-defined reports created using the Reporting. Which is provided to support
customisation, and the running of reports in batch mode.
For further details of this PML object refer to the Software Customisation Guide.

2.7 Default Display of Real Values


The display of real values in Reporting is controlled by the PRECISION command via the
PDMS Command Line. This command enables the user to specify the number of decimal
places for the displayed values of dimensions. Running reports in batch may give different
results if these formats have not been created in TTY mode. So in batch these can be
initialized as follows in a macro
!!comDefineGlobal(object COMFORMATS())

© Copyright 1974 to current year. 2:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Overview

In addition to this, real unit qualified values may be formatted using the FormatDouble
function. See Add Calculated Fields to a Report. For details refer to the Design Reference
Manual - General Commands, Setting Output Precision of Distance Units and Switching
between Actual and Nominal Bores.

2.8 Error Reporting


If the Datasource used for a report encounters an error when attempting to collect data, and
because of this error is unable to return a Field value used on a Report, then an error
message will be substituted for the Field value. This may occur, for example, if a PML1
expression is used to determine a field value, and this expression is incorrect.
Where an error is encountered the substitution text in the report is:
!!Error

© Copyright 1974 to current year. 2:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Overview

© Copyright 1974 to current year. 2:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

3 Getting Started with Reporting

This section describes the basic procedures for creating reports using Reporting. Refer to:
• Overall Workflow
• New Report Definition / Report Layout
• Open Report Definition / Report Layout

© Copyright 1974 to current year. 3:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

3.1 Overall Workflow


The diagram below illustrates the overall workflow for the basic use of Reporting.

© Copyright 1974 to current year. 3:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

3.2 New Report Definition / Report Layout


1. Click on Designer Menu item to open Reporting.
Note: In Hull Design and other Marine modules these functions are available in the Tools
menu.

© Copyright 1974 to current year. 3:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

2. Click the New menu item or Toolbar button.

3. Select the path or browse to the location containing the report layout or report definition
in report explorer.

© Copyright 1974 to current year. 3:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

4. Select the Report Layout for the report definition.

© Copyright 1974 to current year. 3:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

5. On clicking Create in report explorer, the selected Report Layout will be opened in
Reporting. Change the layout using the various controls.

6. Click the Data Source button to bind the data from PDMS to current report definition.
The report Data source wizard will allow the user to define the data for the report.
• Select New to define a new data source.
• Select Copy to copy an existing data source defined in LEXICON or the file system.
• Select Edit to modify the existing data source associated with report definition
Click Next.

© Copyright 1974 to current year. 3:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

7. Provide the name and description for the Data Source and click Next.

© Copyright 1974 to current year. 3:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

8. Select the element type for which the element's attributes will be displayed in the report
and click Next.

9. To limit the number of elements returned by the Data Source define attribute filters, and
click Next.

© Copyright 1974 to current year. 3:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

10. Select the attributes to be included in report for the selected element types and click
Next.

© Copyright 1974 to current year. 3:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

11. Click Finish if the required data for the report has been defined, or else use the Back
button to modify the data.
12. On clicking Finish, the Field List on the right-hand side will display the attributes
selected in the Data Source.

13. Drag and drop or use smart tags to bind the attributes from the field list to various
controls in the report.

14. Click Preview to see a preview of current layout with the first 20 records available from
the associated data source.

© Copyright 1974 to current year. 3:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

15. Click on Run Report to run the report definition with the actual data available from the
currently bound data source.
16. Click the Save toolbar button or menu option to save the current report definition as a
report definition or report layout.

3.3 Open Report Definition / Report Layout


1. Click the Open menu item or Toolbar button.

© Copyright 1974 to current year. 3:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

2. Select the path or browse to the location containing the report layout or report definition
in the report explorer.

3. Select the report definition or report layout from the report definition or the report layout
tab respectively.
4. A preview of the selected item will be displayed with first 20 records.
5. On clicking Open, Reporting will open the selected report layout or report definition.

© Copyright 1974 to current year. 3:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

6. Change the layout using the various controls available in the toolbox.
7. Click the Preview button to view a quick preview of the report definition/report layout.

8. The AVEVA Toolbar button will work only for report definitions.
9. Click the Data Source button to modify the associated Data Source.
10. Change the binding after changing the Data Source.
11. Click on Run Report to run the report definition with the actual data available from
currently bound data source. The Run Report dialog will allow the user to perform the
following operations on the report:
a. Export the report to various file types
b. Print the report
c. Publish the report to AVEVA NET

© Copyright 1974 to current year. 3:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Getting Started with Reporting

d. Apply watermarks etc.

© Copyright 1974 to current year. 3:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4 Report Editing Basics

The Report Editing Basics topic describes the basic tasks the user may need to carry out
when editing a report using Reporting:
• Back up the Current Layout before Modification
• Manually Update Report Output
• Change Element Layout in a Report
• Add or Modify Static Information in a Report
• Delete Report Element
• Display Values from a Database (Bind Report Elements to Data)
• Use Mail Merge in Report Elements
• Change Formatting of Report Elements
• Change Fonts and Colours of Report Elements
• Change or Apply Data Sorting to a Report
• Change or Apply Data Filtering to a Report
• Change or Apply Data Grouping to a Report
• Add Totals to a Report
• Create or Modify Watermarks of a Report
• Add Page Numbers and System Information to a Report
• Add Calculated Fields to a Report
• Add Parameters to a Report
• Add Arrays to a Report
• Add Project Data to a Report.

4.1 Back up the Current Layout before Modification


To guarantee that a user will be able to revert a report to its previous state, a backup copy
must be created. The report can then be restored to this state in case something goes
wrong while is being subsequently edited.
To save a copy of a report, select File > Save or press CTRL+S. The report will then be
saved in the application's current folder. The path to a report will be displayed in Reporting's
title bar.

© Copyright 1974 to current year. 4:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

To manually specify the folder to save a report to, select File > Save As from the main
menu, which will display the standard Save File window.
To load a saved report, click File > Open in the main menu, or press CTRL+O. The
standard Open File window is then displayed, which will allow the user to locate and open
the report.

4.2 Manually Update Report Output


Sometimes the user may only need to change a small number of values in the report before
printing it. In these cases, the best way to make these changes may be to export the report
to an editable file (e.g. an RTF file), then use an appropriate editor tool to edit values and
then print the report.
To export a report, click Run Report and use the Export options as shown below.

For more information about exporting reports, see Preview Reports.

4.3 Change Element Layout in a Report


The user can freely move report elements, e.g. labels, by dragging them. Another way to
change the element position is to select an element, and then press the arrow keys.

© Copyright 1974 to current year. 4:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

To resize an element, select it and then drag one of the small boxes shown on its edges and
corners. To resize an element using keyboard shortcuts, press SHIFT+ARROW or
CTRL+SHIFT+ARROW.

The user can also easily align controls to each other or make them the same size, by
selecting the multiple controls and using the Layout Toolbar.

To select multiple controls, use one of the following methods:


• Click the controls while holding CTRL or SHIFT.
• Click on blank space and drag the mouse to create a selection frame around the
controls. When the mouse button is released, all controls within the selection frame's
boundaries will be selected. In this case, any previous selection is cleared.
Note: For information on how to work with tables, refer to Table.

4.4 Add or Modify Static Information in a Report


Reports display static and dynamic information.
Dynamic information is text or values that are taken from values in a database (actual report
data) or service information (such as current user name or page numbers), and therefore
changes in the report if the source data changes.
Static information is text or images that does not change in this way. For example, general
information in a report header or a page header, or text labels describing data.

© Copyright 1974 to current year. 4:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Change Static Information


To change static information, locate the report element in the designer and display the
element's smart tag. The smart tag will contain a link or a button enabling the user to edit
the element's content.

Text elements, such as labels and rich text boxes, also allow in-place editing of their
content. Double-click an element and activate the editor. When working with rich text, use
the Formatting Toolbar.

Add Information to a Report


To add information to a report, select the appropriate element from the Control Toolbox,
such as a Label, Rich Text Box or Picture Box. Once an element has been placed at the
appropriate position, specify its content using the smart tag. For instance, the following
instructions describe how to add a rich text box into a report.
• Drop the Rich Text control from the Toolbox onto the Detail band.

• Select the created control and click its Smart Tag. In the displayed actions list, click the
Load File... context link.

© Copyright 1974 to current year. 4:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

In the displayed window, define the path to the RTF or TXT file containing the text of the
information, and click Open.

Note: Additional text formatting can be performed using the Formatting Toolbar.

4.5 Delete Report Element


To delete a report element (band or control), use one of the following methods:
• Select the element in the Design Panel or Report Explorer, and press DELETE. To
select multiple elements, hold down the SHIFT key while selecting them.
• Select the element or elements then select Edit > Delete from the Main Menu.

• Right-click the report element, and in the Context menu, choose Delete.

Note: To undo a deletion press CTRL+Z.

© Copyright 1974 to current year. 4:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4.6 Display Values from a Database (Bind Report


Elements to Data)
Report elements can display dynamic data from a bound database. For example, an
employee list report may need to display birth dates. If a database contains this information,
it can easily be added to the report using one of the methods described below.
Databound elements are indicated in the Reporting by a yellow database icon in their top-
right corners.

Use Field List


• To bind an existing report element to database data, click the required field item in the
Field List window, and then drag and drop it onto the element. The yellow database
icon inside the control will then appear.

• To add a new data-bound report element, drag the required field item from the Field List
window onto a report band. This will create a Label bound to the selected data field.

• A more flexible way to create data-bound elements is to right-click a Field List item,
and then drag and drop it onto a report. This will display the context menu shown in the
image below. Choose the element type that will represent the data, and it will be
automatically created and bound to the selected data field.

© Copyright 1974 to current year. 4:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Use Smart Tag


Click an element's Smart Tag, and in the displayed menu, expand the Data Binding
drop-down list and select the required data field.

Use Property Grid


Click an element to show its properties in the Property Grid. Expand the Data Bindings
branch that holds the bindable attributes. Specify a data field for the required attribute (e.g.
Text).

© Copyright 1974 to current year. 4:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4.7 Use Mail Merge in Report Elements


Several report elements support the Mail Merge feature. To use this feature, insert field
names surrounded by square brackets into the element's text.

As shown in the image above, the user can apply formatting to database values when using
the Mail Merge feature. Place the cursor on the field name inside the square brackets and
click the control's Smart Tag. In the displayed actions list, define the required formatting in
the Format String section.

4.8 Change Formatting of Report Elements


To change formatting, locate the element, click its smart tag, and then click the ellipsis next
to Format String.

© Copyright 1974 to current year. 4:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

The FormatString Editor window will be displayed, allowing the user to choose one of the
predefined formatting styles.

Select the required style and click OK to close the window and save the changes.

4.9 Change Fonts and Colours of Report Elements


To change the fonts and colours, as well as paddings, text alignment and other appearance
properties of report controller bands, select an element and use one of the following
methods:
• Use the Formatting Toolbar.

© Copyright 1974 to current year. 4:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

• Use the Property Grid.


Note: All appearance-related properties are located under the Appearance category.

Note: For more information on customizing the appearance of report elements, refer to
Styles and Conditional Formatting.

4.10 Change or Apply Data Sorting to a Report


To sort a report's data, use a report containing a Label control bound to a CategoryID data
field. This field will be used as a sorting criteria.
• Click a Detail band's Smart Tag. In the displayed menu, locate the Sort Fields section,
and click the ellipsis.
• In the displayed window, click Add to add a new entry, and set the FieldName property
to a data field against which the data is to be sorted. The user can also define a sorting
order (ascending or descending).

© Copyright 1974 to current year. 4:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Note: Data can be sorted against multiple data fields. If this is required, add more entries
and specify their data field and sort order settings as described above.

• To apply the settings and close the window, click OK.


The sorting is now applied to the report. Switch to the Preview tab to view the result.

4.11 Change or Apply Data Filtering to a Report


To filter a report's data, select the report, and in the Property Grid, locate the Filter String
property and click the ellipsis. The FilterString Editor is displayed, enabling the user to
define a required expression.

Click OK. The filtering is then applied to the report. Switch to the Preview tab to view the
result.
It is also possible to request a filtering parameter each time a report is previewed. Refer to
Add Parameters to a Report for details.

© Copyright 1974 to current year. 4:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4.12 Change or Apply Data Grouping to a Report


Data grouping can be performed only if a report is bound to a data source.
To group records in a report, follow these instructions.
• Add a Group Header band to the report.
Right-click anywhere on the report, and in the displayed Context Menu, point to Insert
Band and click GroupHeader.

• The Field List is then displayed. Drop a field, which will be used as the grouping
criteria, from the Field List onto the GroupHeader band.

• Drop a field, representing the report’s general data onto the report's Detail band.

© Copyright 1974 to current year. 4:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

• Click the Smart Tag of the GroupHeader band, and in the displayed actions list, click
the ellipsis in the Group Fields section. The GroupField Collection Editor window is
displayed.

• In this window, click Add to add a new grouping field, and set its Field Name property
to the required field.
Note: To define whether the sort order for this grouping field should be ascending or
descending, use the Sort Order property.

• To apply the settings and close the window, click OK.


• Click the GroupHeader band's Smart Tag again, and in the Group Union dropdown
menu, select Whole Page, so that a report group starts on a new page if it does not fit
entirely on the previous one.

The grouping is now applied to the Report. Switch to the Preview tab to view the result.

4.13 Add Totals to a Report


To calculate summaries (totals) within a report, follow these instructions:
• If the Report Footer band is not present in a report, it must be added by right-clicking
anywhere on the report, and in the Context Menu, selecting Insert Band >
ReportFooter.

© Copyright 1974 to current year. 4:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

• Click the field for which a summary will be calculated, to select it. Then, hold down
CTRL and drag the field onto the Report Footer area to create an exact copy of the
label that will display the summary.

Note: A new label can also be created for the total by dragging it from the Control Toolbox.

• Select the newly created label. In the Property Grid, locate the Summary property
and click the ellipsis. The Summary Editor is then displayed.
The following image shows an example of how to set up a total.

© Copyright 1974 to current year. 4:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Note: The Summary Running option is set to Report to make sure that all values from the
specified data field are taken into account.

Note: The Ignore NULL Values option will not affect the result in this example, since by
default NULL values are treated as if they were zeros. So the Sum will not be
affected whether or not these values are taken into account. This option applies to
functions like Count or Average, because it affects the number of elements counted.

• To save the settings and close the window, click OK.


Switch to the Preview tab to view the result.

Note: Summary field results cannot be used in calculated fields.

4.14 Create or Modify Watermarks of a Report


To create or modify a watermark, add a text watermark, or turn a picture into a report's
background follow these instructions:

Note: Watermarks are visible only in Preview and HTML View modes.

Note: Watermarks are not included when a reports are exported to HTML format.

• Select the report and click on any blank area surrounding its bands area.
In the Property Grid that is then displayed, locate the report's Watermark property,
and click the ellipsis. The Watermark window is then displayed.

© Copyright 1974 to current year. 4:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

• If a text watermark is to be used, in the Text Watermark tab of this window, define the
required properties, such as Text, Direction, Color, Font, Transparency, Page Range,
etc.

• If a picture watermark is to be used, in the Picture Watermark tab load the image to be
used as a watermark, and define its properties, such as Size mode, Alignment (vertical
and horizontal), Tiling, Transparency, Page Range, etc.

© Copyright 1974 to current year. 4:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

As shown above, it is possible to use both text and picture watermarks simultaneously.
Note: All the watermark options can be defined without using the Watermark window. In
the Property Grid, expand the Watermark property and set the required properties
directly.

Once the watermark has been set up, switch to the Preview tab to view the result.

4.15 Add Page Numbers and System Information to a


Report
Page numbers or other system information (e.g. current date and time, user name, etc.) can
be inserted into a report.

© Copyright 1974 to current year. 4:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Generally, this information is displayed within Page Headers and Footers and in Page
Margin bands. To add page numbers or system information to a report, drag and drop the
Page Info control from the Control Toolbox.

Follow the instructions below for the following specific tasks:


• Add Page Numbers
• Add System Date and Time
• Add the User Name.
Add Page Numbers
• Select the Page Info control, then in the Property Grid locate the Page Information
property, and display its dropdown list.
There are several options available. Select whether to display only the current page
number (Latin or Roman, uppercase or lowercase) or the current page number and the
of total number of pages.

• Formatting of the control's text can be defined. In the Property Grid, set the Format
property to Page {0} of {1}.

© Copyright 1974 to current year. 4:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Add System Date and Time


• Select the Page Info control, then in the Property Grid, locate the Page Information
property and set it to Current Date and Time.

• Define the formatting of the control's text using its Format property.

The result is shown below.

Add the User Name


• Select the Page Info control, then in the Property Grid, locate the Page Information
property and set it to User Name.

© Copyright 1974 to current year. 4:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Define the formatting of the control's text. In the Property Grid, set the Format property to
Current User: {0}.

The result is shown below.

4.16 Add Calculated Fields to a Report


The main purpose of calculated fields is to perform calculations using data in multiple data
fields. To learn how to perform calculations within a single data field, refer to Add Totals to a
Report.

Note: It is recommended that all fields based on expressions are given a description in the
database view which includes the expression used. This makes it clear to the user
that an expression has been used to calculate the data, and what that expression is.
This is approach is followed in the supplied sample views.

Note: Summary field results cannot be used in calculated fields.

To add a calculated field to a report, follow the instructions below:


• To create a calculated field, right-click any item in the Field List and choose Add
Calculated Field from the displayed menu.

© Copyright 1974 to current year. 4:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

The calculated field is added to the field list. In the Field List, select the created field to
show its properties in the Property Grid. Change the Field Type property to an
appropriate value.

• To create an expression for the calculated field, click the ellipsis in the Expression field
of the Property Grid.The Expression Editor is then displayed. The user can also
open the editor by right-clicking on the field in the field list and choosing Edit
Expression from the displayed menu.

Click Fields to display the field list. Double-click field names to add them to the
expression string. Use the toolbar to add operators between field names.
Note: Calculated fields are not included in the list of fields in the Expression Editor. Users
must type the name of a calculated field into the expression to use result of that
calculated field in that expression.

Two custom functions are available to support the extraction of values, units or
dimensions from a unit qualified attribute returned from string. These functions are:

© Copyright 1974 to current year. 4:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

GetDouble([FieldName])
Returns the value of a unit qualified value.
GetUnits([FieldName])
Returns the unit.
GetDimension([Attribute name])
Returns the dimension.
The function FormatDouble([attribute], ‘units’, precision, 'label', fraction) may be used in
a calculated field to convert the value of an real attribute from current units to given
units and precision. Label and fraction parameter are optional where label is string for
overriding the default unit label and fraction is boolean value to indicate whether
decimal or fractional value for the unit should be displayed. For example, the following
converts HBOR to millimeters with two decimal places, regardless of the units and
precision of the current session.
FormatDouble([HBOR], ‘millimeter’, 2)
FormatDouble([HBOR], 'inch', 2, 'in', true) will convert the HBOR to inches with two
decimal place and will display the inches value with unit label 'in' and fraction.
Quick reports created from Tags, where the units of a real attribute can be changed, will
be displayed in the same units by creating calculated fields for each real attribute using
this function.
Please note:
• These functions are not available from the list of functions available in the
expression builder, and must be manually typed into the expression. The function
name should be used followed by brackets.
• GetDouble, GetUnits and GetDimension will not work in conjunction with other
functions. For example GetDouble([HBOR]) + [NUMB] or GetDouble([HBOR]) +
GetDouble([HBOR]) will not work. A calculated field should therefore contain only
one of the above functions as an expression.
Whenever the calculated field uses the attribute name having ] in the attribute name,
use the escape sequence \] for correct calculation of expression.
For example to get length of attribute name test pressure [1], use the following in
expression Len([test pressure[1\]]).
Same will apply to GetDouble, GetUnits, GetDimension and FormatDouble function.
In addition, the following Summary Functions are available for use with unit qualified
attributes:
• Min
• Max
• Avg
• Sum
These are available in the expression builder, and when setting the summary function
for a form control bound to a field.
• To close the window and save the expression, click OK.
• Drag the calculated field from the Field List onto a control or a table cell.

© Copyright 1974 to current year. 4:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

The calculated field is now set up. Switch to the Preview tab to view the result.

4.17 Add Parameters to a Report


Parameters can be used to filter the data in a report or specify a that will be used to
calculate other values (in the latter case, use calculated fields).
To add parameters and filter a report based on their s, follow the steps below:
• In the Field List window, right-click on the Parameters section, and in the displayed
menu, click Add Parameter.

© Copyright 1974 to current year. 4:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

Repeat this action to create the second parameter.


• In the Field List, select the first parameter, and in the Property Grid, set its (Name) to
FromDate, Description to From: and Parameter Type to Date Time.
For the second parameter, set these properties as shown in the following image.

Note: Every time a report is previewed, the user will be asked to enter the values of any
parameters. The following instructions explain how to use these values to filter a
report's data.

• Select the report (by clicking anywhere on the blank space of the report), and in the
Property Grid, locate the Filter String property and click the ellipsis. The FilterString
Editor is displayed.

© Copyright 1974 to current year. 4:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

In this window, define the required expressions for the parameters.


Note: Make sure that the report's Request Parameters property is set to Yes (which is the
default setting). Otherwise, the parameters will not be requested when the report is
previewed, and a blank report will be the result.

The parameter filtered report is now ready. To view the results, switch to the Preview tab,
and in the Parameters section, define the required values and click Submit.

© Copyright 1974 to current year. 4:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4.18 Add Arrays to a Report


Reporting does not support the dragging and dropping of an Array field from the Reporting
Field List.
To bind a report control to an Array, place the control on the report as normal, then set the
Data Binding property of the control to that of the Array field.
For example:

© Copyright 1974 to current year. 4:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

4.19 Add Project Data to a Report


PDMS project data can be added to a report. Generally such information will be placed in
Header and Footer bands.
To add project data to a report band, drag and drop the Project Info control from the AVEVA
Toolbox onto the band.

© Copyright 1974 to current year. 4:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Report Editing Basics

© Copyright 1974 to current year. 4:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5 Create Reports

Using Reporting, the user can edit existing reports and create new reports. The procedures
for editing and creating reports are described in the following topics:
• Basic Operations
• Bind a Report to Data
• Report Types
• Styles and Conditional Formatting
• Navigation
• Miscellaneous.

5.1 Basic Operations


Basic Operations covers the basic procedures carried out when working with reports in
Reporting, and consists of the following topics:
• Create a New Report
• Open an Existing Report
• Change Measurement Units for a Report
• Change Page Settings for a Report
• Save a Report.

5.1.1 Create a New Report


To create a new report in the Reporting, in the main menu, click File and then New (or press
CTRL+N). The Main Toolbar contains a button with the same function.

Note: Reports can also be created by opening an existing report or layout template and
saving it as a new report. See Open an Existing Report and Save a Report.

If there is another report already loaded in the Designer, then the user is asked whether this
report should be saved before it is replaced with the new one.
The New Report window is then displayed:

© Copyright 1974 to current year. 5:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The window is used to select the template (a .repx file) to be used as the basis for the new
report.
To select a template, first select the template location from the Look In drop-down:

These locations correspond to the following folders:


Product: %PDMSDFLTS%\Data\Reports
Project: %<PRJ>INFO%\Reports
User: %PDMSUSER%\Data\Reports
Select Browse… to look for layout templates in an alternative folder.
Once a folder has been selected, the layout templates in that folder are listed in the Layout
Template tab. Click on a template to view a preview of it.
To select a template and exit the window, click on it and then click Create.
A new report is then created based on the selected template and displayed in the Designer
tab.

5.1.2 Open an Existing Report


To open a report in the Reporting, in the main menu, click File and then Open (or press
CTRL+O). The Main Toolbar contains a button with the same function.

© Copyright 1974 to current year. 5:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The Open Report window is then displayed:

To open a report definition (a .repv file), click the Report Definition tab. To open a template,
(a .repx file) click the Layout Template tab.
To select a report or template, select the report or template location from the Look In drop-
down:

These locations correspond to the following folders:


Product: %PDMSDFLTS%\Data\Reports
Project: %<PRJ>INFO%\Reports
User: %PDMSUSER%\Data\Reports
Select Browse… to look for reports or templates in an alternative folder.
Once a folder has been selected, the reports or templates in that folder are listed in the
current tab. Click on a report or template to view a preview of it.
To select a report or template and exit the window, click on it and then click Open.
The selected report or template is then opened in the Designer tab.

© Copyright 1974 to current year. 5:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.1.3 Change Measurement Units for a Report


Units of measurement are determined by the report's Measure Units property. It defines the
basic measurement unit for all the unit-related properties of the report and its elements
(such as location, size, border width, etc.). It is set to one hundredth of an inch by default.
If required, the user can change the units to a tenth of a millimeter, by setting the Measure
Units property, either using the Property Grid:

... or via the report's Smart Tag:

5.1.4 Change Page Settings for a Report


In Reporting, each page setting of a report can be specified in one of two ways. They can
either be set to use the default printer settings when the report is printed, or use report-
specific printer settings.
• Default Printer Settings
The orientation, margins and paper size can be set to use printer settings instead of the
report's settings. This is useful for reports that could be printed in several places with
different printers and printer settings.
In the example below, the page properties in the Property Grid are set the default
printer settings and are disabled (displayed as greyed out).

© Copyright 1974 to current year. 5:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Specify the Report's Page Settings


Report specific page settings are specified using the Property Grid:

The user can set the page orientation and modify the margins. The margin values are
expressed in the report's measurement units. The user can select from the predefined
paper sizes (Paper Kind property) or choose Custom and create a paper size, or
select one which is already defined for this printer (Paper Name property).
These settings affect the layout of the report's design area. After their modification, red
warning marks might be displayed, indicating that the controls go beyond the page
dimensions. These warnings can be switched off by setting the Show Printing
Warnings property of the report to No.

© Copyright 1974 to current year. 5:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

To change the measurement units shown in the margins tooltips, customise the report's
Measure Units property.

Measure Units = Hundredths of an Inch

• Modify the Settings in Run Report Window


The Run Report window toolbar (see Print and Export Reports) has an icon that
enables the user to modify the page settings. Clicking this icon displays the Page
Setup window, which allows the user to adjust the page layout before printing or
exporting, and to select the printer.

The margins can also be set visually by dragging the dashed lines in the Run Report
window.

© Copyright 1974 to current year. 5:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.1.5 Save a Report


To save a report or template in the Reporting, in the main menu, click File and then Save (or
press CTRL+S). The Main Toolbar contains a button with the same function.
To save a report or template with a different name and/or in a different format, in the main
menu, click File and then Save As....
A standard Windows Save As dialog is then displayed.
As required, enter a new name for the report or template in the File name field.
To save the report or template in a different format, select the required format from the Save
as type drop-down, either Report Definition (.repv) or Layout Template (.repx).

5.2 Bind a Report to Data


The main purpose of Reporting is to create and customise data-aware reports which take
data from an external data source (many types of which are supported), to which the report
is bound, with controls in the report linked to data fields in the data source.
A Report can be bound to data from the PDMS Dabacon project database, or from another
database such as an Access database. A report cannot be bound to both types of database.
Once a data source has been defined, the elements from within that source can be further
restricted by defining a data source scope.
Continue at:
• Bind Report to Dabacon Project Data
• Define Scope within PDMS Data Source

© Copyright 1974 to current year. 5:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Bind Report to Non-Dabacon Data

5.2.1 Bind Report to Dabacon Project Data


To bind a report to the project data, click Data Source on the AVEVA toolbar. The Data
Source Wizard window is displayed.

There are three options:


• Use New to define a new data source
• Use Copy to select an existing data source, editing it if required
• Use Edit to modify the data source of the current report (this option is not available if
the current report does not have a data source defined for it).
Select the required option and click Next.
Continue at:
• Defining a New Data Source
• Copying a Data Source
• Editing a Data Source

© Copyright 1974 to current year. 5:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Defining a New Data Source


To define a new data source, start the Data Source Wizard and click New, then Next.
The Properties page of the wizard is then displayed:

A name for the new data source is automatically generated. This may be changed to a
name which describes the element(s) the data source will use.
Enter a description if required.
Click Next.
The Base Element Types page of the wizard is then displayed:

© Copyright 1974 to current year. 5:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

At least one element type must be selected. This will be the element type used to populate
the report.
The list of elements shown may be filtered by typing in the filter box.

© Copyright 1974 to current year. 5:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Select the element or elements required by clicking on them. The Ctrl and Shift keys may be
used to make multiple selections. Use the arrow buttons to move the selected elements for
the data source to the Base Element Types box.

Click Next.
The Filters page of the wizard is then displayed:

© Copyright 1974 to current year. 5:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Using this page, filters may be added to limit the elements retuned by the data source.
These filters maybe simple attribute based comparisons, or more complex PML1
expressions.
Enter attribute based comparison filters in the Attribute Filters box. Enter PML1 expression
filters in the Expression Filters box.
To add a new filter click the appropriate Add Filter button and enter or select the filter
details in the row of fields that is then provided. Multiple filters may be defined.
To delete a filter, select it from the list of filters and select the appropriate Delete Filter
button.
Click Next.
The Columns page of the wizard is then displayed:

© Copyright 1974 to current year. 5:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The attributes of the base elements of the data source are displayed in the Available
Columns box.
If multiple elements have been selected for the data source, then either all attributes of
these element types may be listed by clicking All Attributes, or only those common to all
the selected element types may be selected by clicking Common Attributes.
Select the columns that are to be available for use in the report by clicking on them. Use the
Ctrl and Shift keys to make multiple selections.
Use the arrow buttons to move the selected columns to the Data Source Columns box.
Once one or more columns have been selected PML1 expressions may be typed into the
Data Source Columns box, the results of which will be available for use in your report. For
example:

© Copyright 1974 to current year. 5:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Click Finish when the data source definition is complete.


The new data source is now available for use in the report. The data source is saved inside
the report. For example:

It may be edited by selecting Edit option of the Data Source Wizard (see Editing a Data
Source).

Copying a Data Source


To create a new data source by copying an existing data source, editing it if required, select
the Copy option of the Data Source Wizard.

© Copyright 1974 to current year. 5:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The Copy Data Source page of the wizard is then displayed:

The existing data sources are listed. Data sources may come from three sources.

Element
Element Views are created automatically by the system. One element view is created
for every base element type. Selecting an element view is an easy way to include data
from one type of element in a report.
Project
Project Views are stored in a LEXICON dictionary database. A user must have read
access to the LEXICON database to see Project Views. Project Views may contain

© Copyright 1974 to current year. 5:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

more complex data, and will be set up by an administrator. A set of sample project
views are include in the sample project.
User
User views may be copies of Project or Element views, or maybe data sources users
have created and stored locally.
Whichever view is chosen to use for a report a copy of it is taken. The original view is left as
it is. Write access to important project resources such as the LEXICON dictionary database
is therefore not required.
The views shown may be filtered based on the type of the owning database of the elements
in the view.

View sets are a way of grouping views together. Currently from the data source Wizard this
is used purely to help the administrator to group logically related views together, for ease of
distribution and use. However, in later releases it will be possible to build relationships
between single views in one view set, in the same way that tables are related in a relational
database. When the view set is selected for use in a report these relationships will be
resolved and the results presented for use in Reporting as a Report data source.

Select the data source to be copied and click Next.


The subsequent steps of the wizard are the same those of the New option, as described
above, but with the details of the selected data source populating the wizard so that they
can be edited if required. See Defining a New Data Source for details.

Editing a Data Source


To modify the data source of the current report, select the Edit option of the Data Source
Wizard (this option is not available if the current report does not have a data source defined
for it).

© Copyright 1974 to current year. 5:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The subsequent steps of the wizard are the same those of the New option, as described
above, but with the details of the current data source populating the wizard so that they can
be edited as required. See Defining a New Data Source for details.

5.2.2 Define Scope within PDMS Data Source


Once a PDMS data source has been defined, the elements from within that source can be
further restricted by defining a data source scope.
Only the elements within the chosen scope will be examined by the data source, and only
those that meet the selection criteria of the data source (Element type(s), filters) will be
returned in the report.
Click Scope on the AVEVA toolbar. The Scope window is displayed.

The window is used to specify a list of elements. The report will be restricted to source data
at and below the level of these elements in the element hierarchy.
If the current element is always to be within the scope, click the CE checkbox. Note this will
mean that if/when the CE changes, so will the scope of the data source.
To add the current element to the source, click the Add CE button. The current element is
then added to the Root Elements list. To add further elements, make those elements the

© Copyright 1974 to current year. 5:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Current Element and click the button again. A list of root elements can be compiled in this
way.

To remove an element from the list of Root Elements, select it in the list and click Remove.
If the scope of the data source is to be restricted to elements either partially within or
completely within a specified volume, select either the Partially Within... or Completely
Within... option from list of values in the Volume field.
The Volume window is then displayed:

© Copyright 1974 to current year. 5:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Specify the required volume and click OK.


From the From drop-down list specify whether the scope is to be restricted to elements in
the drawlist or in the obstruction list. Otherwise leave the drop-down set to the default
selection of MDB, meaning that all elements in the database may be in the scope.

Click OK to save the scope settings and exit the window. Click Cancel to exit the window
without saving.

Note: When root element(s) added in scope are no longer available in current database
then the DbRef will be displayed in scope with "=dbref[0]/dbref[1]" format.

5.2.3 Bind Report to Non-Dabacon Data


To bind a report to data from a non-Dabacon, proceed as follows:
• Create a new report.
• To bind the report to data, click its Smart tag. In the displayed actions list, expand the
Data Source dropdown menu and click Add New DataSource.

© Copyright 1974 to current year. 5:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• A window appears allowing a name to be defined for the dataset being created.

• Click Next. On the next page, specify the database to be used. If it is absent in the
dropdown menu containing existing connections, click New Connection to display the
Data Link Properties window.

© Copyright 1974 to current year. 5:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

In Provider tab of this window, choose a data provider (the database). Then switch to
the Connection tab to specify the path to the data source. Click OK, then Next.

• The next page allows tables to be selected and obtained from the database. Select the
required table and click Finish.

© Copyright 1974 to current year. 5:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: If several tables are chosen, Reporting creates a data relationship between them (if
possible), which is used to create master-detail reports.

• After performing the steps above the report is now bound to the data source and the
report's Data Source, Data Member and Data Adapter properties are set.

After binding a report to a data source, each data-aware report control must be bound
to a data field from that source. Refer to Display Values from a Database (Bind Report
Elements to Data) for further details.

5.3 Report Types


The Report Types provide instructions on how to create reports of different types with
Reporting and consists of the following:
• Static Report
• Table Report
• Master-Detail Report (Detail Report Bands)
• Multi-Column Report
• Cross-Tab Report
• Parameterised Report

© Copyright 1974 to current year. 5:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Chart with Static Series


• Chart with Dynamic Series.

5.3.1 Static Report


A static report is a report that is not be bound to a data source. In the following example, a
one-page announcement will be created which will then be repeated 20 times in a report.
To create a static report, follow the steps.
• Create a new report.
• Drop the Rich Text control from the Toolbox onto the Detail band.

• Select the created control and click its Smart tag. In the displayed actions list, click
Load File.

In the window then displayed, define the path to the RTF or TXT file containing the text
of the announcement, and click Open.

Note: Additional text formatting can be performed using the Formatting Toolbar.

• To repeat the content of the report 20 times, select the Detail band and in the Property
Grid set its Repeat Count when Data Source is Empty property to 20.
Also, to make the announcement print on separate pages (so that each instance of the
announcement is on a separate page), set the band's Page Break property to After
the Band.

© Copyright 1974 to current year. 5:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The static report is now complete. Switch to the Preview tab to view the result.

5.3.2 Table Report


To create a table report, follow these steps:
• Create a new report.
• Bind the report to a data source.
• Add two Table controls, one to the Page Header band and one to the Detail band of
the report.
To do this, click Table in the Toolbox. Then, in the Page Header band's content area,
click and hold down the left mouse button while dragging the mouse cursor across the
Detail band.

As a result, two tables are created. The one placed in the Page Header band will be
used as a header, while the other one will contain the report's detail information.

© Copyright 1974 to current year. 5:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Type the headers into the upper table's cells, and bind the cells in the detail section to
the appropriate data fields. This can be done by dropping these fields from the Field
List onto the cells.

• Various properties of the tables can be customised. For example the Property Grid can
be used to define Borders property and the Background Color. Text appearance can
be customised using the Formatting Toolbar and an odd-even page style can be
applied to the table.
The table report is now complete. Switch to the Preview tab to view the result.

5.3.3 Master-Detail Report (Detail Report Bands)


To create a master-detail report (report with hierarchically linked data) using the Detail
Report band, follow these steps.
• Create a new report.
• Bind the report to a data source containing a data relationship.

• To add a Detail Report band, right-click Reporting, and in the displayed Context
Menu, point to Insert Detail Report. If the bound data source contains a data
relationship, the submenu will contain an item with the name of that relationship. Select
this item to create a Detail Report band, already bound to the detail table.

© Copyright 1974 to current year. 5:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Drop the required data fields from the Field List onto the report's Detail and Detail
Report bands.
Regarding the Detail Report band, note that only items from the relation section (in this
example it is the Categories Products section) should be dropped, or there will be
incorrect output in the report.

The master-detail report is now complete. Switch to the Preview tab to view the result.

5.3.4 Multi-Column Report


To create a multi-column report, follow these steps.
• Create a new report.
• Bind the report to a data source.
• Add a Group Header band to a report.
To do this, right-click anywhere on the report, point to Insert Band on the menu that is
then displayed, and click GroupHeader.

© Copyright 1974 to current year. 5:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Drop a field, which will be used as a grouping criteria, from the Field List onto the
created GroupHeader1 band.
• To define the report's grouping, select the GroupHeader1 band and click its Smart
Tag. In the displayed actions list, locate the Group Fields option and click the ellipsis.

The GroupField Collection Editor is displayed. In this window, click Add, to create a
grouping field and set its Field Name to the same field as was selected for use as the
grouping criteria.

• Now, drop the required fields onto the report's Detail band.
• Select the Detail band, and in the Property Grid, expand the Multi-Column Options
section. Set the Column Count property to 3, Column Spacing to 20 and Direction to
First Across, then Down.

© Copyright 1974 to current year. 5:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• On the Detail band's surface a grey area appears, delimiting the available column's
width. A blue area also appear, representing a space between columns.
The multi-column report is now compete. Switch to the Preview tab to view the result.

5.3.5 Cross-Tab Report


Cross-tab reports are created using a Pivot Grid control, using the following steps.

Create a Pivot Grid and Bind it to Data


• Create a new report.
• Drag a Pivot Grid control from the Toolbox onto the report's Detail band.

• To bind the grid to a data source, click its Smart tag, and in the XRPicotGrid Tasks
menu, expand the Data Source dropdown menu and click Add New DataSource. The
Report Wizard window is displayed.
The wizard will guide the user through the process of assigning a data source to the
grid. For detailed instructions on the wizard's steps, refer to Bind Report to Non-
Dabacon Data, as this process is similar.

© Copyright 1974 to current year. 5:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• The specified data source is then assigned to the grid's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the grid should obtain data from, as is the Data Adapter property.

Note: The report's Data Source property must be set to None. Otherwise, the grid will be
blank when it is previewed.

Manage the Grid's Fields


• Click the grid's Smart tag, and in the displayed actions list, click Run Designer. The
Property Editor is displayed.
• In this window, click Retrieve Fields and switch to the Layout section in the navigation
bar on the left.
• Drag and drop the required fields to the Row Fields, Column Fields and Data Items
areas.

© Copyright 1974 to current year. 5:29 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Click Apply and close the Property Editor.

The cross-tab report is now complete. Switch to the Preview tab to view the result.

5.3.6 Parameterised Report


To create a report with parameters, proceed as follows.
In this example, a report with two parameters of the Date Time type will be created, defining
the time period for data that will appear on the report.
• Create a new report.
• Bind the report to a data source and drop the required fields from the Field List onto
the report's Detail band.
• In the Field List window, right-click on the Parameters section, and in the displayed
menu, click Add Parameter.

© Copyright 1974 to current year. 5:30 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Repeat this action to create the second parameter.


• From the Field List, select the first parameter, and in the Property Grid, set its (Name)
to FromDate, Description to From: and Parameter Type to Date Time.
For the second parameter, set the properties as shown in the following image:

• Select the report (by clicking anywhere on the blank space surrounding the band area),
and in the Property Grid, locate the Filter String property and click the ellipsis. The
FilterString Editor is displayed.

In this window, define the expressions required to created the parameters.

© Copyright 1974 to current year. 5:31 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: Make sure that the report's Request Parameters property is set to Yes (which is the
default setting). Otherwise, the parameters will not be requested when the report is
previewed, and a blank report will be the result.

• Finally, drop the required data fields from the Field List onto the report bands to create
the report layout.
The parameterised report is now complete. To view the results, switch to the Preview tab,
and in the Parameters section, define the required values and click Submit.

5.3.7 Chart with Static Series


To create a report with a Chart control bound to a data source, so that a particular series has
its own data source, proceed as follows.
This example describes how to construct a chart of products and their prices for a chosen
category using the data from the Northwind database (the sample nwind.mdb database).

Note: In this simple example, the series has a single data source. However, different data
sources can be used for different series if required.

• Create a new report.


• Drag the Chart control from the Toolbox onto the report's Detail band.

© Copyright 1974 to current year. 5:32 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: The Chart Wizard may be displayed at this point (if its 'Show wizard every time a
new chart is added' option is enabled). Click Cancel to close the wizard's window
and manually customise the chart.

• To bind the chart to a data source, click its Smart tag, and in the displayed actions list,
expand the Data Source dropdown selector and click Add New DataSource. The
Report Wizard is displayed.

The wizard guides the user through the process of assigning a data source to the chart.
For detailed instructions on the wizard's steps, refer to Bind Report to Non-Dabacon
Data, as this process is similar.
• The specified data source is then assigned to the chart's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the chart should obtain data from, as is the Data Adapter property.

© Copyright 1974 to current year. 5:33 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: The report's Data Source property must be set to None. Otherwise, the chart will be
blank when previewed.

• To add a series to the chart and specify its data binding properties, use the Series
Collection Editor. It can be displayed either via the Property Grid, or via the Series
link in the chart's Smart tag.
In the editor, create a series by clicking Add and selecting the Bar view.
Switch to the Properties tab.

© Copyright 1974 to current year. 5:34 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Set the series' Data Source property to the created dataset, define the Argument Data
Member and Data Members properties.
Click Copy to create another series with the same properties, and set its View property
to Point.
To save the changes and close the editor, click Close.
Note: After this step, there are maybe too many data points, making the chart difficult to
interpret. The chart's Data Filters property is used to limit the number of data points
shown by applying a filtering criterion. Click Series1 in the chart to select it, then in
the Property Grid locate the Data Filters item and click the ellipsis to display the
Data Filter Collection Editor.

• Click Add to add a criterion, and define its properties as shown in the following image:

To save the changes and close the editor, click Close.


Repeat the same actions for Series2, i.e. choose its Data Filters property, add a filter
and define its Column Name.
• To improve a chart's appearance a number of changes can be made, for example:
• Remove the chart's legend, as it shows the same data for the series, select the
legend item in the chart, and in the Property Grid, set its Visible property to No.
• The point labels for Series1 are unnecessary, so select the label and set its Visible
property to No.
• Customise the Series2 marker's appearance. Replace the default circle with the
upside-down triangle by the View.Point Marker Options.Kind property and set its
Size to 12.
• Rotate the X-axis labels for better readability. Click the AxisX item in the chart to
select it, and the adjust properties for its labels (via the Label property). In this
example, setting the Angle property is 20 and the Antialiasing property set to Yes,
improves the appearance of the labels.
It is possible to customise many other properties for the chart, which are not described
here.
The chart is now complete. Switch to the Preview tab to view the result.
For details of another method of binding a chart to data, refer to Chart with Dynamic Series.

© Copyright 1974 to current year. 5:35 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.3.8 Chart with Dynamic Series


To create a report with a Chart control bound to data, in which the all series will be auto-
created using the series template specifying common data binding properties for all series,
proceed as follows.
The data for all series (the series names along with series points' arguments and s) must be
stored in the same data table. Also, the series view type and certain other settings should be
the same for all the created series.
In this example the 'GSP' table of the sample gsp.mdb database will be used. This table
contains the Gross State Product (GSP) statistics for some US regions.

The main steps of the procedure are:


• Create a chart and bind it to data
• Specify a series data member and adjust a series template
• Customise the chart
• View the result

Create a Chart and Bind it to Data


• Create a new report.
• Drag Chart from the Toolbox onto the report's Detail band.

© Copyright 1974 to current year. 5:36 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: At this point, the Chart Wizard may be displayed (if its Show wizard every time a
new chart is added option is enabled). Click Cancel to close the wizard's window
and manually customise the chart.

• To bind the chart to a data source, click its Smart tag, and in the displayed actions list,
expand the Data Source dropdown selector and click Add New DataSource. The
Report Wizard is displayed.

The wizard will guide the user through the process of assigning a data source to the
chart. For detailed instructions on the wizard's steps, refer to Bind Report to Non-
Dabacon Data, as this process is similar.
• The specified data source is then assigned to the chart's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the chart should obtain data from, as is the Data Adapter property.

Note: The report's Data Source property must be set to None. Otherwise, the chart will be
blank when previewed.

Specify a Series Data Member and Adjust a Series Template


In this example, all series will be created using a series template which is common to all of
them.

© Copyright 1974 to current year. 5:37 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• To specify the data field which is to provide data for the series names, the Series Data
Member property must be set.

• Next, set the Argument Data Member property.

• Define the of the Data Members property, specifying the data fields from which the
series obtains the data values of its points.

© Copyright 1974 to current year. 5:38 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Customise the Chart


• Adjust the Series Name Template
By default, the name for every series automatically generated by the chart using its
Series Data Member property's is obtained directly from a data field in the bound data
source. However, it may be necessary to add prefixes or suffixes to these names. The
user may therefore customise the Series Name Template object returned by the
Series Name Template property to add some text to the beginning or to the end of the
series names. For instance, set the Series Name Template.Begin Text property to
GSP in.
• Customise Series Labels
Set the Series Template.Label.Visible property to No, to hide labels for all series
points, and prevent the chart from being crowded with numerous overlapping labels.
• Customise Axis Labels
Initially, all axis labels (which in this example show the names of the US regions) are
lined up and overlap. To avoid this, select the X-Axis (which is also accessed via the
Chart Control.Diagram.Axis X property) and set its Label.Staggered property to Yes.
It is possible to customise many other properties for the chart, which are not described
here.
View the Result
The chart is now complete. Switch to the Preview tab to view the result.

© Copyright 1974 to current year. 5:39 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

For details of another method of binding a chart to data, refer to Chart with Static Series.

5.4 Styles and Conditional Formatting


The appearance of reports is controlled by styles and conditional formatting. For detailed
information refer to:
• Styles Concepts
• Use of Odd and Even Styles
• Store and Restore Style Sheets
• Conditionally Change a Control's Appearance
• Conditionally Hide Bands.
• Conditionally Change a Label's Text

5.4.1 Styles Concepts


Each report element (band and control) and the report itself, has a group of properties
specifying the element's appearance, such as Background Color, Borders, Border Color,
Border Width, Font, Foreground Color, Padding and Text Alignment. By default, these
properties are set to no, meaning that their’s are obtained from their parent element control
or band. In turn, this means that these appearance-related properties, defined for a parent,
are inherited by their child elements.

© Copyright 1974 to current year. 5:40 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

If required, the default inherited appearance properties of a child element can be overridden
and set to difference properties, independent of parent element appearance properties.

If it is subsequently required to reset a child element’s appearance property to that of the


parent, right-click the property in the Property Grid, and in the displayed menu, click Reset.

© Copyright 1974 to current year. 5:41 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: Some of these properties are only applicable to certain controls. For example, the
Text Alignment properties of Line container bands are ignored and not inherited by
Line controls.

Additionally, there can be styles created in a report. A report's styles are stored in the
report's Style Sheet collection. A style stored within this collection has a set of the same
appearance properties as a control or a band has.
There are two ways to store a report's style sheets. The first approach is to save them to
external files (with the REPSS extension), and then load them into a report using its Style
Sheet Path property in read-only mode (this is described at Store and Restore Style
Sheets). The second is to store the style sheets within the report (using the Style Sheet
property), so that they can be modified, if required, and saved with the report itself.
Finally, the styles can be assigned to a report's bands and controls. A band or control can
therefore obtain its appearance either from a style assigned to it, or from the control's own
appearance properties. In this case, the control's Style Priority property allows the user to
define the required behaviour of the control's final appearance.
By default, all the Style Priority's options (Style Priority.Use Background Color, Style
Priority.Use Border Color, etc.), which follow the structure of the style and appearance
properties, are set to Yes (except the Use Text Alignment). Which means that if any style is
assigned to a control via its Styles property, all its properties will have a higher priority than
the properties stored in the control or in its parent. If some of the properties are to be
determined by a control, rather than its style, set the corresponding Use* property to No.

Note: If styles contained in a style sheet loaded in the Style Sheet Path property have the
same names as styles already contained in a report, the latter ones are overriden.

The following image demonstrates how the Style Priority property works.

© Copyright 1974 to current year. 5:42 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Note: When conditional formatting is used, the appearance defined by the conditional
formatting has a higher priority than the properties described above.

Another commonly used feature is odd-even styles. These allow the user to visually delimit
alternating data fields in a report, for better readability. More information about this can be
found in Use of Odd and Even Styles.

5.4.2 Use of Odd and Even Styles


Use of Odd and Even Styles describes how to create a report using odd and even styles.
For more information on using styles in Reporting, refer to Styles Concepts.
To utilise odd and even styles, follow these steps:
• Create a new report.
• Bind the report to a data source.
• Drag the required fields from the Field List onto the report's Detail band.

© Copyright 1974 to current year. 5:43 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Select the Detail band, and in the Property Grid, expand the Styles property.
Display the dropdown list for the Even Style property and click (New).

The xrControlStyle1 will be assigned to the Even Style property.


• Expand the Even Style property and set the Background Color property to Beige (or
any other of the properties available in this section as required).

© Copyright 1974 to current year. 5:44 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Repeat the last two steps for the Odd Style property, i.e. create a new style and set its
Background Color property to Ivory.

• If the report is previewed using the Preview tab at this stage, the created styles are
applied to all the controls contained in the Detail band.
• If a different style is required for one of the fields. Select the required field, and in the
Property Grid, expand its Styles property and open the dropdown list for the Style
property. Click (New).
Expand the Style property, and for the created xrControlStyle3, set the Background
Color property to White.

• The style of this control has priority over the Detail band's styles. Switch to the Preview
tab to view the result.

5.4.3 Store and Restore Style Sheets


It is possible to store a report's style sheet (containing all the report's styles) in an external
REPSS file and to restore a report's appearance from this file. For more information on

© Copyright 1974 to current year. 5:45 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

using styles in Reporting, refer to Styles Concepts.


To store and restore report style sheets, follow these steps:
• Create a new report.
• Bind the report to a data source.
• Click the report's Smart Tag, and in the displayed actions list, locate the Style Sheet
property and click the ellipsis.

• In the Styles Editor that is then displayed, click , to create new styles. Define their
properties and click Save.
In the Save File window, define a name for the style sheet file (.REPSS) and click
Save.

• In the Styles Editor window, click to delete the created styles, and close the window.
• Select the report by clicking anywhere on the blank area around its bands. In the
Property Grid, locate the Style Sheet Path property and click the ellipsis. Using the
Open File window, select and load the created REPSS file.

© Copyright 1974 to current year. 5:46 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Click the Style Sheet properties ellipsis. In the Styles Editor, observe that the
properties of the styles are read-only. This is because the Style Sheet Path property is
being used to define the styles.

If the Style Sheet Path property is subsequently set to None, and a style sheet is
loaded into a report using the Style Sheet property, all the styles loaded from the style
sheet file will still be stored in the report, but will become editable.
• Next, assign the styles to the report controls by using their Styles properties. In this
example, the created styles are assigned to the control's Odd Style and Even Style
properties. For more information, refer to Use of Odd and Even Styles.

Note: The styles loaded from a style sheet file have a higher priority than the styles which
exist in a report's style sheet, returned by the Style Sheet property. This means that

© Copyright 1974 to current year. 5:47 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

if the styles stored in the report have the same names as the styles loaded from a
style sheet file, then the styles in the file will substitute for their namesakes. The
styles loaded from a file cannot be edited in a report. For more information, refer to
Styles Concepts.

5.4.4 Conditionally Change a Control's Appearance


To conditionally change a control's appearance, follow these steps.
For more information on using styles in Reporting, refer to Styles Concepts.
• Create a new report.
• Bind the report to a data source.
• Drag the required fields from the Field List onto the report's Detail band.

• Select the report by clicking anywhere on the blank area around its band. In the
Property Grid, locate the Formatting Rules Sheet property and click the ellipsis. The
Formatting Rule Sheet Editor is then displayed. This is used to manage and
customise formatting rules, which then can be applied to the report's bands and
controls.
In this window, create a new formatting rule (click ), locate its Condition property and
click the ellipsis.

© Copyright 1974 to current year. 5:48 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• In the displayed Condition Editor, define the required Boolean condition. In this
example, the condition defined is that if the UnitPrice is greater than 30 the fields will
be formatted.

To save the condition and close the window, click OK.


• Now, define the formatting to be applied.

© Copyright 1974 to current year. 5:49 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Select the band or control to which the formatting rule must be applied (in this example
it is the Detail band), and in the Property Grid, locate the Formatting Rules property
and click the ellipsis. In the Formatting Rules Editor that is then displayed, move the
formatting rule from the Available Rules list to the Applied Rules list (using the >
button) in order to apply the rule to the control.

It is possible to customise the precedence of formatting rules by using the up and down
arrow icons at the right of the window. Rules are applied in the order that they appear in the
list, with the last rule in the list having the highest priority.

© Copyright 1974 to current year. 5:50 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.4.5 Conditionally Hide Bands


Bands may be conditionally hidden. In this example the Group Header and Detail bands will
be hidden if a grouping field meets a certain condition.

Note: That no scripts are required to accomplish this task.

• Create a new report.


• Bind the report to a data source.
• Add a Group Header band to the report.
Right-click anywhere on the report, and in the Context menu, point to Insert band and
click GroupHeader.

• Drag the field which will be used as a grouping criteria from the Field List onto the
created GroupHeader1 band.

• Click the Smart Tag of the GroupHeader1 band, and in the actions list, click the
ellipsis in the Group Fields section. The GroupField Collection Editor window is
then displayed.

© Copyright 1974 to current year. 5:51 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

In this window, click Add to add a new grouping field, and set its Field Name property
to the required field.
To apply the settings and close the window, click OK.
• Drag the fields representing the general report's data onto the report's Detail band from
the Field List.

• Select the Group Header band's strip, and in the Property Grid, locate the
Formatting Rules property, and click the ellipsis.
In the Formatting Rules Editor, click Edit Rule Sheet.

© Copyright 1974 to current year. 5:52 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• In the Formatting Rule Sheet Editor, click , to create a new rule. Then set its
Visible property to No, and for the Condition property, click the ellipsis.

• Construct the required boolean expression to be met (e.g. [ShipCountry] ==


'Argentina'), and click OK.

© Copyright 1974 to current year. 5:53 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Click Close to close the Formatting Rule Sheet Editor.


• In the Formatting Rules Editor, move the rule from the Available Rules list to the
Applied Rules list (using the > button) to apply it to the band.
Repeat this step for the report's Detail band (e.g. click its Formatting Rules property's
ellipsis, and in the window, make the same rule apply to this band, as well). Otherwise,
only the Group Header band will not be displayed when the rule's condition is met,
while the detailed section of this group will still be visible.

Switch to the Preview tab to view the result.


In this example, the Argentina section has not been added to the report as a result of
the conditional formatting.

© Copyright 1974 to current year. 5:54 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.4.6 Conditionally Change a Label's Text


To conditionally format a label's text, follow these steps.
• Create a new report.
• Bind the report to a data source.
• To create a calculated field, in the Field List, right-click any item inside the dataset, and
from the menu, choose Add Calculated Field.

• In the Property Grid, set the field's Field Type property to String. Locate its
Expression property and click the ellipsis. The Expression Editor is then displayed.

© Copyright 1974 to current year. 5:55 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

In this window, define the required condition for the calculated field (e.g.
Iif([UnitsOnOrder] == 0, 'None', [UnitsOnOrder]), which means that if the
UnitsOnOrder data field's is equal to 0, the appropriate control's text will be replaced
with None).
To close the window, click OK.
• Drag the required data fields (and the created calculated field as well) from the Field
List onto the report's Detail band.

The report is now complete. Switch to the Preview tab to view the result.

5.5 Navigation
Navigation covers the navigation-related features of Reporting and consists of the following
topics:
• Add Bookmarks
• Create Hyperlinks

© Copyright 1974 to current year. 5:56 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Add a Cross-Reference

5.5.1 Add Bookmarks


Reports may be created with bookmarks (or a Document Map). The feature enables users
to navigate through the report during its print preview.
To create a report with bookmarks, follow these steps.
• Create a report
• Define bookmarks
• View the Result

Create a Report
• Create a new report.
• Bind the report to a data source.
• Add a Group Header band to the report.
Right-click anywhere on the report, and in the Context Menu, point to Insert Band and
click GroupHeader.

• From the Field List, drag fields onto the created GroupHeader1 band.

• Click the Smart Tag of the GroupHeader1 band, and in the displayed actions list, click
the ellipsis in the Group Fields property. The GroupField Collection Editor window
is then displayed.

© Copyright 1974 to current year. 5:57 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

In this window, click Add to add a new grouping field, and set its FieldName property to
the required field.
To apply the settings and close the window, click OK.
• To add a Report Header band to the report, right-click anywhere on it, and in the
dropdown menu, point to Insert Band and click ReportHeader.

• From the Toolbox panel, drop a label onto the created Report Header band, and set
its text to Products by Categories.
• Drop a field representing the general report's data onto the created Detail band.

© Copyright 1974 to current year. 5:58 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Define Bookmarks
• Click the label in the Report Header band to select it, and in the Property Grid set its
Bookmark property to the same as its text (i.e. Products by Categories).

• Select the label in the report's Group Header band. As this control is bound to data, its
Bookmark property will be bound to the same data field, using the (Data Bindings)
property.

• Set the Parent Bookmark property for the field to the Report Header's label, to define
the document map's hierarchy.

View the Result


The report with bookmarks is now complete. Switch to the Preview tab or the Run Report
window to view the result.

© Copyright 1974 to current year. 5:59 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.5.2 Create Hyperlinks


The following example demonstrates how to create a hyperlink in a report.

Note: A label will behave as a hyperlink both in a report's Print preview, HTML preview and
when the report is exported to PDF, HTML, MHT, RTF and XLS formats.

• Create a new report.


• Drop a label onto the report and change its Text to that which is required for the link.
• In the Property Grid, set its Navigation Target property to the required (either _blank,
_parent, _search, _self, or _top), and for the Navigation URL property, define the URL.

The hyperlink is now ready. Switch to the Preview tab to view the result.

5.5.3 Add a Cross-Reference


Cross-references are links the targets of which are located within the current document and
are used to help navigation through a report.
In this example, a grouped report is created with a link at the bottom of each group, linking
to the beginning of the report.
To create a report with a cross-reference, follow these steps:

• Create a report with grouping.


• To add a Report Header band to the report, right-click anywhere on the report, and on
the Context menu, point to Insert Band and click ReportHeader.

© Copyright 1974 to current year. 5:60 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Drop a label onto the created ReportHeader band to serve as the report's headline.
Click the label to type the desired contents into it. In the Property Grid, set its Name
property to reportTop.

• Add a Group Footer band to the report.

• Drop another label onto the band. As it will be the link, change its text to Top of Report,
and apply the formatting to it that will indicate that it is a hyperlink (i.e. blue colour and
underlined text).
Finally, set its Navigation Target property to _self. Click the dropdown menu of the
Navigation URL property to view the controls available in the report, and select
reportTop.

© Copyright 1974 to current year. 5:61 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The cross-reference is now set up. Switch to the Preview tab to view the result.

5.6 Miscellaneous
Miscellaneous covers Reporting features which do not fall into other categories:
• Handle Events via Scripts
• Show the Current Row Index
• Count the Number of Records in a Report or a Group
• Cancel Printing If a Report Does Not Contain any Records
• Limit the Number of Records per Page

5.6.1 Handle Events via Scripts


Reporting includes a scripting feature to handle the events of report controls, report bands,
or reports themselves. The basic principles of scripting are described in this topic.

Overview
Scripting enables the user to insert scripts into a report, and execute them when the report
is previewed, printed or exported. Script commands should be placed within the event
handlers of the report objects. When the corresponding event occurs (e.g. a mouse click),
the script code runs.
Generally scripts are used for data-aware report formatting. Though Reporting enables
users to perform such tasks without any scripting (see Conditionally Change a Control's
Appearance, Conditionally Change a Label's Text and Conditionally Hide Bands),

© Copyright 1974 to current year. 5:62 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

sometimes it may be required to use scripts, for example to achieve more specific results.
The report's layout can be fully customised using of scripting.
Scripting also is the only way to calculate custom summaries.
Every report object has a set of events that can result in a script being run. The set of events
depends on a particular element type. For example, the Label control's events are shown in
the following image:

When the ellipsis is clicked for any event, the Script Editor window is displayed:

If there is no script defined for this event, the window contains a script template in the
language specified by the Script Language property of the report (C#, Visual Basic or J#).
Insert the script code with the help of this simple editor. Since there are no syntax checks or
a debugger, the user must ensure that the entered script is correct. If there are errors in the
script, an error message will display on previewing the report.

© Copyright 1974 to current year. 5:63 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

To restore the default script, in the Script Editor window, click Default Script which will
eliminate all the changes made to scripts.
The scripts are saved along with the report layout to a file (for details on this, refer to Back
up the Current Layout before Modification).

Specifics
1. Scripting Language
The report scripts may be written in the following languages that the .NET framework
supports: C#, Visual Basic and J#. Since J# is not installed with the framework
installation by default, make sure it has been installed before writing code in it. The
scripting language is specified via the Script Language property of the Report object.
It is set to the C# language by default.
2. Scripting Scope
Script execution is performed in the following way:
• The report engine generates a temporary class in memory. The names of the
variables are defined by the Name properties of the controls and objects they
represent. When the script is pre-processed, its namespace directives are taken
from the script code and added to the namespace where the temporary class is
defined.
• After pre-processing, all scripts are placed in the code of the temporary class. The
resulting class is then compiled in memory, and its methods are called when events
occur.
• Scripting offers many advantages: to declare classes (they will become inner
classes), variables, methods, etc. A variable declared in one script is accessible in
another script, because it is in fact a variable of the temporary class.
3. Reference External Assemblies
The Script References property of the Report object specifies the full paths (including
the file names) to the assemblies that are referenced in the scripts used in a report.
These paths should be specified for all the assemblies that are included in scripts via
using (C#), Imports (Visual Basic) or import (J#) directives.
Note: Assembles do not usually need including, because most standard assemblies that
may be required in scripts are already referenced by Reporting.

Example: Custom Summary


In this example, the total number of product unit packs in a group will be displayed.
Execute steps similar to those described in Add Totals to a Report, except that for the
summary field, the Function property should be set to Custom.

© Copyright 1974 to current year. 5:64 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

The additional events must then be added to the label's Scripts property.

Handle these events in the following way:

© Copyright 1974 to current year. 5:65 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Finally, switch to the Preview tab to view the result.

5.6.2 Show the Current Row Index


To show the current row index in a report, follow these instructions.
• Create a new report or open an existing one.
• Bind the report to a data source.
• Drop the required fields from the Field List onto the report's Detail band.

• Select the field for which the current row index will be displayed by clicking on it. Then
hold down CTRL and drag the field to create an exact copy of the Label, which will
display the index.

• Select the created Label, and in the Property Grid, locate the Summary property and
click the ellipsis. The Summary Editor is displayed.
In this window, the Bound field is already set to the required data field. So for the
Summary function select RecordNumber and check Ignore NULL Values to avoid
these data fields from affecting the calculation.

© Copyright 1974 to current year. 5:66 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Next, set the Summary Running option to Report (Group or Page if required) and
click OK.

5.6.3 Count the Number of Records in a Report or a Group


To count the number of records in a report or a group, follow these instructions:
• Create a new report or open an existing one.
• Bind the report to a data source.
• Add a Report Footer band to a report. Right-click anywhere on report and in the
Context menu, point to Insert Band and select ReportFooter.

© Copyright 1974 to current year. 5:67 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• In the same manner, add GroupHeader and GroupFooter bands to the report.
• Drop the required data fields from the Field List onto the Report bands.

• Click the field for which the number of records will be calculated to select it. Then hold
down CTRL and drag the field onto the Group Footer area to create an exact copy of
the label, which will display the number of records for a group.

• In the same way, create a copy of this field in the Report Footer area, to display the
number of records for the report.
• Click the Smart Tag of the GroupHeader1 band, and in the displayed actions list, click
the ellipsis in the Group Fields section. The GroupField Collection Editor window is
then displayed.

In this window, click Add, to add a new grouping field, and set its FieldName property
to the required field.
To apply the settings and close the window, click OK.
• Select the Label in the Group Footer area, and in the Property Grid, expand the
Summary property.

© Copyright 1974 to current year. 5:68 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

Set the Running property to Group, the Function property to Count and (if required)
the Ignore Null Values property to Yes. Set the Format String property to Products
in the Group: {0}.
• Similarly, select the label in the Report Footer area, and in the Property Grid, expand
the Summary property.

Set the Running property to Report, the Function property to Count, the Ignore Null
Values property to Yes and the property Format String to Products in the Report:
{0}.
The report is now complete. Switch to the Preview tab to view the result.

5.6.4 Cancel Printing If a Report Does Not Contain any Records


To cancel printing when a report does not contain any records, set the Detail band's Print
when Data Source is Empty property to No.
The user can quickly perform this via the band's Smart tag.

© Copyright 1974 to current year. 5:69 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

5.6.5 Limit the Number of Records per Page


The number of records shown in a report can be limited by means of conditional formatting.
In particular, a formatting rule is applied to the Visible property of the Page Break control. In
this example, the number of data rows is passed to the report as a parameter.
To limit the number of records per page, follow these instructions.
• Create a new report or open an existing one. In this example, a data-aware table report
is used as a starting point.

• To add a parameter to the report, in the Field List, right-click the Parameters section,
and in the dropdown menu, choose Add Parameter.

© Copyright 1974 to current year. 5:70 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• Set the (Name) property of the parameter to rowsNumber, the Parameter Type
parameter to Int32 and the Description property to Rows per Page:.

• Drag the Page Break control from the Toolbox onto the report's Detail band and place
it at the top of the detail table.

© Copyright 1974 to current year. 5:71 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• For the created control, set the Visible property to No, and for its Formatting Rules
property, click the ellipsis to display the Formatting Rules Editor.

In this window, click Edit Rule Sheet. The Formatting Rule Sheet Editor is then
displayed.
• Click , to create a new formatting rule. Set its Visible property to Yes, and for the
Condition property, click the ellipsis, to display the Condition Editor.

© Copyright 1974 to current year. 5:72 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

• In this editor, define the following expression for the rule:


([DataSource.CurrentRowIndex] % [Parameters.rowsNumber] == 0) And
([DataSource.CurrentRowIndex] != 0).

Click OK to save the changes and close the window. Then click Close to close the
Formatting Rule Sheet Editor.
• In the Formatting Rules Editor, the created rule is displayed. Move it to the list of
applied rules on the right, use the > button.

© Copyright 1974 to current year. 5:73 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Create Reports

To close the editor, click OK.


The report is now complete. Switch to the Preview tab, and in the Parameters section,
define the required and then click Submit.

© Copyright 1974 to current year. 5:74 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

6 Running Reports from outside of the Reporting

Reports can be run from outside of Reporting in three ways. Refer to:
• PML Object
• Search Results Grid - Quick Reports
• Run Report

6.1 PML Object


A PML Object is provided to support batch operation of the reporting tool. This object is
described in the Software Customisation Reference Manual.

6.2 Search Results Grid - Quick Reports


The results of a search may be sent from the Search Results grid to the reporting tool for
formatting. Where you want to use a frequently used Saved Search as the basis for a Quick
Report you may save and re-use the Report Layout you design for use with this Saved
Search.
To use the Quick Reports feature, activate the right-click menu available from any column
heading in the Search Results grid, and select Quick Report.

© Copyright 1974 to current year. 6:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

The Report Manager will open. Select a Layout Template to use for the quick report. If you
are using a Saved Search as the basis for the quick report and you have already designed a
layout template for use with this Saved Search, then select that Layout Template.

Note: Group sorting applied to search results (using the Enable Group Sorting menu option
and associated functionality) will not be applied to Quick Reports generated from the
search results.

© Copyright 1974 to current year. 6:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

After you have selected the layout template you want to use for your Quick Report, you will
be asked if you want a default layout to be applied.

If you select Yes, the Reporting Tool will automatically place the fields in your Search
Results grid into a system generated table placed directly in your Quick Report. Select this
option when your search results grid contains a small number of fields.
If you are using a Saved Search and have selected a Layout Template which you have
already designed for use with this Search then do not select Yes, as the Default Layout will
overwrite your Layout Template layout.
If you would like more control over the placement of your search results grid fields in your
quick report, then do not select the Default Layout.
If you selected the Default layout option, the columns displayed in your Search Results grid
will be automatically placed in a system generated table on the report.
If you did not select the default layout option, you will be able to drag and drop the fields
from your saved search from the Field List onto your Report Layout.

© Copyright 1974 to current year. 6:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

The Preview shown in a Quick Report includes all data supplied by the Search Results grid.
Data Source, Scope and Run buttons are disabled in a Quick Report preview. Datasource is
not required as the source of data for a Quick Report is the Search Results Grid. Scope is
defined in the Search. Run is not required, as a Quick Report can be exported from the
Preview, which in a Quick Report contains all of the data from the Search Results grid.
You may only save a Quick Report as a Layout Template, as there is no binding to a
Datasource. Save your Quick Report layout so you may use it again for any Search Results
grid where the Column Headings match, as the Column Heading is used to identify where to
place Search Results on a Report Layout.
For example, the Search Results Column OWNER…

Will be placed in the Layout Template label mapped to the Field OWNER:

© Copyright 1974 to current year. 6:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

6.3 Run Report


Reports created using Reporting may be shared across a project or organisation and run
directly without the need to use Reporting.
The Run Report feature opens the Run Report window. You may navigate to the Product,
Project or User areas or Browse elsewhere to select the report you want to run. A preview of
the Report will be shown.

If the report is parameterised, or a scope needs to be defined, you will be prompted to


provide the information the report requires to run.
The Report output will then be displayed.

© Copyright 1974 to current year. 6:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Running Reports from outside of the Reporting

© Copyright 1974 to current year. 6:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7 Reference

A report is built from controls (text labels, images, zip codes, charts, etc) in report sections
called bands (various headers, footers and content sections). The main interface elements
for managing these building blocks are the control toolbox, data field list and property
grid. These elements enable users to add controls to a report, bind them to data and
change their appearance and behaviour settings, respectively. To learn more about these
and other elements and features in Reporting, use the following links:
• User Interface
Describes how to use a control toolbox, data field list, property grid and other UI
elements.
• Report Settings
Details settings that affect the entire report.
• Report Bands
Details different kinds of bands and their settings.
• Report Controls
Details which controls are available, and how to change their appearance and
behaviour.
• Preview Reports
Describes how to preview reports.
• Print and Export Reports
Describes how to print and export reports.

7.1 User Interface


The Reporting User Interface consists of the following important elements:
• Component Tray
• Context Menu
• Control and AVEVA Toolboxes
• Design Panel
• Designer Tab
• Property Grid
• HTML View Tab
• Field List
• Formatting Toolbar
• Layout Toolbar
• Main Toolbar
• AVEVA Toolbar

© Copyright 1974 to current year. 7:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Property Grid
• Report Explorer
• Smart Tag
• Zoom Toolbar.

7.1.1 Component Tray


The Component Tray shows components (non-visual report helpers) the primary purpose
of which is to bind a report to data. The user can click them to display and edit their settings
using the Property Grid.

Note: Component management and data binding configuration are usually performed by
system administrators or a application vendors, since these areas require advanced
knowledge of database connectivity. A user will rarely, if ever, need to access
component settings when modifying existing reports.

7.1.2 Context Menu


A Context Menu can be displayed by the right-clicking a report or its elements. This menu
provides quick access to frequently used commands such as zooming, clipboard
operations, inserting bands and displaying the Property Grid, etc. The available action set
varies, depending on the element for which the context menu is displayed.

© Copyright 1974 to current year. 7:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.1.3 Control and AVEVA Toolboxes


The Control Toolbox and the AVEVA Toolbox list all available controls and allows the user
to add them to a report.

© Copyright 1974 to current year. 7:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

To add a control from the Toolboxes, do one of the following:


• Double-click an item in the Toolboxes for the appropriate control, which will be created
at the Detail band's top left corner.
• Drag and drop an item from the Toolboxes onto the required location within a report.

© Copyright 1974 to current year. 7:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Select an item in the Toolboxes, and then click the required location within a report.
• Select an item in the Toolboxes, and then indicate the bounding rectangle by holding
the left mouse button and dragging the cursor from one corner of the rectangle to the
opposite corner.

Select to perform selection, re-positioning or resizing operations. It is automatically


selected after a control is dropped onto a report.

Note: If the Toolbox panel is not displayed, select View > Windows > Tool Box in the main
menu to display it.

7.1.4 Design Panel


The Design Panel provides the following three tabs (switched at the bottom):
• Designer Tab
Enables uses to modify a report.
• Preview Tab
Shows a print preview, and enables users to print out a report or export it to a file.
• HTML View Tab
Shows the report output in HTML format.

© Copyright 1974 to current year. 7:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.1.5 Designer Tab


The Designer Tab of the Design Panel enables users to customise a report, manage its
bands and controls, and define their properties.

© Copyright 1974 to current year. 7:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.1.6 Preview Tab


The Preview Tab of the Design Panel is used to check the print output of a report. To learn
more about print preview capabilities, refer to Preview Reports.

7.1.7 HTML View Tab


The HTML View Tab of the Design Panel enables users to preview the HTML output of a
report.

7.1.8 Field List


The Field List window serves the following purposes:
• Displays the list of all available data fields (attributes that can be shown in a report) and
enables users to create report elements that will show information from these fields.
• Enables users to create calculated fields by building expressions based on the values
of data fields, report parameter values, etc.
• Shows existing report parameters, and enables users to add parameters to a report.

© Copyright 1974 to current year. 7:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: If the toolbox window is not displayed, select View > Windows > Field List from the
main menu to display it.

Field list explorer will not display multi-byte characters set if the respective language is not
installed.
Different icons will be displayed in field list for standard attribute and attributes created via
expression.

7.1.9 Formatting Toolbar


The Formatting Toolbar enables users to customise an element's font, colour and
alignment settings.

© Copyright 1974 to current year. 7:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Formatting
Toolbar from the main menu to display it.

7.1.10 Layout Toolbar


The Layout Toolbar enables users to easily align report elements to one another, change
their size to match one another and customise spacing and z-order.

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Layout Toolbar
from the main menu to display it.

7.1.11 Main Toolbar


The Main Toolbar contains icons which provide the capability to create new reports, save
and load report layouts, cut, copy and paste report elements, and undo-redo actions in
Reporting.

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Main Toolbar
from the main menu to display it.

7.1.12 AVEVA Toolbar


The AVEVA Toolbar contains icons for specifying the data source and scope for reports and
for running reports.

Note: If the AVEVA Toolbar is not displayed, select View > Toolbars > AVEVA from the
main menu to display it.

© Copyright 1974 to current year. 7:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.1.13 Property Grid


The Property Grid enables users to change the settings of the currently selected report
element.

To select an element and show its properties within the Property Grid, do one of the
following:
• Click the required element on Reporting surface.
• Select an element using the Report Explorer window.
• Select an element from the Property Grid's box.
Note: If the Property Grid is not displayed, select View > Windows > Property Grid from
the main menu to display it.

7.1.14 Report Explorer


The Report Explorer shows a report's structure in a tree form, providing easy access to
report elements. Once an element has been selected in the Report Explorer, it's settings
can be changed using the Property Grid window.

© Copyright 1974 to current year. 7:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: If the Report Explorer is not displayed, select View > Windows > Report Explorer
from the main menu to display it.

7.1.15 Smart Tag


Most report elements have smart tags that provide easy access to the most frequently used
settings. Clicking an element's smart tag displays a popup window with action links and
editors, enabling users to customise this element.
• Report Smart Tag
A report's smart tag icon is located at the top left corner of the Design Panel.
Note: The corner must be clicked twice. The first click selects the report object, enabling
the user to change its settings in the Property Grid. The second click displays the
smart tag's popup window.

• Band Smart Tag


A band's smart tag icon is located on the band strip right next to its caption. For
instance, the smart tag for the Detail band is shown in the following image:

© Copyright 1974 to current year. 7:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Control Smart Tag


A control's smart tag icon is located in the top right corner of the control. For instance,
the smart tag for the Label control is shown in the following image:

• Picture Box Control Smart Tag


A Picture Box control’s smart tag icon is located in the top right corner of the control.
The smart tag for a Picture Box control is shown in the following image:

© Copyright 1974 to current year. 7:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.1.16 Zoom Toolbar


The Zoom Toolbar enables user to zoom a report in and out, providing easier control over
report's layout.

Note: If the Zoom Toolbar is not displayed, select View > Toolbars > Zoom Toolbar from
the main menu to display it.

7.2 Report Settings


While the main report's properties can be accessed via the report's Smart Tag, the complete
settings list is available in the Property Grid, where all the report's properties are divided
into the following groups:
• Appearance
• Behaviour
• Data
• Design
• Misc
• Navigation
• Page Settings
• Parameters

7.2.1 Appearance
• Background Color
Specifies the background colour of report elements. This option is also available on the
Formatting Toolbar ( ).
Note: Report background colours are not included when a report is exported to RTF or
MHT format.

• Borders, Border Color and Border Width


Specifies border settings for report elements.
• Font
Specifies the font settings for report elements. Some of these settings are available on
the Formatting Toolbar.
• Foreground Color

© Copyright 1974 to current year. 7:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Specifies the text colour for report elements. This option is also available on the
Formatting Toolbar ( ).
• Formatting Rule Sheet
Displays the Formatting Rule Sheet Editor, enabling users to manage and customise
formatting rules, which can then be defined for a report's bands and controls. For more
information, refer to Conditionally Change a Control's Appearance.

• Formatting Rules
Displays the Formatting Rules Editor, enabling users to choose which rules should
be applied to a report during report generation, and define the precedence of the
applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

© Copyright 1974 to current year. 7:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Padding
Specifies indent values used to render the contents of a report's controls.
• Style Sheet
Enables users to display the Styles Editor, which is used to manage and customise a
report's style sheets. For more information, refer to Store and Restore Style Sheets.

• Style Sheet's Path


Enables users to define a path to the style sheet contained in a report style sheet file
(.REPSS). For more information, refer to Store and Restore Style Sheets.
• Text Alignment
Enables users to change the alignment of a report controls' text. This option is also
available on the Formatting Toolbar.

© Copyright 1974 to current year. 7:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Watermark
Enables users to customise a report's watermark options. For more information, refer
to Create or Modify Watermarks of a Report.

7.2.2 Behaviour
• Export Options
Enables users to set the export options for each file type (PDF, XLS, TXT, etc.). These
options vary with Reporting 311 file type.
• Measure Units
Enables users to choose units of measurement for a report (one hundredth of an inch
or a tenth of a millimeter).
• Script Language
Enables users to choose the programming language to be used in scripting (C#, Visual
Basic or J#).
• Script References
Enables users to manage the collection of strings that represent the paths to the
assemblies used by the scripts in a report.
• Scripts
This property contains events which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Show Margin Lines in Preview
The page margin lines are dotted lines shown on the currently selected page in a
report's preview. Use this property to change the visibility of these lines.
• Vertical Content Splitting
Enables users to choose whether report controls outside the right page margin should
be split across pages, or moved in their entirety to the next page.
• Visible
Specifies whether or not a report should be created in print preview.

7.2.3 Data
• Calculated Fields
Enables users to access a report's calculated fields collection editor.

© Copyright 1974 to current year. 7:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Data Adapter
Specifies the report's data adapter, used to populate the report's data source. It is
created automatically when the Data Member property is defined. For more
information, refer to Bind a Report to Data.
• Data Member
Specifies the specific list (database table) in a report's Data Source, from which
Reporting objects display data. For more information, refer to Bind a Report to Data.
Note: It is not usually necessary to specify the Data Member property when binding a
report to data. This property should only be set if the Data Source dataset contains
more than one table.

• Data Source
Determines a report's Data Source. For more information, refer to Bind a Report to
Data.
• Filter String
Used to display the Filter String Editor, which is intended to easily define a filtering
condition for a report's data. For more information, refer to Change or Apply Data
Sorting to a Report.

• Tag
This property is used to add some additional information to a report; for example its id,
by which it can then be accessible via scripts.
• XML Data Path

© Copyright 1974 to current year. 7:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Used to define a path to data contained in an external XML file. The data contained in
the file will then be used as a report's data source.

7.2.4 Design
• (Name)
Determines a report's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts.
• Data Source's Schema
Enables users to load an XML/XSD file, containing the schema of a report's data
source.
• Draw the Grid
Determines whether or not the grid is displayed when a report is being designed.

• Grid Size
Determines the size of the grid that may be displayed when a report is being designed,
depending on the Draw the Grid setting.
• Row Count for Preview
This property is used to reduce the time that report previews take to load when working
with large data sources. For example, if this property is set to 10, only 10 data rows will
be loaded into a data source. All data rows are to be previewed, set this property to 0
(as it is by default).
• Show Designer's Hints
The designer hints are intended to provide tooltips, both describing the purpose of
certain report elements for inexperienced users, and describing the reasons and
solutions for possible export or printing warnings. This property is used to turn these
hints on or off.

© Copyright 1974 to current year. 7:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Show Export Warnings


This setting controls whether or not export warnings are displayed when report controls
are overlapped, indicating that a report layout may be incorrect when exporting to
certain table-based formats (such as XLS, HTML or RTF).

• Show Printing Warnings


This setting controls whether printing warnings are displayed. Printing warnings
indicate that some of a report's controls are placed outside the right page margin, so
that the report contains unnecessary pages.

• Snap to Grid
This property controls whether or not controls snap to the grid when they are positioned
on a report or resized.

7.2.5 Misc
• Bands
Used to display the Report Editor, intended to manage and customise a report's
bands.

© Copyright 1974 to current year. 7:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.2.6 Navigation
• Bookmark
Used to define how a report is named in a document map when report bookmarks are
implemented. By default, it will be the same as the report's Name property.

7.2.7 Page Settings


• Landscape
Determines whether the page orientation is Landscape (when set to Yes) or Portrait
(when set to No).
• Margins
Determines the width of a report's margins (measured in report units).
Note: The report's Margins.Top and Margins.Bottom properties are tied to the Height
property of the Page Margin Bands. Therefore changing these values will change the
appropriate bands' Height value as well, and vice versa.

• Page Height
Specifies page height, in report units. This property can only be set if the Paper Kind
property is set to Custom.
• Page Width
Specifies page width, in report units. This property can only be set if the Paper Kind
property is set to Custom.

© Copyright 1974 to current year. 7:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Paper Kind
Determines the type of paper that a report will be printed on. Setting this property to
any value other than Custom will prevent the Page Height, Page Width and Paper
Name properties from being customised.
Note: If the Paper Kind property is set to Custom, then the printer paper will be selected
according to the Paper Name property's value. In this case, it is also necessary to
set the Page Width and Page Height properties to the values of the paper selected.

• Paper Name
Determines the name of the custom paper used in the printer on which the report will
be printed.
The Paper Name property's value applied only when the Paper Kind property is set to
Custom. If this property is used, it is also necessary to set the Page Width and Page
Height properties to the values of the selected paper. If the printer on which a
document is printed doesn't support the paper type specified by the Paper Name
property's value, then it will default to the Letter paper size.
• Printer Name
Determines the name of the printer to use when printing a report.
• Using Settings of the Default Printer
Specifies which of the default printer's settings should be used when printing a report.

7.2.8 Parameters
• Parameters
Enables access a report's parameters collection.

• Request Parameters
Enables users to define whether the values of a report's parameters are to be
requested when generating a report.

© Copyright 1974 to current year. 7:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.3 Report Bands


Reporting creates banded reports. Bands are report sections that can be printed once in a
report (report header and footer), or on each report page (page header and footer), or for
each data entry (detail band), or for each data group (group header and footer), etc.

7.3.1 Band Types


Reporting uses the following band types:
• Detail Band
• Group Header and Footer Bands
• Report Header and Footer Bands
• Page Header and Footer Bands
• Page Margin Bands
• Detail Report Bands (for Master-Detail Reports).

7.3.2 Manage Bands


Users can manage a report's bands using the Report Editor, which may be displayed either
using the Edit and Reorder Bands context link of a report's Smart Tag actions list:

... or via any band's Smart Tag:

© Copyright 1974 to current year. 7:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

The Report Editor enables users to easily add, remove and reorder a report's bands, and
to define their properties.

Another method of adding a band to a report is to display the Context Menu by right-clicking
anywhere on the report's.

© Copyright 1974 to current year. 7:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.3.3 Detail Band


The Detail Band is the central part of a report. Unlike other report bands, this band cannot
be deleted - the report structure includes the Detail band as its core. The contents of the
Detail band are repeated for every data entry. If a report listing, for example, employees is
being built, it will be rendered for each employee in the database.

© Copyright 1974 to current year. 7:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, a Detail Band's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor which enables users to choose which rules
should be applied to the band during report generation, and define the precedence of
the applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

© Copyright 1974 to current year. 7:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Padding
Specifies the indent values which are used to render the contents of the controls
contained within the band.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the controls contained within the
band, as well as to assign an existing style to them (or a newly created one). For more
information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the band. This
option is also available on the Formatting Toolbar.
Behaviour
• Keep Together
As stated above, the Detail band is printed for every data entry. When the Keep
Together option is on, Reporting attempts to keep sequential detail band entries
together. This option makes sense only when data is grouped or in the case of a
master-detail report. The report engine tries to keep group contents on one page. If a
group does not fit and would start in the middle of a page, the report moves this group
to a new page, thus reducing the number of page breaks in continuous data.
• Multi-Column Options
This property is used to arrange the printout of the band's content in several columns.
For more information, refer to Multi-Column Report.
• Page Break
Use this property if the current report design requires that the detail section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many cases,
this property may be used instead of the Page Break control.
• Print when Data Source is Empty and Repeat Count when Data Source is Empty
The first property specifies whether a Detail band should be printed if the report's
primary data source is empty. When it is set to Yes and the report is not bound to data,

© Copyright 1974 to current year. 7:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

the user may set the second property value to the number of times that the Detail band
contents should be repeated when the report is printed or exported.
• Scripts
This property contains events, which can be handled by the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Sort Fields
Displays the Group Field Collection Editor, which enables users to specify the fields
for sorting the records within the band, the sorting order (Ascending/Descending) for
each field and the order sequence. For more information, refer to Change or Apply
Data Sorting to a Report.
• Tag
This property enables users to add additional information to the band; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units. The default height for a newly created Detail
band is 100.
Misc
• Keep Together with Detail Reports
When this option is on, the Detail band will be always printed on the same page as its
child Detail Report Band, or multiple bands.

7.3.4 Group Header and Footer Bands


The Group Header and Group Footer bands are shown above and below each group. See
Change or Apply Data Sorting to a Report for additional information.
Group Header bands may be used for grouping by multiple data fields in one of the
following ways:
1. Add several Group Header bands. Specify one group field for each of these bands.
This results in nested grouping of the report's data.

© Copyright 1974 to current year. 7:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

2. Specify several group fields for the Group Fields property of the Group Header band.
The data will be grouped by certain combinations of field values.

© Copyright 1974 to current year. 7:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

The Group Footer band is unnecessary without the corresponding Group Header band.
When present, it allows customisation by providing a set of properties similar to those of the
Group Header.
In the Property Grid, the properties of these bands are divided into the following groups.
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor which enables users to choose which rules
should be applied to the band during report generation, and define the precedence of
the applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

© Copyright 1974 to current year. 7:29 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the controls contained within the
bands, as well as to assign an existing style to them (or a newly created one). For more
information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available on the Formatting Toolbar.
Behaviour
• Group Fields
This property is available for the Group Header band only. It displays the Group Field
Collection Editor, enabling users to add and remove grouping fields, define a data
field to be used as a grouping criteria and the grouping order (ascending or
descending).

© Copyright 1974 to current year. 7:30 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

This property is also accessible via the band's Smart Tag.


• Group Union
Determines whether group rows can be printed on different pages (in this case both
Group Union and Group Footer Band.Group Union are set to None), or the entire
group will be printed on a single page (if Reporting 324).
Also, if a group can be split across pages, but if Group Headers are not to be printed
on a page if there is no data row below it (in case a group starts at the bottom of the
page and there is enough room for only a Group Header), set the Group Union to
With First Detail property. In this case, if a Group Header is alone on a page, it will be
moved to the beginning of the next page.
The same option can be applied to Group Footers. To prevent them being printed
alone on a page, set the Group Union to With Last Detail property. The last group
row from the previous page will be moved to the next page to be printed together with a
Group Footer.
This property is also accessible via the band's Smart Tag.
• Keep Together
When this option is on, Reporting attempts to fit the band contents entirely on one
page, not allowing it to split across several pages. In general, if the contents are too
large to fit on a single page, then the band is started on a new page, and continues on
the following page.
• Level
Specifies the nesting level of a group band. The lower the level number, the closer the
group band is to the Detail band. The lowest setting is zero. This is the parameter that
identifies the Group Header / Group Footer band pairs.
This property is also accessible via the band's Smart Tag.
• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.
• Print at Bottom
This property is available for the Group Footer band only. It determines whether the
band should be printed at the bottom of a page, or immediately after the last group's
details.

© Copyright 1974 to current year. 7:31 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

If a report contains several Group Footers with their Print at Bottom properties set to
different values, then the outer Group Footer has the highest priority.
This feature is helpful when the Page Break property of the Group Header band is set
to After the Band. In this instance each group starts a new page, and the Group
Footer has two distinct places to reside - after the last row, or at the bottom of the
page.
• Repeat Every Page
This property improves the readability of reports with group contents that are several
pages long. Without a repeated group header at the top of the page, the report may be
difficult to read.
This property is also accessible via the band's Smart Tag.
• Scripts
This property contains events, which can be handled with the required scripts. For
more information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts
Layout
• Height
Specifies the band's height, in report units.

7.3.5 Report Header and Footer Bands


The Report Header and Report Footer are the only types of report bands rendered once
per report.

© Copyright 1974 to current year. 7:32 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• The Report Header is the first band of a report on the first page, not counting margins
as they are 'out-of-page' zones. The Report Header precedes even the Page Header
band. It is the best place for the report's name, company logo, date of creation, author's
name and miscellaneous information. If a chart that visualises the report's data is to be
included, then drop the Chart control onto this band.
• The Report Footer finalises the informative part of the report. It is placed before the
Page Footer and Bottom Margin bands on the report's last page. Use the Report
Footer for report grand totals or conclusions.
In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 1974 to current year. 7:33 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available in the Formatting Toolbar.
Behaviour
• Keep Together
When this option is on, Reporting attempts to fit the band contents entirely on one
page, not allowing it to split across several pages. In general, if the contents are too
large to fit on a single page, then the band is started on a new page, and continues on
the following page.
• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.
• Print at Bottom
This property is available for the Report Footer band only, and determines whether
this band should be printed at the bottom of the last page, or immediately after the last
report's details. The Report Footer has priority over the Group Footer's Print at
Bottom property, so the Group Footer can never be placed after the Report Footer.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts
Layout
• Height
Specifies the band's height, in report units.

7.3.6 Page Header and Footer Bands


The Page Header and Page Footer bands are located at the top and bottom of every page
in a report.

© Copyright 1974 to current year. 7:34 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

The Page Header/Footer bands are the best place for information that should be printed on
every page. For example, use them to display the header of a table which is continued from
the previous page (refer to Table Report for an example).

Note: If a page break is inserted immediately after the Report Header (by setting its Page
Break property value to After the Band), the Page Footer and Page Header bands
will not be printed on the first page.

In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

© Copyright 1974 to current year. 7:35 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available on the Formatting Toolbar.
Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units.

© Copyright 1974 to current year. 7:36 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Misc
• Print On
This property specifies whether the band should be printed on the same page as the
Report Header and Report Footer bands.

7.3.7 Page Margin Bands


The Top Margin and Bottom Margin bands represent the top and bottom page margins.
They are intended for displaying page numbers, or some sort of supplementary information
(e.g. current system time or the user name).

In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

© Copyright 1974 to current year. 7:37 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available on the Formatting Toolbar.
Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units.

© Copyright 1974 to current year. 7:38 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: That this property is tied to the report's Margins.Top (or Margins.Bottom) property, so
that changing this property's value will cause the appropriate Margin value to be
changed, and vice versa.

7.3.8 Detail Report Bands (for Master-Detail Reports)


The Detail Report Band is a type of band used to incorporate one report into another in
master-detail reports.
The Detail Report Band is quite different from the Detail Band since it holds the whole
detail report in a master-detail report layout.
There can be an unlimited number of Detail Report Bands nested inside one another, and
every new group of bands is coloured differently in Reporting, as illustrated below:

The Detail Report Band cannot be added to a report via the Report Editor like other band
types. To add a Detail Report Band, right-click the report and in the Context menu, point to
Insert Detail Report. If the bound data source contains a data relationship, the submenu
will contain an item with the name of that relationship. Select this item to create a Detail
Report Band already bound to a detail table. Otherwise, add an unbound detail report and
specify its properties later.

© Copyright 1974 to current year. 7:39 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, the properties of this band are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the band.
• Text Alignment
Used to change the text alignment of the controls contained within the band. This
option is also available in the Formatting Toolbar.
Behaviour
• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.

© Copyright 1974 to current year. 7:40 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Data Adapter
Determines the data adapter that provides the detail data for the report. For more
information, refer to Master-Detail Report (Detail Report Bands).
• Data Member
Determines a name of the data relationship established within the bound data source.
For more information, refer to Master-Detail Report (Detail Report Bands).
• Data Source
Determines the data source that provides the detail data for the report. If this property is
not defined, the detail report gets data from the master report's data source. For more
information, refer to Master-Detail Report (Detail Report Bands).
• Filter String
Used to display the Filter String Editor, used to define a filtering condition for a detail
report's data. For more information, refer to Change or Apply Data Filtering to a Report.

• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
• XML Data Path
Used to define a path to data contained in an XML file. The data contained in the file will
then be used as the Detail Report Band's data source.
In this case, the Data Member property will specify the bound list in the XML data
source.
Note: Note that a detail report uses the XML Data Path property value only when the Data
Source property is set to None. The XML Data Path property has a lower priority
than the Data Source property.

Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.

© Copyright 1974 to current year. 7:41 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Misc
• Bands
Used to display the Report Editor for managing and customising a report's bands.
• Level
Specifies the order of several Detail Report Band objects in a report. It enables the
reordering of different Detail Report Bands at the same level of master-detail
relationships.
• Print when Data Source is Empty
Specifies whether or not a Detail Report Band should be printed if its data source is
empty.

7.4 Report Controls


A Report Control is an element showing information in a report (e.g. static or bound text,
line, picture, check box, etc.).
Available Controls
The following controls are available in the Toolbox panel:
• Label
• Check Box
• Rich Text
• Picture Box
• Panel
• Table (including Table Row and Table Cell)
• Line
• Shape
• Bar Code
• Zip Code
• Chart
• Pivot Grid
• Page Info
• Page Break
• Cross-band Line
• Cross-band Box
• Project Info
Add Controls to a Report
To create a control, drag it from the Toolbox panel onto the report's area.

© Copyright 1974 to current year. 7:42 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

To automatically create a control bound to data, drag a field from the Field List panel, and
drop it onto a report's surface. When dropping a field onto an existing control, this control
will be bound to the data field.

A field is dragged with the right mouse button, when the button is released the context menu
is displayed. Use this menu to specify which control should be created.

For more information on data binding for report controls, refer to Display Values from a
Database (Bind Report Elements to Data).

Note: When the controls overlap, the report may be shown incorrectly when exported to
HTML, XLS or RTF formats. Red markings and a tooltip indicate this situation. The
red warning marks may be switched off using the report's Show Export Warnings
property.

© Copyright 1974 to current year. 7:43 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Useful Key Combinations


To change a control's size and position, the following key combinations can be used:

7.4.1 Label
The Label control is used to display textual information in a report. For example, the Label
may be used to show static text, as well as data from the bound data source. In addition, it
can be used to calculate a summary function for the specified data field, or to extend its
usual functionality by writing scripts for the available events.

After a Label is added to a report, its text, appearance and other properties can be
customised using the Property Grid panel. Frequently used properties are also available
via a control's Smart Tag and Formatting Toolbar, which makes it easy to perform common
operations.
In the Property Grid, the Label control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.

© Copyright 1974 to current year. 7:44 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Label.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available in the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of a Label, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound Labels located between upper and lower controls, which are able to resize
depending on their contents.
Note: If the Anchor Vertically property is set to Bottom or Both, the Can Grow and Can
Shrink property (see below) values are ignored, and are not considered when
calculating a final height value of a control.

• Angle
Specifies the rotation angle of the text. The measurement unit is a degree, and the
orientation is counterclockwise. Since standard HTML does not support text
orientation, this parameter is ignored when a report is displayed within a web page.
• Can Grow
When this property is set to Yes, a Label's height can be automatically increased, if
required, to fit the text. If there are other controls below the current Label, they will be
pushed down to prevent them from overlapping. Note that if a control overlaps the
grown Label by even one pixel, it will not be pushed down by the expanded Label.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Label, then the
Label's height will be decreased to the height of its text. If there are other controls
below the current Label, they will be moved up to fill the gap. Note that if a control
overlaps a shrunk Label by even one pixel, it will not be pushed up by the shrinking
Label.
• Keep Together
Specifies whether the contents of a Label can be horizontally split across pages. In
other words, if a Label occupies more space than remains on the page, this property

© Copyright 1974 to current year. 7:45 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

specifies whether this Label should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a label will not fit on the next page
either, then the Label will be split, regardless of this property's value.
• Multiline
When this property is set to Yes, a Label processes newline characters found in the
text to start a new line. For example, when editing a Label’s text, a new line can be
inserted by pressing ENTER, and in this case, the Multiline property will be
automatically set to Yes.
• Process Duplicates
Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into the multiline Label is wrapped to the
next line if it does not fit the line or is interrupted by a newline character. If the property
is set to No, text entered into the multiline Label will be displayed on the same line
except where forced on a new line by a newline character.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained from
the report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of a Label in the Multiline mode.
• Summary
Used to perform calculations (summary, max, min, average, etc.) over a data field. For
more information on calculating summaries, refer to Add Totals to a Report.
Note: Summarisation is possible for a single data column only. To perform calculations with
several data fields, use calculated fields.

• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.

© Copyright 1974 to current year. 7:46 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Text
Used to define a line of static text to be displayed. To type several lines of text, click the
control's Smart Tag, and in the displayed actions list, click Edit Text, or use the Lines
property.
Note: That when a Label is selected in the designer, a user may start typing the text, and it
will be automatically entered into the in-place editor.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Text.Binding dropdown list, select the required data field. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field, obtained from the data source. To do this, expand the (Data Bindings) property,
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the Label. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://'). Cross-references can be
created within the report by assigning the name of the target control to the Navigation
URL property, and setting the Navigation Target property to ‘_self'. For more
information, refer to Create Hyperlinks.

If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property, and in the Navigation URL.Binding dropdown selector, select the required
data field.

7.4.2 Check Box


The Check Box control is used to indicate True/False or Checked/Unchecked/
Indeterminate states in a report, by displaying a check mark and adjacent text.

© Copyright 1974 to current year. 7:47 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, the Check Box control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Check Box.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available in the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound Check Boxes located between upper and lower controls, which are able to
resize depending on their contents.
• Keep Together
Specifies whether the contents of a Check Box can be horizontally split across pages.
In other words, if a Check Box occupies more space than remains on the page, this
property specifies whether this Check Box should be split between the current page
and the next, or whether it will be printed entirely on the next page. If a check box does
not fit on the next page either, then the Check Box will be split despite this property's
setting.

© Copyright 1974 to current year. 7:48 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into a Check Box is wrapped to the next
line if it does not fit the line.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Check State, Navigation URL, Tag and Text) to a data field
obtained from the report's data source, and to apply a format string to it. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Check State
This property is used to specify the Checked/Unchecked/Indeterminate state of a
Check Box (the Indeterminate state is displayed as a greyed out checked box.) Note
that if only Checked and Unchecked states are to be used, use the Checked property
instead.
• Checked
This property is used to define whether a Check Box is checked or not.
• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a line of static text to be displayed.
Note: That when a Check Box is selected in the designer, a user may start typing the text,
and it will be automatically entered into the in-place editor.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Text.Binding dropdown list, select the required data field. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.

© Copyright 1974 to current year. 7:49 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are intended for the creation of a hierarchical structure within a report
called a document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks a Check Box. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

A crossReport reference within the report can be created by assigning the name of the
target control to the Navigation URL property, and setting the Navigation Target
property to '_self'. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

7.4.3 Rich Text


The Rich Text control enables users to display, enter, and manipulate formatted text.
The control has functionality similar to the Label control, but formatting can be applied to
any part of the text. The formatting options include font face, font styles and sizes, and font
colour.

Rich text files (RTF) can be loaded to this control via its Smart Tag.

© Copyright 1974 to current year. 7:50 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, the Rich Text control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound controls located between upper and lower controls, which are able to
resize depending on their contents.
Note: That if the Anchor Vertically property is set to Bottom or Both, the Can Grow and
Can Shrink properties (see below) values are ignored, and do not participate in
calculating a final height value of this control.

© Copyright 1974 to current year. 7:51 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Can Grow
When this property is set to Yes, the control's height can be automatically increased, if
required, to fit the text. If there are other controls below the current control, they will be
pushed down to prevent them from overlapping. Note that if a control overlaps the
growing Rich Text by even one pixel, it will not be pushed down by the growing Rich
Text.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Rich Text, then
the control's height will be decreased to the height of its text. If there are other controls
below the current one, they will be moved up to fill the gap. Note that if a control
overlaps the shrinking Rich Text by even one pixel, it will not be pushed up by the
shrinking Rich Text.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's setting.
• Process Duplicates
Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with a blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with a blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL, Rtf and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of the control, enabling users to input multiple
lines of static text.
• Tag
This property enabling users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Tag.Binding dropdown list, select the required data field.

© Copyright 1974 to current year. 7:52 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Text
Used to define a line of static text to be displayed. To type several lines of text, use the
Lines property. Note that when the control is selected, the user may start typing the
text, and it will be automatically entered into the in-place editor.

If the current report has a data source, the Rtf property (instead of Text) can be bound
to a data field obtained from the data source. To do this, expand the (Data Bindings)
property and in the Rtf.Binding dropdown menu, select the required data field. For
more information on this, refer to Display Values from a Database (Bind Report
Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report, called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: That a URL should have an appropriate prefix (e.g. 'http://').

Users can create cross references within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
'_self'. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property, and from the Navigation URL.Binding dropdown list, select the required
data field.

7.4.4 Picture Box


The Picture Box control is used to display images in a report. Typically, an image is loaded
from an image file, or from the bound data source. In addition, an image can be loaded from
a web location from a specified URL. The following image formats are supported by the
Picture Box control: BMP, GIF, JPEG, PNG, TIFF, EMF and WMF.

© Copyright 1974 to current year. 7:53 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, the Picture Box control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound controls located between upper and lower controls, which are able to
resize depending on their contents.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Sizing
Defines the sizing mode of a contained image. The image sizing settings are briefly
described in the following table:

© Copyright 1974 to current year. 7:54 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Image, Image URL, Navigation URL and Tag) to a data field
obtained from the report's data source, and to apply a format string to it. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Image
Specifies an image to display in the Picture Box control.
When the ellipsis is clicked, the Open File window enables the user to specify the file
to load. This image is then embedded into a report and saved within this report, so it is
always available.
Note: Use of this property increases the size of a saved report definition.To save only the
image path, and not the image itself, use the Image URL property instead.

• Image URL
Specifies the URL of the image to display in the Picture Box control. It supports both
absolute and relative paths. A relative path may be related to the Web site or to the
current Web page. In the second case, the path to the image must start with the '~'
symbol. Setting a relative path makes it easier to move the entire application to another
directory on the server without having to update the code.
• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

© Copyright 1974 to current year. 7:55 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

7.4.5 Panel
The Panel control is used to group individual report controls.

The Panel control is a container used to keep together any number of report controls. When
controls are placed into a Panel, they can be moved, copied and printed as a whole. There
are some limitations on Panel usage. One of them is that the Panel control does not have
the Can Shrink property, and so cannot suppress the white space that appears when the
controls inside are shrunk or collapsed. Also, the Panel cannot be used in different bands,
unlike a cross-band control.
The Panel can also be used for page decoration, e.g. to create borders around the report
elements or add a uniform colour background.
In the Property Grid, the Panel control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control.

© Copyright 1974 to current year. 7:56 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Borders, Border Color and Border Width


Specify border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
Note: If the Anchor Vertically property is set to Bottom or Both, the Can Grow property
setting (see below) is ignored, and is not considered when calculating a final height
value of this control.

• Can Grow
When this property is set to Yes, the control's height can be automatically increased, if
required, to fit the text. If there are other controls below the current control, they will be
pushed down to prevent them from overlapping. That if a control overlaps the growing
Panel by even one pixel, it will not be pushed down by the expanded Panel.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.

© Copyright 1974 to current year. 7:57 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.6 Table
The Table control is used to arrange the report information in a tabular layout.

When a Table control is dropped onto a report's band from the Toolbox, it becomes a table
of one row and three columns. If the user clicks and drags over several bands, the resulting

© Copyright 1974 to current year. 7:58 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

table will be split by the bands into several tables. This enables the creation of a table
header in the header band and the table's body, with one mouse move.

A Table control bound to data is created automatically when a data table is dragged and
dropped from the Field List window.
Manage a Table's elements by using its Context Menu.

A Table control consists of Table Row controls, each representing one table row. Each
Table Row consists in turn of Table Cell controls, each representing one table cell. They
can be selected and customised individually (see Table Row and Table Cell).
To select the Table control in Reporting, use the Report Explorer or the dropdown menu of
the Property Grid.
In the Property Grid, the Table control's properties are divided into the following groups:

© Copyright 1974 to current year. 7:59 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of Table text. This option is also available on the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of a Table, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.

© Copyright 1974 to current year. 7:60 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

7.4.7 Table Row


The Table Row control represents a single row within a Table.

This control is used for changing the layout of an entire row. Although in this document, a
Table Row is described as a separate control, most of its properties are actually applied to
the cells contained within the selected row.
In the Property Grid, the Table Row control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.

© Copyright 1974 to current year. 7:61 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

7.4.8 Table Cell


The Table Cell control represents an individual cell within a Table.

© Copyright 1974 to current year. 7:62 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In general, the Table Cell control's properties are similar to the properties of the Label
control.
In the Property Grid, the Table Cell control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Angle
Specifies the rotation angle of Table Cell text. The measurement unit is a degree, and
the orientation is anticlockwise. Since standard HTML does not support text orientation,
this parameter is ignored when a report is displayed within a web page.

© Copyright 1974 to current year. 7:63 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Can Grow
When this property is set to Yes, a Table Cell’s height can be automatically increased,
if required, to fit the text. If there are other controls below the current Table Cell, they
will be pushed down to prevent them from overlapping. That if a control overlaps the
growing Table Cell by even one pixel, it will not be pushed down by the expanded
Table Cell.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Table Cell, then
the Table Cell’s height will be decreased to the height of its text. If there are other
controls below the current Table Cell, they will be moved up to fill the gap. That if a
control overlaps the shrinking Table Cell by even one pixel, it will not be pushed up by
the shrunk Table Cell.
• Keep Together
Specifies whether the contents of a Table Cell can be horizontally split across pages.
In other words, if a Table Cell occupies more space than remains on the page, this
property specifies whether this Table Cell should be split between the current page
and the next, or whether it will be printed entirely on the next page. If it does not fit on
the next page either, then the Table Cell will be split despite this property's setting.
• Multiline
When this property is set to Yes, a Table Cell processes newline characters found in
the text to start a new line. For example, when editing a Table Cell’s text, a new line
can be inserted by pressing ENTER, and in this case, the Multiline property will be
automatically set to Yes.
• Process Duplicates
Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into the multiline Label is wrapped to the
next line if it does not fit the line or is interrupted by a newline character. If the property
is set to No, text entered into the multiline Label will be displayed on the same line
except where forced onto a new line by a newline character.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of a Table
Cell’s properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of a Table Cell in the Multiline mode.

© Copyright 1974 to current year. 7:64 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Summary
Used to perform calculations (summary, max, min, average, etc.) over a data field. For
more information on calculating summaries, refer to Add Totals to a Report.
Note: Summarization is possible for a single data column only. To perform calculations with
several data fields, use calculated fields.

• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a line of static text to be displayed. To type several lines of text, click the
control's Smart Tag and in the displayed actions list, click Edit Text, or use the Lines
property.
Note: When a Table Cell is selected in the designer, a user may start typing the text, and it
will be automatically entered into the in-place editor.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Text.Binding dropdown list, select the required data field. For more
information on this, refer to Display Values from a Database (Bind Report Elements to
Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.

© Copyright 1974 to current year. 7:65 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Navigation URL and Navigation Target


Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks a Table Cell. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross-references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

7.4.9 Line
The Line control is used for decoration and the visual separation of a report's sections.

In the Property Grid, the Line control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control.
• Borders, Border Color and Border Width
Specify border settings for the control.
• Foreground Color
Specifies the Line's colour.
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Line Direction
The line can be drawn vertically, horizontally and diagonally across a Line control
rectangle from one corner to the other by selecting from the Vertical, Horizontal, Slant
and Back Slant direction types.
• Line Style
Users can select the solid (the default), dashed, dotted or mixed style for the Line.
• Line Width
Specifies the Line's width, in report measurement units.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 1974 to current year. 7:66 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page.
If a control does not fit on the next page either, then the control will be split despite this
property's setting.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

7.4.10 Shape
The Shape control is typically used for adding simple graphics to a report.

© Copyright 1974 to current year. 7:67 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

In the Property Grid, the Shape control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Fill Color
Specifies the colour to fill the contour of a Shape, if applicable. They are transparent by
default.
• Foreground Color
Determines the colour of a Shape's contour. This option is also available on the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Line Width
Used to set the width of the line used to draw a Shape, expressed in the measure units
defined by the report's Measure Units property. For more information, refer to Change
Measurement Units for a Report.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.

© Copyright 1974 to current year. 7:68 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Angle
The value in degrees specifies the rotation angle of a Shape. Rotation is anticlockwise.

A user can hold CTRL while pressing the left mouse button to rotate a Shape within the
control's borders.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Shape
Determines which of the various built-in shapes to use within the control.
A certain shape has its own unique set of properties. The following list is intended to
give a brief overview of these special properties specific to a certain shape:

• Stretch
If a Shape is rotated to some degree (that is, its Angle property is not zero), the
Stretch property may also be used. The Shape image will be stretched to cover
maximum space within the control's borders.
• Visible
Specifies whether or not the control should be printed on report generation.
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).

© Copyright 1974 to current year. 7:69 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.11 Bar Code


The Bar Code control is used to add bar code into a report.

© Copyright 1974 to current year. 7:70 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: The barcode quality can degrade when the report is exported to formats other than
PDF. To ensure reliable barcode recognition, print the report directly from an
application using the native printing methods.
The Module and Auto-Module properties of a control should be used with care.

In the Property Grid, the Bar Code control's properties are divided into the following
groups.
Appearance
• Alignment
Determines the alignment of the barcode image within the control. To define the text
alignment, use the Text Alignment property.
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text and image colour for the bar code. This option is also available in the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Bar Code.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar. To define the alignment of the barcode image, use the Alignment
property.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Auto-Module
When this property is set to Yes, the Barcode image is stretched to fit the entire
control's width. When this option is set to No, this behaviour is determined by the
Module property.

© Copyright 1974 to current year. 7:71 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Bar Code should be split between the current page and the next,
or whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the Bar Code will be split despite this property's setting.
• Module
Specifies the width of the narrowest bar or space in the barcode, in report
measurement units. Set this property to Yes for automatic adjustment of its value when
the control is resized.
Note: If the Module property is set too low, the barcode output may be unreadable by a
barcode scanner.

If the Auto-Module property is set to No, the barcode image could be generated with
the setting of Module property is larger than the control itself. In this case, the control
displays a warning, as illustrated below:

Increase the dimensions of the control to resolve this.


• Orientation
The barcode image within the control can be rotated using the Orientation property to
specify one of four possible orientations (Normal, Upside Down, Rotate to the Left and
Rotate to the Right).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Show Text
Determines whether to display the numerical value, or only the Barcode within the
control.
• Symbology
The Symbology property defines the mapping between Barcode text and an image.
The Bar Code control supports only linear 1D symbologies. They are listed in the
following table:

© Copyright 1974 to current year. 7:72 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

© Copyright 1974 to current year. 7:73 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.

© Copyright 1974 to current year. 7:74 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Text
Used to define a string to be encoded as a barcode. Whether or nor this value is
displayed within the control is specified using the Show Text property.
Note: When a control is selected in the designer, the user may start typing the text, and it
will be automatically entered into the in-place editor.

If the content does not conform to the rules of the specified symbology (determined by
the Symbology property), the control may display a warning, as in the picture below, or
automatically correct the input string by padding it with zeroes or only accepting an
acceptable number of characters for display.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and in
the Text.Binding dropdown menu, select the required data field. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

© Copyright 1974 to current year. 7:75 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.12 Zip Code


The Zip Code control is used to add a zip code a report.

In the Property Grid, the Zip Code control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text and image colour for the bar code. This option is also available in the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Bar Code.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.

© Copyright 1974 to current year. 7:76 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Zip Code should be split between the current page and the next,
or whether it will be printed entirely on the next page. If the control does not fit on the
next page either, then the Zip Code will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Segment Width
This property setting specifies the width of the lines (in pixels) used to draw the
numbers in the zip boxes of the control.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to enter the text of the Zip Code. Enter digits and dashes only. Other characters
will not be displayed.
If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and in
the Text.Binding dropdown menu, select the required data field. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.

© Copyright 1974 to current year. 7:77 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.13 Chart
The Chart control is used for data visualisation in reports. It is used to graphically represent
a series of points using 2D or 3D chart types.

There are many built-in Chart view types to choose from, such as Bar, Point, Line, Pie and
Doughnut, Area, Radar and Polar, Range Bar, Gantt, Candle Stick and Stock.
A Chart control contains multiple elements (diagram, series, series points, axes, legend,
titles, labels, strips, constant lines, etc.). When any of these elements is selected, the
Property Grid shows only the properties for the selected item. Visual Chart elements which
can be highlighted or selected, are described in Chart with Static Series.
The Chart control is data-aware in a different manner than the other report controls.
Consider three common report scenarios:
• Static data for a Chart's series is provided manually. It can be done using the Series
Collection Editor accessed from the Chart's Series property. It is used to manually
define values and arguments for each series point.

© Copyright 1974 to current year. 7:78 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• A Chart's series is created automatically, taking data from the Chart's Data Source
and dependent on the rules defined by the Series Template property. This approach is
described in Chart with Dynamic Series.
• Each series is created and customised manually and each has a separate Data
Source. This approach is described in Chart with Static Series.
A created chart can be customised using both the Property Grid and the Chart Wizard. To
display the Chart Wizard, click a Chart's Smart Tag, and in the displayed actions list, click
the Run Wizard.

The Chart Wizard will guide the user through the process of customising the Chart, from
defining its view type to providing its data and customising its appearance.
In the Property Grid, the Chart's properties are divided into the following groups:
Appearance
• Appearance Name
Used to choose one of the chart appearance options, defining how a Chart's elements
(Diagram, Axes, Legend, etc.) are drawn.
• Background Color
Specifies the background colour for a Chart.
• Background Image
Used to load a background image to a Chart (or define its URL), and also define
whether it should be stretched to fit the entire Chart's area or not.
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Fill Style
Used to specify the fill style of a Chart's background (Empty, Solid, Gradient or Hatch)
and define other fill options if required.
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Image Type
Used to specify whether a Chart should be internally rendered as a metafile in a report
(in which case the quality of the rendered image will be good, but in some cases some
details of the control may be lost), or as a bitmap (in which case the quality of the
rendered image will sometimes be poor, but control will be drawn more precisely).

© Copyright 1974 to current year. 7:79 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Palette Name
Used to choose one of the built-in palettes to be used to draw a Chart's series.
• Palette's Base Color Number
Used to define an integer index determining the base colour for the palette defined by
the Chart's Palette Name property.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of a Chart's
properties (Bookmark, Navigation URL and Tag) to a data field obtained from the
report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Data Adapter
Specifies the data adapter that will populate a Chart's data source assigned using the
Data Source property. It is automatically set to the appropriate value when the Data
Member property is defined. For more information, refer to Chart with Static Series.
• Data Member
Specifies the data source member which supplies data to a Chart. For more
information, refer to Chart with Static Series.
Note: It is not usually necessary to specify the Data Member property when binding a
Chart to data. This property should only be set directly if the data source dataset
contains more than one table.

• Data Source
Determines a Chart's data source. For more information, refer to Chart with Static
Series.
• Series Data Member
Determines the name of the data field values of which are to be used to automatically
generate and populate a Chart's series. For more information, refer to Chart with
Dynamic Series.
When Chart binding is used to automatically generate series within a chart control
based upon the data obtained from the selected data source (defined by the Data
Source property), a rule must be defined to enable the Chart recognise the data
records values of which are used to construct individual series objects. To do this, the
Series Data Member property, which specifies the data field whose values are taken
into account when series objects are automatically created and populated, can be
used.
Each automatically generated series derives its name from the data field specified by
the Series Data Member property. For example, a name is used to identify a series

© Copyright 1974 to current year. 7:80 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

within the chart control's legend. The names of all automatically generated series can
be supplemented with the same prefix and suffix defined by settings which are
accessible from the Series Name Template property.
The template settings for the dynamically created series are defined by the specific
properties which are available from Series Template property of a Chart. In particular,
the Argument Data Member and Value Data Members properties specify the data
fields from which the arguments and data values of the series data points are obtained.
Note: If the Series Data Member property is not set for a Chart, the Chart control cannot
automatically generate series even if the Argument Data Member and Value Data
Members properties are defined.

• Series Name Template


Determines the settings used to name data bound series defining the prefix and suffix
texts for the names of series which are dynamically created as a result of binding a
Chart to data (using the Data Source, Series Data Member, Argument Data Member
and Value Data Members properties). The series names, to which these prefixes and
suffixes are added, are derived by each series from the data field defined by the Series
Data Member property. For more information, refer to Chart with Dynamic Series.
Note: The settings available via the Series Name Template property are not applied to the
data bound series which are contained within the Series collection of a Chart.

• Series Sorting
Used to define the sort mode of a Chart's series: None (default), Descending or
Ascending).
• Series Template
Used to customise a template for series which are created dynamically as a result of
binding a Chart to data (via the Data Source and Series Data Member properties).
The settings which are available via the Series Template property are common to all
such data bound series. These settings enable users to provide centralised
customisation of all dynamically created data bound series. For more information refer
to Chart with Dynamic Series.
Note: The settings which are customised using the Series Template property do not apply
to the series contained within the Series collection of a Chart.

• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid, the
Report Explorer and by scripts.
Elements
• Diagram
Used to customise a Chart's diagram elements: main and secondary axes and panes.
By default, a Chart is displayed in the Default pane, but if necessary, each Chart's
series can be displayed in a separate pane. To do this, click pane's ellipsis to display
the Pane Collection Editor, enabling users to manage and customise panes. Then
select the required series within the Chart and set its View.Pane property to the
required pane.

© Copyright 1974 to current year. 7:81 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Legend
Used to customise a Chart's legend, by defining such properties as text alignment and
antialiasing, font style, background colour or image, border options, markers' size and
visibility, shadow options, etc.
• Series
Displays the Series Collection Editor, used to manage and customise a Chart's
series.
Note: Series which are bound to data at the level of a chart control (in particular, using the
Data Source, Series Data Member and both the Argument Data Member and
Value Data Members properties) are created dynamically, based upon the data
obtained from the specified data source, and they are not presented within the Series
collection. To perform a centralised customisation of such series, use the settings
available from the Series Template property.

• Titles
Displays the Chart Title Collection Editor, used to manage and customise a Chart's
titles.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.14 Pivot Grid


A Pivot Grid control presents data from a data source in a cross-tabulated form to create a
crosstab report. It calculates summaries and summary totals against specific fields, and
displays the summary values within data cells.
A designer is used to customise the Pivot Grid. It can be displayed using the control's
Smart Tag.

© Copyright 1974 to current year. 7:82 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

The Pivot Grid displays data in a manner similar to Pivot Tables in Microsoft Excel. Column
headers display unique values from one data field, for example car models. Row headers
display unique values from another field, for example dates. Each cell displays a summary
for the corresponding row and column values. By specifying different data fields, the report
can display, for example, the total number of cars sold on a particular date, or the total
number of deals, etc. In this way, a compact layout for data analysis can be created.
A tutorial on how to use the Pivot Grid control can be found at Cross-Tab Report.
In the Property Grid, the Pivot Grid control's properties are divided into the following
groups:
Appearance
• Appearance
Used to define the appearance properties (such as Background Color, Foreground
Color, Font, etc.) for the Pivot Grid's elements (Cell, Field Value, Filter Separator,
Header Group Line, etc.).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Styles
Used to display the Styles Editor, which is used to manage and customise the
control's styles, which then can be assigned to the Pivot Grid's elements.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the Pivot Grid, so that after page rendering it
stays attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Pivot Grid should be split between the current page and the
next, or whether it will be printed entirely on the next page. If a control does not fit on
the next page either, then the Pivot Grid will be split despite this property's setting.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.

© Copyright 1974 to current year. 7:83 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Data
• Data Adapter
Determines the data adapter that will populate the Pivot Grid's data source specified
by the Data Source property. It is automatically set to the appropriate value, when the
Data Member property is defined. For more information, refer to Cross-Tab Report.
• Data Member
Specifies the data source member which supplies data to a Pivot Grid. For more
information, refer to Cross-Tab Report.
Note: It is not usually necessary to specify the Data Member property when binding a
Pivot Grid to data. This property should only be set directly if the dataset contains
more than one table.

• Data Source
Determines a Pivot Grid's data source. For more information, refer to Cross-Tab
Report.
• Fields
Displays the Pivot Grid Field Collection Editor, used to manage and fully customise
a Pivot Grid's fields.
• OLAP Connection String
Specifies a connection string to a cube in an Microsoft Analysis Services database. A
sample connection string is shown below:
OLAPConnectionString='Provider=msolap;Data Source=localhost;Initial
Catalog=Adventure Works DW;Cube Name=Adventure Works;Query Timeout=100;'
A connection string can be built via the Connection String Editor. To display it, click
the ellipsis for the OLAP Connection String property.
To represent information from the bound cube, create specific Pivot Grid fields, and
bind them to the required fields in the data source.
If the OLAP Connection String property is set to a valid string, the value of the Data
Source property is cleared. Setting the Data Source property to a valid object clears
the OLAP Connection String property.
• Prefilter
When this property is expanded in the Property Grid, its Enabled property can be set
to Yes, and the Pivot Grid Prefilter window accessed from the Criteria property.
This window enables users to build complex filter criteria with an unlimited number of
filter conditions, combined by logical operators. It provides a set of logical operators
that significantly simplify the process of creating filters for text, numeric and date-time
fields.
Note: The Prefilter property is not supported in OLAP mode.

Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

© Copyright 1974 to current year. 7:84 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
Options
• Data Field Options
Used to customise the options which control the presentation of the data fields.
• Data Options
Used to specify whether a Pivot Grid's fields are case sensitive or not.
• Print Options
Used to customise the Print options of a Pivot Grid.
• View Options
Used to customise the Pivot Grid's display options.

7.4.15 Page Info


The Page Info control is used to insert page numbers, current date and time, and the name
of the current user into a report.

In the Property Grid, the Page Info control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles

© Copyright 1974 to current year. 7:85 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Format
This property is used to specify the format string for the text displayed in the control.
When the ellipsis button is clicked, the Format String Editor window is displayed, in
which the predefined format can be selected and customise as needed. For more
information, refer to Change Formatting of Report Elements.
• Page Information
Used to select the type of information displayed in the control:

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Start Page Number
Used to set the start number for page numbering.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into the control is wrapped to the next line
if it does not fit the line or is interrupted by a newline character. If the property is set to
No, text entered into the control will be displayed on the same line except where forced
onto a new line by a newline character

© Copyright 1974 to current year. 7:86 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

7.4.16 Page Break


The Page Break control is used to insert a page delimiter. It can be placed at any point
within a report.
This control is visually represented by a short line, attached to the left side of the Design
Panel, as shown in the image below:

© Copyright 1974 to current year. 7:87 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

The Page Break control is useful when a user needs to insert a page break between
controls within a band, for example to divide subreports, so that the second subreport starts
printing on a new page.
When a user needs a page break before or after printing a certain band, instead of using the
Page Break control, its Page Break property may be set to Before the Band or After the
Band.
In the Property Grid, the Page Break control's properties are divided into the following
groups:
Appearance
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.

7.4.17 Cross-band Line


A Cross-band Line control is used to draw a line through several bands.
This can be useful if it is required to visually emphasise a part of a report that covers
multiple band areas. In other aspects, this control is similar to the Line control.

© Copyright 1974 to current year. 7:88 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Reporting supports one more cross-band control. Refer to Cross-band Box.


In the Property Grid, the Cross-band Line control's properties are divided into the
following groups:
Appearance
• Foreground Color
Specifies the colour of the control's line. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Line Style
Used to select the line style: solid (the default), dashed, dotted or mixed.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• End Band
Specifies the band in which the line ends.
• End Point
Specifies the end point of the line (from upper left corner of the band specified by the
End Band property).

© Copyright 1974 to current year. 7:89 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• Start Band
Specifies the band in which the line starts.
• Start Point
Specifies the start point of the line (from upper left corner of the band specified by the
Start Band property).
• Width
Specifies the line's width in report measurement units.

7.4.18 Cross-band Box


The Cross-band Box control is used to draw a rectangle through several bands.
This can be useful if it is required to visually emphasise a section that covers multiple band
areas by surrounding it with a rectangle.

Reporting supports one more cross-band control. Refer to Cross-band Line.


In the Property Grid, the Cross-band Box control's properties are divided into the following
groups:
Appearance
• Borders, Border Color and Border Width
Specify border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.

© Copyright 1974 to current year. 7:90 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• End Band
Specifies the band in which the box ends.
• End Point
Specifies the end point of the box (from upper left corner of the band specified by the
End Band property).
• Start Band
Specifies the band in which the box starts.
• Start Point
• Specifies the start point of the box (from upper left corner of the band specified by the
Start Band property).
• Width
Specifies the box's width, in report measurement units.

7.4.19 Project Info


The Project Info control enables users to add PDMS project information to a report.

Select the specific project information to be displayed from Value option in the controls’s
Property Grid.

In the Property Grid, the Project Info control's properties are divided into the following
groups:
Appearance
• Background Color

© Copyright 1974 to current year. 7:91 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Label.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available in the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the Pivot Grid, so that after page rendering it
stays attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Pivot Grid should be split between the current page and the
next, or whether it will be printed entirely on the next page. If a control does not fit on
the next page either, then the Pivot Grid will be split despite this property's setting.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into a Project Info control is wrapped to
the next line if it does not fit the line.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained from

© Copyright 1974 to current year. 7:92 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

the report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Value
The specific project information, for example project name or project type.
• XML Data Path
Used to define a path to data contained in an XML file. The data contained in the file will
then be used as the Detail Report Band's data source.
In this case, the Data Member property will specify the bound list in the XML data
source.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
The Subreport is not limited by the visible size of the control. The size of its actual
content is taken into account when rendering a subreport on the page.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field, obtained from the data source. To do this, expand the (Data Bindings) property,
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the Label. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://'). Cross-references can be
created within the report by assigning the name of the target control to the Navigation
URL property, and setting the Navigation Target property to ‘_self'. For more
information, refer to Create Hyperlinks.

If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property, and in the Navigation URL.Binding dropdown selector, select the required
data field.

© Copyright 1974 to current year. 7:93 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

7.5 Preview Reports


To switch a report to the print preview mode, click the Preview Tab. The report populated
with data and broken down into pages as specified will then be displayed.

Where previews of a report are shown, for performance reasons any data returned is limited
to the first 20 records.

Note: If filters are added to a data source this may impact on the performance of previews.

These toolbar the following facilities.

Search Opens a Find window with standard facilities, used to search for
text within a report.

Scale Used to scale the report. Opens the following drop-down:

Hand Tool Changes the cursor to the hand tool, which can be used to pan
around the report.

Magnifier Changes the cursor to the magnifier tool, used to change the
report view by zooming in and out.

© Copyright 1974 to current year. 7:94 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Zoom Out Used to change the report view by zooming out.

Zoom % Used to adjust the report view by the zoom percent value.

Zoom In Used to change the report view by zooming in.

First Page Used to display the first page of a report.

Previous Page Used to display the previous page of a report.

Next Page Used to display the next page of a report.

Last Page Used to display the last page of a report.

Multiple Pages Used to change the report view to display multiple pages. Opens
the following drop-down:

Color Background Used to change the colour of the report background, as selected
from the following drop-down:

© Copyright 1974 to current year. 7:95 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Watermark Used to add a text or picture watermark to the report. Opens the
Watermark window:

7.6 Print and Export Reports


To print and export a report, click Run Report on the AVEVA Toolbar. The Run Report
window is then displayed:

© Copyright 1974 to current year. 7:96 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Note: In order to export multi-byte characters from a report into various formats (like PDF,
PNG, RTF, etc.), it is advisable to use the Arial Unicode MS font that supports multi-
byte character sets.

The toolbar provides the same facilities as that of the Preview Tab (see Preview Reports),
plus the following:

Print Used to print the current report. Opens a standard Windows


Print Options window.

Quick Print Used to print the report using the default printer settings.

Page Setup Used to configure the report page. Opens a standard Windows
Page Setup window.

Export and Save Used to export the report as a file. Displays the following menu,
Report from which the file format is selected:

© Copyright 1974 to current year. 7:97 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Once the file format is selected a window is displayed from


which export options relevant to the selected file type can be
selected, for example:

Click Ok.
A standard Save As window is then displayed which is used to
specify the location that the file is to be saved to. Click Save to
complete the save.

© Copyright 1974 to current year. 7:98 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

Export and E-mail Used to save the report as a file and send the file via e-mail.
Report Displays the following menu, from which the file format is
selected:

Once the file format is selected a window is displayed from


which options relevant to the selected file type can be selected,
for example:

Click Ok.
A standard Save As window is then displayed which is used to
specify the location that the file is to be saved to. Click Save to
complete the save.

Publish to AVEVA Used to export report data to AVEVA NET. Refer to the
NET appropriate module documentation for details.

Note: Background colours are not included when a report is exported to RTF or MHT
format.

Note: Watermarks are not included when a report is exported to HTML format.

The following documents describe the basics of report exporting and format-specific export
options:

© Copyright 1974 to current year. 7:99 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide
Reference

• PDF-Specific Export Options


• HTML-Specific Export Options
• MHT-Specific Export Options
• RTF-Specific Export Options
• XLS-Specific Export Options
• CSV-Specific Export Options
• TXT-Specific Export Options
• Image-Specific Export Options.

© Copyright 1974 to current year. 7:100 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Index

A I
Appearance . . . . . . . . . . . . . . . . . . . . . . 7:60 Introduction . . . . . . . . . . . . . . . . . . . . . . 1:1
Available Controls . . . . . . . . . . . . . . . . . 7:42
AVEVA . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 L

C List
Field . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
Component Tray . . . . . . . . . . . . . . . . . . . 7:2
Context Menu . . . . . . . . . . . . . . . . . . . . . 7:2 M
Current Layout before Modification
Back Up . . . . . . . . . . . . . . . . . . . . . . 4:1 Miscellaneous . . . . . . . . . . . . . . . . . . . 5:62
Current Row Index
D Show . . . . . . . . . . . . . . . . . . . . 5:66
Handle Events via Scripts . . . . . . . 5:62
Database (Bind Report Elements to Data) Specifics . . . . . . . . . . . . . . . . . 5:64
Display Values . . . . . . . . . . . . . . . . . 4:6 Limit the Number of Records per Page 5:70
Field List . . . . . . . . . . . . . . . . . . . 4:6 Number of Records in a Report or a Group
Property Grid . . . . . . . . . . . . . . . 4:7 Count . . . . . . . . . . . . . . . . . . . . 5:67
Smart Tag . . . . . . . . . . . . . . . . . 4:7 Report with no records
Cancel Printing . . . . . . . . . . . . 5:69
E
N
Editing Basics
Report . . . . . . . . . . . . . . . . . . . . . . . . 4:1 Navigation . . . . . . . . . . . . . . . . . . . . . . 5:56
Explorer Bookmarks
Report . . . . . . . . . . . . . . . . . . . . . . . 7:10 Add . . . . . . . . . . . . . . . . . . . . . 5:57
Create a report . . . . . . . . . . . . 5:57
G Define . . . . . . . . . . . . . . . . . . . 5:59
Result . . . . . . . . . . . . . . . . . . . 5:59
Grid Cross-Reference
Property . . . . . . . . . . . . . . . . . . . . . 7:10 Add . . . . . . . . . . . . . . . . . . . . . 5:60
Guide Structure . . . . . . . . . . . . . . . . . . . . 1:1 Hyperlinks
Create . . . . . . . . . . . . . . . . . . . 5:60

© Copyright 1974 to current year. Index page i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

O Appearance . . . . . . . . . . . . . . . 7:40
Data . . . . . . . . . . . . . . . . . . . . . 7:41
Overview . . . . . . . . . . . . . . . . . . . . . . . . 5:62 Design . . . . . . . . . . . . . . . . . . . 7:41
Misc . . . . . . . . . . . . . . . . . . . . . 7:42
P Group Header and Footer . . . . . . . 7:27
Grouping Bands
Page Info . . . . . . . . . . . . . . . . . . . . . . . . 7:85 Appearance . . . . . . . . . . . . . . . 7:29
Page Numbers Behaviour . . . . . . . . . . . . . . . . 7:30
Add . . . . . . . . . . . . . . . . . . . . . . . . . 4:18 Data . . . . . . . . . . . . . . . . . . . . . 7:32
Panel Design . . . . . . . . . . . . . . . . . . . 7:32
Design . . . . . . . . . . . . . . . . . . . . . . . 7:5 Layout . . . . . . . . . . . . . . . . . . . 7:32
PML Object . . . . . . . . . . . . . . . . . . . . . . . 6:1 Page Header and Footer . . . . . . . . 7:34
Preview Reports . . . . . . . . . . . . . . . . . . 7:94 Appearance . . . . . . . . . . . . . . . 7:35
Print and Export Reports . . . . . . . . . . . . 7:96 Behaviour . . . . . . . . . . . . 7:36, 7:38
Data . . . . . . . . . . . . . . . . . 7:36, 7:38
R Design . . . . . . . . . . . . . . . 7:36, 7:38
Layout . . . . . . . . . . . . . . . 7:36, 7:38
Reference . . . . . . . . . . . . . . . . . . . . . . . . 7:1 Misc . . . . . . . . . . . . . . . . . . . . . 7:37
Report Page Margin Bands . . . . . . . . . . . . 7:37
Add Information . . . . . . . . . . . . . . . . 4:4
Appearance . . . . . . . . . . . . . . . 7:37
Add Totals . . . . . . . . . . . . . . . . . . . 4:13
Report Header and Footer . . . . . . . 7:32
Arrays
Appearance . . . . . . . . . . . . . . . 7:33
Add . . . . . . . . . . . . . . . . . . . . . . 4:26
Behaviour . . . . . . . . . . . . . . . . 7:34
Calculated Fields
Data . . . . . . . . . . . . . . . . . . . . . 7:34
Add . . . . . . . . . . . . . . . . . . . . . . 4:20
Design . . . . . . . . . . . . . . . . . . . 7:34
Change Element Layout . . . . . . . . . . 4:2
Layout . . . . . . . . . . . . . . . . . . . 7:34
Change or Apply Data Filtering . . . 4:11
Report Controls . . . . . . . . . . . . . . . . . . 7:42
Change or Apply Data Grouping . . 4:12
Add Controls . . . . . . . . . . . . . . . . . 7:42
Change or Apply Data Sorting . . . . 4:10
Bar Code . . . . . . . . . . . . . . . . . . . . 7:70
Page Numbers and System Information
Appearance . . . . . . . . . . . . . . . 7:71
Add . . . . . . . . . . . . . . . . . . . . . . 4:17
Behaviour . . . . . . . . . . . . . . . . 7:71
User Name, Add . . . . . . . . . . . 4:19
Data . . . . . . . . . . . . . . . . . . . . . 7:74
Parameters
Design . . . . . . . . . . . . . . . . . . . 7:75
Add . . . . . . . . . . . . . . . . . . . . . . 4:23
Chart . . . . . . . . . . . . . . . . . . . . . . . 7:78
Project Data
Appearance . . . . . . . . . . . . . . . 7:79
Add . . . . . . . . . . . . . . . . . . . . . . 4:27
Behaviour . . . . . . . . . . . . . . . . 7:80
Static Information
Data . . . . . . . . . . . . . . . . . . . . . 7:80
Add or Modify . . . . . . . . . . . . . . . 4:3
Elements . . . . . . . . . . . . . . . . . 7:81
Watermarks
Layout . . . . . . . . . . . . . . . . . . . 7:82
Create or Modify . . . . . . . . . . . 4:15
Navigation . . . . . . . . . . . . . . . . 7:82
Report Bands . . . . . . . . . . . . . . . . . . . . 7:22
Check Box . . . . . . . . . . . . . . . . . . . 7:47
Band Types . . . . . . . . . . . . . . . . . . 7:22
Appearance . . . . . . . . . . . . . . . 7:48
Bands
Behaviour . . . . . . . . . . . . . . . . 7:48
Manage . . . . . . . . . . . . . . . . . . 7:22
Data . . . . . . . . . . . . . . . . . . . . . 7:49
Detail Band . . . . . . . . . . . . . . . . . . . 7:24
Design . . . . . . . . . . . . . . . . . . . 7:49
Appearance . . . . . . . . . . . . . . . 7:25
Layout . . . . . . . . . . . . . . . . . . . 7:49
Behaviour . . . . . . . . . . . . . . . . . 7:26
Navigation . . . . . . . . . . . . . . . . 7:50
Data . . . . . . . . . . . . . . . . . . . . . 7:27
Cross-band Box . . . . . . . . . . . . . . . 7:90
Design . . . . . . . . . . . . . . . . . . . 7:27 Appearance . . . . . . . . . . . . . . . 7:90
Layout . . . . . . . . . . . . . . . . . . . 7:27 Behaviour . . . . . . . . . . . . . . . . 7:90
Misc . . . . . . . . . . . . . . . . . . . . . 7:27 Data . . . . . . . . . . . . . . . . . . . . . 7:90
Detail Report Band Design . . . . . . . . . . . . . . . . . . . 7:91
Master-Detail Reports . . . . . . . 7:39
Layout . . . . . . . . . . . . . . . . . . . 7:91
Detail Report Band Master-Detail Reports Cross-band Line . . . . . . . . . . . . . . 7:88

© Copyright 1974 to current year. Index page ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Appearance . . . . . . . . . . . . . . . 7:89 Layout . . . . . . . . . . . . . . . . . . . 7:53


Behaviour . . . . . . . . . . . . . . . . . 7:89 Navigation . . . . . . . . . . . . . . . . 7:53
Data . . . . . . . . . . . . . . . . . . . . . 7:89 Shape . . . . . . . . . . . . . . . . . . . . . . 7:67
Design . . . . . . . . . . . . . . . . . . . 7:89 Appearance . . . . . . . . . . . . . . . 7:68
Layout . . . . . . . . . . . . . . . . . . . 7:89 Behaviour . . . . . . . . . . . . . . . . 7:69
Label . . . . . . . . . . . . . . . . . . . . . . . . 7:44 Subreport
Appearance . . . . . . . . . . . . . . . 7:44 Appearance . . . . . . . . . . . . . . . 7:91
Behaviour . . . . . . . . . . . . 7:45, 7:92 Design . . . . . . . . . . . . . . . . . . . 7:93
Data . . . . . . . . . . . . . . . . 7:46, 7:92 Layout . . . . . . . . . . . . . . . . . . . 7:93
Design . . . . . . . . . . . . . . . . . . . 7:47 Table . . . . . . . . . . . . . . . . . . . . . . . 7:58
Layout . . . . . . . . . . . . . . . . . . . 7:47 Appearance . . . . . . . . . . . . . . . 7:60
Navigation . . . . . . . . . . . 7:47, 7:93 Behaviour . . . . . . . . . . . . . . . . 7:60
Line . . . . . . . . . . . . . . . . . . . . . . . . . 7:66 Data . . . . . . . . . . . . . . . . . 7:60, 7:62
Appearance . . . . . . . . . . . . . . . 7:66 Table Cell . . . . . . . . . . . . . . . . . . . . 7:62
Behaviour . . . . . . . . . . . . . . . . . 7:67 Appearance . . . . . . . . . . . . . . . 7:63
Data . . . . . . . . . . . . . . . . . . . . . 7:67 Behaviour . . . . . . . . . . . . . . . . 7:63
Layout . . . . . . . . . . . . . . . . . . . 7:67 Data . . . . . . . . . . . . . . . . . . . . . 7:64
Page Break . . . . . . . . . . . . . . . . . . . 7:87 Design . . . . . . . . . . . . . . . . . . . 7:65
Appearance . . . . . . . . . . . . . . . 7:88 Layout . . . . . . . . . . . . . . . . . . . 7:65
Behaviour . . . . . . . . . . . . . . . . . 7:88 Navigation . . . . . . . . . . . . . . . . 7:65
Design . . . . . . . . . . . . . . . . . . . 7:88 Table Row . . . . . . . . . . . . . . . . . . . 7:61
Layout . . . . . . . . . . . . . . . . . . . 7:88 Appearance . . . . . . . . . . . . . . . 7:61
Page Info Behaviour . . . . . . . . . . . . . . . . 7:62
Appearance . . . . . . . . . . . . . . . 7:85 Useful Key Combinations . . . . . . . 7:44
Behaviour . . . . . . . . . . . . . . . . . 7:86 Zip Code . . . . . . . . . . . . . . . . . . . . 7:76
Data . . . . . . . . . . . . . . . . . . . . . 7:87 Appearance . . . . . . . . . . . . . . . 7:76
Panel . . . . . . . . . . . . . . . . . . . . . . . 7:56 Behaviour . . . . . . . . . . . . . . . . 7:76
Appearance . . . . . . . . . . . . . . . 7:56 Data . . . . . . . . . . . . . . . . . . . . . 7:77
Behaviour . . . . . . . . . . . . . . . . . 7:57 Design . . . . . . . . . . 7:77, 7:81, 7:87
Data . . . . . . . . . . . . . . . . . . . . . 7:57 Report Element
Design .7:58, 7:61, 7:62, 7:67, 7:70 Delete . . . . . . . . . . . . . . . . . . . . . . . 4:5
Layout 7:58, 7:61, 7:62, 7:70, 7:75, Report Elements
7:77, 7:87 Change Fonts and Colours . . . . . . . 4:9
Navigation 7:58, 7:70, 7:75, 7:77, 7:87 Change Value Formatting . . . . . . . . 4:8
Picture Box . . . . . . . . . . . . . . . . . . . 7:53 Use Mail Merge . . . . . . . . . . . . . . . . 4:8
Appearance . . . . . . . . . . . . . . . 7:54 Report Output
Data . . . . . . . . . . . . . . . . . . . . . 7:55 Manually Update . . . . . . . . . . . . . . . 4:2
Design . . . . . . . . . . . . . . . . . . . 7:55 Report Settings . . . . . . . . . . . . . . . . . . 7:13
Layout . . . . . . . . . . . . . . . . . . . 7:55 Appearance . . . . . . . . . . . . . . . . . . 7:13
Navigation . . . . . . . . . . . . . . . . 7:56 Behaviour . . . . . . . . . . . . . . . . . . . . 7:16
Pivot Grid . . . . . . . . . . . . . . . . . . . . 7:82 Data . . . . . . . . . . . . . . . . . . . . . . . . 7:16
Appearance . . . . . . . . . . . . . . . 7:83 Design . . . . . . . . . . . . . . . . . . . . . . 7:18
Behaviour . . . . . . . . . . . . . . . . . 7:83 Misc . . . . . . . . . . . . . . . . . . . . . . . . 7:19
Data . . . . . . . . . . . . . . . . . . . . . 7:84 Navigation . . . . . . . . . . . . . . . . . . . 7:20
Design . . . . . . . . . . . . . . . . . . . 7:84 Page Settings . . . . . . . . . . . . . . . . 7:20
Layout . . . . . . . . . . . . . . . . . . . 7:84 Parameters . . . . . . . . . . . . . . . . . . 7:21
Navigation . . . . . . . . . . . . . . . . 7:85 Reports
Options . . . . . . . . . . . . . . . . . . . 7:85 Basic Operations . . . . . . . . . . . . . . . 5:1
Project Info . . . . . . . . . . . . . . . . . . . 7:91 Chart
Rich Text . . . . . . . . . . . . . . . . . . . . 7:50 Dynamic Series . . . . . . . . . . . . 5:36
Appearance . . . . . . . . . . . . . . . 7:51 Static Series . . . . . . . . . . . . . . 5:32
Behaviour . . . . . . . . . . . . 7:51, 7:54 Chart Dynamic Series
Data . . . . . . . . . . . . . . . . . . . . . 7:52 Chart and bind it to data, create 5:36
Design . . . . . . . . . . . . . . . . . . . 7:53 Customise . . . . . . . . . . . . . . . . 5:39

© Copyright 1974 to current year. Index page iii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Reporting User Guide

Result . . . . . . . . . . . . . . . . . . . . 5:39 Layout . . . . . . . . . . . . . . . . . . . . . . . 7:9


Specify series data member and adjust Main . . . . . . . . . . . . . . . . . . . . . . . . . 7:9
a series template . . . . . 5:37 Zoom . . . . . . . . . . . . . . . . . . . . . . . 7:13
Create . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Toolbox
New . . . . . . . . . . . . . . . . . . . . . . 5:1 Control . . . . . . . . . . . . . . . . . . . . . . . 7:3
Cross-Tab . . . . . . . . . . . . . . . . . . . . 5:28
Pivot grid and bind it to data, create U
5:28
Master-Detail Report (Detail Report Bands) User Interface . . . . . . . . . . . . . . . . . . . . . 7:1
5:25
Measurement Units for a Report
Change . . . . . . . . . . . . . . . . . . . 5:4
Multi-Column . . . . . . . . . . . . . . . . . 5:26
Page Settings for a Report
Change . . . . . . . . . . . . . . . . . . . 5:4
Parameterised . . . . . . . . . . . . . . . . 5:30
Report to Data
Bind . . . . . . . . . . . . . . . . . . . . . . 5:7
Static . . . . . . . . . . . . . . . . . . . . . . . 5:23
Table . . . . . . . . . . . . . . . . . . . . . . . 5:24
Types . . . . . . . . . . . . . . . . . . . . . . . 5:22
Run Report . . . . . . . . . . . . . . . . . . . . . . . 6:5
Running Reports from outside of the Report De-
signer . . . . . . . . . . . . . . . . . . . . . 6:1

S
Search Results Grid - Quick Reports . . . 6:1
Static Information
Change . . . . . . . . . . . . . . . . . . . . . . . 4:4
Styles and Conditional Formatting . . . . 5:40
Change a Control’s Appearance
Conditionally . . . . . . . . . . . . . . 5:48
Change a Label’s Text
Conditionally . . . . . . . . . . . . . . 5:55
Hide Bands
Conditionally . . . . . . . . . . . . . . 5:51
Odd and Even Styles . . . . . . . . . . . 5:43
Store and Restore Style Sheets . . . 5:45
Styles Concepts . . . . . . . . . . . . . . . 5:40
System Date and Time
Add . . . . . . . . . . . . . . . . . . . . . . . . . 4:19

T
Tab
Designer . . . . . . . . . . . . . . . . . . . . . . 7:6
HTML View . . . . . . . . . . . . . . . . . . . . 7:7
Preview . . . . . . . . . . . . . . . . . . . . . . . 7:7
Tag
Smart . . . . . . . . . . . . . . . . . . . . . . . 7:11
Toolbar
AVEVA . . . . . . . . . . . . . . . . . . . . . . . 7:9
Formatting . . . . . . . . . . . . . . . . . . . . 7:8

© Copyright 1974 to current year. Index page iv 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like