JASPERSERVER USER GUIDE

RELEASE 3.7

http://www.jaspersoft.com

JasperServer User Guide © 2010 Jaspersoft Corporation. All rights reserved. Printed in the U.S.A. Jaspersoft, the Jaspersoft logo, JasperAnalysis, JasperServer, JasperETL, JasperReports, iReport and Jasper4 products are trademarks and/or registered trademarks of Jaspersoft Corporation in the United States and in jurisdictions throughout the world. All other company and product names are or may be trade names or trademarks of their respective owners. This is version 0110-JSP37-10 of the JasperServer User Guide.

2

Table of Contents

TABLE OF CONTENTS
1 Introduction to JasperServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1 1.2 1.3 Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 The Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Searching the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.3.1 1.3.2 1.3.3 1.3.4 1.3.5 Searching by Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Navigating the Folder Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Refining With Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Changing the Search Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Interacting With the List of Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2

Working with Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.1 2.2 Viewing a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Creating a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.3 2.4 Dashboard Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Creating a Simple Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Adding Controls to a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Adding a Custom URL to a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Refining a Dashboard’s Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Tips for Designing Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 About Screen Sizes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Editing a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Designing Reports for Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3

Running Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.1 3.2 3.3 Running a Simple Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Running a Flash Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Running a Report with Input Controls or Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 3.3.1 3.3.2 3.4 Simple Input Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Cascading Input Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Scheduling Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

3

. . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . .3 4. . 78 Data Policies . . . . . . . .1 4. . . . . . . 38 Running a Job in the Background . . . . 41 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 4. . . . . . . . . . . .2 4. . . . . . . . . . . . . . . . . . . . . . . . . . . 40 4 Working with the Ad Hoc Editor . . . . . . . . . . . . . . . . . . . . . . . 71 Creating Topics from Domains . . . . . . . . . . . . . . . . . . . . . . . . .1 5. . . . . . . . . . . . . . . . . . . . . . . . . .3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Designing an Ad Hoc Report . . . . . . . . . . . . . . . . . 39 Other Report Parameters . . . .4. . . .6 3. . . . . . . . . . . . . . . . . . . . . 81 Defining the Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Simple Report Example . . . . . . . . . . . . . . . . . . . .2 4. . . . . . . . . . . . . . . . . . . . . 54 Creating Custom Fields .2. . . . . . . . . . . . . 80 Uploading Suggested File Resources . . . . . . . . . . . . . . .4. . . . . . . . .JasperServer User Guide 3. . . . . .5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . 67 Uploading a Topic . . 78 5 Adding Reports Directly to the Repository . . . . . . . . . . . . . . . . . . . . . . . 50 Creating an Initial Layout . . . . . . . . . . .1 5.4 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 5. . . . . . . . . . . . . . . . . . . . . . . . . 45 Formatting the Appearance of a Table . . . . . . . . . 84 4 . . . .2 4. . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Adding Report Units from JRXML Files . . 76 Configuring System-level Ad Hoc Options . . . . . . . . 34 Scheduling a Report . . .3 3. . . . 79 5.2 5. . . . . . . . . .4. . . . . . . . . . . . . . . . . .1. 50 Additional Features of the Ad Hoc Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Defining the Query . . Charts. . . . . . . . . . .7 Topics and Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . .6 4. . . . . 63 Working with Crosstabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . .1 4. . . . . . . . . . . . . . . . . 38 Stopping a Job from Running . . .1 Understanding the Ad Hoc Editor . . . . . . . . . . . .1 4. 80 Uploading the Main JRXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Selecting the Content of a Report . . . . . . . . . .2 Overview of a Report Unit . . . . . . . . 62 Working with Charts . . . . . . . . . . . . . . . . . . . . . . 35 Changing Job Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Limits on Queries . . . . 51 Focusing on Specific Data .3 4. . 45 Exploring and Analyzing Data in the Ad Hoc Editor . . . . . . . 41 4. . . . . . . . . . . . . . . . .3 4. .7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 4. . . . . . . . . . 80 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Viewing and Running a Report in the Editor . . . . . . . .1. . . .3 4. . . . . . . . . . . . . . . . . . . . . . . 57 Creating a Report from a Domain .2 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3. . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5. . . . .4 5. . . . . . . . . . . . . . . . . . . . . . . . . .5 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 4. . . . . . . . .4. . . . .1 4. . . . .1 4. . . . . .3. . . . . . . . . . . . . . . . . . . 52 Refining the Crosstab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 The Ad Hoc Editor Tool Bar . . . . . . . . . . . . . . . . . . . . .1 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . .4 4. . 59 Switching Groups . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . 67 Using the Choose Ad Hoc Data Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 4. . . . . . . . . . . . . . . .2 4. . . . . . . . . . . . . . . . . . . . 42 Tables. . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and Crosstabs . . . . . . . . . . . . . .4.7. . . . . . . . . .5 4. . . . 38 Specifying Job Recurrence . . . . . . . . . . . . . . . . . . . .4. . . . . .2 4. . . . . . . . . . . .2. . .1 4. . . . . . . . . . . . . . . . . . . . . 65 Choosing Ad Hoc Data From a Domain . . . . .7 Viewing Scheduled Jobs . . . . . . 61 Sorting Tables . . . . . . . . . . . 57 Using Input Controls and Filters . . . . . . . . . . . . . . . . . . 78 4. . . . . . . .6 4. . . . . . . . . . . . . . . . . . . .2 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

.3 6. . . . .4 Validating the New Report Unit . . . . . . . . . . . . . . . . . . . . . . . . . .8 6. . . . . . . . . . . . . . . . .4 6. . . . . . . . . . .4. . . . . . . . . . . 129 Joins Tab . . . . . . . 116 Components of a Domain . . . . . . .1. . . . . . . . . . . . . . . . . . . 132 The Properties Table . . . . . . . . . . . . . . . . . . .5 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Complex Report Example . 103 Creating a Report Unit in the Repository from iReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Example of Creating a Domain . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 6. . . . . . . . . . . . . . . . . . 133 Domain Design Validation . . . . . . . . . . . . . . .3 The Data and Design Page . . . . . . . . . . . . .10 6. . . . . . . . . . . . 125 6. . . . . . . . . . . . . . .1. . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . .3 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Creating Reports in iReport Based on a Domain in JasperServer . . .5. . . . . .6 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . .4. . . . . . . .3 5. . . . . . . . . . . . . . 126 Domain Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Sample Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 6. . . . 127 6. . . . . . . .1. . . . . 106 Editing a Report in the Repository from iReport .1. . . . . 131 Display Tab . . . . .1 6. . . . . . . . . . . . . . . . . . . . . . .1 Introduction to Domains . . . . 129 Calculated Fields Tab . . . . . . . . . . . . . . . . . . . .4. . . . .2. . . . . . 125 The Resources Page .4. . 115 6. . . . . . . . . . . . . . . . .2 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Table of Contents 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3. .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Designer Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 6. .4. . . . . . . . . . . . . . . . . . . . . . . 103 5. . . .2 5. . . . . . . . . . . . . . . . . . . . .4. . . . 127 Manage Data Source . . . . . . . . . . . . . . .12 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 6. . . . . . . . . . . . .3. . . . . . . . . . . . . 127 Tables Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Localizing JRXML Reports . . . . . . 128 Derived Tables Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Using the JasperServer Plug-in for iReport .9 6. . . . . . . . . . . . . . . . . .3 5. . . . . . . . . 117 Using the Add New Domain Dialog . . . . . . . . . . . . . . . . . . . . . .13 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Uploading Undetected File Resources . . . . 117 Overview of Creating a Domain . . . . 130 Filters Tab . . . . . . .5 Editing a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Connecting to JasperServer from iReport . .2 6. . . . . . . . . . . . . . . . . 116 Terminology . . . . . . . . 108 Creating Chart Themes in iReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 6 Creating Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 5. . . . . .11 5. . . . . . . 136 6. . . . . . . . . . . . . . . .4 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.5 6. . . . . . . . . 101 Editing JRXML Report Units . . . . . . . . . . . . . . . . . . . . . .2. . .6 6. . . . . . . . . . . . . . . . . . . . . . . .7 5. . . . . . . . . . . . . . . . . . . . . . . . . .9 5. . . . . . . . . . . . . . . . . . . . . 135 6. . . . . . . . . . . . . . 107 Running a Report from iReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Default Fonts in JasperServer . 90 Completing the Complex Report Example . . . . . . . . . . . . . . . . . .10 5. . . . . . . . . . . . . .4.7 6. . . . . . . . . . 105 Managing Resources in the Repository from iReport . . . .1. . . .4. . . . . . . .5 6. . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Maintaining Referential Integrity . . . . . . . . . . 115 6. . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 6. . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . .4 Using the Domain Designer . . . . .5. . . . . . . . . . . . . .3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 More about Datatypes . . .6 5. . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . 136 Fixing Referential Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . .4. . . . 88 Adding Input Controls . .3 Domain Use Cases . . . . . . . . . . . . . . . . . . . . .4. . .

. . . . . . 159 Defining the Internationalization Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 7. . . . . . .2 Row-Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Creating Locale Bundle Files . . . . . . . . . . 161 7. . . . . . 173 6 . . . . . . . . . . . . . . . . . . . . 151 Field References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . 153 The DomEL Syntax . . . . . . . .1. . . . . .1. . . . . . . . . . . .1 7. .JasperServer User Guide 7 Advanced Domain Features . . . . . . . . . . 152 Return Value . . . . . . . . . . . . . . . 150 Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 8. . . . . . . . . . . . . . . . . .4 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . . .1. . . . . . .1 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Operators and Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . 140 Working With a Design File . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . . . . . . . . . . .4 Exporting the Design File from a Domain . . . . . . . . . . . . . . . . . 150 Resources of a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Messages . . . . . 166 iReport Plug-ins . . . . . . . . . . . . . 139 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . 141 Uploading a Design File to a Domain .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 7. . . . . . . . . . 167 Index . . . . .3 7. . . . . 162 7. . . . . .5. . . . . . . . . . . . . . . . . . . . . . . . .2. . .2 7. . . .2 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 7. . . . . . . . . . . .2 8 Utilities . . . . . . . . . . . . . . . . . . 165 JasperServer Plug-in . .5 Locale Bundles . . . . . . . . . . . . 140 Structure of the Design File . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Domain Plug-in . . . . . . . . . . . . . . .5. . . . . . . . . . . . .1 8. . . . . . . . . . . . . . . . . . . . . . .2 7. . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 8. . . . . . . . . . . . . . . . . . . . . . . . . . . .3 7. . . . . . . . . . . . . . . . 165 8. .2 Message List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 7. . . . . . . . . . . . . . . . .1 8. . . . . . . . . . . . . . . . . . . . . . . . . 157 Column-Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 The Domain Design File . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 The Domain Security File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Introduction to JasperServer

1

INTRODUCTION TO JASPERSERVER

JasperServer builds on JasperReports as a comprehensive family of Business Intelligence (BI) products, providing robust static and interactive reporting, report server, and data analysis capabilities. These capabilities are available as either standalone products, or as part of an integrated end-to-end BI suite utilizing common metadata and providing shared services, such as security, a repository, and scheduling. JasperServer exposes comprehensive public integration interfaces enabling seamless integration with other applications and the capability to easily add custom functionality. The heart of the Jaspersoft BI Suite is JasperServer, which provides the ability to: Easily create new reports using an intuitive web-based drag and drop Ad Hoc reporting interface. Efficiently and securely manage many reports. Interact with reports, including entering parameters and drilling on data. Arrange reports and web content to create appealing, data-rich dashboards that quickly convey business trends. For business intelligence users, Jaspersoft offers JasperAnalysis, which runs on JasperServer. This optional component is described in its own user guide. While the Ad Hoc Editor lets users create simple reports, more complex reports can be created outside of JasperServer. You can either use iReport (or iReport) or manually write JRXML code to create a report that can be run in JasperServer. Jaspersoft recommends that you use iReport unless you have a thorough understanding of the JasperReports file structure. See 5, “Adding Reports Directly to the Repository,” on page 79 and 8.2, “iReport Plug-ins,” on page 166. If you want to extend your knowledge of Jaspersoft BI software, our Ultimate Guides document advanced features and configuration. They also include best practice recommendations and numerous examples. The guides are available as downloadable PDFs. Community project users can purchase individual guides or bundled documentation packs from the Jaspersoft online store. Professional and Enterprise customers can download them freely from the support portal. This chapter contains the following sections: Logging In The Home Page Searching the Repository

7

JasperServer User Guide

1.1

Logging In

To protect the data that you can access through JasperServer, all users are required to log in with a password.
To login to JasperServer:

1.

Enter http://hostname:8080/jasperserver-pro in your web browser (where hostname is the name of the computer where JasperServer is installed). The Login page appears:

Figure 1-1

JasperServer Login Page

2. 3.

Before logging in, you may want to review the links on the login page, such as the link to the Online Help. To login, enter your user ID and password. If you installed the sample data, you can use any of the user names and passwords shown, as well as your own. The default administrator user is jasperadmin and the password is the same; you should change it after installation.

4. 5. 6. 7.

If the Organization field appears, enter the ID or alias of your organization. If you don’t know it, contact your administrator. Click Show locale & timezone. The Locale controls appear in the Login pane. Select your locale and time zone from the drop-downs. Click Login.
If the Change Password feature has been implemented on your system, you can change your password by clicking Change password. For more information about this configuration option, refer to the JasperServer Administrator Guide.

If all information is valid, you are logged in, and JasperServer displays the home page.

1.2

The Home Page

The Home page lets you quickly access the most-used features of JasperServer:

8

Introduction to JasperServer

Figure 1-2

JasperServer Home Page

The Home page for standard users has three icons that are linked to the basic functions of JasperServer:
view your reports – Displays a list of the reports that you can view and run. create a report – Launches the Ad Hoc Editor in which you can design reports interactively. analyze your results – Displays a list of analysis views. Available only if you implement JasperAnalysis.

The three menus in the menu bar and the links to the Online Help and Log Out link in the upper right appear on all JasperServer pages. The search field is described in section 1.3.1, “Searching by Name,” on page 11. The menus offer these options: Menu
Home View

Description
Returns to this Home page. Repository – Displays the repository’s folders and the resources they contain, including reports, report output, data sources, images, and other files used in reports. Access to repository folders and objects is always subject to permissions set by administrators. Reports – Displays all the reports in the repository that you can view, run, and edit, depending on permissions. Same as clicking view your reports. Analysis – Displays all the analysis views in the repository that you can view, run, and edit, depending on permissions. Same as analyze your results. Available only with JasperAnalysis. Messages – Displays system messages, such as an error in a scheduled report.

Create

Ad Hoc Report – Launches the Ad Hoc Editor in which you can design reports interactively. Same as clicking create a report. Dashboard – Launches the Dashboard Designer in which you can lay out multiple reports and their supporting input controls, labels and images.

For administrators, the Home page has additional options and menu items for managing user, roles, organizations, and settings. Administrator functions are documented in the JasperServer Administrator Guide.

9

To access the repository. or deleting multiple resources at once. Filters for refining results – Provide a quick way to find resources based on other criteria such as type or access time. The repository is organized as a tree structure of folders containing resources. dashboards. Click or right-click a resource in the list to view it or see what actions are available. except to administrators. Search expression and sorting – An interactive status bar showing the search criteria. or if Include subfolders is cleared. cutting (moving). lets you browse individual folder contents. 10 . Bulk operation controls – For selecting and copying. much like a file system. as well as lists of reports and analysis views. This release of JasperServer introduces a search interface for the repository. The new repository interface is designed to help you find resources faster by using intuitive search criteria. JasperServer remembers your settings so that your most commonly needed resources stay visible when you return to the repository page. In addition. select View > Repository from any page of JasperServer. filters. folders. Figure 1-3 Repository Page The repository page is also where search results are displayed. The following sections explain how to use the search features of the repository page. However. List of resources – The resources in the repository that meet the search criteria. you can often find resources with fewer clicks.JasperServer User Guide 1. you can still browse folder by folder. grouped by resource type when appropriate. By clearing the check box to Include subfolders. Instead of viewing resources by folder alone. and sorting criteria. All of the controls on the repository page make it easy to refine or enlarge your set of results. Folder tree – Lets you restrict search results to branches of the tree.3 Searching the Repository The repository is JasperServer’s internal storage for all reports. but once you are familiar with the search interface. analysis views and related files. JasperServer stores all objects and files in a private database that is otherwise inaccessible. the repository now provides many other filters such as who modified the resource and when. the repository page has the following features: Search controls – Let you find resources by searching for text in their names or descriptions. As shown in Figure 1-3.

This mode is most useful in combination with other search settings. To cancel search by name. Use the icons to expand the tree and view all nested folders. If you enter multiple words. select a folder or filter as explained in the following sections. letting you explore folder by folder. There are two ways to navigate the folder tree: Search – When Include subfolders is checked. 11 .1 Searching by Name Use the search field at the top of every JasperServer page to begin a search at any time. Search terms are not case-sensitive. click the icon in the search field to clear the search term and update the search results according to the remaining settings. 1. the search uses the default settings: Include subfolders Start at the top-most folder visible to your user Filter for visualization types only Sort alphabetically by name To refine the search. the search uses the current settings on the page. If you enter a search term and click Search at the top of any other page.2 Navigating the Folder Tree The folder tree shows the folders in the repository that your user has permission to view. This mode mimics a file system browser. JasperServer does not match folder names or display folders in the results. Figure 1-4 shows the results of a search for the term “account” in the sample data. Include subfolders is checked. Click a folder name to select it. Figure 1-4 Search Field and Search Results JasperServer matches the search term. even word fragments. JasperServer searches for resources that match all words. When you click Search. allowing you to search by name or by resource type across the entire repository or a specific branch of it. Browse – Clear the box next to Include subfolders to restrict the scope of any search to the resources directly contained in the selected folder.Introduction to JasperServer 1. selecting a folder searches the entire branch of the tree starting at that folder. anywhere it appears in the display name or description string of a resource. This mode works best when you clear the search term and select All types so that the results are exactly the contents of the selected folder. but not necessarily in order. By default. If you enter a search term and click Search on the repository page.3. Do not enter quotes around terms or any symbols between terms.3. it opens the repository page with the same search term and displays the results.

data types. including today. etc). Displays only analysis views (if you implement JasperAnalysis). views. and analysis views.3 Refining With Filters The filters below the folder tree let you refine your search using several other resource attributes. Resources viewed or modified during the past 30 days. Resources viewed or modified since the previous midnight. Domains. Displays only dashboards. 12 . This includes input controls. and other files that only administrators may add to the repository. images.JasperServer User Guide 1. Selects only resources that have been run and viewed by the currently logged in user. but also to resources that are included in reports such as images. These are the resources that can be viewed by anyone who has read access. Resources viewed or modified during the past 7 days. All times are relative the user’s effective timezone: Filter Setting Any time (default) Today Yesterday Past week Past month Description Does not take into account the last modification time of a resource. Report output can be any of the supported export types (HTML. report output. as a result. Displays only Domains. including today. Displays only the output from reports that were scheduled or run in the background. The resource type filter has the following settings: Filter Setting All types Visualization types (default) Reports Report outputs Dashboards Analysis views Domains Data sources Other types Description Does not take into account the resource type. PDF. Resources viewed or modified during the previous day ending at midnight. The scheduled report filter has the following settings: Filter Setting Any schedule (default) Scheduled Description Does not take into account the existence of scheduled jobs. The access time filter has the following settings.3. For example. dashboards. Displays all types except reports. Displays only data sources. Only reports that have scheduled jobs. both JRXML reports and Ad Hoc reports. and data sources. Displays only reports. This filter not only applies to visualization types. dashboards. The default filter that includes reports. these filters can help you find your most recently viewed reports. The user filter has the following settings: Filter Setting Changed by anyone (default) Changed by me Viewed by me Description Does not take into account user access to the resource. Selects only resources that have been last modified by the currently logged in user. You can set each filter independently of the others. every type is displayed.

Introduction to JasperServer Filter Setting
Scheduled by me Not scheduled

Description
Only reports that have jobs scheduled by the currently logged in user. Only reports that do not have scheduled jobs, and all other resource types.

1.3.4

Changing the Search Expression

Above the list of resources, the search expression shows you all of the criteria that contribute to the search. It contains the following elements, always in this order from left to right: The search term, if any, or the word All. The folder selected, if any. Any and all filter settings. The search expression provides a quick visual summary of the search criteria for the list of results that appear right below it. The search expression is also interactive, allowing you to easily remove some of the filters. It supports the following actions: If there is more than one filter, clicking any one of them removes all those to the right of it. If there is a folder selected that is nested more than one level, you can click any parent folder to select it instead. You can click the search term or the word All to remove any and all folders and filters to the right of it.
To remove the search term, click the icon in the search field. The search expression then displays All.

After any one of these actions, the search controls displayed on the left are refreshed, and the results are updated. To the right of the search expression, the sort criteria let change the order of the results. The following sorting is supported: Click Name to sort alphabetically (A at the top). This is the default sort order. Click Modified Date to sort by the latest modified time and date (most recent at the top).

1.3.5

Interacting With the List of Resources

The list of resources is always the set of results determined by the current search criteria. Because search results can be quite large, the list of resources has two modes: Multiple Types Condensed – When there are more than two types of resources listed, the number of resources of each type is limited to a certain number, by default 5. When there are more resources of that type, there is a link to see all of that type. You can quickly scroll through the condensed results and find the type of resource you want. Click the See all... link to display the results of that type. Single Type Expanded – When there is a single type of resource in the results, either by circumstance, by clicking a See all... link, or because a single-type filter is selected, all resources are listed, with a scroll bar if necessary. If the list of results is still too long, enter or refine the search term, or select additional filters.
When you click See all... for a type that has a single-type filter, for example Domains, that filter is automatically applied. The filter display and the search expression refresh to reflect this. Use the search expression to remove the filter if necessary. When no filter exists for that type, for example input controls, the filter display and search expression are not updated. Use the type filter drop-down to change the types displayed.

Once the resource or resources you want are displayed, there are several ways to interact with them: Click the name of a report or dashboard to run and view it. Right-click the name of a resource to access other operations on the context menu, for example Open in Designer... Items appear on the context menu according to the permissions granted to your user. Check the box beside the resource name or click anywhere in the row to select it. Check several boxes or Control-click anywhere in the rows to select multiple resources. You can drag and drop selected items to move them or press Control while you drag and drop items to copy them. When you have multiple resources selected, you can also used the bulk operation buttons above the results list: Copy, Cut (move), or Delete. You must have the appropriate permissions on the selected items and the target folder to move, copy, or delete resources. For more information about permissions and repository operations, see the JasperServer Administrator Guide. 13

JasperServer User Guide There are two icons that may appear between a report name and its check box: + indicates that the report has saved options for its input controls. Click the + icon to list the saved options below the report. For more information, see section 3.3, “Running a Report with Input Controls or Filters,” on page 30. indicates that the report has been scheduled to run or that it is currently running in the background. Click this icon to view the list of jobs scheduled for the report. For more information, see section 3.4, “Scheduling Reports,” on page 34.

14

Working with Dashboards

2

WORKING WITH DASHBOARDS

A dashboard displays several reports in a single, integrated view. A dashboard can also include input controls (that determine the data displayed in one or more frames), other dashboards, and custom frames that point to URLs to any other content. By combining different types of related content, you can create appealing, data-rich dashboards that quickly convey trends.

Figure 2-1

Dashboard with Ad Hoc Table, Chart, and Crosstab

This chapter contains the following sections: Viewing a Dashboard Creating a Dashboard Editing a Dashboard Designing Reports for Dashboards 15

2. To view a dashboard: 1. controls appear for that individual report. the repository includes the /Dashboards folder where dashboards might be saved. Select new values from the Start Month and End Month drop-downs and click Submit to change the data displayed. or a calendar icon. a check box. that frame does not update when you change that input control’s value. When done. If one of the frames in a dashboard does not refer to an input control. 6. An input control may appear as a text field. When you mouseover each report. 5. 4. JasperServer displays the dashboard. click View > Repository to go back to the repository page. the changes take effect immediately when you change the input control’s value. All three reports update to display data for the months you indicate. multi-select list box. 3. Keep these points in mind when viewing a dashboard that has input controls: Figure 2-2 SuperMart Dashboard Example 16 . right-click the name and select View from the context menu. If a dashboard includes a Print View button. Only reports that refer to the input control reflect the change. By default. Alternatively. Click the name SuperMart Dashboard in the list of results. click it to display the dashboard without JasperServer’s header and footer.1 Viewing a Dashboard You can view an existing dashboard if you have the proper permissions. which includes three reports. depending on your web browser. this also opens your browser’s Print window. The search results are displayed in the repository. Click Reset to set the input controls to the last values saved and return the dashboard to its initial view. a drop-down. and click to open the report in a new window. In the Search field.JasperServer User Guide 2. If the dashboard does not include a Submit button. Click to refresh the report’s content. enter supermart and click Search.

when that logo changes. if multiple reports include the same parameter. your dashboard will automatically update to reflect the branding change. so this feature has nearly-limitless possibilities. Resizing this type of item changes the size of the font in the label. though a user’s permissions in the repository may limit the content they can add and the location where they can save it. the font size in the label is fixed. Reset. Single controls are those that correspond to parameters included in a single report. JasperServer automatically adds a text label for it. you can add them to the dashboard. Free Text. JasperServer dashboards can point to any web content.1 Dashboard Overview A dashboard can include any of the following: Reports in the repository. Resets the values of the input controls to the last value selected when the dashboard was saved. Use free text items to add titles and instructional text to your dashboard. Displays the dashboard without buttons or JasperServer’s header and footer. JasperServer automatically adds a label for it as well. you might include a frame that points to the logo on your corporate website. If a report on the dashboard refers to input controls or filters. Special content: Custom URL. If the dashboard doesn’t include a Submit button.Working with Dashboards 2. and (depending on your browser) opens your browser’s Print window. Standard controls: Submit. Print View. 17 . Multiple controls are those used by more than one report. When you add a control. Resizing this type of item only changes the size of the label itself. When you add an input control to the dashboard. The input control can be mapped to one or more frames. For example. A more complex example is described in “Creating a Dashboard” on page 17. Controls can also be manually mapped to custom URL frames. This section includes: Dashboard Overview Creating a Simple Dashboard Adding Controls to a Dashboard Adding a Custom URL to a Dashboard Refining a Dashboard’s Layout Tips for Designing Dashboards About Screen Sizes 2. Controls (Single or Multiple). Applies the values in the dashboard’s input controls to the reports that refer to each input control. JasperServer refreshes these reports to display the new set of data. For example.2 Creating a Dashboard Any user can create a dashboard. the corresponding control is automatically mapped to each of those reports when you add the input control to the dashboard. Any URL-addressable web content. Text Label.2. A free-form text entry field. A label for an input control. changes to input control values are reflected immediately.

JasperServer indicates this by displaying a red guide line that appears over the Accounts report. In the Available Content list. 7. Click Create > Dashboard. navigate to the /Reports/Samples folder. To create a simple dashboard: 1. With both frames sized for their reports. you must have permission to view the report. displaying the list of available content and the dashboard area.7. “About Screen Sizes. the dashboard is wider than the specified screen size. Click Preview. 5. Hover your cursor over the bottom of right-hand edge of the frame containing the Freight report. The dashboard designer appears. Next to it.2 Creating a Simple Dashboard This section walks you through the creation of a dashboard. Resize the frame containing the Accounts report to fit its width.2.JasperServer User Guide Figure 2-3 List of Available Content in the Dashboard Designer 2. For more information. depending on your browser. The report appears in a frame in the upper left corner of the dashboard area. the user may have to scroll across or down to see the entire dashboard. see 2. when your cursor changes to a resizing icon ( ) click and drag the edge of the frame to resize it. 6.2. 2. In fixed sizing mode. JasperServer allows you to save the dashboard even when its contents hang over the edge of the dashboard area. The end user view of the dashboard appears.” on page 24. click the arrow to the left of the Accounts report to move the report to the dashboard area. and click the arrow to the left of the Freight report to move the report to the dashboard area. 18 . This is because the dashboard area is meant as a guide: if the content fits in the dashboard area without showing the red guideline. you can be sure that a user with the selected resolution will be able to view the entire dashboard without using the browser’s scroll bars. Adjust the width and height of the frame to display the default data returned by the Freight report. it may appear in a new tab or a new window. 3. To add a report to a dashboard. JasperServer shows an outline that indicates where the next frame will be added if you click a field’s arrow. if your content hangs over the edge. 4. In the Available Content list.

Working with Dashboards 8. Return to the designer and click Save. You are prompted for the name and location where the dashboard should be saved. By default, the dashboard is saved in the /Dashboards folder with the name New Dashboard. 9. Accept the default location, and specify the name Freight Dashboard. 10. Click Save. The dashboard is saved to the repository.

Figure 2-4

Creating a Simple Dashboard with Sample Reports

2.2.3

Adding Controls to a Dashboard

Since the Freight report refers to input controls that determine the data it returns, those controls can be added to the dashboard.
To add controls to the dashboard:

1. 2. 3. 4.

If it isn’t open, locate the Freight Dashboard created in section 2.2.2, typically in the /Dashboards folder. Right-click the dashboard name and select Open in Designer... from the context menu. The Freight Dashboard appears in the designer, as shown in Figure 2-4. In the Available Content list, open the Special Content > Single Report Controls folder. The three input controls associated with the Freight report appear. Click the arrow to the left of the Country input control to move the control to the dashboard. The Country input control and its label appear in the upper-left corner of the dashboard area, nudging the Freight report down to accommodate the new control. If you wanted to place the input control in another location, you could drag it from the Available Content list to the desired location. Note that the input control and label are independent; you can delete one or the other and resize them individually.

5. 6. 7. 8. 9.

Select a new value from the Country input control, and notice that the data displayed in the Freight report changes; the Account report does not update because it does not refer to an input control named Country. Use the arrows to add the OrderID and RequestDate controls, as well. Click just above and to the left of the Country label, and drag the mouse to draw a selection rectangle. Draw the rectangle across the three input controls and their labels to select them. Click one of the selected input controls, and drag down to move them below the Freight report’s frame. Draw a selection rectangle to select the OrderID input control and its label, and drag them directly beneath the Country input control.

19

JasperServer User Guide 10. Draw a selection rectangle to select the RequestDate input control and its label, and drag them directly beneath the OrderID input control. 11. Click the OrderID label, and select Edit Label form the context menu. The label becomes editable and its text is selected. 12. Type Order and press Return. 13. Change the RequestDate label to Date. 14. In the Available Content list, navigate to Special Content > Standard Controls, and drag the Submit and Reset buttons so they are underneath the input controls in the dashboard area. By default, a dashboard automatically updates when you change the values in its input controls. When the dashboard includes the Submit button, JasperServer doesn’t update the dashboard until you click the Submit button. 15. Click Save. The dashboard is saved to the repository.

2.2.4

Adding a Custom URL to a Dashboard

You can create a frame that displays any URL-addressable content. Such mashups can help you leverage data from many sources in a single, integrated view.
To add a custom URL:

1. 2. 3.

If it isn’t open, locate the Freight Dashboard saved in section 2.2.3, typically in the /Dashboards folder. Right-click the dashboard name and select Open in Designer... from the context menu. The Freight Dashboard appears in the designer, as shown in Figure 2-4. In the Available Content list, select Custom URL (in the Special Content folder), and drag it to the lower-left corner of the dashboard. You are prompted to enter the URL of the web page you want the frame to display. In the URL field, enter news.google.com. Click the check box next to Country to select that input control, and in the URL Parameter Name field, replace the default text (Country) with the letter q. Note that this field is case-sensitive. This tells JasperServer to map the dashboard’s Country input control to Google’s q (query) parameter. Now, when you select a value in the Country input control, JasperServer passes that value to news.google.com, so that the news displayed in the frame relates to the selected country. Note that the other two input controls also appear in the URL definition window; if news.google.com accepted a parameter that was compatible with these input controls, you could check their check boxes to associate the URL with these input controls, as well.

4. 5.

Figure 2-5

Defining a Custom URL Frame

6.

Click OK to close the custom URL dialog.

20

Working with Dashboards 7. 8. 9. Select a new value from the Country input control, click Submit, and notice that the news displayed in the custom URL frame changes. Resize the custom URL frame so that only the first article’s synopsis appears. Drag the custom URL frame to the left so that its left edge is aligned with the right edge of the input controls. The menu expands to display options for how frequently JasperServer should refresh the frame’s content. Smaller values make JasperServer update the frame more often. By default, a frame is never automatically refreshed (that is, its Autorefresh Interval is set to Manual Only). 11. Click 5 Minutes beneath the Auto-refresh Interval on the context menu. Auto-refresh only affects the end user view of the dashboard. In the designer, the frame is never auto-refreshed. 12. Click Save. The dashboard is saved to the repository.

10. Click the custom URL frame, and click Auto-refresh Interval on the context menu.

2.2.5

Refining a Dashboard’s Layout

Once your overall layout is complete, you can refine the look and feel of your dashboard.
To refine the dashboard’s layout:

1. 2.

If it isn’t open, locate the Freight Dashboard saved in section 2.2.4, typically in the /Dashboards folder. Right-click the dashboard name and select Open in Designer... from the context menu. The Freight Dashboard appears in the designer, as shown in Figure 2-4. Note the gap at the top left when you moved the input controls to a new location, as described in 2.2.4, “Adding a Custom URL to a Dashboard,” on page 20.

3. 4.

Click in the upper-left corner and draw a selection rectangle around all the frames, click one of the selected frames, and drag up to reduce the unused space at the top of the dashboard. Click Preview. The end user’s view of the dashboard appears; if the dashboard is already open in your browser, JasperServer updates that page rather than opening a new window or tab.

5. 6. 7. 8. 9.

In the Country field, select a new value. Note that the Freight report and custom URL frames do not update; this is because the dashboard includes the Submit button. Return to the dashboard designer and, in the dashboard area, hover your cursor over the Submit button, and when the hover border appears, click it. From the context menu, click Delete Item. The Submit button disappears. Reposition the Reset button to so it’s centered in the available space. Click in the Dashboard Selector, and select Add Title Text in the context menu. The title becomes editable.

10. Enter Orders and Current Events by Country. 11. Click Preview. The end user view of the dashboard appears. 12. Change the value in the Country input control, and note that the dashboard reflects the change immediately. 13. Return to the dashboard designer and click Save. The dashboard is saved to the repository.

21

the context menu includes several options that can apply to frames. open it in the designer and click Save As on the Dashboard Selector context menu. You can’t resize buttons or input controls. This is especially helpful for charts and small crosstabs. To create a new version of a dashboard. For example. Use Ctrl-click to select multiple frames and items in the dashboard area. the context menu only includes the Delete Items option. if you select a frame and a button. Press the Ctrl key while dragging or resizing items and frames for smoother cursor movement. display the list again by clicking . You can use the arrow keys to move selected content one grid space at a time. such as Hide All Scroll Bars and Auto-refresh Interval. or use the Available Content context menu Add to Dashboard option. Press the Ctrl key to move the selected content a single pixel at a time. Use the Hide Scroll Bars option on the frame context menu when you can size the frame to exactly match its content. JasperServer shows the default URL without passing the parameter. 22 . it might include the Delete Item or Delete Frame option. Put another way. This disables the default snap-to-grid behavior. Delete them manually. the context menu only includes options that apply to all the selected items. If you select multiple items or frames. The context menu changes depending on your selection. Drag an item from the Available Content list and drop it on an existing frame to replace the existing content.2. you can’t add a dashboard to itself. A dashboard can include other dashboards. when you select multiple frames. keep these tips in mind: You can drag items from the Available Content list and drop them to add them to the dashboard. Click to hide the Available Content list. If a custom URL frame is mapped to one of the input controls that was deleted. For example. depending on whether you selected a button or a frame. When you delete a report with input controls from the dashboard.6 Tips for Designing Dashboards When you are creating or editing a dashboard.JasperServer User Guide Figure 2-6 Dashboard with Sample Reports and Special Content 2. but their labels remain. so long as this doesn’t create a circular dependency. the controls are also deleted.

JasperServer assumes that you want to use the HTTP protocol for custom URL frames. For more information. it is deleted from the dashboard. horizontal scrolling can be awkward. The dashboard designer may seem unwieldy if you design for a screen size as big as or larger than your own. You can also design the dashboard for your resolution. When you drag the edge of one frame. Not all web pages support the technology underlying JasperServer’s dashboards (IFrame).2. create two dashboards that each refer to the input control. However.” on page 24. By default. Adding the same dashboard twice to a parent dashboard can create a compelling comparison. you can specify that it use the FILE protocol by entering file:// at the beginning of the value in the URL. This is helpful for including images.7. but you do not want them to be controlled by a single input control. or using a larger monitor. If you have multiple reports that refer to the same input control. In this case. In such cases. Now. users can set the input controls separately for each set of reports. Select multiple frames to change their sizes all at once. the other frames change size as well. then create a dashboard that includes those dashboards. the URL frame’s behavior may be inconsistent. Figure 2-7 A Dashboard Comparing Data from Two Countries 23 . and then select Use Proportional Sizing from the Dashboard Selector context menu. JasperServer uses the FILE protocol. Try hiding the content pane.Working with Dashboards If a report displayed in a dashboard is moved to a new location in the repository or if it is deleted entirely. “About Screen Sizes. in particular. see 2. and looks for the file you specify in the JasperServer’s WEB-INF directory.

as horizontal room is always at a premium in a dashboard. the repository includes the /Dashboards folder where you can store your dashboards. Edit the dashboard by adding. To create a new version of the dashboard.2. you can set the screen size to change the dashboard area to match a particular screen resolution. In addition to fixed screen resolutions. keep these hints in mind: Charts and small crosstabs are best suited to dashboards. 4.7 About Screen Sizes When you create a dashboard. dashboards support proportional sizing.. When an Ad Hoc report is displayed on a dashboard.4 Designing Reports for Dashboards When defining reports for a dashboard. its margins are stripped. Select View > Repository and search or browse for the Dashboard you want to modify. then. when a dashboard uses proportional sizing. displaying the dashboard.3 Editing a Dashboard You can edit a dashboard if you have the proper permissions. select Save As from the Dashboard Selector context menu. 2. To edit a dashboard: 1. switch to proportional sizing before you save. your reports shouldn’t be too wide. but you can’t make them bigger. By default. The reports should be small. you can design table reports that work well in the dashboard. In proportional sizing. the dashboard designer supports five standard screen resolutions. Right-click the dashboard and select Open in Designer. or when you select a new screen size in the designer. By default. Jaspersoft recommends that you design dashboards using fixed sizing mode. note that: You can resize free text items to a smaller size. click Save. resizing. Jaspersoft resizes the frames so that they all appear in the window without requiring the user to use the browser’s scroll bars. see section 2. which are available under the Screen Size option in the Dashboard Selector context menu. if you are designing a report for end users who use laptops that only display a screen resolution of 800 by 600 pixels. For example. rather than using fixed values. This may result in a change to the shape of the frames. proportional sizing is only evident in the end user’s view of the dashboard. 2. When a dashboard uses fixed sizing. 2. If a dashboard that uses proportional sizing is bigger than the specified screen size. removing. its frames do not resize automatically when the window size changes.” on page 17. For more information about working with dashboard content. 24 . you can set the dashboard area to 800 by 600 pixels to emulate your end users’ screen size. In particular.JasperServer User Guide 2. The designer appears. when the dashboard is viewed. which calculates frame sizes using percentages of the total window size. from the context menu. since dashboards typically contain multiple reports. and specify a new name. When you are satisfied with the dashboard. 3. you don’t need to strip the margins manually when designing the report. “Creating a Dashboard. However.2. its frames resize relative to the size of the browser window. or dragging content.. Put another way. Such reports tend to be very narrow and typically refer to input controls to limit the number of rows they return. Note that frames do not resize automatically in the designer. 5. The grid turns red when any content hangs over the edge of the dashboard area.

the value you enter in the URL Parameter Name field is also casesensitive. in this case. “Adding a Custom URL to a Dashboard. Note that this is the case for Google’s q parameter that is referenced in 2. it is instead displayed as drop-down. the reports themselves need parameters with the same name as the input control.Working with Dashboards If you want a single input control on the dashboard to control the data displayed in multiple reports.” on page 20. For example.4.2. For example. It is essential that the input control pass data that the URL can accept. Beyond these requirements. the target URL is likely to have requirements and limitations. the URL Parameter Name you specify for the input control must match the name of a parameter that URL can accept. Storing such input controls in the repository encourages their reuse when reports are designed and added to the repository. When defining a parameter in a report. the value of the input control must also be a value the URL can accept. when two reports that include this parameter are added to the dashboard. If a report’s input control is set to display as a radio button set. In addition. you might have a query-based list of employee names that can be used in both sales reports and human resources report. Otherwise. the name of the parameter may be case-sensitive. their input controls appear as Special Content in the Available Content list. give it a meaningful name that can be reused in other reports. If you want to pass a value to an external URL. Then. JasperServer may be unable to retrieve the correct data from the external URL. 25 .

JasperServer User Guide 26 .

Running Reports 3 RUNNING REPORTS JasperServer makes it easy to run reports that help you understand and present your data to their best effect.” on page 10. “Searching the Repository. If you know the name of the report you want to run. To run a report: 1. For more information. This chapter contains the following sections: Running a Simple Report Running a Flash Chart Running a Report with Input Controls or Filters Scheduling Reports 3. On the Home page. The tutorials in this section and throughout the user guide assume that you have installed the sample data that is provided with JasperServer. you can enter its name in the Search field and click Search to locate it in the repository. click view your reports. The Repository page appears with a filter showing all reports that your user account has permission to view. 27 . This means you can view other users’ reports. refer to section 1.3. as in this report that simply lists accounts. You can also search on partial names or for words in the report’s description.1 Running a Simple Report Some reports are simple tables with rows and columns of data. so long as you have proper permissions.

right-click anywhere in the report row and select View from the context menu. Microsoft Word (DOCX or RTF). The output can be exported to a file in these formats: Adobe Acrobat (PDF). XSLX. 4. JasperServer displays a message indicating that it is retrieving the data. containing accounts and contact information. or CSV).JasperServer User Guide Figure 3-1 Viewing All Reports in the Repository Use the scroll bar at the right of the page to view the entire list of reports. Use the arrows at the top of the page to view the whole report. To return to the reports listing. you can click Cancel to stop the report from running. 2. Click the name Accounts Report to run the report. Adobe Flash (SWF). and OpenDocument Spreadsheet (ODS). If necessary. Alternatively. OpenDocument Text (ODT). 28 . Figure 3-2 Output of the Accounts Report 3. Microsoft Excel (XLS. click an export icon: . To view and save the report in other formats. You can view the file in its application and save it. The report appears. click the Back icon .

mouseover any of the states on the map to see the full state name and. giving them greater visual appeal. Widgets Pro – Non-standard charts such as gauges. Charts. Flash charts can be animated as they are drawn.2 Running a Flash Chart This release of JasperServer supports Flash charting. when data exists. spark lines. animated. the value for that state. 2.” on page 79. To view these elements in PDF output. the space used by the element remains blank. Flash Map Report. and interactive reports: Maps Pro – Color-coded maps covering all countries and regions of the globe. 29 . These components are based on Fusion libraries and generate Flash output that is embedded in the HTML and PDF output. you must use a Flash-enabled PDF viewer such as Adobe Reader 9. see the iReport Ultimate Guide. Flash charts are JRXML reports that are created in iReport Pro and uploaded to the repository as a report unit. To interact with the map in JasperServer. Make sure Flash is enabled in your browser. a new feature implemented in JasperReports Pro. and Gantt charts. as explained in the following examples: Figure 3-3 Output of the Sample Flash Map Report The color-shaded states correspond to value ranges given by the legend. and Widgets Pro elements in JasperServer. see chapter 5. or Widgets Pro element is exported in a format other than HTML or PDF. Flash must be installed and enabled on your browser. To upload JRXML reports. and press Enter or click Search. JasperServer cannot create Flash charts. The sample data installed with JasperServer includes a very simple example of each Flash chart: 1. When a report containing a Maps. The repository displays the search results. “Adding Reports Directly to the Repository. Flash charts are also interactive. Charts Pro. Charts Pro – Standard and stacked charts with animation and interactivity. and Flash Widget Report. JasperServer Professional and Enterprise editions include the Maps Pro. The reports launch in the same manner as any other reports.Running Reports 3. then click any of these report names. However. type flash into the search field. From any page in JasperServer. including Flash Chart Report. For information about creating flash charts. and Widgets Pro component libraries that create visually appealing. Charts. funnels. To view Maps.

text appearing in the report can be localized. These are simple examples with unrealistic data. The search results are displayed in the repository. You can then display the controls and run the report with new values. or Widgets Pro components. The Maps Pro. enter freight and click Search.3 Running a Report with Input Controls or Filters Input controls and enable you to select the data returned when you run the report. you may need to enable links in order for them to work. 3. Chart elements. Charts. the report runs with default values. but they show how Maps. and Order ID. and Widgets Pro components are fully supported by Jaspersoft. Click the name Freight Report in the list of results. they are rendered as input controls when running the reports based on the Domain Topics. For more information about uploading resource bundles for Maps. and widget segments are clickable and can be linked to more detailed reports. Flash charts have many features that are not illustrated in these sample reports. Charts Pro. click a segment to separate it from the others. Request Date. 2. Charts. In the Search field. even map labels. or Widgets Pro components can present several layers of information in compelling ways. The report appears. When you view the report at first. see the iReport Ultimate Guide. 3. The Open Flash Charts Report listed in the search results is an experimental report that uses a different Flash library. 30 . Depending on the security settings in your Flash player. map regions.3. among them: As with any JRXML report.JasperServer User Guide Figure 3-4 Output of the Sample Flash Widget Report To interact with the pyramid widget in JasperServer.1 Simple Input Controls The Freight Report example has three input controls: Country. When filters are defined in Domain Topics to be prompted. To run a report with simple input controls: 1.

click the Report Options icon The Report Options dialog appears. Select USA in the Country field. and so the postal codes and customer IDs are for Mexico. the country is Mexico. and the postal codes and customer IDs are for the US.Running Reports Figure 3-5 Shipping Report with Country = Mexico by Default In the report as it was saved. Figure 3-6 Setting Country = USA in the Report Options Dialog The report appears with USA as the country instead of Mexico. To run the report with other values. 4. Figure 3-7 Shipping Report With Country = USA You can also click Apply in the Report Options dialog to refresh the report but keep the dialog open. 3. 1997. and click OK. This allows you to interact with the report and easily find the data you need. All order IDs are above 10600 and all order dates are after June 1. 31 . .

. 10.JasperServer User Guide 5. Right-click the saved version and select Properties. Figure 3-10 Report With Saved Values in the List of Reports 9. Click the + icon next to the Freight Report to display all saved versions of the report. 32 . from the context menu. To make USA the default country. 7. The new USA version of the sample report is listed beneath the report’s original version. 8. You can add a description to the saved version of the report. You can open the report directly with the saved values for the input controls by clicking on the name of the saved version. 6. Click the Back icon to display the search page. click to display the Report Options page again. and click OK. You are prompted to name the new set of default values. in this case Mexico.. the values of the report options revert back to the original values stored in the report. then click Save Values. Figure 3-8 Naming the Saved Values The Report Options dialog now has a drop-down list showing USA as a set of saved values. enter USA as the new name. In the window. Figure 3-9 Report Options With a List of Saved Values If you click Reset.

For more information. For example. Select a different state. JasperServer displays an activity monitor while the query is running. you can click Cancel and select different values. Mexico. Reports can also be designed with cascading input controls. The following example also demonstrates required inputs. The other fields are automatically updated to reflect the state and names associated with Mexico in your data. 33 .2 Cascading Input Controls With simple input controls. see 5.7. In the Search field. To run a report with cascading input controls: 1. the choice of a country determines which states or regions are available to choose from. Instead of running the report. enter cascading and click Search. Figure 3-12 Adding a Description to a Saved Version of a Report 3. Figure 3-11 Adding a Description to a Saved Version of a Report 11. Click the name Cascading multi select example report in the list of results. in this example. The new description will appear in the repository. for example Guerrero. 4.3. Enter a description and click OK. every value chosen is independent of the others. 3.2. The search results are displayed in the repository. where the choice for one input determines the choices for the other input. Select a different country in the first field. and in the case of long queries.Running Reports The Resource Properties dialog appears. 2.” on page 98.9. Cascading input controls are implemented as queries that access your database to retrieve the new values. in which case you must enter values before running the report. you are prompted to enter new values for them. “About Cascading Input Controls.

To see the data for their own regions. In these latter cases.. The report creates a list of all account names in the chosen states of the chosen countries. For example. The report will contain all requested data in the data source. Scheduled reports run as the user who defines the job (see 3. JasperServer returns whatever data is passed to it from the data source. Standard data sources in the repository are not subject to access permissions.. Gloria has access only to inventory data from the Southeast US region. Some data sources can pass access grants along with their data. Click OK to run the report with your chosen values. 34 .1 Viewing Scheduled Jobs To view the jobs that are currently scheduled for a report. Joe User has scheduled three jobs for the Freight Report. right-click it and select Schedule. In the figure above. locate the report in the repository. The scheduled jobs page appears for the chosen report. The list shows the following information for each job: ID – The internal ID number of the job. accompanied by a link to edit the job details.” on page 155).JasperServer User Guide The names field updates to reflect the choice of state. Any number of jobs can be scheduled for the same report. Click the icon to see the jobs scheduled for the report. administrators see the jobs defined by all users. External data sources might be subject. your options vary depending on whether the report has scheduled jobs: In the repository. Label – A short description provided when creating the job. The chosen name is listed at the top of the report. and any user that receives the report can view all the data regardless of the user’s access restrictions. You can view the output there. some cannot.” on page 35). 3. from the context menu. Only the user who created the schedule or a user with the administrator role can change or delete it. You can also have the output sent to you and others as email attachments. Owner – The user who created the job. “The Domain Security File. The country and state inputs are defined as multi-select.2. Reports that she schedules only show data from that region even when the report is viewed by users in other regions.4. Figure 3-13 Jobs Scheduled Page for a Sample Report Standard users see only the jobs that they have defined themselves. reports with scheduled jobs have a small icon beside the report name.4 Scheduling Reports The report scheduler enables you to run reports at prescribed times. The other values are updated to reflect your choices. If the report’s data source is subject to access permissions. “Scheduling a Report. It is up to the user to configure whatever is passed to JasperServer.4. 5. as well as data sources authenticated by security frameworks other than the Acegi framework used by JasperServer (see the JasperServer Administrator Guide). Be careful when you schedule a job as an administrative user with no data restrictions. If a report does not have the schedule icon. Permission to edit a schedule is simpler. the report contains the data that the user has permission to see. Jobs that you define in the scheduler run the reports in the background and save the output in the repository. 3. use controlclick to select multiple values in each lists. but Domains are (see 7. the other users need to schedule the report themselves.4.

Figure 3-14 Job Page for Scheduling a Report 5. from the context menu. Deletes all the jobs selected with a check mark.4. click the small icon beside the report name. “Running a Job in the Background. Click Next. modify. 6. Complete – The job is complete. click view your reports. as shown in Figure 3-13 on page 34. or delete. Right-click the report and select Schedule. Scheduling a Report To schedule a report: On the Home page. If the report already has a schedule that you want to add. 4. Refreshes the list of jobs. Next run time – The next time the report will run. but an error occurs while it runs. click View > Reports.” on page 39. Opens the Job Details page to define a new job..2 1. allowing you to continue working in JasperServer.6. Last ran at – The last time the report was run. Checkbox – Select for removal. Running – The job is currently running. This does not include cases where the job is successfully triggered. the report is completed before the job is deleted. or from any page. 35 . Click Schedule Job. The Job Details page appears. When a job is deleted while it runs.4..Running Reports State: Normal – The job is scheduled. 2. enter a name for the job. Use the search field or browse the list of reports to find the report you want to schedule. In the Label field. The description is optional. 3. Buttons on the page include: Button Back Schedule Job Run Now Refresh Remove Description Returns the user to the repository manager or the list of reports. Runs the report in the background. See section 3. The Scheduled Jobs page appears. JasperServer deletes completed jobs automatically. 3. for example to see if a job has finished running. Error – The scheduler encountered an error while scheduling or triggering the job.

5. you may still want to delay the first report date. If you have saved values. we used the saved values for USA. “Specifying Job Recurrence. Click the calendar icon to select a future start date and time. the time zone you entered at log in. Choose a set of saved values. 9. daily. Recurrence – Choose one of the following: No Recurrence – Run the report once.” on page 38. see section 3. or if specified. for example a weekday report that you want to start next week. additional controls appear on the page. If you do not specify recurrence below. Figure 3-16 Parameters Page for Scheduling a Report This dialog is identical to the Report Options dialog. as well as save them as a named set of values. Calendar Recurrence – Schedule the job to recur on days of the week or days of the month. The default time zone is the that of the server. the start date and time define when the report will run. Click Next. 8. Set the following schedule attributes: Time Zone – Specify the time zone in which you wish to define the schedule.4. 10. the new job will start on a fixed date and run only once. If you are in a different time zone. In this example. set this field accordingly so that the report is scheduled at the exact time you intend. For details. the Parameter page appears. Figure 3-15 Schedule Page for a New Job 7. The fields that appear are the input controls defined for the report you are scheduling. 36 . Start – Immediately or in the future. In this example.JasperServer User Guide The Schedule page appears. they appear in a drop-down list at the top. If the report you are scheduling has input controls that prompt for user input. Simple Recurrence – Schedule the job to recur at an hourly. If you select Simple or Calendar Recurrence. You can always set the input values directly. or set the input controls as desired. If you specify recurrence. Click Next. or weekly interval.

Figure 3-17 Output Page for Scheduling a Report 11. your administrator must configure one. numbers.sun. for example 200906150601. Folder – Select the folder where the report output will be saved. To send notifications. choose whether newer files overwrite the older ones.Running Reports The Output page appears. based on the java. Be careful when sending reports containing sensitive data via email. Attach Files – Select this option to send the output of the report with the email. Locale – Locale for generating the report. Useful for the output of recurring jobs or for time-sensitive reports where the output must be dated. For more information on the valid patterns for this field.text. “Resources of a Domain. enter one or more email addresses separated by commas. specify these attributes as needed: Base output file name – The name of the file as it appears in the repository. underscores and periods. To – For email notification.” on page 153). not including the file extension. Output description – The output file is stored in a repository object. each format will be stored as a separate file in the repository and attached as a separate file to the email notification. The default pattern is yyyyMMddHHmm. for example a report based on a Domain with language bundles (see section 7. The report must support locales.SimpleDateFormat. select this option to avoid attaching the empty files. as described in the JasperServer Administrator Guide. Skip Empty Reports – In case of an error and the report is empty. and this is the optional description for the object. and the format extension is added automatically. dashes. Timestamp pattern – Specify an optional pattern for the timestamp. If you email the report and do not wish to save it.3. refer to: http://java. The timestamp pattern can be added to the base name. On the Output Details page.html Overwrite files – If you do not have sequential filenames or if you specify a timestamp pattern that may lead to identical filenames.com/j2se/1. This field is required and you must have write permission to the folder.<extension>. When the timestamp is used. 37 . However. Sequential file names – Appends a timestamp to the names of files created by the job. specify the Temp folder. Message Text – Content of the notification email. Output formats – Select at least one. When you select more than one. the output filename is <basename>-<timstamp>. By default.4. no mail server is configured in a JasperServer installation.2/docs/api/java/text/SimpleDateFormat. Subject – Subject line of the notification email. valid patterns for report output files can only contain letters.

4. according to the chosen interval.1. Make your changes on the Job Details. you should create a new job rather than changing the past one. “Viewing Scheduled Jobs. The job appears in the list of scheduled jobs (see 3. or weekly interval that is quick to set up. how often it repeats. 3. “Viewing Scheduled Jobs. days. 3. In the list of jobs. X times – Runs the specified number of times.4. 5. you specify when the job starts.4. and when it ends.” on page 34. Schedule. hours. 3. verify that the next run time for the job is the new date and time you want. To delete a scheduled job: 1. Click Save. daily. 2. verify that the next run time for the new job is the date and time you want. if you want to run the job every Monday. Every – The interval between jobs. Click the calendar to select the date. For each.” on page 34.4. Select the check box in the row of the job you want to delete and click Remove.JasperServer User Guide 12. Open the Jobs List page for the report. For example. Click edit in the row of the job you want to change. Simple recurrence makes the job repeat at an hourly. as described in section 3. Open the Jobs List page for the report. Parameters.3 Changing Job Schedules When the start date for a job is in the past. In the list of jobs. Until – Runs until a calendar date is reached. or weeks. the start date and time determines the date and time of all occurrences. To edit a scheduled job: 1. 4. Indefinitely – Runs until you delete the job.5 Specifying Job Recurrence Simple recurrence and calendar recurrence allow you run reports automatically on a regular basis.4. 38 .4. in minutes. 3. and Output pages of the dialog. 2. Click Save.1. set the start date to the first Monday.1. “Viewing Scheduled Jobs. Your update applies immediately.4 Stopping a Job from Running To stop a job from running. delete it.” on page 34). 13. Figure 3-18 Schedule Page With Simple Recurrence Simple recurrence supports these options: Start – With simple recurrence. Occur – Determines how many times or for how long the job will repeat. as described in section 3.

which is quick way to share a report with others. Figure 3-19 Schedule Page With Calendar Recurrence Calendar recurrence supports these options: End date – Calendar recurrence runs until a calendar date is reached. or from any page. for example: 1. use calendar recurrence. You can also enter multiple minutes or hours.4. Use the search field or browse the list of reports to find the report you want to run. 15 Months – Choose the months during which the report will run. Week Days – Choose the days of the week. Month Days – Enter dates or date ranges separated by commas. Enter an asterisk (*) to run the job every minute or every hour. to 5:45 p. The hours use 24-hour format. 15. If you want your jobs to recur at the same time of day and respect DST adjustments. On the Home page. 0. and keep working in JasperServer. 3. potentially a long-running one. 45 for the minutes and 9-17 for the hours will run the report every 15 minutes from 9:00 a. including the time of day. To run a job in the background: 1. separated by commas. Minute and Hour – Set the time of day when the job should run. It also has the option to export the report directly to any format and save it in the repository. days of the week or days of the month.Running Reports Calendar recurrence enables you to define a job’s recurrence at a higher level of detail.m. If your servers recognize Daylight Savings Time (DST). You can also send the generated report by email. click View > Reports. Days – Choose the days when the report should run: Every Day.m. 3. 30.. Running a job in the background is equivalent to scheduling the report to run immediately without recurrence. 2. from the context menu. jobs scheduled using simple recurrence may seem to occur one our later (when DST ends) or one hour earlier (when DST begins). and months of the year. click view your reports. Right-click the report and select Run in Background. 39 . as well as ranges. Click the calendar to select the date. For example..6 Running a Job in the Background Running a job in the background lets you generate a report.

“Output Page for Scheduling a Report. as in Figure 3-16.” on page 36.” on page 35. you can continue working in JasperServer. In the meantime. the Parameter page appears. 5. 40 . “Parameters Page for Scheduling a Report.4.7 Other Report Parameters When the report scheduler runs a report. The report begins to run immediately and.util. a built-in parameter named _ScheduledTime can pass the date and time the report was scheduled to the report. 6. Click Save.JasperServer User Guide 4. “Scheduling a Report. Choose a set of saved values. If the report you are running has input controls or filters that prompt for user input.4. You can use this parameter in a report by declaring it in the JRXML using this syntax: <parameter name="_ScheduledTime" class="java. or set the fields one at a time.Date"/> Use the _ScheduledTime value to display the date the report was run. Enter the information as described in step 11 in 3.2. The Output page appears as in Figure 3-17. Click Next. when finished. 3.” on page 37. stores or sends the output as directed on the Output page.

JasperServer may load a Topic or Domain’s entire result set into memory when you edit or run the report. A Topic can also be created from a Domain. and charts as you drag and drop elements. Depending on your configuration. “Data Policies. For more information. select labels and styles. refer to section 4. You can edit reports in the Ad Hoc Editor if they were created there originally.7. Domains give JasperServer administrators and business analysts flexibility to filter the data and create input controls and control the list of available fields. crosstabs. add fields. you can change the data loading policy.” on page 78. This chapter contains the following sections: Understanding the Ad Hoc Editor Designing an Ad Hoc Report Exploring and Analyzing Data in the Ad Hoc Editor Additional Features of the Ad Hoc Editor Creating a Report from a Domain Uploading a Topic Configuring System-level Ad Hoc Options 4. While Topics contain the fields used directly in a report. and select summaries and data formats for each field. given your environment’s load capacity. administrators and iReport users create Topics as JRXML files. You can select report types. refer to 4. “Uploading a Topic.5. The Ad Hoc Editor loads data from Topics or Domains.1 4.6. 41 .3.2.Working with the Ad Hoc Editor 4 WORKING WITH THE AD HOC EDITOR The Ad Hoc Editor creates tables.1. You can also use the editor to explore and analyze your data interactively. “Saving Domain Settings as a Topic.” on page 76 and 4. For more information. Alternately. ensure that each Topic or Domain’s query returns a manageable amount of data. define groups.1 Understanding the Ad Hoc Editor Topics and Domains Generally. which are repository objects defined by data analysts or server administrators to provide a prepared view of a data source.” on page 74. If the data policies are disabled. but you can’t edit reports in the editor if they originated in iReport.2.

those filters can be changed or removed.” on page 62.4. click this icon. For more information. Sort When working with tables. “Using Input Controls.1. for example. you can change its filter and input control values but you can’t change its layout. “Sorting Tables. you can change summaries and datatypes for all report types. If the report includes filters created in the editor. In tables. To work with the complete data set. Place your cursor over this icon to open a menu of save options. For more information. Input Controls Styles 42 . and display options in charts. Click this icon to run the report and view its HTML preview. For more information. refer to 4. Description Click this icon to hide the editor interface and view the report by itself.2 Table 4-1 Icon The Ad Hoc Editor Tool Bar Ad Hoc Editor Tool Bar Icons Name Presentation Mode The tool bar at the top of the editor provides access to many of the Ad Hoc Editor’s functions:. and provides export options to formats such as XLS and PDF. The words Sample Data appear to the right of the Crosstab tab when you are working with a subset of the data.3. Instead. In some cases. Click this icon to redo the most recently undone action. Save Run Undo Redo Undo All Sample Mode Pivot or Switch Group Click this icon to change the way groups are displayed. For example.2. which improves performance when adding fields.” on page 61. After you click Undo All. since the summary context menu appears at the bottom of the column. clicking this icon removes the field from the report area.4. Click this icon to select a style that determines the fonts and colors in your report. When you run a report. This icon is only available when input controls are defined for a JRXML-based Topic. Save the report with the current name and location or save it with a new name and location using the Save Report As option. This view opens in a new window or tab.4. click the Styles icon and choose a different style. refer to 4. the behavior differs: Crosstab: pivots the column groups with the row groups. changing grouping. you can click the redo icon to recreate the steps you took before you clicked the Undo All icon. Click this icon to undo the most recent action. “Switching Groups. Depending on the tab you’re viewing. you can select new values to change the data displayed in the report. click this icon to view the current sorting (if any) and to select fields by which to sort your data. you could change the dates the report includes. This icon is only available immediately after you have clicked the Undo icon. Click this icon to view the input controls applied to this report. click this icon to load the full set of data. For example.” on page 59. taking any other access disables the Redo icon. Click this button to revert the report to its state when you last saved. refer to 4. if you added a field to a table. JasperServer only loads a subset of the data in your data source. Note that you can’t undo a style selection. The full data set gives you an accurate view of the your report and is helpful for exploring the data itself. Chart: displays the alternate grouping. By default.4. Table: displays the alternate grouping. you can change the chart type.1. When working with a table or crosstab. This mode provides a subset of the Ad Hoc Editor’s full feature set. the subset is helpful in visualizing how your groups will look and for setting summaries.JasperServer User Guide 4. legends. and other changes that require JasperServer to process your data. you can define sorting and the order and size of columns for tables.

you can also hide or show the detail rows when the data is summarized.1. Columns can include both properties and measures. This option is only available if the table includes grouped columns. In tables. each row represents a something being measured. and the rows could be grouped by city and product.. Change whether to display the title. Change the page size. For instance.3 Tables.. and Crosstabs The Ad Hoc Editor provides three modes for working with your data—tables. and crosstabs: Table – Use tables to view all the data in the report or to summarize the data across one set of related fields. You can: Change whether to display the filter pane. Count Sum Date Date Date Date Date . Rows can be grouped by their properties. Amount Amount Amount Amount Amount . each column might contain one measurement of the orders.Working with the Ad Hoc Editor Table 4-1 Icon Ad Hoc Editor Tool Bar Icons Name Page Properties Description Place your cursor over this icon to open a menu of page-level options. Change the page orientation. 4.. 43 . Charts.. Date Placed City A Product 01 Date Date Date Date Date Product 01 totals: Product 02 Date Date Date Date Date Date Count Date Date Date Date Product 03 totals: Date Date Date Date Date Count Date Date Date Date Date Date Count Date Date Date Date Count Amount Amount Amount Amount Amount Sum Amount Amount Amount Amount Amount Amount Sum Amount Amount Amount Amount Sum Date Filled Payment Received Product 02 totals: Product 03 City A totals: City B Product 01 Date Date Date Date Date .. charts. in a report on orders..

. Crosstab – Use crosstabs to summarize data across multiple sets of related fields. Charts summarize data in a graphical representation that can highlight your successes and challenges.. For instance.. you could configure the chart in a number of ways: you could group the bars by region or city. you could click the Chart tab to view the data in a bar chart that showed the sum of payment received for each of the products in each of the cities. and two data measurements in each cell.. Columns and rows specify properties that are used as dimensions for grouping.. Tom 2007 City A Product 01 Product 02 Product 03 Product Totals City B Product 01 . Crosstabs are more compact representations than tables.... or use a completely different chart type. Filled Payment Year Totals Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment .. such as a pie chart in which each slice depicts the payment received grouped by product or city. Filled Payment 2008 Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment .. With the exception of time series and scatter charts. Filled Payment Year Totals Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment . rows grouped by city and product... Filled Payment Manager Totals Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment . For example... cells contain the summarized measurements. Total Payments Received City A Product 01 City B Product 02 Product 03 City C Depending on your needs. Filled Payment 44 . Filled Payment Harriet 2007 Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment . City Totals Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment . the example above could be displayed in a crosstab with columns grouped by sales managers and year. each type of chart compares summarized values for a group. Filled Payment 2008 Filled Payment Filled Payment Filled Payment Filled Payment Filled Payment .JasperServer User Guide Chart – Use charts to compare one or more measures across multiple sets of related fields...

This section discusses some of the editor’s basic functionality. you’ll create a table that shows the ship date and shipping charge of orders. The Ad Hoc Editor appears. this table might be used to analyze whether shipments could be combined to save on costs. On the Topics tab. Figure 4-1 Topics and Domains Window 2.3. and click Open Report. including: Selecting the Content of a Report Formatting the Appearance of a Table Viewing and Running a Report in the Editor The Ad hoc Editor is also helpful in exploring and analyzing your data.2 Designing an Ad Hoc Report While many users think of the Ad hoc Editor as a report designer.1 Selecting the Content of a Report In the following example. 4. It is typically in Ad Hoc Components/Topics. click Create > Ad Hoc Report.2. To design a table in the Ad Hoc Editor: 1. and Crosstab).” on page 50. The fundamental areas in the editor are: The tool bar. see 4. “Exploring and Analyzing Data in the Ad Hoc Editor. While the example in this section is based on a JRXML Topic. for more information. After logging into JasperServer. The Domain or Topic and its list of available fields. The Topics and Domains window appears. select the demo for adhoc Topic. the concepts and procedures apply more broadly to Domains and Domain Topics when used as the basis of Ad Hoc reports. The location of this Topic may depend on your system configuration.Working with the Ad Hoc Editor 4. click Table. 45 . The report type tabs (Chart. Table.

and select Add as Group from the context menu. Remove the column from the table by dragging the column heading out of the report area. The field context menu also provides this option. 5. With the new ordering. right-click the City field.JasperServer User Guide The report area. 4. the editor displays rows that describe stores in Argentina. Review the data in the Buenos Aires group. In the list of fields. When you create a new report. and notice that the rows are mixed. click Country and drag it to the Group Control icon . 6. In the list of fields. The report area refreshes and displays your selected data grouped by city. Notice that the Shipped via column displays a list of numbers that seem irrelevant. 8. some show data for Cactus Comidas por llevar. Figure 4-2 New Report in the Ad Hoc Editor 3. click Date ordered Date shipped Order ID next to the following fields to add them to the report: Name Postal code Shipped via Shipping charge Data for each field appear as you add the columns to the table. 7. Drag the Name column out of the report area to remove it from the table. However. while others show data for Rancho grande or Océano Atlántico Ltda. and the report area is empty. right-click Name and select Add as Group from the context menu. 46 . Drag the top-most Country heading upwards above the City group and drop it. The report area refreshes and displays the data grouped by both city and country. The field context menu also provides the option to add fields. The order of the groups is determined by the order in which you added them to the report. you can change the order to correct it if it doesn’t make sense. 9. the available fields appear. In the list of fields. You can also drag to add fields from the list of fields and to rearrange columns in the table. The report area refreshes and displays the rows grouped by country and then city. In the list of available fields.

16. You have created a basic report that shows the ship date and shipping charge recorded for orders in the sample data. and displays a context menu where you can change or remove the summary function if necessary. and name. working with a subset of the data may improve the performance of the Ad Hoc Editor. The default location depends on the permissions granted to your user account. 13. Above the report area. In the Description field. Working with the full set of data gives you a clearer understanding of the final report. 17.00 to $600. the editor only displays a subset of your data when working with a table. 18. the words Sample Data disappear and the total for Argentina changes from $597. 12. Place your cursor over and select Save the Report. Accept the default value for Location Folder.00 when the full set of data is displayed. enter Ad Hoc Demo Report. 14. enter This report was created with the Ad Hoc Editor. Figure 4-3 Unformatted Table 11. 47 . 10. to the right of the Crosstab tab.Working with the Ad Hoc Editor The report area refreshes and displays the data grouped by country. 15. city. Click to include the entire data set in your table. and country. The Ad Hoc Editor displays the totals (sum) for each name. city. or click Browse to select a new location. click the Table tab to return to the table view. Right-click the chart and select Chart Type > Pie to view a pie chart of the data. by default. Above the report area. Note that. Also note that it is easier to work with summaries in tables when only the subset is shown. Right-click the Shipping Charge column heading and select Add Summary from the context menu. In the Report Name field. click Chart to view this same data as a chart. this is because the summary context menu appears at the bottom of the column. This is because.

4. Right-click the first Name group (Cactus comidas por llevar) and select Edit Label from the context menu. Your changes are lost when you use the browser navigation buttons. 7. 6. The Ad Hoc Demo Report appears. click the text Click to Add a Title. In the Repository pane. but you can’t edit reports in the editor if they originated as JRXML files. 3. displaying objects that match the text you entered. The title becomes editable. Select the Ocean style and click Close. the main menu. All data and formatting are lost when you select a new Topic or Domain and click Open Report. or the Search field. enter ad hoc demo and click Search. 5. Right-click the Date ordered column and select Edit Label from the context menu: 48 .JasperServer User Guide 4. Note that you can select a different Topic or Domain for your report. 2. This option is only available for reports that were created in the Ad Hoc Editor. The group label becomes editable. The Search page appears. Click change to the right of Topic to select a different Topic or Domain. In the Search field. 11. Note that your changes are preserved if you select the current Topic or report once again. right-click the Ad Hoc Demo Report and select Open in Designer from the context menu. Enter Customer for the group label. 9. Enter Orders and Fees by Customer. Click to choose the report’s style. Click Cancel to return to the editor without changing the Topic.2. Above the table. The Styles window appears: 8. To format a table in the Ad Hoc Editor: 1.2 Formatting the Appearance of a Table Next you’ll change the appearance of the table. You can edit reports in the Ad Hoc Editor if they were created there originally. Your changes are also lost if you navigate to another page. 10.

and click Change Data Format > ($1. drag the column edge to the left until the heading is no wider than the data in the column cells. 20. as well. Make all columns as narrow as possible. Adding some space might help. Drag the field and spacer to the left-most position in the report and drop them. The Save Report As option creates a new copy of the report.S. 19. 49 . 22. Spacer to left edge of the table. Drag the 16. as well. you can remove labels from the report and make the column only as wide as the data. Right-click the Postal code column heading and click Delete Label from the context menu. The Ad Hoc Editor applies a summary to each field depending on its datatype and inserts a spacer in the leftmost position to improve the table’s formatting. and select Save the Report. If space is at a premium. Click the Ordered on column heading and place the cursor over its right-hand side. Drag a Spacer to the right edge of the table. select Change Data Format. Right-click the Ordered on column. The dates in the columns now appear in the short date format. Enter new labels for these columns as well: Date shipped – Shipped on Shipping charge – Fee 12. it is only displayed in the Ad Hoc Editor. Type Ordered on as the new label. 5/01/08. and select the short date format. When your cursor changes to the resize icon ( ). The name of the column in the database is displayed with a different font and background color. Accept the existing values in the dialog by clicking Save. Dollars data format is applied to the Fee column. for example.56). 17. Use Ctrl-click to select both the Order ID field and the spacer to its right. Place your cursor over menu. drag the Spacer into the table between each of the columns. 14. Apply the short date format to the Shipped on column. You have now created and formatted an Ad Hoc report. click Change Data Format. The U. You could also add the spacer to the farthest right position by clicking its arrow icon . 13. Place your cursor over and select Hide Detail Rows to show only the summarized totals for each group. Display the detail rows again from the 23. The label isn’t used in the report itself. 18. Spacers can also be used to create margins.234. The last few columns are now difficult to read because they are crowded together. 21.Working with the Ad Hoc Editor The column label becomes editable. 15. 24. In the list of fields. Right-click the Fee column. Resize the column again until it is as narrow as the data.

JasperServer User Guide Figure 4-4 Formatted Table Any unused space at the right of the report area is retained when you run the report. Click and select a page size (Letter. you can save it in the repository for future use. it is displayed as a Jasper Report. you can: View the report in presentation mode by clicking . or Actual Size) if your table fits one of these formats better. This section describes: Creating an Initial Layout Focusing on Specific Data Refining the Crosstab 50 . Run the report by clicking . A4. as described in 3.” on page 27.1.2. or crosstab. chart. you can also run the report directly from the repository. 4. When you run the report.3 Exploring and Analyzing Data in the Ad Hoc Editor You can use the Ad Hoc Editor to delve into your data and recognize trends and outliers by exploring and analyzing your data.3 Viewing and Running a Report in the Editor When you have created a compelling table. “Running a Simple Report. In the Ad Hoc Editor. 4. The following example explores the state sales data in the Foodmart sample data that can be installed with JasperServer.

click Crosstab. Review the data in the crosstab. Creating an Initial Layout To set up the crosstab and define its initial layout: After logging into JasperServer. Right-click the Store Country column group label and select Expand Members. Right-click Customer State and select Switch to Column Group. Use the scroll bars if necessary. Drag: Store Country into the Column Group area. 3. 5. 7. This indicates that most customers shop in their home state (the store state recorded for their purchases is the same as the customer’s home address state). On the Topics tab. Click Save > Report enter a name. For example. click Create > Ad Hoc Report.1 1. The Topics and Domains window appears. Customer State into the Row Group area. There are a exceptions. Product Family into the Row Group area. You can make the crosstab more readable and compact by pivoting the Customer State row group so that all geographical groups are on the same axis of the crosstab. but they are obscured by all the zero values. 51 .Working with the Ad Hoc Editor 4. 6. and click Open Report. Figure 4-5 Crosstab of Foodmart sales totals by state and product family Note that zeroes appear in many of the cells. where both the Store State column group and the Customer State row group are BC. every cell shows a zero except for the first. The location of this Topic may depend on your system configuration. Create a crosstab. It is typically in Ad Hoc Components/Topics. 4. Store State into the Column Group area. The non-zero values mainly appear in cells where the Store State column group intersects a Store Customer row for the same state. The Ad Hoc Editor appears. 2.3. Right-click the Product Family row group label and select Expand Members. 8.56). in the BC column group. Set the data format: right-click Store Sales in the measure label area and click Change Data Format > ($1234. and specify a location. Store Sales as Measure. select the foodmart data for crosstab Topic.

11. 10. save the crosstab. Given that Sinaloa is 1000 miles from Guerrero. If the filter pane is displayed. and select Exclude. 3. But in Mexico. The crosstab is redrawn without data regarding the US or Canada. 5.JasperServer User Guide 9. Jalisco. 7.2 1. That seems trivial. Why are customers willing to drive hundreds of miles to visit this location? Since the crosstab only includes a single country now.3. the other shows the customers’ locations. Right-click Store Country and select Delete Column Summary. take a look at the sales in stores nearer to Sinaloa: Distrito Federal. BC is the only province that appears in either the Store State or Customer State: all the Canadian customers live in the the same province as the store they frequent. focus on the data from Mexico. This seems like an important outlier. and Zacatecas. place your cursor over and select Toggle Filter Pane to hide it. Next.select Save the Report. Several stores are much closer to Sinaloa than Guerrero. If the filter pane is displayed. Figure 4-7 Crosstab of Foodmart in Mexico 4. Right-click Store State and select Expand Members. The crosstab is getting easier to read. Select Veracruz. place your cursor over and select Toggle Filter Pane to hide it. Focusing on Specific Data To focus on specific group members and measures: If it isn’t open. this may be another important outlier. 6. Right-click Customer State and select Expand Members Right-click Mexico and click Keep Only. Note that in Canada. Hide the Store Country column group summary. but notice a similar issue in Guerrero: the Guerrero store is selling to customers in Sinaloa. Place your cursor over . 4. 2. the two column group summaries show identical data. and specify a name (Foodmart Crosstab) and location (/reports). 52 . The same is true in the US. Note that fewer cells show zero values. Stores in DF (Distrito Federal) sell to customers in two states: DF and Mexico. Figure 4-6 Streamlined crosstab of Foodmart sales Two column groups now show state names. many customers cross state lines to shop. First. exclude the others. Ctrl-right-click Yucatan. In the next procedure. and the crosstab is more streamlined. Any cases where a customer made a purchase in another state is more evident. one shows the stores’ locations. which border each other. locate and edit the Foodmart Crosstab report created in the last example.

Right-click the new custom field and click Add as Measure.Working with the Ad Hoc Editor The crosstab now shows sales values for Sinaloa and the four nearest states. or 65% of the CA sales LA sold $350. You can automatically compare them against each other and against the total for each store state. The measure appears in the crosstab. the percent of row group parent for snacks is 61% and is 29% for Batteries. If the store also sold $2000 in another department (for example. SF sold $650. Right-click the measure’s label. You can change the data format of the new measure to make it more readable. or 66% of the US sales. or 33% of the US sales The total for WA is $2000. Consider this example: The total for CA sales is $1000. Figure 4-9 Crosstab of Foodmart sales and Percent of Column Group Parent 53 . or 20% of the Snack sales. 10. Batteries). or 80% of the Snack sales. RGP means row group parent. note its abbreviated name: % CGP (Store Sales): CGP means column group parent. 8. 9. It compares values in row groups to their parent values and expresses each measure value as a percent of the containing row group. right-click Store Sales > Create Custom Field > Special Functions > % of Column Group Parent (value). It compares values in column groups to their parent values and expresses each measure value as a percent of the containing column group. in this case the total for the inner group is expressed as a percent of the outer group total. Sodas sold $4000. the crosstab shows a sales total for all products in the Food product family. and select -1234. Note that dropping such percent of parent calculated fields in the row or column group area has no affect. Jalisco. Consider this example: The total for the Snack Department sales is $5000. To continue the above example: The total for all states is $3000 The total for CA is $1000. In available fields. it’s similar to CGP but applies to row groups rather than column groups. and Zacatecas For each customer state. Figure 4-8 Crosstab of Foodmart sales in DF. click Change Data Format. or 35% of the CA sales These calculated fields can be used in crosstabs that include nested column and row groups. % Column Group Parent can also be used in tables with more than one group. A new field appears. Chips sold $1000.

Right-click Non-consumable and select Keep Only. 4. Click the Ascending to change the sorting to Numeric Ascending ( ). 6. Review the data in the crosstab. Click the column group labels and select Expand Members to restore the view of the crosstab shown in Figure 4-9 on page 53. Note that the words Sample Data disappear to indicate that you are working with all the available data. the non-consumable product family seems to have many customers from Sinaloa. Click the arrow next to DF. The crosstab shows two categories where more than 50% of the sales in the Guerrero store were made to residents of Sinaloa: Cold Remedies and and Hygiene. Click . right-click Hygiene. one might be expecting the % CGP values for Sinaloa and Guerrero customer state CGP values to roll up and equal the Guerrero CGP store state value. put another way. The percent of column group measure shows that a third of the people that shop in Guerrero live in Sinaloa. the measures are sorted across both axis. in Guerrero the detail for Sinaloa and Guerrero customers (47% and 53% respectively of all sales in Guerrero). 9. Place your cursor over and select Save the Report.that is. Refining the Crosstab To refine the crosstab while viewing the full data set: If it isn’t open. for the other states. Note that clicking the editor’s scroll bars causes JasperServer to remove focus from groups selected in the crosstab. 3. $420.04 is 13% of all Mexican sales occurred in Guerrero. Sort by % CGP (Store Sales). 2. Jalisco.3 1. The data in the crosstab is now filtered to a narrow view of the foodmart data. your options are Alphabetical Ascending (the default) and Numeric Ascending and Descending. Select a member and use the mouse scroll button to scroll to the next member.3. the % CGP is 13 . Instead. Click Cold Remedies. the crosstab is sorted by both columns groups and row groups. At first glance. 4.JasperServer User Guide 11. and click Keep Only. these numbers may seem incorrect. Right-click Product Family and select Expand Members from the context menu. 5. For the % CGP measure. locate and edit the Foodmart Crosstab report. Use the scroll bars if necessary. click to change the sorting to Numeric Figure 4-10 Crosstab of Foodmart sales When you sort a crosstab. the Guerrero store state shows 54 . so you can start working with the full data set. the crosstab shows summarized values. 7. and Zacatecas to collapse them. Take a closer look. Add Product Category as a row group for more detail. In particular. In the current view: The measures show detail only for the Guerrero store. In the Customer State total column. 8.

and Steady Multi-Symptom Cold Remedy. 14. Add Product Name as the inner-most row group. Note the cold remedies that are selling well to Sinaloans but not selling at all in Jalisco: Faux Products Childrens Cold Remedy. Right-click Cold Remedies and select Keep Only. right-click Product Category and select Expand Members from the context menu. and click Keep only. “Creating Custom Fields. Figure 4-12 Jalisco disappears from the crosstab 15.1. 10. You can continue to refine the crosstab to understand why the Guerrero store is selling to customers in Sinaloa. Jalisco. Click to undo the last action. Guerrero. shift-click Faux Products Multi-Symptom Cold Remedy and Steady MultiSymptom Cold Remedy. Faux Products Multi-Symptom Cold Remedy.” on page 57. For more info see 4.Working with the Ad Hoc Editor its percent of all of Mexico. Several cold remedy brands sold mostly to Sinaloans (above 50% CGP) are selling poorly in Jalisco. Figure 4-11 Cold Remedy sales in DF. Click Faux Products Childrens Cold Remedy. that’s because these products have never been sold in Jalisco. and Zacatecas 13. focus on it first. Hygiene is removed from the crosstab. 12. The discrepancy is slightly greater in the Cold Remedies group member. 55 . Notice that Jalisco disappears. 11.4. and each of its customer states show the percent of store state.

see 4. For more information. the buttons are disabled when you save.2. When the report is run. Jalisco is restored to the crosstab. To continue further analysis. Figure 4-13 Crosstab of Cold Remedies sold in Mexico 18. In the above example. switch to 16.61) to open a new instance of the Ad Hoc Editor. and make your edit again.4. When you click the All check box. and a change takes too long.” on page 59. If you are working with the full data set. . Click Crosstab to continue data exploration or Chart to create a compelling visualization of your data. you can click the sample data. Place your cursor over and select Save the Report. or is there a supply chain problem at this location? Are other factors contributing to the discrepancy.JasperServer User Guide and (Undo All) are only available when you have made a change in the editor since saving. shift-click Faux Products Multi-Symptom Cold Remedy and Steady Multi-Symptom Cold Remedy). If the filter pane is hidden. click the Product Category total for Guerrero ($314. JasperServer retrieves all the values for the specified field and adds them to the filter. Locate the Product Name filter and click the All check box to add all the cold remedies back into the crosstab. you can locate the Product Name filter and reset it to include all product names. “Using Input Controls and Filters. remove the filter. place your cursor over and select Toggle Filter Pane to hide it. 17. Undo can be used to cancel your last action if it JasperServer takes a long time to return. . Further analysis might reveal an underlying cause: Are these brands being regularly stocked in Jalisco. For example. the values JasperServer retrieved are used to filter the report. Instead of clicking a. To ensure that all values are included in a report at run-time. Note that JasperServer does not retrieve a list of new valid values at run-time. you explored the Foodmart data set and analyzed an interesting outlier: Sinaloans are willing to bypass a closer store (in Jalisco) in order to buy a few brands of cold remedy (Faux Products Childrens Cold Remedy. b. 19. such as the age or gender of the customer? 56 .

These functions don’t take constants. percent of group. For example. create two custom fields. you could divide the Profit custom field in the previous example by the Revenue field to express each record’s margin as a percent. The Ad Hoc Editor supports three types of functions: Basic functions include addition. the Create Custom Field option appears on the context menu when you right-click a numeric field. you can create complex calculations. When you right-click and select Create Custom Field > Subtract #. 4. To use more than one function to create the field you need. nor do they support multiple fields. You could calculate the profit for each record by creating a custom field that subtracts the Cost field from the Revenue field. rounding then multiplying yields different results than multiplying then rounding. subtraction.1 Creating Custom Fields You can create new fields in a report by applying mathematical formulas to an Ad Hoc report’s existing numeric fields. You can multiply or add any number of fields. When a custom field is the basis of another field.4 Additional Features of the Ad Hoc Editor Creating Custom Fields Using Input Controls and Filters Switching Groups Sorting Tables Working with Charts Working with Crosstabs The Ad Hoc Editor offers many features that are described in the following sections: 4. or you can use them with multiple fields. such as years. Date functions can calculate the difference between two dates in a number of intervals. and rank. click Revenue first. In this case. right-click to open the context menu and create a custom field. and division. you can’t delete it until you delete the one that builds on it. Create a custom field by selecting an existing field in the list of fields or in the report area of a table report. A custom field can only include a single function. Special functions include round. 57 . right-click a numeric field and select Create Custom Field from the context menu. then Ctrl-click Cost. For ordered operations. consider a report that includes both a Cost and a Revenue field. Because custom fields can build upon one another.4. but ordered functions (subtract and divide) and date functions can only be used with two fields at a time. When working with multiple fields: You can only select basic functions and date differences. with one building on the other. You can use these functions with a constant (such as multiplying the cost by two to calculate a standard 50% markup). and seconds. the columns’ borders change color to indicate that multiple fields are selected. percent of total. to calculate profit in the example above. the order in which you select fields matters. You can always change the order of fields using the context menu’s Swap Fields option. In the list of fields. Select multiple fields using Ctrl-click. days. multiplication. For example.Working with the Ad Hoc Editor Is this an isolated incident or a growing trend? If it’s a trend. weeks. To create a custom field based on one field: 1. For example. pay special attention to the order in which you create the custom fields. for example. what common characteristics of the customers or products are involved? Are the data for hygiene products similar to the data for cold remedies? Do any of the similarities shed light on the issue? You can use the same techniques discussed in this section to analyze and explore your own data in the Ad Hoc Editor. as this may affect the results. the Ad Hoc Editor assumes you are subtracting the Cost field from the Revenue field.

Bear the following in mind when creating custom fields: To edit an existing custom field. you can add new masking options by editing configuration files. Click Swap Fields from the context menu to change the order of the fields in the formula.JasperServer User Guide 2. and functions it includes. If it is not expanded. Subtract. 3.5 are rounded to the next largest whole number. In the list of fields. the following limitations apply: The percent of column group function aren’t meaningful in charts and tables. If your custom fields return data that are significant to the third decimal place. Right-click the column and select Edit Label to enter a more compelling name. the Ad Hoc Editor supports only two decimal places. click Basic Functions. and then enter a number in the field that appears. The percent of group functions can’t be used as a group. Note that you can toggle the order of the field and function from the context menu (Edit Formula > Swap Number and Field). To create a custom field based on two date fields: 1. or enter a different value (if you are editing a basic function). Custom fields using the percent of group functions can’t be the basis of other custom fields. in which decimal values greater than 0. constants. click Basic Functions or Special Functions. When you create a custom field based on a field in the table. Subtract #. select Add #. The custom field appears in the list of fields. If you selected a basic function. The Round function uses the standard method of rounding (arithmetic rounding). 3. Depending on the type of function you want to create. right-click it and select Edit Formula from the context menu. this number is the constant to use in the formula. and click Create Custom Field from the context menu. Multiply #. A custom field’s label is determined by the fields. for example. If you selected a basic function. or Divide. or Divide #. Thus. the default label for the Profit field in the example above is Store Sales . and select Add. refer to the JasperServer Administrator Guide. 1. this is only useful in conjunction with ordered functions. The summary functions for Custom fields using the percent of group functions can't be edited. To create a custom field based on multiple numeric fields: 5. Ctrl-click two or more numeric fields. click Swap Field and Number to put the constant before the field in the formula. right-click. 3. click Date Difference. and select a interval. the function always returns 100. it appears at the bottom of the list. 2. You can only subtract or divide when exactly two fields are selected. Click Create Field. Custom fields using the percent of group functions can’t be used as filters. this is only useful in conjunction with ordered functions. the new field appears in the report area. 4. when you create it from a field in the list of fields. and click Create Custom Field from the context menu. 4. it always returns the value 100. If it is not expanded. Click Create Field. Click Create Field. The custom field appears in the list of fields. For more information. 58 . The percent of group functions are unique among the custom functions in that they calculate values based on the grouping defined in the report.Store Cost. You can only subtract dates when exactly two date fields are selected. In these contexts. right-click one of the selected fields. In the list of fields. You can then choose a different function. Ctrl-click two date fields. By default. when added to a table. Multiply. This limitation also applies to the Percent of Total function. This limitation also applies to the Percent of Total function. The percent of column group parent is meaningless in table. The custom field appears in the list of fields. 2.

1. Since this can result in a combination of input controls and filters that don’t return data. For more information about: JRXML Topics and input controls.5.” on page 67. The parameters can be mapped to input controls that allow users to select the data they want to include. “Adding Input Controls. see 4.2. see 4.5. 4. “Choosing Ad Hoc Data From a Domain. Click this icon to select new 1. for example. when a JRXML Topic includes input controls that prompt users.4. JasperServer refreshes the editor against both the filters and the input controls. the Ad Hoc report has both input controls (displayed by clicking ) and filters (displayed in the filters pane). The filters can be configured to allow users to select the data to include. some combinations of filters and input controls may result in no data being returned. First remove the custom field from the report area and then delete it from the list of available fields. . “Adding Input Controls.1 Using Input Controls In the Ad Hoc Editor.9. 59 . filters can also be defined.2. you can display the input controls defined in the Topic as visible to users.2. “Choosing Ad Hoc Data From a Domain. if you have both a standard filter (set against a Country field) and a complex filter (set against both Country and State).” on page 67.” on page 90. Within the Domain design. If your results are empty but don’t understand why. click > Toggle Filter Pane (if it is hidden) and click You may find a combination that explains an empty result set.2 Using Input Controls and Filters JRXML Topics and Domains use different mechanisms for narrowing down the data they return: JRXML Topics can contain parametrized queries.4. Domain Topic filters. Click . you can also define filters regardless of whether you are working with a Domain or Topic. You can accept the queries’ default values or enter other values. Domains (and Domain Topics) can be filtered by selecting fields in the Domain and specifying comparison values. see 5. In the Ad Hoc Editor. see 5. 4. and you also create filters. To edit the values for a report’s input controls: as active. For more information about: JRXML Topics and input controls. Nevertheless. For example. The Ad Hoc Editor indicates that the report has input controls by displaying values or to save values as the new defaults for this report. they're never displayed in the editor or when the report is run.1. Input controls and filters interact seamlessly. Domain Topic filters.Working with the Ad Hoc Editor You can’t delete a custom field that is used in the report area.9.” on page 90.

2 Using Filters Filters can be defined at three levels: In the Domain Design. select the Set these values as defaults when saving report option. 5. To ensure that all values appear in the report whenever it is edited or run. 2. the filter maybe multi-select.2. Click to display them once more. In the Ad Hoc Editor (even when the report is based on a JRXML Topic). 4. “Using Input Controls and Filters. Figure 4-14 Input Controls in the Ad Hoc Editor 2. 3. 4. it appears when you create a new filter. The data that appears is determined by the new values. 60 . Instead. Note that the All check box doesn’t guarantee that all values will be selected every time the report is run. For more information. Right-click a field in the list of available fields and click Create Filter.” on page 59. you must rightclick the field in the list of those available. Click the All check box to select all values currently available in the data set. If appropriate. the selected values are made the default values when you save the report. Depending on the datatype of the filed you selected. or from columns in tables. 3. 4. If you do not select the option. remove the filter entirely. or text input. You can also create a filter from groups in tables and crosstabs. 6.4. If the filter pane was hidden. to hide the filter’s details.4. Select new values. see 4.2. the previous default values are used. To create a filter: 1. A new filter appears in the filter pane. On the Chart tab. When creating a report from a Domain (in the Choose Ad Hoc Data wizard). Click Click Click to expand the filter and change the filter’s operator. Click OK. 7. Use the fields in the filter to change its value. single-select. the check box is a shortcut to help you quickly select all the values currently available in the data set. The report appears. When this option is selected.JasperServer User Guide A window listing the current values for the input controls appears. to remove the filter.

Note that if you only change the the operator in a single-select filter. allowing them to run the unfiltered report. You can also click the current value to force the editor to update your view Filters are also created when you right-click a group member in a crosstab and select Keep Only or Exclude. 2. When a report is run. press Enter or Tab to apply the new values. click the input control. However. Filters defined in the domain design are always hidden in the editor and when the report is run.” on page 90. as they can be hidden from end users.4.3 Switching Groups icon lets you change how the groups are displayed. see 5. Depending on the type of report you are In the Ad Hoc Editor. For more information.” on page 52. To the right of the new filter. see 4. Note that users can still remove the filter while in the editor. JasperServer doesn't apply the filter automatically. JasperServer uses the new value to determine the data to display. For more information. To determine whether an input control is displayed: 1. For more information. and click the Visible check box to change whether the input control appears. see 4. “Focusing on Specific Data.4. To determine whether a filter defined in the Choose Ad Hoc Data wizard is editable: 1. a complex filter can’t be edited but it can be removed. and skip step 6 in section 4.2. You can’t change whether a Choose Ad Hoc Data wizard filter is displayed once the report is created. create a filter and click OK. Such filters can be helpful in improving the report's initial performance by reducing the amount of data the report returns by default. “Adding Input Controls.2. Note that they can still remove the filter. The filter pane does not automatically open in this case. if your aim is to disallow users from seeing the full data set.4. 4. “Exploring and Analyzing Data in the Ad Hoc Editor. Filters created in the editor are always available in the editor and when the report is run. and on the Filters tab. Note that similar complex filters also appear in the Ad Hoc Editor if a Choose Ad Hoc Data wizard filter was created and set to not prompt for values. click to view them. Filters that aren't set to prompt are displayed in the editor but hidden when the report is run.3 Input Controls and Filters Availability Input controls and filters can appear in both the editor and when the report is run: Input controls can be set to be hidden or displayed: Input controls set to prompt are always displayed in the editor and when the report is run. Edit the Topic and. the filter that appears may be created as a complex filter.” on page 50.3. Filters created in the Choose Data Wizard can be set to be hidden or displayed: Filters set to prompt are always displayed in the editor and when the report is run. Input controls in a JRXML Topic or filters defined in the Domain design can also be used. the viewing.2. users are prompted to select a value when they create a report against the Topic.3. Input controls that aren't set to prompt are always hidden in the editor and when the report is run. You can learn more about how filters and input controls interact in the editor by walking through the data exploration tutorial with the filter pane open. If you don’t provide a default value for the input control. if they aren't displayed directly on the report page.” on page 61.3. Click Next. When you create a filter against an inner group.2. 4. Create a new report against a Domain. user data-level security instead. “Input Controls and Filters Availability.Working with the Ad Hoc Editor When you change a filter. any input controls or filters that are set to prompt are available. allowing them to see all the data unfiltered. on the Controls and Resources page.9. the behavior varies: 61 . 2. Filters defined in a Domain design are always hidden in the editor and when the report is run. click the Prompt? box to remove the check if you don’t want users to edit this filter’s value in the editor.

This option is only available for tables that have a column group. the Sorting window appears and you can define the sorting as above.6. When sorting a table: You can click a field in the list of fields and select Use for Sorting from the context menu. you can sort the rows of a table by one or more fields. The Sorting window appears. the window shows the fields that are used. a table or chart is grouped by the column group. the table is sorted by a field that isn’t in the table. for more information see Figure 4-14 on page 65. the Table tab displays the first group in the set (the outermost group). you could create a bar chart that showed your sales by region. the report must have been edited on the Crosstab tab to add a column group. Select one or more fields to sort by. For more information. click Add Fields. 4. Put another way. you only have a row group defined. By default.4. Press Ctrl and click to select multiple fields. click the icon next to a measure’s label. Down. 3. and click OK. . In tables.JasperServer User Guide In crosstabs. The Fields window appears with a list of available fields. The Sorting window reappears with your selected fields. 4. For example. select it and click Click OK. When you design a table or chart and then view the Crosstab tab. To sort a crosstab. “Working with Crosstabs.” on page 65. Otherwise. To remove a field. When multiple row or column groups are defined. Create the table or chart with the most important grouping field. JasperServer displays the alternate group. JasperServer displays the alternate group. This comparison can help you identify trends and outliers in your data. In this case. If the table is already sorted. Click . the Chart tab displays the outermost group. To add a field. The table updates to display the rows sorted by your selected fields. switch the groups to display the sales data grouped by Client Industry. To sort a table: 1. Click Table or Chart to return to your initial view. Top. By switching to the Crosstab tab. click to group it by the row group.4 Sorting Tables In the Ad Hoc Editor. or Bottom icon. then click Crosstab to add another compelling field as the column group. To arrange the sorting precedence of the fields. there is no alternate group to switch to. see 4. 5. JasperServer moves the row groups to column groups and vice versa. Back in the Chart tab. right-click the column and select Change Sorting from the context menu. This option is only available for charts that have a column group. 2. This action is also referred to as pivoting. If a column is already being used and you want to stop using it or change the sorting. You can also sort crosstabs. and then click to display the alternate group. you may want to note the sorting fields in the title. In either case. for this feature to be available for tables and charts. This option is only available for crosstabs that have both a column group and a row group. you could add Client Industry as the column group. In charts. 62 . the field you select is now available as an alternate group in the table and chart.4. When multiple row or column groups are defined. It only lists fields that are not already used. select each field in the Sorting window and click the Up. 6. Drag a field into the column group to complete the crosstab.

Horizontal Bars or Vertical Bars.2 Designing Charts Charts have different layout and format options than table or crosstabs. in a bar chart.5. 4. Whether the background should be filled. Remove Background or Fill Background. Compares values expressed as pairs of values that determine the position of a point on the chart.Working with the Ad Hoc Editor 4.1 Working with Charts Chart Types Charts are graphical representations of your data. Whether the bars are parallel to the width or height of the chart. the Ad Hoc Editor creates a bar chart. When you create a chart. When the gradient is removed. the background is filled with a solid color. Unsummarized charts show each data point individually. Compares values based on times or dates associated with the data. Pie Chart Line Chart When creating a pie chart. The data aren’t summarized. location of points (in line charts). When creating a line chart. For example. Compares values displayed as bars.5 4.4. Compares values displayed as shaded areas. The Ad Hoc Editor can create both summarized and unsummarized charts: Summarized charts show data grouped and summarized: Bar. two dimensional appearance or a three dimensional (3D) appearance. Note that the gradient doesn’t appear when you run the report.5. Stacked or Simple Series. Whether the background color should graded or solid. Compares values displayed as points connected by lines. Whether multiple measures of each group are depicted as individual bars or as portions of a single bar. or the default. the category field determines how the bars are grouped.4. the context menu provides these options: Flat Bars or 3D Bars. They determine the length of bars. you can indicate whether to display markers at each data point and lines that join them. You can select a different type of chart at any time. Measure fields. 63 . For each type of chart. and don’t support grouping: Scatter. Bar Chart When creating a bar chart. you can: Remove Gradient or Apply Gradient. Whether to use a flat. and height of areas. Note: A series chart displays multiple measures for each group value. Time Series. Line. you generally indicate how to arrange the data by specifying: A group field. which is three dimensional (3D Pie). Measures are the other data in your chart. each data point is mapped individually. Note that time series and scatter charts don't support grouping. in a pie chart it determines what each slice represents.4. the context menu provides these display options: Type All Chart Types Description Regardless of the type of report. Keep these points in mind: By default. instead. Compares values displayed as slices of a circular graph. you can indicate whether to use a Flat Pie (which is two dimensional). since pie charts can only show a single measure. Area. a chart’s group field determines how data are categorized. size of pie slices. Pie. Select Hide Lines or Hide Points to remove the indicators from the chart. The Ad Hoc Editor automatically hides all but the first measure if you change to a pie chart. Similar to the table's grouping option.

the Ad Hoc Editor displays a simple placeholder with the legend displaying a single entry: No Data. refer to the JasperServer Administrator Guide. giving your chart more horizontal and vertical room. When creating a time series chart. when you add a group to a pie chart. Click Hide Lines to remove the lines that join the data points. By default. Note that there is no for adding fields. When you place your cursor over and click A4 Size or Letter Size from the menu. It plots paired values against one another. one field must be a date or date/time. drag it to the group target to the left of the report area. If you change the summary function back. and you can save or run the report. the page is set to Actual Size. such as Purchase Date. one on top of another. If space is at a premium in your chart. you can indicate whether to display markers at each data point and lines that join them. area charts emphasize quantities rather than trends. Click Show Points to add a marker at each data point. As compared to line charts. Once you have added at least one group and one measure. To add a field as a group. drag it into the report area or right-click it in the list of fields and select an option from the context menu. the Ad Hoc Editor snaps the chart back to the maximum allowable size in either dimension (height or width). and the other must be numeric. This option is also available on the chart context menu. the pie displays the correct number of pie slices. One variable determines the horizontal position and the other determines the vertical position. If you resize the chart to be larger. A scatter chart uses Cartesian coordinates to display values as points whose locations are determined by two variables you select. the resize arrow appears. Note that when you strip the margins of a chart set to the Actual Size page size. When you place your cursor over the right-hand or bottom edge of the chart. If you add a field to the horizontal axis that has a datatype other than a date/time. the mock-up changes to reflect the data in the chart. For more information about portal integration. the Y-axis units and values show the range of values in the measure you selected. The Ad Hoc Editor removes the margins. Unsummarized charts (scatter and time series) can only be run or saved if the fields selected for the X and Y axis are appropriate: For scatter charts. or forecast future results. for example. For example. In a time series chart. If you change the measure’s summary function. Time series charts plot your data against the passage of time. the mock-up is replaced by the chart. Scatter When creating a scatter chart. The text you enter replaces the field’s name. the Ad Hoc Editor renders the chart as best it can. you can indicate whether the groups should be displayed as transparent overlays or as solid areas. such as Liferay. the last name entered for that measure with that summary function appears. both fields must be numeric. Select Stacked Series to display the groups as solid areas arranged vertically. the change isn’t reflected in the Ad Hoc Editor. the label updates to reflect the change. Fields can be added as groups or measures. Click Hide Points to remove the marker at each data point. but the result is likely to be meaningless. place the cursor over and click Strip Margins. you can indicate whether to display markers at each data point and lines that join them. As you add groups and measures. You can increase a chart’s size to improve its legibility or you can decrease its size if it’s intended for use in a JasperServer dashboard or JSR-168 compliant portal. Click Show Lines to add lines that join the data points. identify trends. You can rename the measures displayed in your chart by right-clicking the measure’s label in the legend and selecting Change Legend Label from the menu that appears. 64 . the Ad Hoc Editor limits the size of the chart to the selected page size. Time Series Before any fields are added to the chart. which resizes the page to fit your chart’s dimensions. and you can add fields more than once. To add a field as a measure. You can see the change by setting the page size to Letter or A4. They can help you understand the nature and underlying context of your data. the horizontal axis must represent a date or time field.JasperServer User Guide Type Area Chart Description When creating an area chart. For time series charts. you can add a field as both a measure and a group. when you add a measure to a bar chart. or if you want to use it in a portal. select Simple Series to display groups as transparent overlays. click and drag the edge of the chart to increase or decrease its size.

click . you can also right-click a heading and select a Move option from the context menu or press the cursor keys. To add a field. 4. and specify whether to display the legend (generally. you can drop it in the legend in the desired location. drag it into the crosstab or right-click it in the list of fields and select an option from the context menu. and format options than tables or charts. layout. The Measures menu also allows you to change the summary function and data format. In bar. In the chart context menu. If the chart displays multiple measures. You can also right-click a different field in the list of fields. Remove a chart’s group by right-clicking the chart and selecting Remove Group from the context menu.4. this prevents invalid crosstab layouts in which there is nothing to display for some totals if the the summary has been deleted previously. the measures change color as they are reordered. line. For more information. The new measure appears in the correct location in the chart. To make the ranges of values more similar. and measures. You can pivot a crosstab in two ways: Pivot the entire crosstab. Pivot a single group: To pivot a single row group. Consider the case where you are comparing the number of items sold (values ranging from 0-50) and the total sales revenue for each product (values ranging from 0-50. rightclick the chart and select Remove Measure. Right-click a measure in the legend to change its label.3.” on page 61.6 Working with Crosstabs Crosstabs have different data. The measures are listed in the order they appear within your groups. the order of colors is not.000). you can change the order of measures by dragging the legend entry right or left. Rearranging the groups may change the preview data in the editor. On the chart context menu. Drag the group headings to rearrange the hierarchy. To add a field in a specific position in a chart. This reorders the measures in each group. While the order of measures is changed. it is the list of groups). When the crosstab includes more than one row group or more than one column group. click the arrow in each heading cell to expand the inner group. This can be helpful improving a chart’s legibility and visual appeal. 65 . you could create a custom field that divided the revenue measure by 1000.Working with the Ad Hoc Editor You can hide legends and labels to allow the chart more space. the context menu lists them under the Measures menu option. To edit a measure. you can add a field as both a measure and row group. or you can show them to make the chart easier to understand. for example. Keep these points in mind: Fields can be added as row groups. and you can add fields more than once. The row and column groups switch places. right-click it and select Switch To Column Group. Adding this measure in place of the actual revenue measure yields a chart in which the two measures are depicted in closer scale. and click Replace Group. The new chart is both easier to read and more appealing. column groups. create a custom field that multiplies or divides one of the measures. refer to 4. It is available from the chart context menu as well as from the legend. When working with a chart that displays two measures with very different ranges of values. Thus. the chart may be difficult to read or understand. Row and column groups are arranged in hierarchies. If the chart only displays a single measure. click Measures > [Measure Name] > Remove Measure (where [Measure Name] is the name of the measure you want to remove). To pivot a single row group. Note that there is no for adding fields. or simply drag the new group field and drop it on the group control. for pie. Remove measures from the chart using the legend or chart context menu. the group title (which identifies the name of the group field). Jaspersoft recommends that you note such changes in the legend label or title.4. Click the arrow again to collapse the inner group once more. right-click it and select Switch To Row Group. right-click its label. When you collapse a group. or measure titles (which identifies the measures). click Legends and Labels. its summary is automatically displayed. Measure labels are displayed to the left of the first column group. the list of measures in the chart. “Switching Groups. and area charts that display multiple measures.

if there are 3 widgets of type A and 3 widgets of type B. The icon changes to order is reversed. The Expand Members and Collapse Members options are only available for outer-most groups or inner groups nested in an expanded outer group. right-click the group label and select Expand Members. This new instance of the editor is completely independent of the original crosstab: you can change it and save it without changing the crosstab. see 4. Hover your cursor over a measure value or total and notice the underline that indicates a hyperlink. and filtering. By default. the editor only displays a smaller.4. Note that you can select multiple row groups or multiple column groups. For instance. You can add any number of measures. When the crosstab includes more than one row group or more than one column group. You can sort it by any of its measures: Click to change the sort order from the default. Average. and the crosstab is once again alphabetically sorted When you sort by a measure. This means that you can see the totals for the group. Note that this option is only available for the outermost group on either axis (that is. Minimum. Exclude to remove this group from the crosstab. see 4. For more information on drill-through. Its columns are created from the fields used as measures in the crosstab. When a group’s members are expanded. Click to return to the default sort order. Distinct Count. right-click a group member and select: Keep Only to remove all groups except the selected one from the crosstab. Only one measure can be used for sorting at any one time. row and column sizes are fixed and no spacer is available. right-click any heading in the group and select Delete Row Summary or Delete Column Summary from the context menu. and Count All.3. you can also right-click a measure label and select a Move option from the context menu. select Collapse Members from the same menu to hide the measures. by default.” on page 59. Distinct Count is 2 and Count All is 6. and Percent of Row Group Parent). All row and column groups are summarized automatically: To turn off a group summary. Sum. To rearrange the measures. drag them in the measure label area. the entire crosstab is reordered: both columns and rows reflect are re-sorted within each group. and the crosstab is sorted in ascending and the crosstab’s sort Click to switch the numeric order from ascending to descending. Click the hyperlink to open the Table tab of the Ad Hoc Editor in a new window or tab (depending on your browser and its settings). right-click the measure label and select from the context menu. The icon changes to numeric order by its measure values. Percent of Column Group Parent. The icon changes to by its group names. either the outermost row group or the outermost column group). the editor displays each row and column group in a collapsed state. 66 . or press the up and down arrow keys on your keyboard. sample set of the data in your crosstab. All the measures appear together in every cell. for more information on filtering. Note that you can’t change the summary function on custom fields that calculate percents (Percent of Total. To select the summary function and data format for a measure. On the Crosstab tab. Use Ctrl-click and Shift-click to select multiple groups to keep or exclude. “Exploring and Analyzing Data in the Ad Hoc Editor. “Using Input Controls and Filters. a crosstab is sorted in alphabetical ascending order according to its group member names. drill to details.JasperServer User Guide You can use the slice menu to keep or exclude group members in a crosstab.” on page 50. Many of the layout and formatting options set manually in tables are set automatically in crosstabs. Compare slice to drill-through. In particular. To see measures for a group’s members. Collapsing an outer group also collapses its inner groups. On the Crosstab tab. by default. but not the measures for its individual members. Count All is the total number of items. To slice. For more information on working with crosstabs. Measures are arranged in cells. you can't slice by both row groups and column groups at once. see the JasperAnalysis User Guide. This new table is filtered to only show rows that were rolled up to create the hyperlinked value you selected. Distinct Count is the number of different items in the row or column. Click to view the full set of data.2. The summary functions for numeric fields are Maximum. the inner groups are also sorted according to your selection.

“Example of Creating a Domain.5 Creating a Report from a Domain Like Topics. the Choose Ad Hoc Data wizard leads you through the steps of choosing fields and filters. click Table. if a Domain includes all sales data for a company.5. Figure 4-15 Topics and Domains Window With the Simple Domain Selected 3. The Ad Hoc Editor opens to the Topics and Domains window. The frame at the bottom shows you the description of the Domain currently selected in the list.2. Click the Domains tab.1 Choosing Ad Hoc Data From a Domain When you create an Ad Hoc report based on a Domain. 2. a report based on that Domain could present detailed information grouped by postal code and have an input control to let the reader select the geographic area. Domains also allow you create reports that prompt the reader for input that determines what data is presented. such as a US state. and click Choose Data. see section 6. For complete information on all of the options and settings available for designing reports. The tab opens with a list of the available Domains. Select the Simple Domain for your report. Domains are created by data analysts and JasperServer administrators for use by others to access data more conveniently. To create a basic report from a Domain: 1. The Choose Ad Hoc Data wizard opens to the Data page. On the Home page.2.” on page 71. For a more complete description of how to create Domains. 67 . “Using the Choose Ad Hoc Data Wizard.5. Domains differ in that they give more flexibility in choosing fields from the database and allow some filtering of the data before it is included in a report.” on page 117. For report makers. 4. The following example shows how to use the wizard to create a simple report from a Domain.Working with the Ad Hoc Editor 4. see 4. click Create > Ad Hoc Report. For example.

you see only sets and items for which you have permission. so a set is duplicated in the list of selected list if any of its fields are moved. the fields that you can see might include ones that other users can’t see. The Choose Ad Hoc Data wizard shows the Filters page. In this example. If a Domain is configured for secure access. but then drag back the Sales Stage field Users set: First Name and Last Name fields Fields always appear within their set. select the fields that appear in the Ad Hoc Editor. A set appears in the Ad Hoc Editor as a set of fields that can be added together to a table. 4. Conversely. 68 . You can select whole sets or individual items within a set. Figure 4-17 Selecting Item Sets 5.JasperServer User Guide Figure 4-16 Choose Ad Hoc Data Wizard: Data Page On the Data page. expand each set and drag the following fields into the Selected items list: Accounts set: Account Name field Opportunities set: Drag the whole set. Other items might not be visible to you. even though another user can see them if he used the same Domain. Click Next. you can set limits on the data that are retrieved and displayed in your table.

you can edit the table and field names that will appear in the Ad Hoc Editor so that they are more appropriate for the report’s audience. Click Next. 10. double-click the Amount item and change its display name to Opportunity Amount. The names in the Domain are often appropriate as is. For this example. 8. 7. For this example. the values that you can see might include ones that another user can’t see. In the Condition Editor’s Comparison drop-down. the filter selects only the rows of data where the opportunity amount has a value of 10. select Amount by clicking its arrow icon The item appears in the Condition Editor. enter the value to compare the data against: 10000.000 or more. select the operator for the comparison: is Greater than or Equal to. . In this example. Click OK. Other values might not be visible to you.Working with the Ad Hoc Editor Figure 4-18 Defining a Filter on an Item 6. 11. If a Domain is configured for secure access. 69 . The Choose Ad Hoc Data wizard shows to the Display page. 9. even though other users see them if he used the same Domain. but this Display page gives you a final opportunity to change them. the values displayed in the condition editor are the ones for which you have permission. On the Display page. Conversely. In the Values field. The complete filter condition appears in the Current Conditions list.

you can save them as a Domain Topic. 70 .” on page 73. “Selecting the Content of a Report. 13. as described in section 4. as described in section 4. In this example: c. “Creating Topics from Domains.2.JasperServer User Guide Figure 4-19 Changing the Display Name of an Item Note that the display names are shown on the left side of the page. 12.” on page 48. Expand the Users set and click the arrow next to the Last Name field. click Open Report. Notice that all amounts are greater than 10000.5. and the list of fields shows the item sets selected in step 4. e.” on page 45 and 4. Figure 4-20 Ad Hoc Editor with Fields Configured for Report As shown in this example.2. Drag the Opportunities set to the report area to add all its fields as columns. f. If you want to create different reports with the same settings. creating an Ad Hoc report based on a Domain gives you more flexibility in selecting data and can subsequently speed up the design of the report itself.1.3. They are added (with the display name) in the order you defined on the Display page in step 4. as determined by the filter you defined. Design your report in the Ad Hoc Editor. The Ad Hoc Editor appears. To confirm all the selections made in the Choose Ad Hoc Data wizard and begin creating a report. 14.2. “Formatting the Appearance of a Table. Expand the Accounts set and drag the Account Name item to the grouping icon. d. Click the arrow next to the Spacer item.

The Filters Page – Define a filter on any field. as shown in Figure 4-17 on page 68.5. You can define filters to limit data that appears in a report and to define whether a report should prompt users for input on a given filter. 16. When you select a field from one set. as filters. Choose the operator and operand for comparison. 4. Note that you can only select tables in the join tree chosen when you created the report originally. You must first select some fields on the Data page. They are similar to input controls. The tables on the right are those that were selected when the report was created. fields that are used in the report area. all the its fields are removed except those that are in use. When you remove a table. The left-hand list displays the sets of fields in the Domain. or selecting it and clicking an arrow button. Expand a table to see its fields. Use the controls in the tree to close or expand each set. with the option of prompting for user input.Working with the Ad Hoc Editor 15. then click OK to define your filter. but the other three pages are optional and can be completed in any order. 17. Doing so removes all settings and updates the list of fields. or to compare fields. use the settings on the Display page. 4. Drag a table from the Available list to the Selected list to add it to the report. You can also drag individual fields to add or remove them. column. double clicking it. or for sorting appear gray to indicate that they can’t be removed from the report. For example. the ones on the left are the other tables available in the Domain.2. click select to change the fields used in the report. The list on the right-hand side shows you the items you have selected. Alternately. you can click the arrow next to the field name or double-click the field name. Select a field in the left-hand list and click Create Condition to begin defining a filter on that field. or group. Click Done at any time to begin designing your report.1 The Data Page Use this page to choose fields and sets of fields to use in your report or make available in your Domain Topic. 18. Some Domains define sets that are not joined.5.2. In top right corner of the list of available fields. the comparison operator and value operand depend on the datatype of the field and on the actual data that exist for the field.2 The Filters Page The Filters page provides powerful functionality for designing reports within JasperServer. you can filter data to select a single country. The filter is still applied and only data that satisfies all defined filters will appear in the final report. in which case it doesn’t make sense for the Country field to appear as a row. If you do not want sets.2 Using the Choose Ad Hoc Data Wizard This section gives more detail about the four pages of the Choose Ad Hoc Data wizard: The Data Page – Choose the fields to make available in the Ad Hoc Editor. it appears in a set of the same name. the unjoined sets aren’t available. The Display Page – Change the order and names of fields that will appear in the Ad Hoc Editor. displaying two lists of tables. If you add or remove a field accidentally. click to undo the change. 71 . The Change Field Selection window appears.5. You can change Domains on the drop-down list above. You can define a filter on a field that you do not plan to use in the report. If you move an individual field out of a set. You can move a field or set back and forth between the lists by dragging the item. In the Condition Editor. Drag a table from the Selected list to the Available list to remove it from the report. 4. The Topic Page – Save your settings as a Domain Topic.

” on page 59. double-click the available values to select them. The note at the bottom of the current conditions reminds you that data rows much match all conditions. users can click to enter a comparison value for this condition. For example. When the Prompt? check box is checked. The list of Current Conditions shows all the filters you have defined. thereby speeding up report creation. use the search controls to the left and click to narrow your list of available values. See Figure 4-19. Once defined.2. For details. to the top or bottom. “Changing the Display Name of an Item. If there are more than 50 values to display.5. but the country is chosen by the user. double-click anywhere in the row and type the new name in the text box. For multiple value matching. To define a filter that compares two fields of the same datatype. After you click OK. click once anywhere in a row and use the arrow buttons to move it up.” When you select a whole string matching operator. the dialog displays a list of all existing values for the chosen field retrieved in real-time from your database. A field name becomes the label for the row. The maximum number of items that can be displayed in the list of values in the Condition Editor is configurable. filter prompts can be modified in the Ad Hoc Editor. The value defined here is the default. On the report page.JasperServer User Guide Figure 4-21 Condition Editor on the Filters Page Text fields have both substring comparison operators such as “starts with” or “contains” and whole string matching such as “equals” or “is one of. but sets as a whole may be also be moved. down. Click OK to save your changes. 72 . the final report might present data for a single country.4. In other words.3 The Display Page Use the Display page to change the default name and order of the fields as they should appear in the list of fields in the Ad Hoc Editor. Click a row in the list of Current Conditions to make it editable again in the Condition Editor. “Using Input Controls. The condition is available as a prompt even if the filtered field does not appear in the report. Fields may be moved only within their set. when the user clicks Apply or OK. You can perform multiple searches and select values from each list of results. 4. Note that when the is Prompt? check box isn’t checked. they can’t edit it. To change the display name of a field or set. Sets are not used in reports but can be used to add all their fields at once. or measure that you create from the given field. You can always change the field labels and ordering in the Ad Hoc Editor. This button is only enabled when two compatible fields are selected. but users can only remove it. such a filter is hidden when the report is run. the selected filter is available to end users when they run the report. then click Create Condition. select the second field using Ctrl-click.2. To change the order of fields. but setting them here will make them available for reuse in a Domain Topic.1. see the JasperServer Administrator Guide. you can edit and delete it as with other conditions. the overall filter applied to your data is the logical AND of all conditions you have defined. column. Sets and the fields they contain appears in the list of fields in the Ad Hoc Editor. the condition is still available in the Ad Hoc Editor. you can also click Delete Condition to remove it from the list. Not that such filters can’t be presented to your users when they run the report. as explained in 4.” on page 70. the report preview refreshes with data that match the condition. After selecting a row.

Once you save a report. “Editing a Domain.Working with the Ad Hoc Editor If you don’t want to use sets in the Ad Hoc Editor. such as derived fields and different joins to make new fields available in a report. 73 . your field selections appear in the Ad Hoc Editor and you can create reports from them. filters. They appear on the Topics tab when you start a report. but the settings themselves are not saved.3. or make very similar reports in the Ad Hoc Editor. In other circumstances. This corresponds to the Ad Hoc Components > Topics location in the repository. You can now rename the fields and move them in any order. users can run it repeatedly and be prompted for input each time if you defined filters with prompts. Explanation When you click Done.5. The description text is associated with the Domain Topic in the repository. You can also edit the Domain Topic to change any of the settings you made in the Choose Ad Hoc Data wizard.” on page 74. Click Open Report after defining your settings in the Choose Ad Hoc Data wizard. “Editing a Domain Topic.2.5. and display names you have defined. The main consideration is how reports based on the Domain will be used. and display settings on this Domain to create new reports with different formatting.2.” on page 75. For more information. then format and run your report.” on page 48. Domains provide advanced functionality such as table joins and derived fields based directly on a data source. filter. save your settings as a Domain Topic on the Topic page of the Choose Ad Hoc Data wizard. see section 6.2. select the check box Show items as simple list in designer above the table of display names. you can give your settings a name and a description to be saved as a Domain Topic. Domain Topics can be edited as described in section 4.5. you can create different reports from this Domain Topic. After you save your changes. “Saving Domain Settings as a Topic. Then do this Click Open Report after defining your settings in the Choose Ad Hoc Data wizard. it is important to create a Topic based on the Domain and data settings you chose. JRXML Topics and Domain Topics in this folder appear on the Topics tab when you start a report. Edit the Domain and save it with a new name. It is displayed at the bottom of the Topics tab and when browsing the repository. Find your Domain Topic in the repository and open it in the Edit Domain Topic dialog. save your settings as a Domain Topic. Domains usually require administrator permissions to create and modify. Before you click Open Report. Then start a new report and choose your data from the new Domain. Start a new report and choose your Domain Topic from the Topics tab. By default.3. 4. Be able to modify one or more of the settings you made in the Choose Ad Hoc Data wizard. it is saved when you click Create Report from any page in the wizard. you can create reports based on the modified Domain Topic. After you enter a name for your Domain Topic. 4. See section 4.3 Creating Topics from Domains In some circumstances. Run reports from the same repository data source but with different Domain settings. Before you click Open Report.3.” on page 135. Thereafter. Domain Topics are saved in JRXML format in the repository. Users with permissions may also open it again in the Ad Hoc Editor. “Formatting the Appearance of a Table. If you want to … Create a single-use report from the Domain with your settings. then format and save the report in the Ad Hoc Editor.5. Enter an informative description that helps users identify this Domain Topic.5. using all the same fields. Domain Topics are saved in the standard Topics folder.2. See section 4.4 The Topic Page On the Topic page. Do not modify this folder name. Run a report repeatedly as is or with prompting for new input. Reuse your field. The following table explains your choices. creating a Topic isn’t necessary.

Anita can access fields C-E and data rows 25. they see those of your fields to which they have access and the data in those fields that they can access. they see different combinations of fields and the data in them. Tomas uses the Choose Ad Hoc Data wizard and saves a Domain Topic based on the Domain. You might not have access to all of the fields in the Domain nor to all the data in those fields. Enter a Topic name and description. user Tomas can access fields B-C and data rows 1-3. There may be fields that can be seen only by other users. so when she opens or runs the report. it is important to consider everyone’s access permissions.3.JasperServer User Guide 4.4. Even though Anita has permission to see more fields. Fields Tomas’s report from his Domain Topic Anita’s reports from the same Domain Topic BC C Data 123 2345 See section 7. When Tomas and Anita run reports. navigate to the Topic page. they are not available to her because Tomas did not have access to them when he created the Domain Topic. Anita does have permission to see more data than Tomas. Do not change the location folder.2 Saving Domain Settings as a Topic To save your settings in the Choose Ad Hoc Data wizard as a Domain Topic: 1.5. The default /adhoc/topics folder makes the saved Domain Topic available on the Topics tab when you select Create > Ad Hoc Report. When others run reports from the Topic. only the fields that you selected appear in the Domain Topic.5.3. When you save your Domain as a Topic. While making selections in the Choose Ad Hoc Data wizard. the field she does see has more rows than when Tomas views the report. and in the fields that you can see. only the data that you can access in those fields appears. “Editing a Domain. “The Domain Security File. See the note in section 6. in a Domain.” on page 155 for a technical explanation of data security for Domains.5.1 Access Permissions in Domain Topics If other users run reports from your Domain Topic and the Domain is configured for security. 4.” on page 135 about the impact of editing a Domain or Domain Topic. When you run a report from the Topic. However. 2. there may be data that is hidden from you. For example. 74 .

If your data selections. and the Domain Topic is created when you subsequently click Done anywhere in the Choose Ad Hoc Data wizard.5. navigate to the other pages to finish making your settings. You can also change the name and description by returning to this Topic page anytime before clicking Done in the wizard. Your Domain Topic name and description are preserved.Working with the Ad Hoc Editor Figure 4-22 Entering Information Needed for Saving a Domain Topic 3. it appears when the Search page is filtered to show reports: Figure 4-23 Choose Ad Hoc Data Settings Saved as a Domain Topic 4. While its repository type is Domain Topic.3 Editing a Domain Topic Editing a Domain Topic modifies the settings that were defined in the Choose Ad Hoc Data wizard when creating it. click Done. filter definitions. and display settings are complete as well. 75 . Otherwise. The new Topic appears in the Ad Hoc Components > Topics folder.3.

. by default. 76 .3. Figure 4-24 Modifying the Sample Domain Topic in the Edit Domain Topic Wizard 3.JasperServer User Guide To edit the settings in a Domain Topic: 1. the list of Topics on the Topics tab is populated from that location. The Domain Topic opens in the Edit Domain Topic wizard.2. To upload a Topic: 1. Domain Topics are usually kept in the Ad Hoc Components > Topics folder. Typically. “Using the Choose Ad Hoc Data Wizard. then click Done.” on page 71 to edit the Domain Topic as needed. Locate the folder where Topics are stored. The location of the Topics folder depends on your system configuration. Right-click the Topics folder and select Add Resource > JasperServer Report from the context menu. Select View > Repository and search or browse for the Domain Topic you want to modify.” on page 73. To save your changes to the selected Domain Topic. Log in to JasperServer as an administrator and select View > Repository. when associated with a data source in JasperServer. 2. Use caution when editing Domain Topics that may have been used to create reports.5. Topics are in the Ad Hoc Components > Topics folder. Domain Topics are a type of Topic created in JasperServer from a Domain.. In the Select a Domain drop-down menu on the Data page. you can choose a different Domain for the Topic. 4. Right-click the Domain Topic and select Open in Designer. for more information see section 4. Users who relied on the Domain Topic might receive unexpected data or errors. click Save on any page. navigate to the Topic page and enter identifying information for the new Topic. from the context menu. a Topic is an empty report. all the selections that you made with the current Domain are lost when you click Choose Data. When a user clicks Create > Ad Hoc Report on the Home page. It is safer to save your changes as a new Domain Topic. “Creating Topics from Domains. can be used as a Topic in the Ad Hoc Editor. Follow the guidelines in section 4.6 Uploading a Topic Topics can be created by uploading JRXML files to the proper location in the repository. which has the same features as the Choose Ad Hoc Data wizard. 3. Regular Topics are created by administrators using iReport. To save your changes as a new Domain Topic. 4. that.5. If you select a different Domain. 2.

The Topic appears in the repository. 6.Working with the Ad Hoc Editor Figure 4-25 Topics Folder on the Search page The Report Wizard appears. but it is possible to define them. See 5.10. Click Finish. If you select it. this JRXML code declares a StoreState field that will be displayed in reports as Store State: <field name="StoreState" class="java. On the Locate Data Source page. When you select Create > Ad Hoc Report. The Description field helps users know what the file is. When you create a JRXML file that will be used as a Topic. If your Topic has a parametrized query.jrxml. Topics must be associated with the data source that they were designed for. 7. On the Resources List page. 9. you can create input controls for it. click Browse to upload the topic from the file system. “Localizing JRXML Reports. starting with the Naming page. such as example_topic. In this example.2. see 5. On the Main JRXML page. Such input controls can appear in the Ad Hoc Editor and when the report is run. you can create a report based on the database columns it contains and the data source selected in step 7. then click Next. define a field property named adhoc. 5.String"> <property name="adhoc. you can specify the name to display for each field that the Topic returns. The Name field is the internal ID of the object. The Label field is the visible name of the file in the repository. “Completing the Complex Report Example. When the upload is finished. there are no resources associated with this Topic. 77 . Because this is a simple Topic without parameters. click Next. the Example Topic appears on the Topics tab.” on page 99. To do so. Topics usually do not need a query or customization.” on page 101.12. Give the Topic a name. a label. click Save to create the Topic in the repository. click Next again. 8. and an optional description.display for each field declared in the JRXML. The adhoc. then select the data source named datasources/JServerJdbcDS from the drop-down list.display field property should have the following syntax: <property name="adhoc. such as Topic uploaded for User Guide example.display" value="Store State"/> </field> Topics also support the $R expressions for field names. for more information.display" value="Any Name"/> For example.lang. select the radio button next to From the Repository. such as Example Topic.2. 4. On the Validate page. the file is <js-install>/samples/adhoc/topics/adhoc_sample.

the editor starts but it displays a warning message about the number of rows being returned. the query and the report are cancelled. For JDBC-based reports. and aggregate data returned by queries based on Domains when this is feasible. sort. 78 . instead. When an Ad Hoc report with complicated queries runs. JasperServer processes the data in memory by default. you might be able to reduce the number of rows by changing the filter values. refer to the JasperServer Administrator Guide. When the Ad Hoc Editor starts. JasperServer limits the number of rows that it fetches: If the row limit is reached when starting the Ad Hoc Editor. For details. If any one query reaches the time limit before returning data. non-JDBC data sources. It also limits the data it retrieves to the fields that appear in the report. the report stops and a message about the row limit appears. JasperServer relies on the database to group. For more information. Row Limit. 4. If a filter is in effect.1 Limits on Queries There is a limit on the number of rows that a report run from the Ad Hoc Editor can contain. In all cases.2 Data Policies Data policies control whether certain processing occurs in JasperServer or in the application storing your data source. You can redefine the report so that it fetches fewer rows. change the limit. 4. These data policies are controlled on the Ad Hoc Options page. By default.7. see the JasperServer Administrator Guide. If the limit is reached when running an Ad Hoc report. it may take a long time to start returning data. There is also a limit on the length of time that a report can take to complete.7. it sends a query to the current data source to fetch data. Your system administrator can configure JasperServer to handle Domain-based and JDBC-based Ad Hoc reports differently: For Domain-based reports. Time Limit.JasperServer User Guide 4. you can also ask the system administrator to raise the limits. JasperServer can be configured to process the data in memory. and for nonDomain. changing the settings does not retroactively affect existing reports). as is done by default for Ad Hoc reports based on Domains. You can redefine the report so that the query completes more quickly. The limits are defined in configuration parameters set by the system administrator. JasperServer can be configured to push the processing down to the database. These settings apply to reports created or re-saved in the Ad Hoc Editor (that is.7 Configuring System-level Ad Hoc Options System administrators (users with ROLE_SUPERUSER) can control how JasperServer handles the data for Ad Hoc reports. For JDBC data sources. Consider factors such as the number of users and report complexity when deciding how JasperServer should process data for Ad Hoc reports based on Domains data sources.

define the report and use the iReport JasperServer plug-in to upload it.Adding Reports Directly to the Repository 5 ADDING REPORTS DIRECTLY TO THE REPOSITORY While the Ad Hoc Editor allows end-users to create reports from pre-defined Topics and Domains. as well as a discussion of using the using iReport plug-in for JasperServer. When you upload the report. along with any other resources the report needs. you can create reports outside of JasperServer and add them to the repository. You can add these reports in two ways: From within JasperServer. a wizard guides you through each step. upload a JRXML file to the repository. From iReport. This section gives both a simple and a complex example of uploading a report using JasperServer’s wizard. This chapter contains the following sections: Overview of a Report Unit Adding Report Units from JRXML Files Editing JRXML Report Units Using the JasperServer Plug-in for iReport 79 .

one for each of the different kind of element in the report unit. 5. This simple report has file resources but no input controls.JasperServer User Guide 5. The following figure shows how the various elements contribute to the report output. resource bundles.2 Adding Report Units from JRXML Files This section presents two examples. you need access to the <js-install>/samples/reports/AllAccounts. Each sub-section can be referenced individually when adding your own reports with different combinations of elements.2. the main JRXML uses the repo: syntax to refer to the other elements. fonts. the main JRXML determines the layout.jpg files on the JasperServer host. 5. and input controls and various resources contribute to the output as needed. The simple example also includes a custom query to demonstrate how a report unit can modify the JRXML report it is based upon. Each example is split into several sub-sections. You also need the sample data installed with JasperServer. one simple and one more complex. In this case. Report Data Data Source Query Input Controls Main JRXML Resources * References Data Flow Figure 5-1 Elements of a Report Unit Report Output * Images.2 Uploading the Main JRXML The first tasks when creating a report unit is to give it a name in the repository and then upload the main JRXML file that references all other elements.jrxml and the <js-install>/samples/image/logo.1 Simple Report Example To create the simple report in this example. 5. that illustrate many aspects of uploading JRXML files to create a report unit. a report unit is the collection of elements required to retrieve data and format output. The main JRXML file is the core of the report unit.2.1 Overview of a Report Unit In JasperServer. It can either define the other elements internally or refer to existing ones elsewhere in the repository. 80 . and scriptlets The data source and query retrieve data for the report.

If your report does not reference any file resources. 3. Click Next to begin specifying the components of the report. select From File System and click Browse to locate the file <js-install>samples/reports/AllAccounts. in this example new_simple_report. On the Main JRXML page. Click Next. in this example New Simple Report. “Defining the Data Source. The main JRXML file is the report you have created in another editor such as iReport. Right-click the Samples folder and select Add Resource > JasperServer Report from the context menu.Adding Reports Directly to the Repository To upload the main JRXML for the simple report example: 1. you can skip to section 5.2. Label – Display name of the report in the repository. You can either upload a new JRXML file or create a new report based on a JRXML file you have previously uploaded.2. 2. JasperServer uploads the main JRXML file. The Report Wizard opens to the Naming page: Figure 5-2 Entering the Report Properties on the Naming Page of the Report Wizard 4. Description – Optional description. The Report Wizard displays the list of suggested resources on the Resources List page so you can add them to the report unit. 5. In this example.3 Uploading Suggested File Resources When JasperServer uploads the main JRXML file. Enter the following properties for the new report: Name – ID of the report object in the repository. it processes the file to create a list of the resources that are referenced in the JRXML. Locate the folder where you want to add the report. in this example This is a simple example. 5. 7. The description is displayed in the repository and on the View > Reports page to help users determine the contents of the report. go to Organization > Reports > Samples. and the Report Wizard displays the list of suggested resources. Log in to JasperServer as an administrator and select View > Repository. The Report Wizard continues to the Main JRXML page: Figure 5-3 Locating the Report on the Main JRXML Page of the Report Wizard 6. 81 .jrxml.” on page 83.4.

JasperServer User Guide To upload the suggested file resources for the simple report example: 8. Figure 5-5 Selecting a Resource From the Repository on the File Resource Page File resources referenced in the main JRXML can either be chosen among existing images in the repository or be uploaded from a file. The File Resource page appears. For LogoLink. The file resource within the report unit has name. The resources list shows their name and has a link to add them to the report unit. there are two images needed in the report. which it does by default. they do not redefine the properties on the repository object that was referenced. you can associate any image file you choose with the resource ID in the main JRXML. 82 . The Resources List page appears again and shows that the LogoLink resource was added. Click Next. 11. click Add Now. Accept the default property values for the image resource by clicking Next. Click From the Repository and select images/JRLogo from the drop-down. The Name field must match the resource name referenced in the main JRXML. In this example. The first image in this example is found in the sample data that was created in the repository. label. 10. Figure 5-6 Properties of a Resource From the Repository on the File Resource Page 12. Review the resource names on the Resources List page of the Report Wizard. Figure 5-4 Suggested Resources on the Resources List Page of the Report Wizard 9. These are visible only within the report unit. and description properties. In either case.

4 Defining the Data Source Data sources belong to the report engine.Adding Reports Directly to the Repository 13.jpg. in the process of creating a report unit. Therefore. and the Report Wizard displays the properties page for the file resource Figure 5-8 Properties of an Uploaded Resource on the File Resource Page 16. The File Resource page appears again to locate the second image: Figure 5-7 Uploading a Resource From the File System on the File Resource Page 14. Click Next. 5. For the second image resource. Click Next to proceed to the Data Source page.2. click Upload From File System and browse to the file <js-install>/samples/images/logo. click Add Now on the Resources List page of the Report Wizard. JasperServer uploads the file. 83 . The Data Source page of the Report Wizard lets you choose the data source in the repository or define a new data source on-the-fly. Accept the default naming of the image by clicking Next. and cannot be defined in the main JRXML. The Report Wizard returns to the Resources List page where it shows that all resources referenced in the main JRXML have been added: Figure 5-9 Suggested Resources Added to the Simple Report on the Resources List Page 17. in this case JasperServer. you must define a data sources in JasperServer that the report can use. For AllAccounts_Res2. 15.

” on page 80 already contains a query. Locally Defined – Lets you define a new query that will only be available within the report unit. Proceed to the Locate Query page of the Report Wizard: Figure 5-11 Locate Query Page of the Report Wizard The three choices for the query are: From the Repository – Select an existing query object previously defined and stored in the repository. if any. The main JRXML may contain a query. You will see an error if you run the report in this state. None – Uses the query defined within the main JRXML. select From the Repository and choose /datasources/JServerJNDIDS that is created as part of the sample data in JasperServer.JasperServer User Guide To define the data source for the simple report example: 18. “Uploading the Main JRXML. This example overrides the existing query by defining a new query in the report unit. 20. If there is no query in the main JRXML. 19. In this example. 5. but the Report Wizard also allows you to define a new query for the report unit.5 Defining the Query The query in report unit determines what data will be retrieved from a data source. the reports will look the same. To define a custom query for the simple report example: 21. but their data will be different. This allows you to create several different reports from the same JRXML file.2. The AllAccounts. you will see an error when trying to run the report. Locally Defined – Lets you define a new data source that will only be available within the report unit. None – Lets you select or define the data source at a later time.2. 22. 84 . Proceed to the Locate Data Source page of the Report Wizard: Figure 5-10 Locate Data Source Page of the Report Wizard The three choices for the data source are: From the Repository – Select an existing data source from the repository. Click Next to proceed to the Query page. select Locally Defined and click Next.jrxml file uploaded in section 5. The simple report example defines a custom query that displays accounts from a single country.2. On the Locate Query page.

Select None to use the report unit’s existing data source. the Report Wizard gives you the opportunity to select a data source that overrides the one associated with the report unit. 24. Enter the following properties for the example: Name – CanadaAccounts.4. Selecting None uses the default data source that you selected in section 5. you can select one from the repository or define a new one. 23. then click Next. The Query Locate Data Source page appears: Figure 5-13 Selecting a Query Data Source on the Locate Data Source Page When specifying a local query for the report unit.Adding Reports Directly to the Repository The Query page appears where you can enter the properties for you local query: Figure 5-12 Entering Properties of a Locally Defined Query on the Query Page The locally defined query and its properties are visible only within the report unit.2. “Defining the Data Source. Click Next. Select SQL in the Query Language field and enter the following Query String to retrieve only Canadian accounts: SELECT * FROM accounts WHERE billing_address_country = "Canada" ORDER BY billing_address_city 85 . we create a query that retrieves only Canadian accounts. As with the default data source. Label – CanadaAccounts. Description – Query for New Simple Report in User Guide. In this example.” on page 83. The Edit Query page appears: Figure 5-14 Entering a Locally Defined Query on the Edit Query Page 26. 25.

The report appears in the repository with the properties given on the Naming page: Figure 5-16 New Simple Report Added to the Repository 29. with a message indicating whether the report was successfully validated: Figure 5-15 Validation Page of the Report Wizard If the report was not validated. You could easily change the images in the report by referencing other file resources. If you navigate to the last page of the report. The Validation page appears automatically. Click Finish to skip to the end of the wizard. To validate the report unit of the simple report example: 27. Click the name of your new report to run it and view the output. Use the left-hand navigation buttons to jump directly to the pages where errors occurred. and saves the new report unit in the repository with the type Report. you may be prompted to review your entries.6 Validating the New Report Unit You may click Finish anytime in the Report Wizard to skip pages you do not need. The report wizard validates all the elements of the report unit when done. click Save. 28. you see the two logo images that were referenced as file resources. If the report is valid.2.JasperServer User Guide 5. all the accounts listed are in Canada. 86 . As shown in the figure below. It’s always a good idea to test the report and review the output.

2.2. 2. To create the report. Description – This is a complex example. “Uploading the Main JRXML. The list of suggested resources indicates that you need a sub-report (the SalesByMonthDetail. For detailed instructions. as well as a scriptlet class JAR file and resource bundles. The following procedure assumes you are familiar with the Report Wizard and how to navigate between its pages.jrxml. Select Upload From File System and click Browse to locate the file <js-install>/samples/reports/ SalesByMonthDetail. The report file and its resources are found in the <js-install>/samples directory. b.” on page 81. 87 . Label – New Complex Report. Click Add Now in the same row as SalesByMonthDetail. Locate the folder where you want to add the report. you must have access to all its resources. The complex report also uses a datatype and an image in the repository that are part of the sample data installed with JasperServer.jrxml. including the SalesByMonth. go to Organization > Reports > Samples.” on page 80 and 5. On the Main JRXML page. the SalesByMonthDetail. select From File System and click Browse to locate the file <js-install>/samples/reports/ SalesByMonth.” on page 27.1. Right-click the Samples folder and select Add Resource > JasperServer Report from the context menu. upload the sub-report: a.2. see section 3. see sections 5.2. “Running a Simple Report. On the Resource List page.jrxml file) and a logo image. 4. Enter the following properties for this example on the Naming page: Name – new_complex_report.jrxml file. 5.7 Complex Report Example This section describes the creation of a more complex report with a full set of input controls. To upload the main JRXML and suggested resource files for the complex report example: 1. 3. It may help if you are very familiar with the SalesByMonth. “Uploading Suggested File Resources. 6. The beginning of the complex example is similar to that of the simple example. In this example.Adding Reports Directly to the Repository Figure 5-17 Output of the New Simple Report Showing the Image Resources For more information about running reports.3. 5. Log in to JasperServer as an administrator and select View > Repository.jrxml file and the resources it requires. This example uses these resources to create a report that behaves just like the SalesByMonth report found in the Reports > Samples folder of the repository.jrxml file (the sub-report).

the file must have the . The complex report example needs a scriptlet JAR and two language bundles (Java properties files). and description. b. On the Resource List page. a.2. accept the default report name and label.jar file. On the Resource List page. 7.TTF file extension. click Add Resource. click Add Resource again. You must be aware of other file resources needed in your report and upload them from the Resources List page. the name is referenced in the main JRXML file. c. Select Upload from File System and click Browse to locate the <js-install>/samples/jars/scriptlet.8 Uploading Undetected File Resources The report wizard cannot detect every type of resource referenced in the main JRXML. b. Enter the following information. On the Resource List page again. Description – Scriptlet JAR for complex example. Figure 5-19 Adding the Scriptlet JAR on the File Resource Pages 9. When you upload a TrueType font as a resource. To upload the undetected file resources for the complex report example: 8. Click Add Now in the same row as Logo. label. you must know how they are referenced and give your file resources exactly the same name so they can be associated. The next page indicates that the file was successfully loaded and automatically detected as a JAR. Add and upload the English resource bundle with the following steps: a. Add and upload the scriptlet JAR file with the following steps: a. Figure 5-18 Suggested Resources Added to the Complex Report on the Resources List Page 5. In addition. Click From the Repository and choose /images/JRLogo. accept the default name. upload the logo image resource: Both suggested resources in the list have been added. c. Label – Scriptlet JAR. On the next page.JasperServer User Guide c. 88 . so you must enter it exactly as shown: Name – Scriptlet. On the next page.

c.properties. enter the Name field exactly as shown: Name – sales_ro. c. the Name field must be exactly as shown: Name – sales. The next page indicates that the file was successfully loaded and automatically detected as a resource bundle (a Java properties file). click Add Resource again.properties. Enter the following information. Figure 5-20 Adding the English Resource Bundle on the File Resource Pages 10.properties. b.properties. Label – sales_ro. Label – sales. Description – Default English resource bundle.properties file. The next page indicates that the file was successfully loaded and automatically detected as a resource bundle (a Java properties file). On the Resource List page.Adding Reports Directly to the Repository b. Select Upload from File System and click Browse to locate the <js-install>/samples/resource_bundles/ sales_ro. Enter the following information. Description – Romanian resource bundle.properties file. Figure 5-21 Adding the Romanian Resource Bundle on the File Resource Pages 89 . Add and upload the Romanian Resource bundle with the following steps: a. Select Upload from File System and click Browse to locate the <js-install>/samples/resource_bundles/ sales.

Boolean – A yes/no value determined by a check box.2. You can also change the label and description of the resource. Once the list of values is determined. optionally constrained by a minimum value. the widget type can be: Drop-down list to select a single value. for example to interpret a string of digits as a number. but not its name. but date and date/time also provide a calendar icon. you must create the input controls so that they return the exact type.1 Adding a Text Input Control The most straightforward input control is a text box that allows the user to enter a value. Check boxes to select multiple values. 5.jrxml file of the complex example has several parameters that require input controls. click the resource name/ID in the table and locate the new file or repository object. You must define an input control even when parameters have default values. All choices are presented and selected by their text representation. JasperServer displays the input control widgets with the report and regenerates the report when the user changes the input values. To prevent users from changing the default. Single values provide a text box for the user to enter a value. meaning that JasperServer will verify that the user input is numeric. Choice of multiple values – The choices offered to the user can either be a static list of values that you specify or a dynamic list of values returned by a separate query. and number of values expected by your report. Radio buttons to select a single value. you can make the input control read-only or invisible. In this example. Each input control is a different type to demonstrate how each can be added to the report unit. input controls and the data types they rely on can either be locally defined or reused from the repository. Multi-select list to select multiple values. When a report is designed and configured for input controls. all three files appear in the Resources List. or both. the data type for the value is a number. Single value – A text. number. However. but the report may process the input value. date or date/time. In general. there are two aspects to defining an input control: the data type (for example number or text) and the widget type (for example text field or radio button) that allows that input. click the X icon in the same row to remove the file resource and add it again. Text input can also be constrained by a matching pattern. a user can modify runtime selections.2.9.9 Adding Input Controls Input controls are standard graphical widgets that take user input in a pre-determined format and pass it into the report. If there is a mistake in a resource name/ID. 90 . range.JasperServer User Guide When done. The query in the SalesByMonth. such as WHERE filter clauses in SQL parametrized queries. Input controls are complex objects that can be configured in many ways. Most components in the example are defined locally to demonstrate the use of the report wizard. 5. As with other elements of a report unit. Figure 5-22 Undetected File Resources Added on the Resources List Page If you wish to upload a different file for a named resource. maximum value.

so you must enter it exactly as shown: Parameter Name – The name of the parameter in the report that receives the user value. If you have created input controls for similar reports. you can locate a datatype already stored in the repository. click Add Control. 13. in this example TextInput. date. On the next page. If you have a data type saved in the repository that you want to reuse. select Locally Defined: Figure 5-25 Locating the Datatype for the Text Input Control 91 . Type – Determines the type of the input control. enter the naming properties for the input control as well as the type of the input: Figure 5-24 Entering the Properties of the Text Input Control The name is referenced in the main JRXML file. Prompt Text – The label that the user sees next to the widget for this input. select Locally Defined. Also. Description – An optional description that only appears within the report wizard. For this example. On the next page. or date/time). Mandatory. text. in this example use the default settings. For this example. in this example Single Value. make sure its type and range are compatible with the input control you want. you cannot reuse input controls that you defined locally in another report. 14. Visible – Affect how the input control is displayed. in this example Text Input Control. but the they can also include range restrictions that JasperServer will enforce. Read-only. Figure 5-23 Locate Input Control Page of the Report Wizard 12. On the Resource List page of the report wizard. you can reuse them if they have the same parameter name in the report. The Locate Input Control page appears.Adding Reports Directly to the Repository To add a text input control to the complex report example: 11. Data types can be simple definitions of the expected input (numbers. you must create the input control in the repository.

Figure 5-27 Added Controls in the Resources List of the Report Wizard 5. 16. The number format allows users to enter both integers and decimals. On the next page.JasperServer User Guide 15. 18. Label – Integer Control.9. leave blank in this example.2 Adding a Simple Check Box Input Control A simple check box provides a true/false (boolean) input that can be used to conditionalize some part of the report. but they are visible only when defining the input control: Name – integer_type. a strict minimum means the value itself is not allowed. 92 . The Resources List page appears with the new TextInput control in the list of resources. Leave blank in this example. in this example choose Number. Click Save. Leave blank in this example. Description – An optional description that only appears within the report wizard. Type – Determines the format of the data that the user may enter. Maximum value and Is strict maximum – The upper bound of the value the user may enter. On the Resource List page of the report wizard. a strict maximum means the value itself is not allowed. click Add Control. On the Locate Input Control page. To add a simple check box input control to the complex report example: 17. Your report must handle both kinds of values when processing the parameter that receives the number. Minimum value and Is strict minimum – The lower bound of the value the user may enter. enter the properties for the locally defined datatype associated with the input control: Figure 5-26 Defining the Properties of the Datatype for Text Input The name and label are required. select Locally Defined.2.

20. The Resources List page appears with the new CheckboxInput control. Type – Boolean in this example. This example only has three pre-determined but uses a drop-down list. On the next page.9. Read-only. enter the naming properties for the input control as well as the type of the input: Figure 5-29 Entering the Properties of the List Input Control The name is referenced in the main JRXML file. 22. On the Resource List page of the report wizard. Mandatory. To add a drop-down input control to the complex report example: 21. Multi-select controls can either be a multi-select list or a set of check boxes. select Locally Defined. but use Checkbox Input Control in this example. usually five or less. You can either create one locally for the input control or reuse one that you have created beforehand in the repository.2. On the Locate Input Control page. so you must enter it exactly as shown: 93 . Description – Leave blank in this example. Click Next. The predetermined choices are defined in a list of values object. Visible – Use the default settings in this example. The design of the report determines whether you must create a single-select or multi-select list. so you must enter it exactly as shown: Parameter Name – CheckboxInput in this example.3 Adding a Drop-Down Input Control Another type of input control gives the user a pre-determined list of choices to select from. click Add Control. 5. When creating the input controls you can select whether to present a single choice as a drop down list or a set of radio buttons. Prompt Text – The label for the input control is usually formulated as a question. 23. enter the naming properties for the input control as well as the type of the input: Figure 5-28 Entering the Properties of the Check Box Input Control The name is referenced in the main JRXML file. Radio buttons and check boxes are usually appropriate if there are few choices. On the next page.Adding Reports Directly to the Repository 19.

If you make a mistake. The label for every item must be unique. enter its label and its value. For this example. Description – Leave blank in this example. Label Second Item with value 2. Description – Leave blank in this example. so you must ensure that its type and value match what is expected. Click Save. and optional description for the locally defined list of values. 24. Each value has a label that is displayed instead of the actual value. 26. then click +. enter a name. The value itself is passed to the report. check the box in the row you want to remove and click –. enter the values that the user will choose from. Figure 5-32 Defining the Values of the List of Values For each value that you want to add to the list. For this example. Read-only. On the next page. you can locate a list of values already stored in the repository. Label Third Item with value 3. These properties are not visible outside of the input control: Figure 5-31 Defining the Naming Properties of the List of Values Enter the following values: Name – list_type in this example. On the next page. If you have a list of values saved in the repository that you want to reuse. Type – Single-select List of Values in this example. Mandatory.JasperServer User Guide Parameter Name – ListInput in this example. Visible – Use the default settings in this example. 94 . The Resources List page appears with the new ListInput control. Prompt Text – List Input Control in this example. Label – List Type in this example. 27. enter: Label First Item with value 1. label. select Locally Defined: Figure 5-30 Locating the List Type for the List Input Control 25. On the next page. make sure its values are compatible with the parameter that receives this input.

Mandatory. You must configure the query and designate how the results are displayed in the input control. select From the Repository. 34. click Add Control. 95 . 5. Type – Single Value in this example. JasperServer performs a query whose results are used to create the list of choices. On the Locate Input Control page. On the next page. click Add Control.4 Adding a Date Input Control In this example of adding a date input control.9. The Resources List page appears with the new DateInput control. Click Next. select Locally Defined. 30.2. 31.5 Adding a Query-Based Input Control This last example of an input control shows how the choices available to the user can be dynamically based on your data. On the Resource List page of the report wizard. enter the naming properties for the input control as well as the type of the input: Figure 5-33 Entering the Properties of the Date Input Control The name is referenced in the main JRXML file. The drop-down automatically shows the data datatypes found in the repository.2. Description – Leave blank in this example. On the Locate Input Control page. Visible – Use the default settings in this example. as well as what value is passed as the corresponding parameter. Read-only. 29. Select /datatypes/date from the drop-down: Figure 5-34 Locating the Datatype for the Date Input Control 32. so you must enter it exactly as shown: Parameter Name – DateInput in this example. To add a query-based input control to the complex report example: 33. On the Resource List page of the report wizard. Prompt Text – Date Input Control in this example. On the next page. select Locally Defined.9. we use a data type that already exists in the sample data in the repository: To add a date input control to the complex report example: 28.Adding Reports Directly to the Repository 5.

you can use a query stored in the repository. enter testQuery in both the Name and Label fields. so you must enter it exactly as shown: Parameter Name – QueryInput in this example. we define a query that is local to the input control. Read-only. Figure 5-37 Defining the Properties of the Query for the Query Input Control 96 . On the next page. For a query-based input control. Type – Single-select Query in this example. In this example. On the Locate Query page. For this example. enter naming properties for the local query. enter the naming properties for the input control as well as the type of the input: Figure 5-35 Entering the Properties of the Query Input Control The name is referenced in the main JRXML file. Description – Leave blank in this example. Prompt Text – Query Input Control in this example. select Locally Defined.JasperServer User Guide 35. with its own properties and query string. On the next page. Figure 5-36 Locating the Query for the Query Input Control 37. 36. Mandatory. Visible – Use the default settings in this example.

Figure 5-40 Selecting Columns for the Query Input Control For this example. JasperServer will display one choice in the widget you chose as the input type (drop-down. Figure 5-38 Locating the Data Source for the Query Input Control 39. On the Query Information page. you can select a different data source from the repository or define one that is local to the input control. name the database column that will be used as the input value and those that will be presented to the user. For each row in the results of the query. 41. keep the default value in the Query Language field. check boxes). radio buttons. mutli-choice. including the new input controls. enter the following column names: Value Column Enter – user_name. Visible Columns – first_name and last_name. select None to use the same data source you defined for the report. 97 . In your own reports. In this example. first_name. The column names must match those in the SELECT clause of the query string exactly. define the query that retrieves both the labels and the values to be displayed by this input control. The Resource List page displays all the resources. On the Edit Query page.Adding Reports Directly to the Repository 38. On the Locate Data Source page. last_name FROM users Figure 5-39 Editing the Query String for the Query Input Control 40. If you make a mistake. For each column that you want to display in a choice. then click +. and enter the following Query String: SELECT user_name. Click Save. check the box in the row you want to remove and click –. enter its name.

a parameter is referenced using the following convention: $P{parameter name} Consider an example report that returns data identified by country and city. see section 3.2. the input control's query must use a special syntax to reference a parameter name. enter the optional settings at the bottom of the Resources List page. the list of values includes only those in the selected state. The syntax is identical to the JasperReports syntax used in report queries. consider a report that has input controls for country. Check Always Prompt to force JasperServer to prompt the user even though none of the input controls are mandatory. To configure the display of input controls in the complex report example: 42. By leveraging the cascading functionality. 98 . For an example of running a report with cascading input controls. The following settings appear whenever one or more input controls are defined. The goal is to use input controls as parameters for a query that populates another input control. To do so. the CITY input control is refreshed to show the result.” on page 33. For example.3.9. “Cascading Input Controls. This example uses the default pop-up window. This setting allows you to specify a different JSP file to change to appearance of the input controls. state. It includes input controls called COUNTRY and CITY. When the user selects a state. Leave the field Optional JSP location blank for this example.2.JasperServer User Guide Figure 5-41 All Added Controls on the Resources List Page 5. and city.6 Configuring the Display of Input Controls To complete the configuration of input controls.9.2. Note that there are other ways to use a parameter in a query. 5. the value selected is used by the query of the CITY input control. but you can also make the input controls appear in a separate browser window or at the top the report itself. for example: select city from accounts where country = $P{COUNTRY} When the user selects a country from the COUNTRY input control. They apply to all input controls simultaneously: The Controls Layout specifies where the input controls should appear. For example.7 About Cascading Input Controls JasperServer JRXML-based reports can include input controls whose values are determined by user's selection in other input controls. These cascading input controls use queries to determine the values to display in each input control field. The query used by the CITY input control retrieves city names from a table called accounts based on the value selected by the COUNTRY input control. the options in the State input control are determined by the value selected in the Country input control.

The Validation page displays a message indicating whether the report was successfully validated. The report appears in the repository. The pop-up dialog appears with all of the input controls you defined.2. The left-hand figure also shows all the dynamic choices for the Query Input Control: Figure 5-43 Entering Input Controls When Running the New Complex Report 99 . 44. you may be prompted to review your entries. 45. If the report was not validated.10 Completing the Complex Report Example To finish the complex report example and validate it: 43. Click Finish to skip to the end of the wizard. Skipping the last steps of the wizard accepts the default values for those options. Click the display name of your new report to run the report and view it. On the Locate Data Source page. Make corrections and try to validate the report again. Figure 5-42 New Complex Report Added to the Repository 46. If the report was validated. select From the Repository and choose /datasources/JServerJNDIDS from the dropdown. click Save. Enter sample values as shown in left-hand figure below.Adding Reports Directly to the Repository 5.

Clicking OK closes the Report Options window. 48. or Date-Time. If running the new report results in an error. The number of decimal places allowed in the field. the minimum value itself is not permitted. The sample report includes a header that displays the value of each parameter received from the input controls. The Text Input Control is defined as a numeric type and only accepts valid numbers. The label of the datatype. The datatype description page contains these fields: Name Label Description Type Max length Decimals Pattern Minimum value Is strict minimum Maximum value Is strict maximum The name of the datatype. The highest permitted value for the field. edit the SalesByMonth sample report (in the repository at /reports/samples) and compare its settings to those you configured for your new report. It also includes validation criteria. The maximum number of characters allowed in the field.11 More about Datatypes A datatype in JasperServer is more than just a classification of the data. If checked. only values greater than the minimum value are permitted. Any additional information you want to provide about the datatype. Number. Click OK or Apply to run the report with the selected input.2. If checked. Enter a number and click OK or Apply again.JasperServer User Guide 47. as shown in the righthand figure. The lowest permitted value for the field. only values less than the maximum value are permitted. JasperServer enforces the proper format defined for each input control. edit the report to review your settings. If you cannot identify the problem. Figure 5-44 Output of the New Complex Report Showing Values from the Input Controls You can open the Report Options widow at any time from the report by clicking the icon. A regular expression that restricts the possible values of the field. 5. Possible values are Text. the maximum value itself is not permitted. clicking Apply keeps it open to easily change values and run the report again. Date. The actual data type. 100 .

12 Localizing JRXML Reports JRXML reports (including Topics) support the $R expressions for field names. but should be considered deprecated.org/wiki/index. the filename must include the correct extension (. In order for this localization to work properly. If you edit a resource bundle in iReport. For example. we might use this JRXML: <field name="StoreState" class="java. you don’t need to set any other font attributes (such as the pdfXXX attributes) in the JRXML.lang. and declare the resource bundle in the header of the JRXML file. When you upload the report. simpleTable is the name of the resource bundle file that contains the StoreState property. you must upload the resource bundle. 5.2. Serif. iReport can help you localize your report by creating the resource bundle as well. For example. Also. All is taken care of in the font extension file that makes these fonts available. For example: <jasperReport name="StoreSales" pageWidth="595" pageHeight="842" columnWidth="515" leftMargin="40" rightMargin="40" topMargin="50" bottomMargin="50" resourceBundle="simpleTable"> In the above.2. the java logical fonts listed above aren't recognized by browsers and are substituted with other font families in some browsers. When you upload a TrueType font to the repository. nor do you need to specify font mapping. and run the risk of text being cut when exported to PDF. 101 . such expressions are used to localize reports into various languages.TTF). which in turn ensures the PDF will be pixel perfect every time. This is because these Java logical fonts map to different TTF files in different environments.Adding Reports Directly to the Repository 5. For more information on DejaVu. you must create the resource bundle with the correct labels. The DejaVu replace the Java logical fonts used in previous versions of JasperServer: SansSerif Serif Monospaced SansSerif.php?title=Main_Page. due to font metric mismatches. Each $R expression refers to an entry in a resource bundle properties file that you must create. refer to its SourceForge project at: http://dejavu-fonts. if we were to localize a field called StoreState. when viewing a report that uses the SansSerif logical font in Firefox in a Windows environment. the font is rendered as Serif. JasperServer uses three fonts you can use in your reports: DejaVu Sans DejaVu Serif DejaVu Sans Mono Using the DejaVu fonts shipped with JasperServer ensures that the fonts are always available in all environments. When using the DejaVu fonts coming from JasperReports font extensions.13 Default Fonts in JasperServer By default. Monospaced can still be used.display" value="$R{StoreState}"/> </field> JasperServer looks for a label with the ID of StoreState. you can right-click it in repository (using the JasperServer Plug-in) and select Replace with Current File.String"> <property name="adhoc. as well.

5. or even change the data type to one from the repository. Click the name of the TextInput control. Right-click the New Complex Report and select Edit from the context menu. Because none of the input controls in this example are required. In this example. When the report has successfully validated. 2. as if you were creating the report unit. b. the input controls appear above the full report. b. You can make modifications in the report wizard. Navigate to the page of the report wizard where you want to make changes. On the Resources List page of the report wizard: a. don’t make any changes. If desired. d. in this example click Controls & Resources in the left-hand list. 8. Instead of appearing in a pop-up before the report. The Locate Input Control page shows that this input control is locally defined.JasperServer User Guide 5. Change the Controls Layout to Top of Page. including the file resources and input controls. Search or browse the repository to locate the report. For this example: a. Run the New Complex Report again. the report can display with all input controls still blank. Click Next.3 Editing JRXML Report Units Once a report unit has been added to the repository. go to Organization > Reports > Samples. you can see the new prompt label for the text input control. c. click Save. Figure 5-45 Output of the Modified New Complex Report In Figure 5-45. you can go back and edit any of its elements. 6. 102 . The report wizard opens with all the settings of the saved report. 7. Enter values and click Run Report to modify the report output according to your input. Click Next until you reach the Datatype page where you can click Save. c. This example will modify the display text of the ambiguous Text Input Control. 4. Change the contents of the Prompt Text field to Enter a number. Clear the Always Prompt box. Log in to JasperServer as an administrator and select View > Repository. To edit the complex report example: 1. In this example. you could make changes on these other pages. Click Finish. The properties page shows the settings for this input control. 3.

remove. The Repository Navigator tool bar appears: 2. in Windows select Start > Programs > JasperServer Pro > Start iReport on the computer hosting JasperServer. and link controls to reports.1 Connecting to JasperServer from iReport You can connect to JasperServer (Professional or Enterprise) directly from iReport. modify. and delete folders. Access to Domains through the Domains plug-in for iReport. reports. For more information.7 and JasperReports 3. This can make it easy to access both test and production environments. Open the JasperServer Plug-in for iReport by clicking Window > JasperServer Repository. datatypes.Adding Reports Directly to the Repository 5. list of values. and import data sources (JDBC. and JavaBean). you cannot necessarily use a version of iReport or JasperReports that has a later version number than the version of JasperServer you use. and property files). Drag and drop images and sub-reports into the design page. For example. and you can connect to multiple servers.” on page 166.4 Using the JasperServer Plug-in for iReport The JasperServer plug-in for iReport provides report developers with a quick and easy way to access reports inside the JasperServer repository. This section includes these topics: Connecting to JasperServer from iReport Creating a Report Unit in the Repository from iReport Managing Resources in the Repository from iReport Editing a Report in the Repository from iReport Running a Report from iReport Creating Reports in iReport Based on a Domain in JasperServer Creating Chart Themes in iReport 5. This section assumes that you installed iReport when you installed JasperServer.2. For example. refer to section 8. The plug-in offers these features: Repository browsing. The plug-in uses the JasperServer web services to interact with the server. fonts. modify. JasperServer supports the version of iReport that ships with it. JRXML files. JNDI.4. Jasper Server 3. Add. generic resources (including images.7 supports iReport 3. 103 . Create.7. and input controls. To access the JasperServer repository within iReport: 1. Start iReport. Jaspersoft keeps the release numbers of compatible versions consistent. “iReport Plug-ins. JAR files. iReport appears. Create.

you must specify the ID or the alias of the user’s organization. When iReport starts for the first time. Note that you may experience problems when connecting to servers that are not compatible with your version of the plug-in. Organization – If there is more than one organization in the JasperServer instance. for example organization_1. To add a server. Figure 5-46 Connecting to JasperServer from iReport 4.JasperServer User Guide 3. the default URL is provided and you only need to change the hostname. The JasperServer repository tree appears as it would to the user in the given organization. Username – ID of the user account to use when accessing JasperServer. The view of the repository and any actions you take through iReport will use the permissions for this user. Enter the information that the plug-in will use to access your JasperServer instance. If you have multiple versions of the plug-in installed.1) that is installed on this computer. the list includes all the servers configured for every version iReport (after 3. then expand the repository tree in the Repository Navigator. 5. click the first button in the repository navigator tool bar. you can leave this field blank. no servers are configured. Password – Password for the given user. You can add any number of servers to this list. In the default installation with a single organization. JasperServer URL – Full URL to the repository web service. 104 . Click Save. All fields are required: Name – An identifier for this JasperServer instance and its repository in the iReport Repository Navigator.

Download. which you should create in iReport beforehand.4. If you have a report open in the design area.2 Creating a Report Unit in the Repository from iReport To add a new report unit. you need a JRXML file. Select a valid data source (either from the repository or locally defined) and click Finish. select Locally Defined and click Get source from current opened report to use it in the new report unit. right-click the server name and select Refresh from the context menu. Download images and other files by clicking Export File on the Resources tab of the resource’s Properties window. and a set of resources (zero or more). and upload JRXML files. To create a report that returns data from a Domain. Right-click the parent folder for the new report and click Add > Report Unit in the context menu. Select a JRXML file in the repository or one saved on your hard drive. The report unit appears in the repository tree.4. “Creating Reports in iReport Based on a Domain in JasperServer.6. A report has a main JRXML file. To add an image from the repository to a report. 4. 6. drag the image into the design window from the repository tree. You are prompted for the data source. a set of input controls (zero or more).” on page 108. To create a report unit in the repository: 1. edit. a data source. see section 5. 5. View the property information of the resources in the repository. you can: Browse the repository by double-clicking the server and folder icons. setting an expression that refers to the image’s location in the repository. 3. For each server to which you have configured access in the JasperServer Plug-in. The iReport plug-in adds the image element for you. If it doesn’t. Click Next. 5.Adding Reports Directly to the Repository Figure 5-47 iReport Displaying a Report from the Repository Navigator 6. 105 . You are prompted for the main JRXML file. 2.

Browse the repository to the correct resource and click OK. contain controls that are specific to each type of resource. properties files for localized reports. You can also modify the location. or delete resources to the repository from iReport: 1. Alternatively. or description of the repository folders. You must confirm you action to prevent accidental deletions. JARs. navigate the repository tree to find its folder. modify. 4. you can view the object’s repository label and description. If the logged in user has administrative privileges. you can modify the values and save them back to the Repository. 3. respectively. You cannot run a subreport directly on the server. To add. To modify a resource. refer to 5. or use the keyboard shortcuts: Ctrl-C and Ctrl-X. right-click it. you may need to access. Figure 5-48 Editing General Properties of Repository Objects in iReport The other tabs. File-based resources have a Resource tab to replace or export the file. there are one or more tabs depending on the type of resource. and data sources. For more information. 8. select Add then click the desired object in the context menu. Locate the destination and right-click and select Paste. and other repository objects have their own specific settings. To run the report. such as images. To delete a resource from the repository. “Running a Report from iReport.4. locate the object. name.JasperServer User Guide 7. If the main report uses a JDBC connection.3 Managing Resources in the Repository from iReport While creating reports that you intend to store in the JasperServer Repository. The JRXML for the subreport must already be created and saved as a resource in the repository or in the report A sub-report element is created. iReport prompts you to locate the resources. drag the JRXML for the subreport from the repository into the detail band. set the connection expression of the subreport to $P{REPORT_CONNECTION} in the Properties window’s subreport tab. style templates (JRTX). an image resource shows the image itself. To add a resources in the repository navigator. When you upload a report that uses the repo: syntax to refer to resources in the repository. and select Delete. then right-click the resource and select Properties. In the dialog window that appear. or use the keyboard shortcut Control-V. right-click the report unit and select run Report Unit from the context menu. and save changes to existing resources. JRXML files. right-click the folder that will hold the resource. modify. right-click the object and select Copy or Cut. To add a subreport to a report. input controls. On the General tab. To change the location of a resource in the repository. 2. When cutting the object. you must run the whole report unit. it will not be removed from its original location until pasted in the new location. and an input control lets you edit its various parameters: 106 . As shown in the following figure. lists of values. datatypes. Or if you are maintaining existing reports.4. locate the object.5. you will also need to create and manage the resources associated with them. 5. 5.” on page 108. if any. then drag-and-drop it to the new location.

right-click the JRXML file in the report unit and select Open in Editor. change the repository name or description as appropriate.2. You must upload it back to the repository when finished. report units appear as special folders with this icon: .4. either by selecting one from the repository. On the Main Report and Data Source tab. In the repository tree. Click Current Report to use the JRXML currently being edited in iReport. you can change the JRXML file for the report. and the Controls Layout determine where they appear. The JRXML appears in the Designer window. 107 . To edit a Report Unit in the Repository from iReport: 1. They contain JRXML files with this icon: .ireport/jstmp directory. When working with JRXML files in the Repository from iReport. Edit the file as needed. either in the Designer or in the XML editor. On the Other tab. right-click the report unit and select Properties. as explained in the following procedure: To edit a JRXML file in the Repository from iReport: 1. you can select the data source from the repository or from iReport. This directory is never automatically cleared out. Click Save in the Properties dialog to make your changes effective in the repository. 5. 2. 3.” on page 105 for instructions on adding images or subreports to your JRXML file. On the General tab. The JRXML is extracted from the repository and stored as a local copy in the <USER_HOME>/. A message confirms the operation’s success. See Figure 5-50 on page 108. “Creating a Report Unit in the Repository from iReport. right-click it in the repository tree and click Replace with Current JRXML.Adding Reports Directly to the Repository Figure 5-49 Editing Resource-Specific Properties of Repository Objects in iReport 6. 4. 2. In the repository tree. The JSP fields are for modifying the appearance of the controls. or uploading one through iReport. To save the file and upload it to the repository. See section 5. Similarly. you can set display properties for any input controls. 3.4 Editing a Report in the Repository from iReport In the repository tree. you must be aware that iReport operates on a copy of the file.4.

4.6 Creating Reports in iReport Based on a Domain in JasperServer A Domain is a virtual view of a data source that represents the data in business terms appropriate to your audience. The Domain plug-in enables iReport users to generate reports from Domains. Click Save Report Unit in the Properties window to make the changes effective in the JasperServer repository. see chapter 6.” on page 115. It relies on the JasperServer plug-in to access the repository. Figure 5-51 Report Parameters Window in iReport The report is displayed in the Report Viewer Window. Running a Report from iReport To run a report on the server using all the export options set in iReport: Right-click a report in the repository tree and click Run Report Unit. 108 . The plug-in is installed in iReport by default. “Creating Domains. If the report does not display. look for errors or messages in the Report Problems Window at the bottom of the iReport interface.4.JasperServer User Guide Figure 5-50 Editing Parameters of a Report Unit in iReport 5. If the report has input controls.5 1. 2. the Report Parameters window prompts you for values. 5. and it limits the data to that which is appropriate for the audience. 5. For more information about Domains.

“Connecting to JasperServer from iReport.Adding Reports Directly to the Repository To create a report in iReport based on a Domain in JasperServer: 1.4. Configure iReport to access your JasperServer repository as described in section 5. Click Window > Domains. The Domain Report wizard opens to the Connection step: Figure 5-53 Connection Step in the iReport Domain Report Wizard 4. Select a JasperServer connection to determine the server and repository containing the Domain you want.1. then click Next. 2. The Domain Window appears docked on the left-hand side of the screen. Figure 5-52 Domains Window in iReport 3. To start a report based on a Domain.” on page 103. click File > New > Domain Report. Figure 5-54 Domain Step in the iReport Domain Report Wizard 109 .

See below to publish your report in the repository. which may correspond to fields and calculated fields in the Domain. If the user’s organization includes sub-organization. Define any necessary filter conditions on the fields of the Domain. the list will include any Domains they define as well. For more information. “The Filters Page.JasperServer User Guide The Domain step displays a selector containing all the Domains within the repository visible to the user defined in the connection. Even if that field is not included in the report. and you may select any field to prompt the user with an input control. This dialog is similar to the Filters page in the Choose Ad Hoc Data wizard within JasperServer. 110 . 5. 8.2. Figure 5-56 Name and Location Step in the iReport Domain Report Wizard The Name and Location step determines the file name of your report in iReport. Figure 5-55 Filters Step in the iReport Domain Report Wizard The Filters step displays the Domain’s items.2. Filters will limit the data your report will return. Click Finish.5. The report document appears in design area. Click Next and specify a name and a location on your hard drive to save the report. not in the JasperServer Repository. 7. see section 4. 6. The Domain Window now shows the sets and items in the Domain.” on page 71. Select a Domain and click Next. the filter will be active and will apply to the rows of data that will appear.

Filters are defined as queryFilterString elements in the XML of the report. right-click the server name and click Refresh. click Edit Filters in the Domains Window. 111 . For the simple filter shown in step 6. 12. then click Next. 14. “The DomEL Syntax. 13. label (display name) and an optional description for the report in the repository. You cannot run a Domain report until it has been published to JasperServer. When you are satisfied with the report. label. drag them to the detail area of the JRXML in the designer. To add items from the Domain. You are prompted for a name. and description of the new report unit.= 10000</queryFilterString> </query>]]> </queryString> The query has two elements: queryFields and queryFilterString: Field IDs in both elements are specified as set_ID. With the report published to the server. save your report. you can test it by clicking The report output appears in the Report Viewer Window.2. 10.field_ID.Adding Reports Directly to the Repository 9. Edit your report to format its data and look and feel.” on page 150. Select a valid repository location and click Finish. If the report doesn’t appear in the repository tree. The filter uses the Domain Expression Language described in section 7.amount"/> </queryFields> <queryFilterString>newSet2. Enter a name (object ID). Figure 5-57 Designing a Report in iReport Based on a Domain in JasperServer If you want to change the filters on the Domain data. in the repository navigator window. the generated XML is the following: <queryString language="sl"> <![CDATA[<query> <queryFields> <queryField id="newSet2. Click XML next to Designer to view the XML. 11.amount &gt. You are prompted for location for the report unit. then click Publish Report in the Domain window.

JasperServer User Guide

5.4.7

Creating Chart Themes in iReport

Using iReport, you can create new chart themes that give a custom look to any chart. You can easily set the fonts, colors, line widths, and other settings that determine the appearance of charts. You can then import the chart theme for use in reports generated in JasperServer, either on a report-by-report basis or as a global setting for all charts that do not provide their own theme.
To create a new chart theme in iReport:

1.

Select File > New > Chart Theme. The new file dialog opens with a default file name. Chart themes use the .jrctx file extension.

Figure 5-58

New Chart Theme in iReport

2.

Enter a name and location and click Finish. Alternately, open an existing chart theme file with the .jrctx extension. The chart theme editor appears in the Designer window.

3.

Use the following panes to work with your chart theme: Template inspector on the left . Contains the categories of properties that can be modified. Chart properties on the right. Lists the properties in each category and lets you modify their settings. These panes are shown in Figure 5-59 on page 113. The available options are based on the JFreeChart library used to generate charts. Note that iReport only supports the most common options provided by JFreeCharts.

4. 5.

Select each category in the template inspector and review the available option, which appear in the properties pane to the right. Select a property to change its value. Depending on the nature of the property, you might type text, select a color, check or clear a check box, or select a value from a dropdown. As you update the chart theme, the Designer shows your changes. For example, change the Series Color property in the Plot category to set the color of the data series in the chart. Selector different chart types from the dropdown at above the Designer to see how the theme appears with different types of charts. This is especially important if you are creating a theme that will be used with many reports, such as a corporate chart theme. To view the XML that defines the chart theme’s appearance, click XML above the Designer.

112

Adding Reports Directly to the Repository

Figure 5-59

Chart Theme Editor in iReport

6. 7.

When you are satisfied with the chart theme, click File > Save to save your chart theme. This saves the report to your local hard drive. In the template inspector, right-click Chart Theme and click Export as Jar from the context menu.

Figure 5-60

Exporting a Chart Theme

You are prompted to identify the chart theme. 8. 9. Enter the name of the theme and the name of the JAR file. The chart theme name is the text that appears in the Chart Theme dropdown in iReport’s properties pane. If you don’t want this theme to be available in iReport for some reason, clear the check box. 10. Leave the box checked if you want the JAR to be placed on iReport’s classpath. 11. Click Export. The chart theme is exported. It can be used at the report or server level in JasperServer. For more information, refer to the JasperServer Administrator Guide.
In iReport, you can upload the chart theme to JasperServer using the JasperServer plug-in; right-click the folder in the repository where the theme should reside, and select Add > JAR Archive.

113

JasperServer User Guide

114

They are different from Topics in several significant ways: Domains can be created directly through the JasperServer user interface. and it can limit the access to data based on the security permissions of the person running the report. a Domain performs all these functions and more such as the localization of report text and permissions based on data values. Typically. Domains are similar to Topics in that they are used in the Ad Hoc Editor as a basis for designing reports. A Domain defined in JasperServer and can be used to create reports. as described in section 5.Creating Domains 6 CREATING DOMAINS A Domain is a metadata layer that provides a business view of the data accessed through a data source. a view can perform some of these functions.” on page 67. Ad Hoc reports. users see columnss that have been joined. “Creating Reports in iReport Based on a Domain in JasperServer. Domains are created for end users by database administrators or business analysts who understand the structure of the raw data in the database. and the data values they can access are limited by security policies. and labeled with user-friendly names.” on page 108. see section 4. This chapter covers the process of creating Domains and defining their contents. 115 .6. Domains defined in JasperServer can be accessed through iReport as well. “Creating a Report from a Domain. filtered by business needs.1 Introduction to Domains Production databases typically contain data in tables that are optimized for storage and retrieval. In the default JasperServer installation. Administrators define Domains. and Domain Topics. It presents the data in business terms appropriate to your audience. In relational databases. For instructions on creating Domain Topics and reports based on Domains in the Ad Hoc Editor. This chapter contains the following sections: Introduction to Domains Example of Creating a Domain Using the Add New Domain Dialog Using the Domain Designer Editing a Domain 6. and users create reports based on the Domains using either the Ad Hoc Editor or iReport. In JasperServer. filtered and labeled for their business needs.4. A Domain is a virtual view created and stored in JasperServer.5. Columns with data relevant to users need to be joined across several tables. those who create Domains must have organization admin privileges. Through a Domain. secured against unauthorized access. without modifying the data source.

Users of the Domain might only see a single set of tables according to their security permissions. The preceding examples illustrate two extreme cases. they have to opportunity to further choose the data from within the Domain.1. They could then perform their own filtering. Domains can be used to perform complex joins. The number of users in your production environment and their level of proficiency will also determine your general use cases.1. but they are defined by the columns that determine the fields involved. Administrators create Domains.1. In this scenario. For more information.5.3 Components of a Domain A Domain is saved as an object in the repository. there might be many specific Domains. relabel columns for their own needs. columns are called items.3. administrators could create very targeted Domains and Domain Topics. and select a small set of columns for specific users or specific types of reports. A small number of users who understand their database might be given administrator privileges to define complex Domains as an extension of the Ad Hoc report design process. Similarly. joins. it has a name. and saved reports in JasperServer depends on the complexity of your data and your business needs.5. a Domain could contain dozens of tables in several unjoined sets. “Creating a Report from a Domain. In the first case. administrators will want to create Domains that help the users meet their business goals. operations such as joins and filters operate on designated field values in a row. as well as labels and locale bundles to specify how the data appears. Users can select a subset of columns to appear in the Ad Hoc Editor and give them custom labels. “Creating Topics from Domains. “Creating Topics from Domains. however the two terms refer to the same concept from different perspectives. see sections 4.” on page 73 gives individual use cases for Domains. filter expressions and security files to specify exactly what data can be accessed. perform very little filtering. and more importantly create input controls on columns so that report readers can modify the filter values. Because an item may originate from derived tables or calculated fields. it may not correspond to a single column in the database. optional description and folder location specified at creation time.2 Terminology This chapter refers to both columns and fields. and each would have corresponding locale bundles and a single Domain Topic. For example. but no opportunity to access the Domains to perform their own filtering.3. Domains and Domain Topics can give users great freedom in designing reports while the security features make sure they do not access inappropriate data. but there are many scenarios that combine some degree of both. Once all these settings have been made. A Domain references the following components: 116 . The table in section 4. and save their settings as a Domain Topic for future reuse in Ad Hoc reports. 6. On the other hand. In the other case. there might only be one Domain within the organization but many Domain Topics that users have created for specific needs. Conventionally.JasperServer User Guide Domain creators can write SQL queries.” on page 73. In this case. a calculated field refers to a field in row that is computed from the field values in other columns. Domain Topics. 6. have formulae for calculating new columns. 6. filter data. with large numbers of users or less database proficiency.5. Domain Topics. but define a strong data-level security policy. This last point is a very powerful feature of Domains. Report creators have the opportunity to further filter data and prompt for user input later when running the report. Some Domain operations refer to columns. database tables are composed of columns. Within a Domain. But the effect of a calculated field in every row is to create a new caluculated column. then use repository access permissions to make sure users cannot modify them. Users can filter the data for each column. Perhaps reports also need to be internationalized. and reports based on Domains. and also save the settings in a Domain Topic so others can design similar reports.” on page 67 and 4. users can save the report for others to run. others to fields. each for a specific purpose.1 Domain Use Cases The use of Domains. and columns are composed of fields in each row. On the other hand. Users would have a wide variety of Domain Topics to choose from. Like other repository objects. but when users create a report based on a Domain. JasperServer can optimize database access to allow editing of reports that access huge datasets. When designing a report based on a Domain. so the administrator creates the corresponding locale bundles.

joins between tables. “The Domain Design File. as described in section 7. 5.” on page 139.1.5.” on page 139. creating or uploading the components of a Domain. “Creating Topics from Domains. as well as see complex reports based on Domains: Simple Domain – Demonstrates very basic features of Domains Based on the SugarCRM JNDI sample data source.3. Based on the Foodmart sample data source. you need to determine a security policy for the data retrieved through the Domain. You can export the Domain’s design file as described in section 7. Log in to JasperServer as an administrator and select View > Repository. and item properties to expose to users. 117 .5 Overview of Creating a Domain In practice. The new Domain is not created until you click Save in the Add New Domain dialog. You should know the elements of your design: tables and columns to choose. Launch the Domain Designer and step through its tabs to ultimately define the sets and items of your Domain.” on page 127. To create a sample Domain: 1. The Domain design is either created through a dialog or uploaded from an external XML file. Domain used to create Simple Domain Topic in the Organization > Ad Hoc Components > Topics folder. and labels to display the columns. queries for derived tables.Creating Domains A JDBC or JNDI data source whose tables and columns will be presented through the Domain.1. as described in section 4.3. “The Domain Design File. 6. There are several dialogs involved in creating a Domain in JasperServer: 1. “Using the Domain Designer. Shows how report creator can see the items in a Domain through a Domain Topic. sets you need.4. 4. Complex Domain with many tables and joins. filters to define. Data sources are selected from previously defined data sources in the repository. Optionally define localization bundles or data-level security on the Resources page of the Add New Domain dialog. SuperMart Domain – Demonstrates advanced features of Domains.1. select Add Resource > Domain in the repository to open the Add New Domain dialog. “Using the Add New Domain Dialog. You can download and inspect the Domain’s security file and locale bundles.” on page 73. And finally. You can export the Domain’s design file as described in section 7. Optional locale bundles consisting of localized property files to give labels and descriptions in other languages. see sections 6. joins to perform. For complete information on all of the options and settings available for designing reports. As an administrator user. 3.” on page 125 and 6. You also need to determine whether the users of your Domain need localized resources. “The Domain Design File. you should plan your Domain’s features before you begin the creation process. 2.1. The next section gives a detailed example of using these dialogs to create a Domain. On the Data and Resources page. such as translated labels and local formats. 6. 6. The following sections describe the various dialogs for selecting. You should decide on the data source and define it in the JasperServer repository.1. select a data source then enter a name and optional description for your Domain. The Domain design that specifies tables and columns in data source. You can use them to practice designing and using Domains. calculated fields. Optional security file that defines row and column-level access privileges based on users or roles. Locale bundles and security files are uploaded from external files.4 Sample Domains Two sample Domains are provided in Organization > Domains in the default installation.” on page 139.2 Example of Creating a Domain The following example shows how to create a Domain.

In this example. Figure 6-1 Data and Design Page of the Add New Domain Dialog 4. Under the Data Source heading. The Domain Designer opens to the Tables tab showing the data source you selected in the previous step. The Add New Domain wizard opens to the Data and Design page.JasperServer User Guide 2. and optional description of the Domain. expand and select Analysis Components > Analysis Data Sources > SugarCRM Data Source. Figure 6-2 Select a Data Source Dialog for a New Domain 6. You can expand each table to see its individual columns. The list of tables to choose from shows all the database tables found in the data source. 118 . Click Launch Domain Designer on the Create tab under the Design heading. 5. Locate the folder where you want to place the Domain. click Browse. 3. enter a name. the click OK. repository location. Under the Properties heading. Right-click the folder and select Add Resource > Domain from the context menu. In this example: Display Name is Example Domain Location is /Domains (unchanged) Description is Created in User Guide tutorial. for example Organization > Domains.

so you may leave it checked or not. Double-click the following tables in the left-hand list to add them to the list of selected tables: accounts. Figure 6-4 Derived Tables Tab of the Domain Designer 119 . opportunities. the check box to Inspect new tables and automatically generate joins has no effect. 8. cases. accounts_opportunities. Click Next to display the Derived Tables tab. users With the data source in this example.Creating Domains Figure 6-3 Tables Tab of the Domain Designer 7.

select a column in the left table list and a column in the right table list. define the following joins: Left Table and Column accounts: id accounts_opportunities: opportunity_id opportunities: assigned_user_id Right Table and Column accounts_opportunities: account_id opportunities: id users1: id Join Type Inner Inner Inner 120 . Click New and enter a meaningful name in the Query ID field. For this example. expand the tables to see column names. Create a derived table as follows: a. In the left-hand list.deleted=false Click Run to see the columns in the result of the query. in this example: p1cases.JasperServer User Guide 9. select the users table and click the Copy Table icon users table again and click the Change Table ID icon to create the users1 table. c.priority=1 and cases. Click Next to proceed to the Joins tab. b. The new derived table is shown in the list of tables and contains the columns you selected. To specify a join. Click Create. 11. then click a join icon. Select the same . 10. Type the following query: select * from cases where cases. and rename it to users2. Figure 6-5 Joins Tab of the Domain Designer The tables selected on the Tables tab and defined on the Derived Tables tab appear in both lists. 12. d. Now there are two table aliases for the users table to avoid circular joins. A derived table is defined by a query and a selection of the columns in the result. Select the following columns by Control-clicking in the list of query results: account_id assigned_user_id case_number date_entered description id name resolution status e.

'. 121 . and the right outer join includes P1 cases without assigned users.Creating Domains Left Table and Column accounts: id users2: id Right Table and Column P1cases: account_id P1cases: assigned_user_id Join Type Left Outer Right Outer Outer joins are needed when columns might have null values. In this example. click Next to proceed to the Calculated Fields tab. accounts. Click Create Field to begin. The list of available columns shows all the joined and unjoined tables resulting from the joins you defined. you can expand the join tree and double-click column names to insert them. '. the left outer join includes accounts without P1 cases. then enter the following details for a calculated field that creates unambiguous city names: Name: city_and_state Type: String Expression: concat( accounts.billing_address_state ) When entering the expression. When you have selected all the necessary joins. Click OK to validate the expression and add the calculated field to the list of available columns. the cases table was used only to help create the p1cases derived table.billing_address_city. Figure 6-6 Calculated Fields Tab of the Domain Designer 14. but itself was not joined to the other tables. In this example. 13.

Choose the “Does Not Equal” comparison operator and type closed as the value. d. Click OK to save this condition in the list below.JasperServer User Guide 15. 122 . Use Equals as the comparison operator. Click Next to proceed to the Filters tab. If you select the wrong one. but you can still enter a value in this way. g. JasperServer did not find any values for this column in the data source. Expand the join tree and the opportunities table in list of Available Fields. c. click Cancel to clear the Condition Editor. Click the arrow next to the opportunity_type column to create a condition for it in the Condition Editor. This also places it in the Condition Editor. The list of available columns is identical to the one on the previous tab. including any calculated fields. and select Existing Business from the list of available values. Define two filters as follows: a. Create another condition by expanding the p1cases table and double-clicking the status column. f. b. Click OK to save this condition as well. e. Figure 6-7 Filters Tab of the Domain Designer 16.

Create a hierarchy of item sets and items from the tables and columns in the left-hand list. as well as default formats and summary functions. 18. descriptions that appear as tooltips. You can also use the icons above the lists to create new sets and move columns into them. in the properties table shows the Edit description dialog: Figure 6-9 Edit Description Dialog of the Domain Designer For this example. Click Next to proceed to the Display tab. select them and click the arrow buttons to the right of the list. The names and descriptions shown here are meant to be realistic but do not represent an actual business case. You can double-click or drag-and-drop sets and items between the two lists. The simplest way is to double-click JoinTree_1 to select all of its tables and columns. select it and double-click its current label in the properties table. create the sets and items in the following table. Figure 6-8 Display Tab of the Domain Designer The join tree is shown on the left again. A set is a grouping of items independent of the tables in which the columns originate. An item is a column or calculated field. Display properties include labels. Double clicking the description property or clicking . along with its display properties. The table on the right shows the display properties of the set or item selected in the list. To rename an item or set. and then rename the sets and remaining items and give them descriptions. Only columns from the joined tables in JoinTree_1 will be added to this example Domain. To the right of it is a list of sets and items that will appear in this Domain. remove the unwanted items.Creating Domains 17. To change the order of sets or items. that is chosen to appear in the Domain.. 123 . then type the new label..

JasperServer User Guide (Set ID) Set Label Set Description (accounts) Account Customer account information name account_type industry annual_revenue employees city_and_state (users1) Account Rep Primary account representative (opportunities) Opportunity Sales opportunity first_name last_name date_entered1 amount probability description1 lead_source sales_stage (p1cases) P1 Case High priority support cases case_number date_entered2 name2 description2 resolution status (users2) Case Rep Support case representative or engineer first_name1 last_name1 Customer Type Industry Revenue Size Employee Size City. Click Done. Date: data format of Jan 01. 124 . 20. Click Save in the Add New Domain dialog. State First Name Last Name Date Amount Probability Description Source Stage Case Date Summary Description Resolution Status First Name Last Name Name of customer Account type Primary industry Estimated annual revenue Estimated number of employees City and state of headquarters Given name Surname or family name Date opportunity opened Anticipated amount of the contract Estimated chance of winning the contract Description of the opportunity Lead source Sales stage Case number Date case opened Name or summary of the case Detailed description of the case Description of the case resolution Current status of the case Given name Surname or family name Item ID Item Label Item Description 19. Date: data format of Jan 01. The example Domain design is finished. The Edit tab under the design heading informs you that the design has been created and that you can launch the Domain Designer again to edit it. these items will have the data formats and summary functions by default. The new Domain is stored in the repository folder named in the Location field and appears in search results. Amount: data format of ($1.234) and summary using average P1 Case. 2009 When used in reports. 2009 Opportunity. Set the data format and summary properties on the following items: Opportunity. 21. The Add New Domain dialog appears again.

3. The text field shows the repository path of the chosen data source. when modifying an existing Domain. and a display name on the Data and Design page before you may navigate to the Resources page or Save a Domain. Properties heading: For new Domains. Resources – Optionally specify a security file and one or more locale bundles. and the properties of its repository object. 125 .Creating Domains 6. If your data source supports schemas. it remains unchanged. you will select schemas when you launch the Domain Designer.” on page 126.1 The Data and Design Page The Data and Design page of the Add New Domain and Edit Domain dialogs lets you specify the mandatory components of a Domain. Both contain JDBC data sources that can be use for a Domain. JasperServer locates Domains by their repository object type.3 Using the Add New Domain Dialog The dialogs entitled Add New Domain and Edit Domain are identical and are used to define all the components of a Domain. but you may use any location. as well as set its repository object properties. click the page name at the top of the dialog or the Next and Back buttons at the bottom. The mandatory components of a Domain are: A data source selected from the repository A Domain design created interactively with the Domain Designer or uploaded from a file Figure 6-10 Data and Design Page of the Add New Domain Dialog Data Source heading: You may use only data sources that are in the repository and to which your user has access privileges. “Domain Validation. Domains may only have JDBC-based data sources. a design or valid design file. The location for Domains in the sample data is the Organization > Domains folder. Click Browse to open a dialog that lets you choose from among all the data sources in your organization.3. To navigate between pages. 6.3. The Cancel button exits the dialog without saving any of your Domain settings. not by their location. The Save button validates your Domain components then saves the Domain. enter a display name and specify a location in the repository by typing or clicking Browse. If you installed the sample data. There are two pages: Data and Design – Specify the domain’s data source. The default location is the last folder selected in the repository. its domain design. such as an Oracle RDBMS. For more information. You must specify at least a data source. For new Domains. there are sample data sources in Organization > Data Sources and Organization > Analysis Components > Analysis Data Sources. no Domain is created. see section 6.

Make the necessary changes to your settings and save again.3 Domain Validation The validation of a Domain ensures that all of its components are consistent among each other. In special cases where you need to create a design before the data source is available. See the JasperServer Administrator Guide. 4.4.” on page 139. “The Domain Design File. The first four steps are the same as in section 6. click Launch Domain Designer to open the interactive Domain Designer dialog. click in the text field or Browse to specify a design file to upload.” on page 139.JasperServer User Guide The description field is optional but recommended. You can use this page to add.1. the Add New Domain dialog remains open and a message appears to help you correct the error. replace. 5. Figure 6-11 Resources Page of the Add New Domain Dialog The Resources page is documented in section 7. 126 . You can then edit your design in the Domain Designer again or upload another file to replace the current design. The description is displayed with the Domain in the repository and when users are selecting a Domain to create an Ad Hoc report. If a security file has been uploaded. or remove any previously uploaded files for your Domain. verify that all items and sets in the security file exist in the Domain design.2 The Resources Page The Resources page of the Add New Domain and Edit Domain dialogs lets you upload security and locale bundle files for your Domain. When you click Save. If validation fails. Verify that the tables and columns of the Domain design exist in the data source. the Add New Domain or Edit Domain dialog performs the following validation. The Add New Domain dialog checks the syntax of files when they are uploaded.3. Verify that all items reference existing columns. If the settings are in the uploaded files. After using the Domain Designer or uploading a design file.1. In each defined set. you need to edit the files and upload them again. 6. Design heading: On the Edit tab. this step can be omitted by setting a parameter in the JasperServer configuration file.10. 2. both tabs indicate that a design has been created. but overall consistency must be checked when saving the new or edited Domain.3. Verify that derived tables have valid SQL queries. For more information. 6. “Domain Design Validation.” on page 134: 1. see section 7. On the Upload tab. verify that all items originate in the same join tree. “The Domain Design File. 3.

Same as clicking Cancel at the bottom of the dialog.4. Once you have selected the tables on the first tab. either directly or indirectly. 6. To be precise. Export Bundle Stub – Exports a Java properties file for the labels and descriptions of sets and items in your design. you may jump to any tab. or if you access synonyms on an Oracle database. The Cancel button exits the dialog without saving any of your design settings. replacing any current design.” on page 161. see section 6. you will be prompted to choose one or more schemas. For more information. you select the tables that need to be joined.” on page 134.10. “Domain Design Validation. you need to configure JasperServer to recognize them. “Domain Design Validation. It gives you the option of automatically generating keys based on the set and item IDs. Along the top of the Domain Designer are tabs for various aspects of the design: Tables – Select all tables whose columns you wish to use in the Domain. and the Tables tab will present all tables and columns found in those schemas. when modifying an existing design. If your data source has special data types such as CLOB or NVARCHAR2. Derived Tables – Enter queries whose results appear as derived tables available in the Domain.4 Using the Domain Designer The Domain Designer is an interactive dialog for specifying all the settings in the design of a Domain.5.1. Joins – Define inner and outer joins between all the tables and derived tables. For new Domains.” on page 139. Same as clicking Done at the bottom of the dialog. Exporting the XML from the Domain Designer avoids having to write it from scratch. Display – Give display properties to various tables and columns to expose them sets and items in the Domain. Typically. Filters – Specify conditions on field values to limit the data accessed through the Domain. such as an Oracle RDBMS. select all tables you wish to reference in your Domain design. no design is saved. the Tables tab shows all columns that have a supported type listed on page 143. Cancel – Closes the dialog without saving your Domain design and returns to the Data and Design page. The Done button validates your design then saves it in the Domain. “The Domain Design File. Check Design – Validates the domain as described in section 6. 127 . select the tables containing columns that you will use in a derived table or calculated field. Use this feature if you wish to edit your Domain design in an external editor. 6. Calculated Fields – Enter expressions whose results appear as calculated fields. Done – Saves your current selections as the Domain design and returns to the Data and Design page. it remains unchanged. even if their columns will not appear directly in the Domain. therefore you must understand the logical design of tables in your data source. For data bases that support schemas. but you cannot save your settings until you make a selection on the Display tab. regardless of which tab is selected. For more information.1 Designer Tool Bar The tool bar buttons operate on the Domain design in its current state. see section 7. Additionally. see section 7. click the tab name at the top of the dialog or the Next and Back buttons at the bottom.4. To navigate between tabs.4.10.4. for example to duplicate settings with copy-paste or to enter a complex formula. Use this button to create a template for your locale bundles after you have defined your sets and items on the Display tab. See the configuration chapter in the JasperServer Administrator Guide.Creating Domains 6. “Locale Bundles. For example.2 Tables Tab The Tables tab presents all the tables and columns found in the chosen data source so you can select the ones to appear in the Domain. For more information.” on page 134. Export Design to XML – Exports the Domain design in its current state to an XML file.

To change the data source and alias. you must add all new columns together by moving their table name to the right-hand list. However. otherwise the Domain will have a validation error. double-click it or drag it out of the Selected tables list. 6. if you had selected the dropped columns for display. you are prompted to remove them from the right-hand list. The Tables tab does not detect changes to your database tables and columns in real-time. all of your settings in the Domain Designer that do not have an are discarded. only whole tables may be selected on this tab. Click OK to apply your changes. [ Figure 6-12 Manage Data Source Dialog of the Tables Tab You can edit the alias by double-clicking the alias name and typing a new alias. selecting it has no effect. all previous settings in the Domain Designer that do not conform to the new data source will be lost without prompting. You can also click the doublearrow button to clear the list of Selected tables. single-click a table name and use the arrow button between the list. Alternatively. click Delete to remove the current one. To update a Domain after making changes to your database structure.” on page 136. or click Cancel to return to the Tables Tab without changing the data source. Double-click or drag a table name in the Choose tables list to move it to the Selected tables list. Because the Tables tab selects entire tables. If your data source supports schemas. To remove a table you do not want. click Done to close the Domain Designer. the Domain Designer removes those columns or tables from the Tables tab. For deleted tables and columns that were selected in the Domain.3 Manage Data Source Domains assign aliases to data sources. When you change the data source. then launch it again: New tables and new columns appear in left-hand list. the generated joins will appear on the Join tab.5. The default alias for a data source is the display name of its repository object. 128 . click Select Schemas to choose among all available schemas in the data source. The Data Source field at the top shows the name of the data source for your Domain. and the Manage Data Source dialog available on the Tables tab lets you set aliases as well as change the data source. if your database changes servers. “Maintaining Referential Integrity. such as an Oracle RDBMS.JasperServer User Guide Click the tree icons beside the table names to inspect the columns of a table. Usually this is not necessary because the data source alias is not displayed to Domain users. The Replace button lets you select a different data source to be associated with the alias. If you change the data source. However. The Inspect new tables and automatically generate joins check box creates joins only if your database has been configured with referential constraints (foreign keys). All the tables in the schemas you choose will appear in the left-hand list on the Tables tab. then click Add to open a dialog to select an available data source from the repository. Use this button to replace the data source with an equivalent one. Otherwise.4. you must manually remove them from the Display tab. If applicable. new columns appear under their table name. you need to create a new data source objet and use it to replace the previous one in your Domain. column-level selections are made on the Display tab.1. For example. When you accept. see section 6. Click Manage to change the chosen data source. For information about removing columns that were displayed through the Domain.

In some cases. When your query is complete. the other to choose the right table. A distinctive icon identifies it as a derived table. a table with data for support cases has a column for the assigned engineer user ID that can be joined with the table of user data that has a user ID column. Once a derived table is defined. click Run to test it and see the list of columns in the result. The result will contain all rows from both tables. For example. Type a name for your table in the Query ID field.). The copy appears in both lists. In order to create a join between two tables. Delete Selected Table – Removes the table from both lists. removing it on the Joins tab also removes it from the list of selected tables on the Tables tab. the WHERE clause may contain conditions that determine the rows of the derived table. but don’t click them. all columns in the result are selected. it is easier to specify the column names in the SELECT clause of the query.1. Click the following icons above the left-hand list to make copies of a table: Copy Table – Copies the selected table and gives it a name with sequential numbering. select a column in each table with the same logical meaning and compatible formats. In this example. 129 . 6. The syntax for a valid SQL query does not include a closing semi-colon (. If you only want a few columns out of many. all based on equality between values in each column: Join Inner – The result will contain only rows where the values in the chosen columns are equal. JasperServer supports the four most common join types. Multiple joins associate columns across many tables to create powerful data visualizations when used in reports. Join Right Outer – The result will contain all the rows of the right-hand table. The new join appears below in the list of joins. then click one of the join icons. You can also duplicate a table so it may be joined with different tables for different uses. the result of a left outer join will contain all support cases even if they do not have an assigned engineer. it can only be selected by editing an existing join. paired with a row of the left-hand table when the values in the chosen columns are equal. Click New to begin defining a derived table.5 Joins Tab Joins create associations between tables so that their rows may be presented together in the same report. each must have a column with the same meaning. the columns selected from the result are available for use in the Domain design.4 Derived Tables Tab A derived table in a Domain is defined by a custom query and a selection of the columns in the result.1. Your query may refer to any table or column available in the data source shown.4. Enter a valid SQL (JDBC) query in the Query field. a user might also appear several times if different support cases refer to the same support engineer user ID. the list of selected and derived tables is duplicated in two lists.” on page 116. paired with a row of the right-hand table when the values in the chosen columns are equal and with blanks otherwise. Full Outer Join – This join type cannot be created directly. For example. if any. Because Domains are based on JDBC data sources. the result of an inner join will contain only support cases that have been assigned to a support engineer.Creating Domains 6. the query is written in SQL. Expand the tree icons of the tables in the left-hand list to view column names you may wish to use. one to choose the left table. and is updated everywhere it appears in the Domain Designer. If the deleted table was the only instance of a table. On the Joins tab. By default. Click Create to add the derived table with the current selection of columns to the left-hand list of tables and columns. The number of tables and joins in your Domain depends on your business needs. the result of a right outer join will contain all the users and the support case assigned to each. or in order to join it to itself. In the support case example above. paired when the joined columns are equal. If the users are in the right-hand table of the example.4. Expand a table in each list. “Domain Use Cases. The new name becomes the ID of the table throughout the Domain. as described in section 6. Change Table ID – Lets you edit the name of the selected table. Use control-click to change the selection. If the support cases are in the left-hand table of the example. Join Left Outer – The result will contain all the rows of the left-hand table. you may need to duplicate a table in order to join it several times without creating a circular join. The result of an SQL query is a table whose structure and contents are determined by the clauses in the query. and with blanks otherwise. and filled with blanks otherwise.

there will be two join trees. use the indications of the error message to help correct the expression. 6. B and C. Figure 6-13 Calculated Fields Editor in the Domain Designer Click OK to save your new calculated field. because the calculated fields editor does not validate expressions as they are written. you can change the join type by selecting another type in the drop-down list. all columns that appear in the expression for a calculated field must be from the same join tree. When you select a join on either tab. This list include the Full Outer join type that cannot be created directly. you can later give it a descriptive label and full description. then join tables D and E. Once validated. In order for the values to be coherent. Calculated fields have a distinctive icon for easy recognition in the list of columns. The expression uses the Domain Expression Language fully described in section 7.” on page 150. The Domain Designer validates the expression and warns you of any errors at this time. If there are errors.JasperServer User Guide Below the lists of left and right tables. Therefore. qualified by its table name. Enter a short name for your calculated field. click Cancel. Tables that are not joined appear individually along with the join trees. “The DomEL Syntax.2. To insert a reference to the value of another column. 130 . The result of the Joins tab is a number of join trees that appear on subsequent tabs. if you join tables A and B. their columns may not be compared or appear in the same report. you need to be familiar with the datatypes of the various columns in your data source. This name becomes the ID of the field in the Domain. the All Joins tab summarizes the joins you have defined. Do not insert column reference from unjoined trees. For most expressions this is also the datatype of the columns you wish to use in the expression. Delete Join – Removes the selected join definition from the list of joins and from the Domain design. use the Joins on Selected Table tab to see only those defined on the table currently selected in the left-hand list. To clear the calculated field editor without saving.4. a calculated field appears in the table or join tree whose columns are used in the expression. Tables A and D are said to be unjoined. Enter the expression to compute the value of your calculated field. If you have many joins in your domain. For example.6 Calculated Fields Tab A calculated field is defined by an expression that computes a value based on the values of other columns. expand the join-tree to find its table and double-click the column name. The expression you write must compute a value of this type. Click Create Field to being defining a new calculated field. Columns of table A and table C may appear in the same report because their tables belong to the same join tree. The column name appears in the expression at the cursor. Select a datatype for your calculated field.

then click Create Condition. financial reports for the current fiscal year may need data from the previous fiscal year for comparison. or delete the definition of a calculated field. the condition editor will display two calendar icons for specifying a date range. Modify its name. then click OK to save the new definition. Alternatively. reports based directly on the Domain can define their own filters. so that users understand what data is accessible through the Domain.Creating Domains An expression that does not use any columns will have a constant value. select the second column with a Control-click. cancel any input in the calculated field editor. you can click the arrow next to the column name or double-click the column name. If you only wanted to view the definition of the field. double-click the available values to select them. For multiple value matching. If there are more than 50 values to display. use the search controls to the left and click to narrow your list of available values. This button will only be enabled when two columns of the same type are selected. Figure 6-14 Condition Editor on the Filters Tab of the Domain Designer Text columns have both substring comparison operators such as “starts with” or “contains” and whole string matching such as “equals” or “is one of. For example. the dialog displays a list of all existing values for the chosen column retrieved in real-time from your database. in which case it doesn’t make sense for the column to appear in a report. if you select a date column with the “is between” operator. To define a filter that compares two columns of the same datatype. However. edit. To view. you might create an integer field named Count that has the value 1 and later has a default summary function to count all occurrences. For example. 131 . Select a column in the left-hand list and click Create Condition to begin defining a filter on that column. you may filter data to select a single country. Double-click the calculated field name to insert a reference to it into an expression. Calculated fields may be used to compute other calculated fields. The filter value depends on the datatype and the comparison operator. The filter will still be active and only data that satisfies all defined filters will appear to report users.” When you select a whole string matching operator. You may define a filter on a column that you do not plan to expose in the Domain. 6. its type. For example. Constant fields are independent of join trees and automatically appear in a set called Constants. then click the name of the field in the left-hand list.7 Filters Tab A filter on one or more columns reduces data that is not needed or not wanted in reports based on the Domain. For example. or its expression.4. string types offer a choice of string search operators and date types have a choice of time comparison operators. You may perform multiple searches and select values from each list of results. you should clearly document such data restrictions in the description of your Domain. It is always good practice to filter out irrelevant data to reduce the size of query results and processing time within JasperServer. In the Condition Editor. Also. click Cancel to remove it from the editor. For example. the choice of comparison operators depends on the datatype of the column. Click Delete Field to remove the calculated field from your Domain design. but nothing earlier. Putting often-used filters in the Domain design avoids the need for each user to define them independently and also reduces the chance for errors.

Click a row of Current Conditions to edit it again in the Condition Editor. it creates a subset. Add New Set – Creates a new set or subset in the list of sets and items. and the columns they contain are created as items within the sets. double-click the join tree name or drag-and-drop it to the list of sets and items. If you only want to display a few of the columns from the join tree. Use carefully. you may create a list of items outside of any sets. The table list displays the list of unjoined tables and derived tables. all items in a set must correspond to columns in the same join tree. You can also expand sets in the right-hand list and drag-and-drop tables and columns to the destination set. Then remove any unwanted sets or items individually from the right-hand list as follows: Delete (above Sets and Items) – Removes the selected set or item from the left-hand list. Change Table ID – Lets you edit the name of the selected table. but when creating a report. Then add items chosen among the columns of the left-hand join tree. 132 . and is updated everywhere it appears in the Domain Designer. such as a label and description.8 Display Tab The Display tab lets you specify which columns and calculated fields are exposed through the Domain and how they will appear. and columns are added as items outside of any set. The new name becomes the ID of the table throughout the Domain. you also define display properties for each chosen column. After selecting a row. click OK to define your filter. The table is removed from the Joins tab. to further help report creators. you may also click the Delete Condition button to remove it from the list. click Cancel. You can also drag-and-drop tables and columns from the join tree to the list of sets and items. A set is a grouping of items independent of the tables in which the columns originate. It also activates the following icons: Add All (active only if the right-hand list is empty) – Creates all the tables as sets and all the columns they contain as items in the right-hand list. Change Label – Lets you edit the name of the selected set or item. Add Selected – Make a selection in the join tree and click this icon: tables are added as sets. If you want to display all or most of your tables and columns in the join tree. however.JasperServer User Guide After choosing the comparison operator and filter value. start by creating sets in the right-hand list. On the Display tab. Add to Set – Select a destination set in the right-hand list. and columns are added as items within the destination set. including any calculated fields in their defined locations. The left-hand list also offers an alternative view mode: click Table List just below the icons. The list of Current Conditions shows all the filters you have defined. 6. The label name is also updated in the list of properties. Delete Selected (above Table List) – Removes the currently selected table from the left-hand list and from the Domain altogether. the overall filter applied to your data is the logical AND of all conditions you have defined. Typically. Removed items automatically reappear in the join tree or table where they originated in the left-hand list. You may include any combination of joined and unjoined items in the list of Sets and Items. To clear the condition editor without saving a filter. if a set or item within a set is selected.4. Sets are optional. Click OK to save your changes. The list of Sets and Items to the right shows the sets and items that will appear to report creators. only columns that are useful in reports or for further filtering should be selected. If no set is selected it creates a top-level set. All tables are created as sets. and any joins with this table are deleted. You can also double-click the object or drag-and-drop it to a blank area of the join tree list. The Join Tree list at the left of the tab contains all the join trees and unjoined tables. as they appear on the Join tab. The note at the bottom of the current conditions reminds you that “data rows much match all conditions. A column along with its display properties is called an item in the Domain. then make a selection in the join tree and click this icon: tables are added as subsets. users will only be able to include items that originate in the same join tree. and unneeded columns should be omitted to simplify the report creation interface.” In other words. You can then remove any unwanted sets or items from the right-hand list as described above.

To achieve this. and providing descriptions for them: To change the order of sets or items. remove the item or subset and add it again in the new set. 133 .. you should not change any IDs. The internationalization keys are the property names of internationalized strings in locale bundles. renaming them. properties shown in red are read-only. you may change any set or item ID as long as it is unique among all set and item IDs. Table and field IDs are based on the names in the data source. When the left-hand list displays the Table List. although based on table and field IDs by default. to edit the description. When creating a Domain. and default format and summary properties (view and edit) Figure 6-15 Table of Properties on the Display Tab of the Domain Designer Table and field properties appear only when Table List view is enabled. see 6. Data Source Source Table Type Table. All others you can double-click to edit. but items and subsets may not be moved into other sets. depending on the selected object: Table – The name of the table and the name of the data source (view-only) Field (column) – The name of its table in the data source and its Java datatype (view-only) Set – The label. 6. Item Description An identifier used within the Domain. When editing a Domain that has been used to create Topics and reports. Does not change when the ID property of a table is modified. “Maintaining Referential Integrity. subsets. To add a description to a set or item. description. select it then click the Change Label icon or double-click its label in the properties table.4.. select it then double-click its description in the properties table. but you may change the ID of a table as long as it remains unique. Field Set. The display properties determine how the sets and items will appear to users of the Domain. Set and item descriptions appear as tooltips in the Ad Hoc Editor and help report creators understand their purpose.9 The Properties Table The properties table is located on the Display tab to the right of the list of sets and items. the properties of tables and columns can also be viewed. You can reorder items within a set and sets within the list. Set and item IDs are a separate namespace in which each ID must be unique. The following table describes each of the properties in detail.” on page 136. and items is defined.5. Property ID Appears On Table. Java type of the selected field. For sets and items. Subsets always appear after the items in a set.Creating Domains After your list of sets. It lets you view and edit the display properties for the currently selected set or item. description. To rename a set or item. and internationalization keys (view and edit) Item – The label. All table and field properties are read-only. The label and description help report creators understand the data represented by the set or item. The data format and summary properties determine how the item will appear by default in a report. Field Field Alias of the data source for the selected field or table. internationalization keys. refine your Domain display by reordering them. Field Table. For more information. or click . select the objects and use the arrow buttons to the right of the list to move them up or down.1. The following properties are available. Name of the selected table or of the field’s table in the data source.

10 Domain Design Validation The Domain Designer must ensure that all tables and columns are consistent with the data source. Internationalization key for the description property. Default summary function for the item when used in a report.4. “Designer Tool Bar. User-friendly description displayed as tooltip on the label in the Ad Hoc Editor. Item Item Item Summary Item Labels and descriptions may contain any characters.1.” on page 139. Item Description User-friendly name displayed in the Choose Ad Hoc Data wizard and the Ad Hoc Editor.4. 2. For more information about saving and uploading XML. Validation performs the following steps: 1. The generated keys are added to your Domain design and appear in the table of properties. the following buttons in the tool bar can help: Export Design to XML – Lets you edit the properties of your sets and items within an XML file.5. Internationalization key for the label property. When you export the design file. 6. for example ($1. For more information about the internationalization keys. the syntax is Domain_jointree. locale bundles associate this key with the localized text for the set or item description. Validation is important because the Domain design may include derived table queries and calculated field expressions entered by the user. ID Source Data Format Set. For a large number of sets and items.Domain_table. “Locale Bundles.datasource_field. References the Domain names of the table and field associated with this item.” on page 127. “The Domain Design File. This will detect any inconsistencies in Domain designs from uploaded files. If you wish to edit the properties for a large number of sets and items. when navigating from tab to tab. See the JasperServer Administrator Guide. Items with string values do not have a data format. Item Set. The description helps the report creator understand the data represented by this set or item. see section 7. verify that all items originate in the same join tree. If you change the data source.” on page 161. all others let you count distinct values or count all values. 134 . When you click the Validate tool bar icon. This will detect problems on the tab where they occur. locale bundles associate this key with the localized text for the set or item label. See section 6. Make sure your set and item IDs are finalized because they are used to generate the keys. In each defined set. In special cases where the design is created before the data source is complete. When you click Done to exit the Domain Designer. this step can be omitted by setting a parameter in the JasperServer configuration file. Item Set. this could be faster than using the properties table on the Display tab. Verify that all tables and columns exist in the data source. but the ID property value must be alphanumeric and not start with a digit. Label ID Descr. The data format is a numerical or date format. see section 7.1. In certain cases. Validation occurs at the following times: When opening the Domain Designer.JasperServer User Guide Property Label Description Appears On Set. Export Bundle Stub – Generates the internationalization keys if needed and saves them to a file that serves as a template for your locale bundles.234) or 01/01/2009. Numerical items have functions such as sum or average. Default data format for the item when used in a report.

4. If you change to a data source with a different database.4. there is no message when validation succeeds. Changing the data source only makes sense in certain cases.” on page 127. Under the Data Source heading. 3. typically by setting the Domain filter. To change the location of a Domain. “The Domain Design File. If you wish to add or replace the security file or locale bundles for the Domain.” on page 139. Verify that all items reference existing columns. .Creating Domains 3.” on page 125. for example if your data source definition changes slightly but not the underlying database. “Maintaining Referential Integrity. 135 7. 6. Browse or search the repository to locate the Domain. This allows you to reimport the XML file of your Domain design after exporting it and making modifications in an external editor. Figure 6-16 Data and Design Page of the Edit Domain Dialog 4. To edit a Domain: 1. For instructions. select the Edit tab and click Launch Domain Designer. a message appears when validation fails to help you correct the error.” on page 136. Log in to JasperServer as an administrator and select View > Repository. you can change the display name or description of the Domain’s repository object. See also “Maintaining Referential Integrity” below if you need to remove items in your Domain. Under the Properties heading. use the repository manager to move the Domain object to a different folder. Before you proceed. The Resources page is further documented in section 7.5 Editing a Domain Use extreme caution when editing Domains that might have been used for reports and Domain Topics. You can edit a Domain by changing. “Using the Add New Domain Dialog. and click Browse to locate a Domain design file.1. click the path or click Browse to change the data source for your Domain. The Domain appears in the Edit Domain dialog. they will certainly fail if the underlying Domain is deleted.3. see section 6. A Domain specifies the data source for the Domain Topics and reports that are based on the Domain. 2. Alternatively. adding to. This dialog is identical to the Add New Domain dialog documented in section 6. 5. Under the Design heading. and deleting its components. 6.5. Unless you clicked the Validate tool bar icon. click Next or Resources.1. the definitions in your Domain design will no longer be valid and you will not be able to save the Domain. select the Upload tab. However. Verify that derived tables have valid SQL queries. see section 6. Right-click an existing Domain and select Edit from the context-menu. “Using the Domain Designer. They might fail if the underlying Domain is edited.

When deleting Domain items in a case like this. the sets and items referenced in the Domain must still exist in the Domain. some users were confused by the additional items and used the date_modified item in their reports.” on page 117. an administrator or data analyst creates a Domain and many end-users create Topics and reports based on it. you must clear your Ad Hoc cache of all queries based on the Domain. it does not fix the broken reports based on the items deleted from the Domain Topic. However. In a typical scenario.5.4. there is inevitably a report that is not updated. This will remove any data that was based on the old instance of your Domain and avoid inconsistencies in new reports. however. 6. nor can it be opened in the Ad Hoc Editor again. Domain items are identified by their IDs and the IDs of the sets in which they are located. the solution for maintaining referential integrity is to avoid deleting items from a Domain if they might be in use. 136 . It may also occur if the underlying database changes so that the item is no longer valid.” on page 133). The following procedure explains how to fix referential integrity with placeholder items. click Cancel. Changing the ID of an item or moving it to a different set will also make it unavailable to any Topics and reports that referenced the ID. JasperServer provides a mechanism to replace the deleted item with a placeholder. 6. This means that changes to sets and items that are not used in a given report or Topic do not affect the report or Topic.1 Maintaining Referential Integrity When editing an existing Domain. Instead. not its ID (see section 6. Sometimes. You can.9. if you delete an item used by Topic A but not Topic B. Unfortunately. To close the dialog without modifying the Domain stored in the repository. that only allows new reports to use the Domain Topic. 9. A Domain Topic that references a deleted item will cause errors when used in the Ad Hoc Editor. Referential integrity means that at the time a Domain Topic or report is opened or run. After modifying a Domain. and the user will require support to fix the broken report. edit its label property. If you modify a Domain by removing sets or items. For instructions. all the items that it references are still defined in the Domain. click Save to update the Domain with your changes. as are any reports based on Topic A that did not include the deleted item. However. the creator accidentally exposed the accounts_opportunities table that contains no useful columns and is necessary only to join the accounts and opportunities tables.JasperServer User Guide 8. The granularity of referential integrity is at the individual set and item level. To change the name of an item or set. you must be sure that no Domain Topics or reports are based on that item. so that each may modify his or her reports that use the item. The Domain in this example is similar to the one in section 6.5. “Example of Creating a Domain. When done. “The Properties Table. even after the original item has been removed.2 Fixing Referential Integrity Normally. it is necessary to communicate with users beforehand. it becomes necessary to remove an item or set from a Domain. open a Domain Topic for editing and remove references to deleted items. then Topic A will fail and reports based on Topic A that included the item will fail. But Topic B and its reports are unaffected. 1. Even if the underlying tables and columns still exist in the database. allowing the user to open the report and edit it. For example.2. Any report that references a deleted item will no longer run. However. it is up to the user to maintain the referential integrity between the items in the Domain and any Domain Topics or reports that have been created from the Domain. Moving an item must be treated as deleting it from its current location so it can be added elsewhere. see the JasperServer Administrator Guide. This may occur if it was erroneously included in the first place and found to expose data that should not be exposed.

From the dialog. the set was deleted along with the item.2. Now click the Display tab of the Domain Designer. The dialog shows all the items that are deleted and the information necessary to replace them with placeholders. In this example. Figure 6-17 also shows the warning dialog about referential integrity. the set and items IDs as a path. so we must create a placeholder set as well. Since the value of the column is not important. A calculated field is essentially a custom column of a userselected type. the placeholder item must exist in exactly the same path of nested sets as the original item. and that is what we need to create a placeholder. in this case a timestamp. the dialog lists the item label. and was of the type java. we create a constant value that will be recognized as a placeholder should it actually appear in a report. The most important setting is the type. In general. We use the ZZ prefix on the name to distinguish it from other meaningful columns in the Domain. “Datatypes. which must match the type of the item that this placeholder will replace. Placeholder items must be located in placeholder sets that mimic the same structure as the original item that was deleted.sql. 3. We remove the accounts_opportunities set and all its items by selecting it and clicking the Delete icon . 137 .1. Click the Calculated Fields tab of the Domain Designer. Figure 6-18 Creating a Calculated Field of the Same Type 4. see section 7. For the syntax of calculated field types.” on page 151. Click Create Field and enter values as shown in Figure 6-18. and the data type of the item.Creating Domains Figure 6-17 below shows the Domain open in the Display tab of the Domain Designer. Then we enter an expression that gives a constant value of the same type. For each deleted item. Figure 6-17 Deleting Items From an Existing Domain 2.Timestamp. we learn that the date_modified item that we need to replace had the ID date_modified1 in a set with the ID accounts_opportunities.

using the values shown in Figure 6-20 above. Conceptually.4. see section 7. then enter the ID value of date_modified1. Now select the new item created above and double-click its ID property.JasperServer User Guide Click the Add New Set icon to create the placeholder set. “Uploading a Design File to a Domain. then enter the ID value of accounts_opportunities that we noted in step 2.1.3. Figure 6-20 Setting the ID Properties to Match the Deleted Item 6. Now we edit the properties of the placeholder set and item so that they will effectively replace the deleted item. and replace it with an item that references the placeholder field. 3. ensuring that the report can be opened and run. Alternatively. Instead of deleting the item. For more information. Click Done in the Domain Designer and then Save in the Edit Domain dialog. but the order is slightly different: 1. Figure 6-20 shows the properties for the placeholder item and set after they have been modified. We set the label and description to distinguish the placeholders from real items and discourage their use when seen by users in the Ad Hoc Editor.3.1.” on page 147. This will remove the reference to the unwanted column.” on page 141. Update the other properties of the item and its enclosing set. as described in section 7.6. as described in section 7. Save the design file and upload it. Click the Add to Set icon to create the placeholder item from the calculated field. Select the placeholder set created above and double-click its ID property. 138 .1. first create the constant calculated field.” on page 150. Then locate the item definition and change its resourceID so that it references the newly created calculated field. You can even do this in the Domain Designer before exporting the design file. “Representing Sets and Items in XML. also noted in step 2. but now that they are identical to those of the deleted item and set. Figure 6-19 Inserting the Calculated Field as a Placeholder 5. Now expand the list of Constants to select ZZdate_modified created above. The IDs are not visible to users. as shown in Figure 6-19. You must be familiar with the design file syntax to create the calculated field with the correct type and expression. 2. 4. you can edit the XML design file of a Domain to fix referential integrity. the modifications are the same as described in this procedure. the placeholder will be substituted in reports and in the Ad Hoc Editor. “Structure of the Design File.

1. field. This chapter contains the following sections: The Domain Design File The DomEL Syntax Resources of a Domain The Domain Security File Locale Bundles 7. In addition. see section 6. Both take effect in the Ad Hoc Editor when creating the report and in the final output when running the report. When implemented. In addition. the Domain design can be created interactively through the Domain Designer dialog. This chapter documents the syntax for each of these files and the considerations necessary when writing or modifying their contents.” on page 116. The XML file is only a representation from which the design can be inferred. and item as used in Domains. The elements and attributes are defined by an XML schema provided in an XSD file. In JasperServer.2. This gives Domain creators an alternative way to specify the design and allows Domains to be shared between systems. as long as it conforms to the XML schema and the design constraints. joins. any derived tables. Data security and localized strings are defined in external files that Domain creators must upload to the Domain. A design file can be modified or written from scratch in an editor and uploaded to JasperServer. The text file containing a Domain design represented in XML is called a design file. For a definition of the terms column. there are constraints on a Domain design that are not expressed in the XML schema. “Terminology.1 The Domain Design File The design of a Domain specifies the selection of tables in the data source. calculated fields.Advanced Domain Features 7 ADVANCED DOMAIN FEATURES Both the security file and locale bundle are optional components of a Domain. and filters. There are several common use cases for working with design files: 139 . XML is not the native format of the Domain design. they provide data access permissions and localized strings for reports based on a Domain. A design has additional constraints that are not mapped in the XML format. as well as how those elements will appear to users. however there is also an XML file format for exporting and uploading the settings. the Domain design itself can be exported to an XML file and edited outside of JasperServer. We start with the Domain design file because the security file and locale bundles rely on certain values it contains. The XML in a design file is a hierarchy of elements and attributes on those elements that specifies all the settings in the Domain.

2 Working With a Design File The relationship between item definitions. Your browser will download the XML file and usually give you the choice of viewing or saving the file. Other elements of the XML file will appear on some or all of the Designer tabs. 140 . but editing the labels and descriptions of dozens of items is faster when they appear in a single design file. In order to be usable when uploaded to a Domain. This means that all syntax. Repetitive changes to an existing Domain design. For example. It must be valid with regards to the XML schema. you may need to edit each table or item in the design in the same way. and used to define the design of a new or existing Domain. 4. Browse or search the repository to locate the Domain. The file will contain the current state of the Domain in the Domain Designer. The Domain Designer opens to the Tables tab. The Domain Designer makes it easy to select all tables and columns and expose them as sets and items. The XML schema of a Domain design is given in the XSD file is located in: <install-dir>/samples/domain-xsd/schema_1_0. click the Export Design to XML icon . If errors are found.4. attributes and content. After editing. select a location and give it a name. These are constraints that cannot be expressed in the XSD file because they are outside the scope of an XML schema. For more information. To save the design file.1. and it is often more convenient to copy-paste them between external files. a design file can be uploaded. The Domain appears in the Data and Design page of the Edit Domain dialog. then export the design file and add your handwritten code to the exported file. you can cancel the export.1 Exporting the Design File from a Domain The design file of a Domain can be exported from the Domain Designer dialog and saved as an XML file. Use the Domain Designer to define as much of the design as possible. 6. your modifications will appear and be editable in the Designer. Right-click an existing Domain and select Edit from the context-menu. However. and you will be able to edit it again the Designer.10. This ensures that the elements and attributes are the same ones with the same meaning used by JasperServer. In the tool bar at the upper-right of the dialog. If your database changes or you want to move a design file to a different system. 5.xml suffix. Log in to JasperServer as an administrator and select View > Repository.xsd The design file must be internally consistent and define all the necessary elements of a Domain design. Working with very large Domains. For example. The tabs of the designer show you the design settings for this Domain that will be exported to XML. “Domain Design Validation. you can enter the SQL query for a derived table or complex expressions for a calculated field.1. a design file must meet the following conditions: It must be well-formed XML. JasperServer validates the design before exporting the XML file. a description you added in the XML design file will appear in the Properties table of the Display Tab. click Launch Domain Designer.” on page 134. see section 6. and actual database columns is the essence of the Domain itself and must be maintained when editing the design file. Creating locale bundles and security files as described in the other sections of this chapter. On the Edit tab under the Design heading. These other resource files refer to elements of the Domain design. To export a Domain’s design file: 1. validated. typically by setting the Domain filter. 3. Creating a Domain design from scratch. due to the complexity of creating a valid design file. Using search-and-replace on an external editor will do this quickly. 7. When you open the design in the Domain Designer again. 2. spelling and punctuation is correct so that the file contains a hierarchy of elements. It is possible to write a valid XML file that meets the constraints of JasperServer and defines a Domain design. Be sure to keep the . column definitions. The XML schema defines element and attribute names that are allowed and how they are nested to create a hierarchical structure. 7. it is much easier to begin with a basic design file exported from the Domain Designer or to modify an existing design file.JasperServer User Guide Completing the elements of a new design.

editing. If you want to make structural changes or write a design file from scratch. in which case you must not open the uploaded design file in the Domain Designer. The design must references valid table and column names in the data source. see http://www. </itemGroups> <items>. and uploading. “Example of Creating a Domain. The xmlns attribute specifies an XML namespace for all element names. so you don’t introduce other errors. </items> <resources>. For example. a design file is plain text and can be edited in any text editor. Expressions for filters and calculated fields must be valid programmatic expressions in a local format called Domain Expression Language (DomEL). in a design file. the Domain Designer cannot read some valid designs.2.. this type of XML editor lets you insert elements and attributes only in the places they are allowed to ensure that the design file is valid. in particular. When exported from the Domain Designer. The XML is only a representation from which the design can be inferred. and the columns in the results must match those declared in the design. a text editor is sufficient. As a result. although some elements have been added to show structures that did not appear in the example. The design of a Domain is stored internally in the repository.com/2007/SL/XMLSchema" version="1. “The DomEL Syntax. JasperServer exports well-formatted XML.” on page 117.Advanced Domain Features The tables and columns in the design must be consistent with their external definition in the data source of the Domain. but it does not correspond to a valid URL. no editor can enforce the internal and external constraints on a design file. and if you only want to make a few changes or simple additions. which affects the security file. Because certain XML elements correspond to objects in the Domain design..org/TR/REC-xml-names. In addition... For editing the content of the design file. The following section explains all of the possible elements and attributes of an XML design file and the various constraints you must maintain on each of them. This is a short-hand description that means the XML elements contain other XML elements that represent the Domain objects.jaspersoft. Furthermore. This string must be unique to Jaspersoft. you may select the columns of a table whereas you can only select whole tables on the Tables tab. and it may have some validity errors that cannot be detected. This format is documented in section 7. items. As a result. and the design must use that column accordingly. 7. the schema element includes the xmlns and version attributes. table names for a design based on an Oracle RDBMS must include the schema name. However.xsd file. the Domain Designer sometimes renames the result of a join (JoinTree_1). For example. As with any XML file. this section refers to XML elements that contain Domain objects such as sets.2. the Domain Designer also has limitations and cannot create some valid designs. The top-level container elements of a design file are schema. These rare cases are documented in the following sections. The sample XML code is taken from the example Domain created in 6. For more information. However. 141 .0" schemaLocation="schema_1_0. the more complex elements of a design file have further constraints: SQL queries for a derived table must be valid with respect to the JDBC driver for the data source.1.. </resources> </schema> schema – The outer-most container element of a design file (originally called the schema file of a Domain).” on page 150. By loading both the XML and XSD files. and resources: <schema xmlns="http://www. a specialized XML editor will ensure that the design file is well-formed. use an XML editor that understands the XML schema in the schema_1_0..w3. itemGroups. The data source also defines the datatype of a column. the tables and columns in the query must exist in the data source.3 Structure of the Design File This section explains each of the XML elements and attributes in a design file and how they relate to the settings in the Domain Designer. Also. a design file is specific to a given data source and will most likely fail when used in a Domain with a different data source.xsd"> <itemGroups>. the Domain resource and the XML may not remain totally synchronized through several cycles of exporting to XML. The version attribute gives the version of the XSD used to create this design file.

.lang.String"/> <field id="name" type="java. respectively. </jdbcTable> <jdbcTable datasourceId="SugarCRMDataSource" tableName="opportunities" id="opportunities"> .String"/> <field id="status" type="java. they must be externally consistent with the data source intended for this Domain.3.sql. not individual columns. Even though the itemGroups appear first in the design file. The resources element contains the jdbcTable and jdbcQuery elements to represent database tables and derived tables. </jdbcTable> <jdbcTable datasourceId="SugarCRMDataSource" tableName="accounts" id="JoinTree_1"> . </jdbcTable> <jdbcTable datasourceId="SugarCRMDataSource" tableName="accounts_opportunities" id="accounts_opportunities"> . tables.String"/> </fieldList> <filterString>status != 'closed'</filterString> <query>select * from cases where cases.String"/> <field id="resolution" type="java.priority=1 and cases.lang..String"/> <field id="id" type="java.deleted=false</query> </jdbcQuery> <jdbcTable datasourceId="SugarCRMDataSource" tableName="users" id="users1"> .. Along with items. joins. Therefore.. 142 .lang. this element is absent. however. Because the elements under resources refer to data base objects. </jdbcTable> </resources> 7.. this element corresponds to all the sets and items defined on the Display tab of the Domain Designer. you can only select entire tables. this section will document the resources first so that design elements are presented in the same order as the tabs of the Domain Designer. The sets and items defined under itemGroups and items must be internally consistent with the tables and columns under resources..String"/> <field id="case_number" type="java.Timestamp"/> <field id="description" type="java.lang. resources – Contains all the definitions of columns. and filters in the design.Integer"/> <field id="date_entered" type="java..lang.. items – Contains all the items that are not within sets.JasperServer User Guide The schemaLocation attribute is often added by XML editors to locate the XSD file. itemGroups and items define what users will see when they create a report based on this Domain.. itemGroups – Contains all the sets and items within sets in the Domain. analogous to their definitions on the corresponding tabs of the Domain Designer.lang. These correspond to the items at the root level of the Display tab.. </jdbcTable> <jdbcTable datasourceId="SugarCRMDataSource" tableName="users" id="users2"> . derived tables.1 Representing Tables in XML In the Domain Designer. When all items are contained in sets. calculated fields. you can specify any subset of columns that you need.. Join trees are represented as a jdbcTable element with additional contents to define the joins.lang.String"/> <field id="assigned_user_id" type="java..1.lang. <filterString>opportunity_type == 'Existing Business'</filterString> </jdbcTable> <jdbcQuery datasourceId="SugarCRMDataSource" id="p1cases"> <fieldList> <field id="account_id" type="java. In the XML design file. <resources> <jdbcTable datasourceId="SugarCRMDataSource" tableName="accounts" id="accounts"> .

2 Representing Derived Tables in XML Derived tables are similar in structure to tables.Timestamp java. You can configure the mapping for proprietary types. You may then export the XML design file with this information and refine your design. this alias must be identical for all tables and derived tables. When the derived table is created in the Domain Designer. as determined from the data source by the JDBC driver. the table name includes the schema name in the form schema_name. 7. If your proprietary type cannot be cast in the specified type.lang. When creating a design file.Float java. the id must be unique within the jdbcTable. Required on jdbcTable elements because it would not make sense to have a table without columns in the Domain design. As in the JDBC model that the data source is based on.Byte java.Double java. but this case is documented separately on page 144. id – Literal name of the column in the query result.sql. each has the same datasourceId and tableName but must be given a different id. Only the columns represented by a field element are available for reference by other elements. Any valid SQL can be used.lang. JasperServer will use this Java type for the field. as determined from the data source by the JDBC driver.lang. In the design file. If you copy a table in order to join it multiple times. you can override any mapping by specifying the type attribute for any given field in the XML design file.Short java.1. it will run the query and generate columns based on the result set. If you have proprietary types in your database.3. but not necessarily within the Domain. All three attributes of jdbcTable are required: datasourceId – Alias that identifies the data source.lang. but it must be identical for all tables and derived tables. the datasourceId will automatically become the alias associated with the data source defined for your Domain.table_name.Date java. fieldList – A required container for the field elements.lang.BigDecimal java. fieldList – A container for field elements.Long java.Advanced Domain Features jdbcTable – Represents a table or a copy of a table in the data source.” on page 128. You could then export the design file containing the generated column list. query – The SQL query sent to the database server. type – The Java type of the column. but they use the jdbcQuery element which contains the query element: jdbcQuery – Represents a derived table that is the result of an SQL query.4.sql.). but not necessarily within the Domain. The alias designates the data source that will be queried. A Domain design must reference all the tables that it needs to access. The columns of a derived table must be among those returned by the query. Any reference to the id of a jdbcTable may also reference the id of a derived table. If you add a derived table in the Domain Designer.Integer java. 143 . The Domain Designer accesses the data source to find the names of all tables and columns. When uploading the file. The jdbcTable element is also used to describe join trees. For a Oracle RDBMS. “Manage Data Source. Both attributes of field are required: id – Literal name of the column in the data source.util. as described in the JasperServer Administrator Guide. field – Represents a column in the results of the query.Boolean java. You must reference all the columns that you use in the Domain.Time java. the set of columns corresponds to the selection of columns in the query result on the Derived Tables tab. this is the data source alias defined in section 6.lang. JasperServer will raise an exception. as well as their types. type – The Java type of the column.String java. regardless of its mapping.lang. this alias may be any name you choose. it is often easier to select and export tables from the Domain Designer. If your query gives an alias to the column in a SELECT AS statement.Character java. The syntax for a valid SQL query does not include a closing semi-colon (.Date Unless you know the name and type of every column in the data source.lang. The id must be unique within the query results.3. as long as the columns in the result match the id and type of all field elements of the derived table given in the fieldList.sql. All the columns that you want to reference in the Domain defined with this element. field – Represents a column of a table in the data source. The type is one of the following: java. Both attributes of jdbcQuery are required: datasourceId – Alias that identifies the data source for the Domain. id – Table ID that is used to reference the table in the Domain design. tableName – Literal name of the table in the data source.math. id – Table ID that is used to reference the derived table in the Domain design. JasperServer may not be able to map its Java type from the JDBC driver. the id is the same as the alias. Alternatively. When created in the Domain Designer.lang.

1.amount. To define the join. this alias must be identical to that for all tables and derived tables. from the result of a join with sorted results.assigned_user_id == users1.exp_date) = c.date) order by e.2. and as_dollars can be exposed as columns of this derived table.id == p1cases. Here are some things to keep in mind when deciding how to implement your Domain: Unlike joins defined in the Domain.currency. datasourceId – Alias that identifies the data source for the Domain..account_id)</joinString> </joinedDataSetRef> <joinedDataSetRef><joinString>join opportunities opportunities on (accounts_opportunities.currency_id = c. Unlike calculated fields in DomEL.3. “The DomEL Syntax. e.3. only exp_date.JasperServer User Guide The following sample query selects some columns.3.String"/> .id == p1cases. each with a prefix on the field id attribute to identify its originating table. For more information. joins within a derived table are not restricted to equality comparisons when uploaded to the Domain Designer.opportunity_id == opportunities.account_id" type="java. there is one jdbcTable representing each join tree and containing only the join expressions for that tree.exp_date </query> A derived table provides an alternative way to create joins and calculated fields.1.account_id)</joinString> </joinedDataSetRef> <joinedDataSetRef><joinString>right outer join users2 users2 on (users2. The Domain Designer automatically exposes all columns of all tables in a join. The alias designates the data source where the join will be performed.currency_id and date(e. including a field calculated in the SQL. <jdbcTable datasourceId="SugarCRMDataSource" id="JoinTree_1" tableName="accounts"> <fieldList> <field id="accounts_opportunities.conversion_ratio as_dollars from expense_fact e join currency c on (e. amount * c. but in the design file you only need to specify those you wish to reference elsewhere in the Domain.lang. If not all tables are joined together.assigned_user_id)</joinString> </joinedDataSetRef> </joinedDataSetList> </jdbcTable> jdbcTable – Represents the results of one or more joins between tables. <query> select e. c. which may be less efficient on some databases than the equivalent query generated for a non-derived table 7. c. It also contains a list of columns that are exposed through the Domain. calculated fields within derived tables may use any function call recognized by the RDBMS. currency.” on page 144.store_id.id)</joinString> </joinedDataSetRef> <joinedDataSetRef><joinString>left outer join p1cases p1cases on (accounts. 144 . amount. The Domain mechanism applies filters.. and joins to derived tables by wrapping the SQL in a nested query. aggregation. In this case. See section 7. e. “Representing Joins in XML. It contains the joinInfo and joinedDataSetList elements to define the actual joins.” on page 150 for restrictions on function calls in calculated fields. store_id.conversion_ratio conv. In the design file. see section 7.3 Representing Joins in XML A join is represented in the design file as a special jdbcTable element. conv.id == accounts_opportunities. </fieldList> <joinInfo alias="accounts" referenceId="accounts"/> <joinedDataSetList> <joinedDataSetRef> <joinString>join accounts_opportunities accounts_opportunities on (accounts. the attributes and elements have a different meaning than for a regular table.exp_date.id)</joinString> </joinedDataSetRef> <joinedDataSetRef><joinString>join users1 users1 on (opportunities.

such as boolean operators and other comparisons. left outer. field – Represents a column in the join tree. you can give the join any name you wish.field_name == right_table_alias. This element and its two attributes are required even if they are identical. or full outer. join expressions other than equality between field values are not supported in the Domain Designer. When you create your own design file.2.Advanced Domain Features id – ID that is used to reference the join results in the Domain design. the design file includes every column in every table of the join. table_alias – Alternative name to use for the table_ID within the join expression. By default.3. but you may supply a true alias in handwritten design files. the alias is the same as the table_ID. 7. The subsequent ones may only reference the table_alias they define and ones that appear in joinString elements before them.field_name Join expressions are actually written in the DomEL syntax to allow more complex expressions. joinedDataSetList – Container for the list of join statements. The first one must contain a join expression between the table_alias it defines and the alias in the joinInfo element. The syntax is table_ID. In the design file. as well as in the join tree. Calculated fields that rely only on columns of the same table appear in jdbcTable for that table. joinString – A string expressing an SQL join statement in the following format: join_type join table_ID table_alias on join_expression Where: join_type – One of right outer. tableName – Literal name of the first table in the join. joinInfo – Gives the table ID and alias for the table given by the tablename attribute. the table name includes the schema name in the form schema_name. the alias is the same as the referenceID. Join expressions with several boolean clauses are not supported in the Domain Design either. alias – Alternative name within the join expression for the table identified in referenceId. where n is a sequential number. By default. The table ID and alias are used as the first table in the join definition. only the columns you wish to reference are needed.table_name. See section 7. but they will be overwritten with equi-joins if you open the design in the Domain Designer. The order of joinedDataSetRef elements is important. you must be careful to use the alias throughout the joinString element that defines the join. table_ID – The ID of a table within the design. type – The Java type of the column. The following example shows the XML for a calculated expression in the accounts table. Inner join is the default if no join type is specified. You can sometimes replace them with filters on tables in the join. 145 . as long as it is unique among all other tables and derived tables. The table of each column is identified by a prefix on the id attribute. Both attributes of field are required: id – Field ID composed of the ID of the table in the design and the literal name of the column in the data source. identical to the type in its table definition. but you may supply a true alias in handwritten design files.” on page 150. However. fieldList – A required container for the field elements in the join tree. In the Domain Designer. If you use a distinct alias. join_expression – Expression that compares the columns on which the join is made. joinedDataSetRef – Container for the join statement. Calculated fields that rely on columns from different tables that are joined appear only in the join tree. “The DomEL Syntax. in the form left_table_alias. each join tree is automatically given the ID JoinTree_n. You can upload a design file with such joins. When created in the Domain Designer. This table name is combined with those in the joinInfo and joinedDataSetList to define the join expressions.field_name.1.4 Representing Calculated Fields in XML Calculated fields are defined as regular columns in a field element with an additional attribute. For an Oracle RDBMS. Because it references only the columns of accounts. it appears in that table and in the join tree. referenceId – Table id of the table within the design whose data source name is given in tableName.

“The DomEL Syntax.field_name.String. and the id has the form jointree_ID. a filter determines which rows when running the report.” on page 150. “The DomEL Syntax.String"/> .. '..2..1. '. query.lang. Other filter expressions are not supported..3. Constant fields are further explained below.” on page 150. for example java.5 Representing Filters in XML Filters are defined as optional filterString elements inside of jdbcTable and jdbcQuery elements..city_and_state" type="java. Because constant fields are not dependent on any column values.If the expression references columns in the same table: a. 3. including how to reference columns.When the expression computes a constant value. they may be used in any join tree and exposed to the user along with the items from any join tree. <field dataSetExpression="concat( billing_address_city.String"/> . In the Domain Designer. Thus. <field dataSetExpression="concat( accounts.2. the id has the form table_ID. b. The format of the id is dependent on how the calculated field appears in the design file: 1. Filters defined in the Domain Designer are limited to conditions on one column or comparisons of two columns.. '.field_name. but they will be overwritten or cause errors if you open the design in the Domain Designer. the field appears only in the join tree of those tables. '..lang.lang.billing_address_city. A special case of a calculated field occurs when the expression does not reference any column names. This type must be compatible with the result of the DomEL expression and among the JDBC-compatible types listed on page 143.When the expression references columns in different tables.JasperServer User Guide <jdbcTable datasourceId="SugarCRMDataSource" id="accounts" tableName="accounts"> <fieldList> . id – User-defined name of the calculated field.The field appears in the table and the id is a simple column name. They impose a condition on any results that will be returned for that table. You can upload a design file with more complex filters.. The syntax for the expression. filterString – Expression which evaluates to true or false when applied to each row of values in the data source. filters.. type – The Java type of the value calculated by the expression. you must treat constant calculated fields in the same way. accounts. constant fields are automatically grouped in a table named Constant and may be used in other calculated fields. with more complex filters created by the conjunction (logical AND) of several conditions. thereby limiting the number of rows returned when accessing the data source. but a filter on a join tree refers to the table_ID. billing_address_state )" id="city_and_state" type="java. The expression refers to columns using their id attribute. 7.The field also appears in a join tree that uses the table. a filter on a table or derived table refers to the simple column name. For example. 2. and the id is a simple column name. is documented in section 7. or join tree. or even as an item. the following filters are defined in the example Domain on page 122: 146 .. </fieldlist> </jdbcTable> . When editing a design file.billing_address_state )" id="accounts. </fieldlist> </jdbcTable> The attributes of the field element have a different meaning when defining a calculated field: dataSetExpression – Expression which calculates a value based on other columns. The field appears in a table named Constant. The full syntax for the expression is documented in section 7. Whereas other settings mainly determine which columns will be available for use in a report.field_name. <jdbcTable datasourceId="SugarCRMDataSource" id="JoinTree_1" tableName="anything"> <fieldList> . The calculated field will always have the same value and is said to be a constant.

. we look at the definitions of sets and items that will be exposed through itemGroups and items elements at the top of the Domain design file. visible to users of the Domain. <item label="outersetitem2" . <items> <item label="innersetitem1" <item label="innersetitem2" </items> </itemGroup> </itemGroups> <items> <item label="outersetitem1" ... labelId – The internationalization key for the label in the Domain’s locale bundles. respectively.. The following example shows two levels of sets. For a description of each possible property.. The attributes of itemGroup are the properties of the set it represents: id – The unique identifier of the set among all set and item IDs. /> ..</query> </jdbcQuery> 7. This attribute is required..4.String"/> </fieldList> <filterString>opportunity_type == 'Existing Business'</filterString> </jdbcTable> <jdbcQuery datasourceId="SugarCRMDataSource" id="p1cases"> <fieldList> .. itemGroup – Represents a set. the Ad Hoc Editor will display the id..lang.1. with items inside each level as well as at the root. see section 6... or both. outside of any set. description – The optional description of the set. </items> </itemGroup> </itemGroups> <items> <item label="outsideitem1" . If the label is missing. <field id="status" type="java. 147 .. “The Properties Table.3. representing its subsets and items.. an items element. <field id="opportunity_type" type="java. <itemGroups> <itemGroup label="outerset" ... /> /> /> itemGroups – A container for itemGroup elements.9.. The itemGroups and items elements are equivalent to the selection of sets and items on the Display tab of the Domain Designer. visible to users as a tooltip on the set name in the Ad Hoc Editor.lang.. /> <item label="outsideitem2" . The itemGroup element may contain an itemGroups element. > <itemGroups> <itemGroup label="innerset" .6 Representing Sets and Items in XML Now that all the table and field IDs have been defined. label – The set’s name.. /> </items> > . descriptionId – The internationalization key for the description in the Domain’s locale bundles..” on page 133.String"/> </fieldList> <filterString>status != 'closed'</filterString> <query>.. They create a hierarchy of sets..Advanced Domain Features <jdbcTable datasourceId="SugarCRMDataSource" id="opportunities" tableName="opportunities"> <fieldList> . subsets and items and hold attributes that define all the properties available on sets and items..

description – The optional description of the item.table_ID. descriptionId – The internationalization key for the description in the Domain’s locale bundles. The following table gives the possible data formats and summary functions based on the column type.00) $#.field_name because the field ID in a join tree includes the table ID. This attribute is required because it defines the connection between what the user sees and the corresponding data in the data source. This attribute is required. the Ad Hoc Editor will display the id.234.234) 3/31/09 Mar 31.##0. 148 .56) ($1. resourceId – A reference to the column on which the item is based.##0.field_ID. When an internationalization key is defined for the label or description. See the table below.##0. visible to users.($#. 2009 Mar 31.(#.” on page 117. defaultMask – A representation of the default data format to use when this item is included in a report. This attribute is required. “Locale Bundles. label – The item’s name.##0.00.234) (1234) -1. the label or description will be replaced with the value given by the key in the local bundle corresponding to the user’s locale.hide medium.##0) short.hide long.00 0 $#. visible as a tooltip on the item name in the Ad Hoc Editor.##0 0 $#. labelId – The internationalization key for the label in the Domain’s locale bundles.medium Not allowed Default Summary Functions Appearance -1.##0. defaultAgg – The name of the default summary function (also called aggregation) to use when this item is included in a report.##0) #.2. When the item refers to a column in a join tree.($#.($#. the resourceID corresponds to jointree_ID. but it has no meaning on a set and is not significant in the design. If the label is missing.hide medium. The possible values for the defaultAgg depend on the type attribute of the column referenced by the resourceId.” on page 161.##0) #.56 -1234 ($1. see section 7.234 -1234 ($1. The possible values for the defaultMask depend on the type attribute of the column referenced by the resourceId. The attributes of item are the properties of the item it represents: id – The unique identifier of the item among all set and item IDs.##0. 2009 March 31. “Example of Creating a Domain. items – A container for item elements. The resourceId has the form table_ID. The appearance columns show the equivalent setting in the properties table of the Display tab: Field Type Integer Default Data Formats Attribute Value #. item – Represents an item. For more information. 2009 23:59:59 Attribute Value Highest Lowest Average Sum DistinctCount Count Appearance Maximum Minimum Average Sum Distinct Count Count All Double Date DistinctCount Count Distinct Count Count All All others The following example shows the use of the itemGroup and item elements to represent the sets and items from section 6.JasperServer User Guide resourceId – A reference to the table on which the set is based.234.5. The design file was exported from the Domain Designer.

opportunities.users1.##0)" defaultAgg="Average" resourceId="JoinTree_1.date_entered"/> <item id="name2" label="Summary" description="Name or summary of case" labelId="" descriptionId="" resourceId="JoinTree_1..p1cases.case_number"/> <item id="date_entered2" label="Date" description="Date case opened" labelId="" descriptionId="" resourceId="JoinTree_1. <itemGroup id="users1" label="Account Rep" description="Primary account representative" labelId="" descriptionId="" resourceId="JoinTree_1"> <items> <item id="first_name" label="First Name" description="Given name" labelId="" descriptionId="" resourceId="JoinTree_1..sales_stage"/> </items> </itemGroup> <itemGroup id="p1cases" label="P1 Case" description="High priority (P1) support case" labelId="" descriptionId="" resourceId="JoinTree_1"> <items> <item id="case_number" label="Case" description="Case number" labelId="" descriptionId="" resourceId="JoinTree_1.lead_source"/> <item id="sales_stage" label="Sales Stage" description="Sales Stage" labelId="" descriptionId="" resourceId="JoinTree_1.p1cases.opportunities.p1cases.name"/> <item id="description2" label="Description" description="Detailed description of the case" labelId="" descriptionId="" resourceId="JoinTree_1.p1cases.last_name"/> </items> </itemGroup> <itemGroup id="opportunities" label="Opportunity" description="Sales opportunity" labelId="" descriptionId="" resourceId="JoinTree_1"> <items> <item id="date_entered1" label="Date" description="Date opportunity opened" labelId="" descriptionId="" defaultMask="short.probability"/> <item id="description1" label="Description" description="Description of opportunity" labelId="" descriptionId="" resourceId="JoinTree_1..first_name"/> <item id="last_name" label="Last Name" description="Surname or family name" labelId="" descriptionId="" resourceId="JoinTree_1.opportunities.users1.p1cases.p1cases.($#.hide" resourceId="JoinTree_1.Advanced Domain Features <itemGroups> .opportunities..amount"/> <item id="probability" label="Probability" description="Chance of closing the contract" labelId="" descriptionId="" resourceId="JoinTree_1.resolution"/> <item id="status" label="Status" description="Current case status" labelId="" descriptionId="" resourceId="JoinTree_1.status"/> </items> </itemGroup> .##0.date_entered"/> <item id="amount" label="Amount" description="Estimated contract Amount" labelId="" descriptionId="" defaultMask="$#.opportunities. </itemGroups> Labels and descriptions may contain any characters.description"/> <item id="lead_source" label="Lead Source" description="Lead Source" labelId="" descriptionId="" resourceId="JoinTree_1. 149 .opportunities.description"/> <item id="resolution" label="Resolution" description="Description of the case resolution" labelId="" descriptionId="" resourceId="JoinTree_1. but the ID property value of both itemGroup and item elements must be alphanumeric and not start with a digit.

you should click Cancel on the Data and Design page so that the uploaded design is not saved. Once the design appears correctly in the Domain Designer. The Domain appears in the Data and Design page of the Edit Domain or Add New Domain dialog. the following features in XML design files are expressed in DomEL: The on and where clauses of derived tables The on clause of join statements Calculated fields Filter expressions in Domains and Domain topics (equivalent to where clauses) Row-level security (see section 7. Select the Upload tab under the Design heading. then click Browse to find and upload your XML design file. To upload an XML design file: 1. you can upload it through the Edit Domain dialog. you can create a new Domain based on a modified file or even on a design file created from scratch.” on page 155) A DomEL expression is a shorthand way of writing a complex query.1. right-click the folder and select Add Resource > Domain from the context menu. For instructions. If you are creating a new Domain. or JasperServer will perform a simpler query and apply the DomEL expressions to the full data set in memory.4 Uploading a Design File to a Domain Once you have modified an XML design file. If you used only supported features in your design file. you must clear your Ad Hoc cache of all queries based on the Domain. see the JasperServer Administrator Guide. 4. the current design is not replaced. When processing a report based on a Domain. Currently. To create a new Domain. If you made a mistake or upload the wrong file. JasperServer interprets DomEL expressions to generate parts of the SQL expression that will perform the desired query. and environment variables. If there are syntax or semantic errors. The Domain Expression Language (DomEL) was created to fulfill this need. 5. To update an existing Domain. Browse or search the repository to locate the Domain. typically by setting the Domain filter. right-click the Domain and select Edit from the context-menu. Alternatively. the augmented SQL with either be passed to the data source. The Domain Designer can have unpredictable results with some XML designs it does not support. If you modified an existing Domain. 6. Log in to JasperServer as an administrator and select View > Repository. Make sure the settings you made in the XML file appear as expected on the various tabs of the Domain Designer. upload it again.2 The DomEL Syntax Various components of Domain need to compute values based on some expression involving constants. you must select a data source before you can proceed. you may make further modifications on any of the tabs. Click Save to update the Domain in the repository. The results of editing a design in the Domain Designer based on inconsistent XML file are unpredictable.4. 150 . If you want to create a new domain. you should make changes to the XML file. “The Domain Security File. This will remove any data that was based on the old instance of your Domain and avoid inconsistencies in new reports. If you cannot resolve the error or inconsistencies. If you intentionally use syntax in your design file that Domain Designer does not support. The design file overwrites any existing design without prompting. You can make changes to the XML file and upload it again until there are no errors. do not launch the Domain Designer after uploading the file. field values. 7. If there are any errors or inconsistencies. JasperServer validates the uploaded XML file. and verify it again. 3.JasperServer User Guide 7. click Cancel on the Data and Design page and start over. verify the uploaded Domain design by selecting the Edit tab and clicking Launch Domain Designer. Depending on the data policy. 7. 2. locate the folder where you want to place it.

2. Even though join expressions may appear in separate joinedDatasetRef elements. ANSI standard date and time.34) (d'2009-01-01':d'2009-12-31') (limit_min:limit_max) 7. However. all references to field values in an expression are based on the IDs given in the Domain design. Within a join expression.).0:12. Join expression table_alias. in which case no table ID is needed. Whole numbers.2. Decimal separator must be a period (. The values in these composite types are not necessarily constant. you must include the table ID.1 Datatypes The following simple datatypes may be declared as constants. Calculated fields can only appear on a table if they refer exclusively to fields of the table. Example of Constant none integer decimal 123 or -123 123. the table ID is not forbidden. 2. the alias declared in each one can be used in any subsequent one. they could be determined by field values: Composite Type set range Description Contains any number of any simple type above. Inclusive range applicable to numbers and dates. and returned as values: Simple Type boolean Description Expressions such as comparison operators return boolean values. used in expressions.2 Field References DomEL expressions are stored in the Domain design and interpreted when JasperServer prepares to run a query to retrieve data from the data source. including fields that are number or date types. but true and false constants are undefined and cannot be used. Example (1. Character string entered with single quotes (').Advanced Domain Features 7. and the Domain Designer sometimes includes it.45 string date timestamp 'hello world' d'2009-03-31' or Date('2009-03-31') ts'2009-03-31 23:59:59' or TimeStamp('2009-03-31 23:59:59') The following composite datatypes may be declared as constants and used with the in set or in range operator. depending on where the expression appears: Appears In Derived table Field Reference table_ID. ANSI standard date. Therefore. 3) ('apples'.45 or -123. Field references have the following format.'oranges') (0:12) or (0.field_name Explanation The SQL query that defines a derived table can refer to any previously defined table or derived table in the Domain. Therefore.) are not supported. Floating point numbers.field_name Calculated field on a table or derived table field_name 151 . other separators such as comma (. tables are given alias names that must be used. double quotes (") are not supported.

Boolean operators. Comparison operators for string.name). 'substring') concat(i. See your vendor documentation for available functions and their syntax.k i == j i != j i < j i <= j i > j i >= j i in ('apples'. To test string equality. numeric. Comparison operators for numeric and date types only.field_name Explanation Calculated fields declared in join trees refer to fields prefixed with their table ID. use i in ('string'). You may also use SQL functions in a DomEL expression under limited circumstances: They must be supported by your database.field_name 7. The SQL context must be appropriate for the functions.2. either within the expression or for the type of the calculated field.. you can use TRIM(person. and date types. 'suffix') contains(k. Parentheses for grouping are not supported. For example. field_name table_ID. subtract equal not equal less than less than or equal greater than greater than or equal in set in range not and or Syntax i * j / k i + j . j. ' and '. Filters that refer to fields in separate tables of the join tree need to use the table ID on each field name. 'prefix') endsWith(j.. Filters that are evaluated within the table or derived table do not need the table ID. divide add. Parentheses are required for not and may be used for grouping. Filter on a table or derived table Filter on a join tree Field Reference table_ID.3 Operators and Functions DomEL provides the following operators. Operator multiply. you cannot use aggregation functions such as COUNT in a calculated field because there is no GROUP BY clause. listed in order of precedence.) Description Comparison operators for strings. Operators higher in this list will be evaluated before operators lower in the list. 152 .JasperServer User Guide Appears In Calculated field on a join tree.'oranges') i in (j:k) not ( i ) i and j and k i or j or k Description Arithmetic operators for numeric types only. . For example. Sets can be of any type. They must follow the convention of comma-separated parameters.name) The type of the return values must be appropriate. DomEL also defines the following operations as functions: Function startsWith endsWith contains concat Syntax startsWith(i. but not TRIM('Jr' FROM person. Ranges must be numeric or date types. Returns the string of all parameters concatenated.

'OR'. they must be logically associated with and or or (currently.first_opened_date in ( Date( '2000-01-01' ) : Date( '2004-12-31' )) and not( s1.5. so if you export a design file. The on clause may also contain other DomEL expressions logically associated with and or or to create a complex join condition (see warning on page 144). 'CA'. The following examples show expressions suitable for filters. The expected return type depends on where the expression appears: Appears In Derived Table Expected Return Type SQL query with boolean expressions Explanation A derived table is defined by an SQL expression that contains DomEL expressions. This first one selects only stores in western states of the US: s1. field values are often compared to constant values such as 'USA'. The join on clause may contain boolean comparisons and the where clause may contain filters. Any number of locale bundles.3 Resources of a Domain The two optional components of a Domain are also called resources because they are defined by uploaded files: A single security file. “Locale Bundles. Filters must be true or false overall. see sections 7. To compute complex arithmetic expressions. Within a join expression. For more information about the syntax of resource files. you may need to define several expressions as separate calculated fields.store_country in ('US'. 'NV') The following filter expression uses a date range: s1.closed ) As shown in these examples. the expression must compute a decimal value. Another way to reduce errors and also support future data changes is to use more general expressions such as: s1. 'United States') 7. a wrong value might go undetected and impact the quality of data in reports based on the Domain. only and is supported in the Domain Designer). but arithmetic expressions that rely on parentheses are not supported. This section describes how to upload and replace Domain resources. The Domain Designer determines values for comparison by accessing the data source.” on page 161. otherwise your expression will cause errors when using the Domain to create a report. the DomEL validation cannot enforce these criteria. the author of the design file must ensure that values used in a DomEL expression exist in the data source. “The Domain Security File. Provide internationalized labels for the sets and items of the Domain design. if the declared type is java. These files are uploaded and managed on the Resources page of the Edit Domain or Add New Domain dialog. For example. Defines row and column-level access to data selected by the Domain. The expression must evaluate to a type that is compatible with the SQL type declared in the Domain Designer or in the design file.store_country in ('USA') and s1.Advanced Domain Features Except for the comma-separated parameter pattern. and then reference them in a simpler expression in another calculated field.4 Return Value DomEL expressions are used in different contexts for different purposes. you can use the values it has found. 153 . Complex expressions are written by grouping any of the operators or functions above.2. You must ensure that any SQL functions meet these criteria. Join expression boolean Calculated field any type Filter boolean 7.lang.store_state in ('WA'.” on page 155 and 7.4. When there are several conditions. Parentheses () may be used for grouping boolean operators. Otherwise. Therefore. the on clause contains a comparison of fields from each table that has a boolean result. 'USA'. both of which are described below.Float.

unlike a local file that is uploaded directly into the Domain. When a security file exists. Click Resources at the top of the page or Next at the bottom. If the file type is not recognized or there is a syntax error. There can only be one security file but any number of locale bundles. Click the Local File or Repository tab and then Browse to select a file or repository object. 7. you must ensure that any updates to the files are compatible with the Domains that reference them. See step 9 to replace an existing security file. A window appears in which you can select the resource. but it will not warn you if you replace it with a different file. When browsing the repository. Figure 7-1 Blank Resources Page in the Add New Domain Dialog 5. typically by setting the Domain filter. The repository manager will warn you if you attempt to delete a resource that is referenced by a Domain. Figure 7-2 Add Security File Dialog 6. the XML file in the repository is referenced by the Domain. For the security file. Right-click an existing Domain and select Edit from the context-menu. When you store resource files in the repository. When selected. Log in to JasperServer as an administrator and select View > Repository. The Domain appears in the Data and Design page of the Edit Domain dialog. JasperServer validates the file to make sure it matches the format of a security file or locale bundle. the Add Security text is disabled. Click OK to upload the file and add it to the list of current resources. 3.JasperServer User Guide To upload or manage a security file and locale bundles for a Domain: 1. select an XML file created explicitly as a security file. you will see only XML files or locale bundle objects in the repository. Resources can be uploaded from local files or from objects in the repository. 154 . 2. Search or browse the repository to locate the Domain. the file is not added to the list of resources and you must select another file or click Cancel. 4. Click Add Security or Add Locale Bundle to upload a security file or locale bundle to the Domain.

Security on columns is defined by permissions on the sets and items of the Domain. corresponding to columns in the data source.and row-level access. Repeat steps 5 through 7 to upload one security file and any number of locale bundles. and uploading the security file as well. Download each of the locale bundles in your Domain. 10. When creating or running a report based on a Domain. modifying. you must clear your Ad Hoc cache of all queries based on the Domain. they get different results.4 The Domain Security File The security file defines permissions to control access to Domain data on the basis of user names and roles existing in JasperServer. row security is defined on resourceId. Figure 7-3 Resources Page for Supermart Domain in the Edit Domain Dialog 9. For instance. Column security is defined on itemGroupId and itemId. select a file and click one of the following buttons on the Resources page: Edit – Replaces the selected file with a different one uploaded from a file or from the repository.Advanced Domain Features 8. see the JasperServer Administrator Guide. You might also want to define access permissions for the new item by downloading. you will need to add its label and description keys to each bundle. 7. columns. This will remove any data that was based on the old instance of your Domain and avoid inconsistencies in new reports. for example a manager might only be allowed to see the salary column of employees whose manager field equals the manager’s employee number. sets and items that appear in the design are referenced by the security file. Security on rows is defined by permissions on the data values. edit each file to add the new keys. rows display the values of each item. David sees data in cells where columns A-F 155 . In Domains. Delete – Removes the selected file from the Domain. A user can only see results where he has both column. user David has access to columns A-F and rows 1-6. if you add an item to you Domain after creating your locale bundles. Tomas has access to columns B-C and rows 1-3. For instructions. To manage the uploaded resources. in a certain Domain. Anita has access to columns C-E and rows 2-5. the user name and roles are checked against the permissions in the security file. only certain users might be able to see sensitive employee information such as a Social Security Number. For example. columns display the items in the Domain. The Resources page shows the list of all uploaded files. Permissions can be set separately on the data’s columns and rows. If you modified an existing Domain. The IDs of tables. When the users run reports from the Domain. For example. then upload each file to replace the corresponding locale bundle. Download – Lets you save the security file or locale bundle to a local file.

see section 7. When the report runs. determined first for item groups and items. an expression can test for any object in the principal. the security definition finds the access grants and determines his access rights. All access grants for a Domain are defined in a single security file that is attached to the Domain as a resource. When the query is passed to the data source and the report is run.any{ it. If you modify your Domain. 156 .jasperforge. it evaluates the roles for the specified role. Tomas sees data only where columns B-C and rows 1-3 intersect. you should also export the design file and update the security file with any IDs that have changed. it gets the user and roles associated with the object. Then.” on page 153. Anita sees data only where columns C-E and rows 2-5 intersect.2. Access grants take a principalExpression that evaluates the principal in authentication objects created in the Acegi security framework (http://www. For more information.principal. When creating a security file.getRoleName() in ['ANY_SUPPORTED_ROLE'] } </principalExpression> The expression gets the current authentication object and determines the access privileges of the principal in the object. For example.org). the grants are applied as filters on the report’s columns and rows. as described in section 7. The expression evaluates to <principalExpression>authentication.JasperServer User Guide and rows 1-6 intersect.codehaus.any{ it. Security that is defined on a join applies only to the presentation layer content that is specific to the join. this expression tests for attribute A: <principalExpression>authentication.roleName in ('ANY_SUPPORTED_ROLE') </principalExpression> While the standard principal expression tests for a given role. When a user is designing a report in the Ad Hoc Editor. portions to which the user has no access will be blank. then for resources.getRoles().1. be sure to use the IDs of items and groups as they are defined in the Domain design file exported from the Domain Designer.org).getAttributes(). The access grants are applied to the role.getAttributeA() in ['ANY_SUPPORTED_ROLE'] } </principalExpression> The scripting language for principalExpression is Groovy (http://groovy. from JasperServer. Finally.roles.getPrincipal(). “Resources of a Domain.3. “Working With a Design File. The standard expression is <principalExpression>authentication. The default access is granted.” on page 140.getPrincipal(). he sees only the columns to which he has access. Item A 1 2 David Item B David Tomas David Tomas Item C David Tomas David Tomas Anita David Tomas Anita David Anita David Anita David Item D David Item E David Item F David David David David David 3 David David Tomas David Anita David Anita David 4 5 6 David David David Anita David Anita David David Anita David Anita David David David David David David David David For a given query on the data source. Security that is defined on the physical layer applies to all content in the presentation layer.

</resourceAccessGrants> <itemGroupAccessGrants> <!-. </itemGroupAccessGrants> </itemGroupAccessGrantList> .getPrincipal(). Tomas’s report uses columns from Region but he cannot see them because he does not have access to Sales.Advanced Domain Features A typical security file has the following structure: <securityDefinition xmlns="http://www. User Tomas has access to Region but not Sales. Row-level security applies whenever access to a secured resource is requested.any{ it. a column in the Region table might be joined to a column in the Sales table. 157 . For instance..jaspersoft..getRoleName() in ['ROLE_ADMINISTRATOR'] }</principalExpression> </itemGroupAccessGrant> .store_country in ('USA') and s.getRoles(). a resourceAccessGrantList specifies the rows to which a user has access..getPrincipal().Begin row-level security --> <resourceAccessGrantList id="expense_join_resource_access_grant" label="aLabel" resourceId="expense_join"> <resourceAccessGrants> <resourceAccessGrant id="expense_join_ROLE_SUPERMART_MANAGER_store_row_grant"> <principalExpression>authentication.. For each dataset from which data is returned by a query in the design file.com/2007/SL/XMLSchema" version="1.4. </resourceAccessGrants> </resourceAccessGrantList> .getRoles(). Each grant is defined in a resourceAccessGrant that contains a principalExpression and a filterExpression.0" itemGroupDefaultAccess="granted"> <resourceAccessGrants> <!-. even if the request is indirect.. </itemGroupAccessGrants> </securityDefinition> 7.. even if that query does not include the related dataset...Begin column-level security --> <itemGroupAccessGrantList id="expense_join_item_group_access_grant_group" label="aLabel" itemGroupId="expense_join" defaultAccess="denied"> <itemGroupAccessGrants> <itemGroupAccessGrant id="expense_join_super_user_item_group_grant" access="granted"> <principalExpression>authentication.getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <filterExpression>s. A resourceAccessGrant must be defined for a joined resource if any query in the security definition has at least one item from the resource.any{ it.1 Row-Level Security Row-level security is specified in resourceAccessGrants.store_state in ('CA') </filterExpression> </resourceAccessGrant> .

store_country in ('USA') and s.getPrincipal().any{ it.store_number == 0</filterExpression> </resourceAccessGrant> <resourceAccessGrant id="account_ROLE_SUPERMART_MANAGER_account_row_grant2" orMultipleExpressions="true"> <principalExpression>authentication.getRoles().any{ it.” on page 150 for examples of valid filter expressions.getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <filterExpression>s. See the section 7. Filter on the dataset. such as a user role or profile attribute.getPrincipal().getPrincipal().Begin row-level security --> <resourceAccessGrantList id="expense_join_resource_access_grant" label="aLabel" resourceId="expense_join"> <resourceAccessGrants> <resourceAccessGrant id="expense_join_ROLE_SUPERMART_MANAGER_store_row_grant"> <principalExpression>authentication.getRoles(). principalExpression.getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <filterExpression>account_type == 'Expense'</filterExpression> </resourceAccessGrant> </resourceAccessGrants> </resourceAccessGrantList> </resourceAccessGrants> Elements of resourceAccessGrants are: resourceAccessGrantList.getRoles(). List of grants for one dataset in the Domain. “The DomEL Syntax.any{ it.getRoles().getPrincipal(). determines the rows to which access is granted. 158 .getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <filterExpression>s.getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <filterExpression>s. Evaluation of the authentication object and user to determine the role to be granted access. filterExpression.2.JasperServer User Guide Row-level security is defined as follows: <resourceAccessGrants> <!-. Grant in the dataset for a specific case. Filters are applied to resource IDs.any{ it.getRoleName() in ['ROLE_ADMINISTRATOR'] }</principalExpression> </resourceAccessGrant> <resourceAccessGrant id="account_ROLE_SUPERMART_MANAGER_row_grant"> <principalExpression>authentication. resourceAccessGrant.getRoles().getPrincipal().store_state in ('CA') </filterExpression> </resourceAccessGrant> <resourceAccessGrant id="account_ROLE_SUPERMART_MANAGER_account_row_grant" orMultipleExpressions="true"> <principalExpression>authentication.any{ it.store_number == 24</filterExpression> </resourceAccessGrant> </resourceAccessGrants> </resourceAccessGrantList> <resourceAccessGrantList id="account_resource_access_grant" label="aLabel" resourceId="account"> <resourceAccessGrants> <resourceAccessGrant id="account_resource_super_user_row_grant"> <principalExpression>authentication.

the item group’s access applies. In this case (specified item group > unspecified item group > unspecified item). If the unspecified object is an item in an item group. or ANDed.getRoleName() in ['ROLE_ADMINISTRATOR'] }</principalExpression> </itemGroupAccessGrant> <itemGroupAccessGrant id="ROLE_SUPERMART_MANAGER_store_item_group_access_grant" access="granted"> 159 . access for the item cannot be specified in an item-level grant. An itemGroupAccessGrantList defines default access to one item group.getPrincipal(). Access to items within an item group can be specified by itemAccessGrants.any{ it. the access of the nearest parent item group applies to the item. in a simple series. If the nearest parent group’s access is also unspecified.getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <itemAccessGrantList id="expense_join_ROLE_SUPERMART_MANAGER_item_grant" defaultAccess="denied"> <itemAccessGrants> <itemAccessGrant id="itemAccessGrant1" itemId="ej_expense_fact_exp_date" access="granted" /> </itemAccessGrants> </itemAccessGrantList> </itemGroupAccessGrant> </itemGroupAccessGrants> </itemGroupAccessGrantList> <itemGroupAccessGrantList id="expense_join_store_item_group_access_grant_group" label="aLabel" itemGroupId="expense_join_store" defaultAccess="denied"> <itemGroupAccessGrants> <itemGroupAccessGrant id="expense_join_store_super_user_item_group_grant" access="granted"> <principalExpression>authentication. their access grants are combined.any{ it. Within the group.Advanced Domain Features 7. As a result. access is granted by user role in itemGroupAccessGrants.2 Column-Level Security Column-level security is specified in itemGroupAccessGrants.getRoles(). one denied statement overrides multiple granted statements. the user’s access to items for which access is specified will be as specified.Begin column-level security --> <itemGroupAccessGrantList id="expense_join_item_group_access_grant_group" label="aLabel" itemGroupId="expense_join" defaultAccess="denied"> <itemGroupAccessGrants> <itemGroupAccessGrant id="expense_join_super_user_item_group_grant" access="granted"> <principalExpression>authentication.4.getPrincipal().getPrincipal(). If a matching item group principal expression does exist. Column-level security passes from parent object to child object unless specified otherwise: If access is unspecified for an object. that group takes its access from its parent group and passes it to the item. If multiple item group principal expressions match the user (such as one expression for the user and one for his role).getRoles(). not the item group’s specified access. the user has the item group’s default access. If the unspecified object is an item in an item group that is nested in another item group. If access is specified for an item group but there is no item group principal expression matching the current user. Access to other items will be the item group’s specified access. the access of the parent object applies.any{ it.getRoleName() in ['ROLE_ADMINISTRATOR'] }</principalExpression> </itemGroupAccessGrant> <itemGroupAccessGrant id="ROLE_SUPERMART_MANAGER_item_group_access_grant" access="granted"> <principalExpression>authentication. Column-level security is defined as follows: <itemGroupAccessGrants> <!-.getRoles().

Specifies default access to the item group and all items in the group.getPrincipal(). Access is denied to everyone initially. List of access grants to items in the item group. The ANDed series can be modified by an OR expression (orMultipleExpressions="true"). itemAccessGrant. access to each item group is granted for administrator roles. Evaluation of the authentication object and user to determine the role to be granted or denied access. For instance. access to all items in the group is denied. which is more secure. all grants for a given role are ANDed. deny access to all group items. Grant group access to additional roles. access is defined for the SuperMart manager role. However. itemAccessGrantList. the progression of column access grants is: Deny access to everyone. followed by grants to specific items. Next. For each item group: Grant group access to administrator roles.any{ it. Specifies access to one item. The latter requires the programmer to specifically identify each item to which the role has access. itemGroupAccessGrant. deny access to specific items or. this method is not as secure as denying access to all items then granting access to some. If access is not granted at the group level. For each additional role. the following grants are implemented as A and B and C: 160 . alternatively. all users would have complete access. Specifies access to the item group for one user role. create an itemGroupAccessGrantList for them where the id of the group is "". First. An alternative way to restrict access is to simply deny it on specific items. List of access grants to one item group. Overrides default in itemGroupAccessGrantList.getRoles().getRoleName() in ['ROLE_SUPERMART_MANAGER'] }</principalExpression> <itemAccessGrantList id="expense_join_ROLE_SUPERMART_MANAGER_store_item_grant" defaultAccess="denied"> <itemAccessGrants> <itemAccessGrant id="itemAccessGrant3" itemId="ej_store_store_type" access="granted" /> <itemAccessGrant id="itemAccessGrant4" itemId="ej_store_region_id" access="granted" /> <itemAccessGrant id="itemAccessGrant5" itemId="ej_store_store_name" access="granted" /> <itemAccessGrant id="itemAccessGrant6" itemId="ej_store_store_number" access="granted" /> <itemAccessGrant id="itemAccessGrant7" itemId="ej_expense_fact_exp_date" access="granted" /> <itemAccessGrant id="itemAccessGrant8" itemId="ej_expense_fact_amount" access="granted" /> </itemAccessGrants> </itemAccessGrantList> </itemGroupAccessGrant> </itemGroupAccessGrants> </itemGroupAccessGrantList> </itemGroupAccessGrants> Elements of itemGroupAccessGrants are: itemGroupAccessGrantList. In the above example. access is granted to each item group even though the access may be limited eventually. Then. then grant access to specific items. Otherwise. If you want to restrict access to items outside of any group or set. Specifies default access to the items. the SuperMart manager will have no access at all. Next. By default. principalExpression.JasperServer User Guide <principalExpression>authentication.

edit your Domain design to define the internationalization keys.properties Sample Contents ACCOUNTS. A locale bundle for a Domain consists of a single file containing all the internationalization keys for the sets and items in the Domain.DESCR=Name of Customer ACCOUNTS. 7. except they are left blank if there is no locale bundle. If these exist. As your enterprise grows. you could have one of the following scenarios: You do not have any localization needs at the time you create your Domain.NAME. In this way. JasperServer displays the text associated with the key. In case a label or description is left untranslated. so JasperServer automatically associates it with the user’s locale when needed. if no label is defined. only the internationalization keys. or description property defined. if the default bundle or key does not exist.NAME. Language English Locale default Filename ExampleDomain. it displays the text associated with the key in the default bundle. then JasperServer looks for the same key in a default bundle among the resources. You can create locale bundles incrementally each time you have users who need a new language.properties When a Domain with locale bundles is used to create or run a report. you do not specify any labels or descriptions in your Domain design.NAME. The JasperServer interface is already internationalized. then It displays the text of the label property defined in the Domain design. users in another country need to create reports based on your Domain. if the bundle or key does not exist. and you can use specialized software or translation services to create all the locale bundles you need. You give all labels and descriptions a clear and complete text within the design. Then you create a default locale bundle that gives the clear and complete text of every label and description in your preferred language. In this case. then It displays the value of the id property. To create localized text for those users.Advanced Domain Features <resourceAccessGrant id="A"> <resourceAccessGrant id="B"> <resourceAccessGrant id="C">. If both exist.LABEL=Customer ACCOUNTS. users will see the text of the default locale bundle. The files contain other-language versions of the labels and messages that are displayed to users. 161 . and you leave the key names undefined. You want to create your Domain tailored to a multilingual environment where reports need to be localized for each user’s specified locale. Descriptions are localized in the same manner. default bundle. JasperServer resolves each label to display as follows: JasperServer looks for a bundle corresponding to the current locale and for the key corresponding to the label. JasperServer looks for the corresponding locale bundle and uses the labels and messages it contains.NAME. all user-visible text for your Domain is in the standard format of a locale bundle. The name of the file includes the target locale. There are several strategies for managing your locale bundles. while these grants are implemented as (A or B) and C: <resourceAccessGrant id="A"> <resourceAccessGrant id="B" orMultipleExpressions="true"> <resourceAccessGrant id="C"> The OR expression can be applied in grants for items and item groups as well as resources.LABEL=Client ACCOUNTS. Users in your home country who do not specify a locale will still see the labels and description in the original Domain design. and Domains make reports internationalizable so that users can create and view reports in their language. then create the locale bundle.5 Locale Bundles A locale bundle is a set of properties files used in localizing software. Based on the search algorithm above and your localization needs. Each key is associated with the text for the label or description in the language of the target locale.DESCR=Nom du client French fr ExampleDomain_fr. When a user’s operating environment specifies a locale.

1 Defining the Internationalization Keys In the Domain Designer.5. When you click OK. You have the option of generating only the label keys. 162 . the name of the internationalization keys are defined by the Label ID and Descr. the set of keys is identical in the properties file of each locale bundle. export the bundle stub as explained above.ITEM_ID. the generated key names have the following format: SET_ID. ID properties.JasperServer User Guide 7. both. Usually. use the Generate Bundle Stub icon performs two tasks: in the menu bar of the Domain Designer. Optionally.2 Creating Locale Bundle Files A locale bundle for a Domain is a Java properties file where each property name is a unique internationalization key from one of the labels or descriptions in the design. This is a properties file in the proper format containing all the defined keys. where <locale> is any Javacompliant locale identifier. 7.5. the keys are not defined. To automate this process.LABEL SET_ID. If these attributes are missing or defined with an empty value (""). these properties are blank. The text for a given key in a given locale is determined by the algorithm given on page 161. give these attributes a value that is unique among all the keys. If your design file does not load properly in the Domain Designer. you will not be able to use the exported design file.properties.DESCR It outputs a locale bundle stub. By default. but save the exported file to another name and attempt to merge in the generated keys. This function Figure 7-4 Locale Bundle Stub Options Dialog It automatically generates all the key names. The locale bundle stub is further explained in the next section. any keys that already exist will not be modified. ID properties on each set and item defined on the Display tab. If the _<locale> part of the file name is omitted. only the description keys. If you have many sets and items. You may name the keys in any way you wish. use the Generate Bundle Stub icon in the menu bar to export a blank properties file.LABEL SET_ID. it may be easier to upload the design file in a Domain and open it in the Domain Designer. do not overwrite your design file. To define the keys. the name of the keys are given by the labelId and descriptionId attributes on each itemGroup and item element. ready for translation. Whether you have created your design in the Domain Designer or in an external file uploaded to the Domain Designer. you may generate any missing keys.DESCR SET_ID. the file designates the strings for the default locale. as described in the previous section. and export the XML design file that now contains the generated keys. In this case. The value of each property is the text for the label or description in the target language. the generated key names will be added to all the blank Label ID and Descr. Often.ITEM_ID. as long as each key is unique among all keys within the Domain. but this is not necessary. You can then generate the keys automatically. In order to guarantee uniqueness. it is simplest to create the properties files from the stub exported by the Domain Designer. In the design file. or neither. for example fr or fr_CA. The name of the file identifies the locale in the form <any_name>_<locale>.

NAME.INDUSTRY. As the example shows.LABEL= USERS1. sets and items in the bundle stub appear in the same order as on the Display tab of the Domain Designer: ACCOUNTS.LABEL= ACCOUNTS.DESCR=Responsable du compte client. . you can simply copy the file and change the _<locale> designator to begin translation of another locale bundle. ACCOUNTS.NAME.DESCR= ACCOUNTS.EMPLOYEES. For international characters that are not in ISO-8859-1.LABEL= ACCOUNTS.DESCR=Pr\u00e9nom usuel.FIRST_NAME.LABEL=Responsable USERS1.NAME.DESCR= ACCOUNTS.DESCR=Type du compte client.LAST_NAME.NAME.LABEL=Pr\u00e9nom USERS1.EMPLOYEES.EMPLOYEES.FIRST_NAME. ACCOUNTS. use Unicode escape sequences (for example \u00e9 is é).LABEL=Localit\u00e9 ACCOUNTS.ACCOUNT_TYPE.INDUSTRY.LABEL=Comptes ACCOUNTS...DESCR= ACCOUNTS.CITY_AND_STATE. ACCOUNTS.INDUSTRY. ACCOUNTS.ANNUAL_REVENUE.LABEL=Client ACCOUNTS.FIRST_NAME. USERS1.Advanced Domain Features The following example shows part of the properties file output for the Domain created in section 6.ANNUAL_REVENUE.LAST_NAME.DESCR=D\u00e9tails des comptes clients. The following example shows the French translation for the properties file shown above. A best practice is to save a blank properties file or the default locale bundle as a 163 ..DESCR= USERS1.CITY_AND_STATE.LAST_NAME.DESCR=Revenus annuels estim\u00e9s.LABEL=Nom USERS1.DESCR= USERS1. “Example of Creating a Domain.LABEL=Industrie ACCOUNTS.LABEL= USERS1. USERS1. ACCOUNTS.LABEL=Taille du personnel ACCOUNTS.ACCOUNT_TYPE.DESCR= USERS1. Once you have the properties file for your first locale.ANNUAL_REVENUE.LABEL=Taille par revenus ACCOUNTS.LABEL= ACCOUNTS. The syntax for the properties file is the same as for Java properties files.DESCR=Nom de famille. Java properties files use the ISO-8859-1 (Latin-1) encoding that is the same as ASCII for all English nonaccented characters. All of the internationalization keys were generated automatically as well.DESCR= .DESCR=Nom du client ACCOUNTS.LABEL= ACCOUNTS.LABEL=Type ACCOUNTS. ACCOUNTS.DESCR=Industrie d\u2019activit\u00e9 primaire. USERS1.DESCR= ACCOUNTS.” on page 117.LABEL= USERS1.FIRST_NAME. Generally.LABEL= ACCOUNTS.ANNUAL_REVENUE..DESCR= ACCOUNTS.ACCOUNT_TYPE.CITY_AND_STATE.EMPLOYEES.CITY_AND_STATE. including the UTF-8 code for accented characters and other symbols.DESCR= ACCOUNTS.ACCOUNT_TYPE. everything after the = symbol is part of the translated text.LAST_NAME.2.INDUSTRY.DESCR=Ville et r\u00e9gion ou \u00e9tat du client.LABEL= ACCOUNTS.LABEL= ACCOUNTS.DESCR=Nombre d\u2019employ\u00e9s estim\u00e9s.

For additional information on locales and locale bundles in JasperServer. if you change your Domain design and need to modify your properties files. You can create and edit the properties file in any text editor.” on page 153 for instructions on uploading locale bundles. See the procedure in section 7. you can export the locale bundle stub again and compare it to the template to find all new keys. Also. modify. There are also translation products that manage all of the resource bundles together. 164 .3. follow that same procedure to download. when all translations are finished. Regardless of how you edit properties files. “Resources of a Domain. Certain editors provide features for editing properties files. and upload each locale bundle. you need to upload them as locale bundles to your Domain in order to take effect. Also.JasperServer User Guide template for future translations. allowing you to translate in parallel and find missing keys and missing translations. if you change your Domain design. see the Localization chapter in JasperServer Administrator Guide.

1 Messages When an event occurs (such as an when a scheduled report returns errors). You can browse these messages to gain an understanding of report scheduling problems in JasperServer. 165 .1 Message List The Messages page displays the list of events logged for the current user. click View > Messages in the menu bar. You can view a message by clicking its name. JasperServer notifies the owner of the report through an internal message. such as if a report fails because its data source is configured with incorrect credentials. 8. Information there can help you troubleshoot problems with your scheduled reports. The message opens in the Event Details page.1. Figure 8-1 Messages Page Use the check boxes and buttons on this page to manage your list of messages. To open the Messages page: On any page.Utilities 8 UTILITIES Messages iReport Plug-ins This chapter contains the following sections: 8.

8.1 JasperServer Plug-in The JasperServer plug-in requires: iReport 3. change to the iReport home directory and enter . The JasperServer plug-in enables you to move reports between iReport and JasperServer.7 The Domain plug-in is included by default in the Professional version of iReport. 8. iReport includes JasperServer and Domain plug-ins. refer to section 5. or In Linux. click Start > All Programs > JasperServer Pro > Start iReport. 3. refer to the JasperServer Administrator Guide. Click Window > JasperServer Repository.JasperServer User Guide Figure 8-2 Event Details Page A common cause of the error message indicating that the report failed to execute is a misconfigured mail server.5 or greater JasperServer with enabled web services To launch the JasperServer Plug-in in iReport 1./iReport. “Using the JasperServer Plug-in for iReport.2. iReport 3. To launch iReport: 1.2 Domain Plug-in The Domain plug-in for iReport requires: JasperServer plug-in. The Domain plug-in enables you create reports from Domains in the JasperServer repository. Launch iReport. 8. For more information.4.2.” on page 103.sh at the command prompt.7 Java Sun JDK 1.7 JasperServer Professional or Enterprise 3. 166 . 2.7. In Windows. iReport opens. For more information on mail configuration. The mail server must be manually configured after installation in order for users to send email notifications.2 iReport Plug-ins By default. A JasperServer pane appears in the upper left corner of your iReport workspace.

Like JRXML reports. and scheduled within JasperServer. The practice of managing every facet of a company’s interactions with its clientele. such as slice and dice. Calculated Field In a Domain. schemas are stored in the repository as XML file resources. Analysis Schema A metadata definition of a multidimensional database. In addition. All Ad Hoc reports can be run with auditing enabled. CRM Customer Relationship Management. 167 . operators. and saved. Analysis View A view of multidimensional data that is based on an analysis client connection and an MDX query. Starting from a collection of fields predefined in a Topic or selected from a Domain. preview. and constants. Ad Hoc reports may be reopened in the Ad Hoc Editor. An analysis client connection is either a direct Java connection (Mondrian connection) or an XML-based API connection (XMLA connection). A calculated field is defined in the Domain Designer dialog. CrossJoin An MDX function that combines two or more dimensions into a single axis (column or row). Analysis Client Connection A definition for retrieving an analysis view. the results can be used as input for other reports. further modified. Ad Hoc reports can be run. the Ad Hoc Editor lets you drag and drop report elements to draft. a field whose value is calculated from a user-written formula that may include any number of fields.Glossary GLOSSARY Ad Hoc Editor JasperServer’s integrated report designer. and finalize reports. and drill through. and it becomes one of the items to which the Domain’s security file and locale bundles can apply. such as limiting them to a range of dates or a total number of instances. A range of criteria can be audited and the results logged. Audit Archiving Determining the limit on saving audit results. Audit Logging Recording who used JasperServer to do what when. It is the entry point to analysis operations. In JasperAnalysis. drill down. CRM applications help businesses track and support their customers. printed.

a cube that stores data about sales figures might include dimensions such as time. defining a calculated field. Data Source Defines the connection properties that JasperServer needs to access data. Data Policy In JasperServer. When you navigate the data displayed in an analysis view. labels. As such. JNDI.JasperServer User Guide Cube The basis of most analysis applications. JasperServer transmits queries to data sources and obtains datasets in return for use in filling reports and previewing Ad Hoc reports. calculated fields. JasperServer supports JDBC. Dice An OLAP operation to select columns. and default properties. all of which define items and sets of items for creating Ad Hoc reports. and web content displayed in a single. a JasperServer datatype is more structured than a datatype in most programming languages. you can write an SQL query that includes complex functions for selecting data. number. For example. A datatype must be of type text. it is best to define it as a calculated field in a Domain. Dataset A collection of data arranged in columns and rows. For example. integrated view. Domain A virtual view of a data source that presents the data in business terms. you can narrow down the data to a specific date range. allows for localization. graphics. Dashboard A collection of reports. It can include constraints on the value of the input. such as joining tables. custom data sources can be defined as well. and provides data-level security. input controls. a datatype is used to characterize a value entered through an input control. Custom Field In the Ad Hoc Editor. Dashboards often present a high level view of your data. or filtering. Embedded web content. Denormalize A process for creating table joins that speeds up data retrieval at the cost of having duplicate row values between some columns. join clauses. You can use the items in a derived table for other operations on the Domain. Datatype In JasperServer. a derived table is defined by an additional query whose result becomes another set of items available in the Domain. Dimension A categorization of the data in a cube. and customer’s industry. region. with a JDBC data source. such as other web-based applications or maps. but it implements the same functionality within JasperServer. date. a setting that determines how JasperServer should process and cache data used by Ad Hoc reports. Datasets are equivalent to relational results sets and the JRDataSource type in JasperReports. A Domain is not a view of the database in relational terms. product. a cube is a data structure that contains three or more dimensions that categorize the cube’s quantitative data. For example. make dashboards more interactive and functional. but input controls can parameterize the data to display. a field that is created through menu items as a simple function of one or two available fields. you are exploring a cube. When a custom field becomes too complex or needs to be used in many reports. 168 . including other custom fields. display names. The design of a Domain specifies tables in the database. for example maximum and minimum values. Derived Table In a Domain. The items in a derived table can also be referenced in the Domain’s security file and locale bundles. or date-time. and Bean data sources. Select your data policies by clicking Manage > Ad Hoc Options.

input controls and their associated datatypes must be defined as repository objects and explicitly associated with the report. Fields originate in the structure of the data source. a member of a dimension containing a group of members. text field. 169 . An OLAP operation that displays detailed transactional data for a given aggregate measure. user input. the field chosen to define the group becomes the independent variable on the X axis. An OLAP operation that exposes more detailed information down the hierarchy levels by delving deeper into the hierarchy and updating the contents of the navigation table. but you may define calculated fields in a Domain or custom fields in the Ad Hoc Editor. Facts are typically numeric. Items can be grouped in sets and are available for use in the creation of Ad Hoc reports. a group is a set of data rows that have an identical value in a designated field. Load. Hierarchy Level In analysis. Item When designing a Domain or creating a Topic based on a Domain. Fact The specific value or aggregate value of a measure for a particular member of a dimension. Transform. When either type of report is used in a dashboard. an item is the representation of a database field or a calculated field along with its display name and formatting properties defined in the Domain. Input Control A button. Drill up. check box. In a table. For JRXML reports. Frame A dashboard element that displays reports or custom URLs. Unlike a JRXML-based Topic. the input controls are defined internally. its input controls are available to be added as special content. while the other fields appear as columns. Any type of field. Eclipse An open source Integrated Development Environment (IDE) for Java and other programming languages. ETL Extract. An OLAP operation for returning the parent hierarchy level to view to summary information. Drill through. drop-down list. is called an item and may be used in the Ad Hoc editor. Field A field is equivalent to a column in the relational database model. For Domain-based reports that prompt for filter values. A Domain Topic is based on the data source and items in a Domain. but it allows further filtering. A process that retrieves data from transactional systems. Group In a report. In a chart. the new table displays the low-level data that constitutes the data that was clicked. and selection of items. along with its display name and default formatting properties. while the other fields of each group are used to compute the dependent value on the Y axis. a Domain Topic can be edited in JasperServer by users with the appropriate permissions. and filters and aggregates the data to create a multidimensional database. the value appears in a header and footer around the rows of the group. such as C/C++. Click a fact to open a new table beneath the main navigation table.Glossary Domain Topic A Topic that is created from a Domain by the Choose Ad Hoc Data wizard. Frames can be mapped to input controls if their content can accept parameters. or calendar icon that allows users to enter a value when running a report or viewing a dashboard that accepts input parameters. Drill To click on an element of an analysis view to change the data that is displayed: Drill down.

visit http://jpivot. Object In JasperServer.mysql. report output.sourceforge. In an analysis view. Provides multidimensional views of data that help users analyze current and past performance and model future scenarios. A standard interface that Java applications use to access databases. Mondrian Schema Editor An open source Eclipse plugin for creating Mondrian analysis schemas. font. A language for querying multidimensional objects. For information. such as OLAP (On Line Analytical Processing) cubes. data source. saved report. Administrators set user and role-based access privileges on repository objects to establish a security policy. such as an image. a crosstab’s data values. JDBC Java Database Connectivity. Mondrian A Java-based. MDX Multidimensional Expression Language. open source multidimensional database application. or a chart’s dependent variable (such as the slices in a pie). domain. JPivot An open source graphical user interface for OLAP operations. a formula that calculates the facts that constitute the quantitative data in a cube. Mondrian XMLA Source A server-side XMLA source definition of a remote client-side XMLA connection used to populate an analysis view using the XMLA standard. Only the fields in a same join tree or calculated from the fields in a same join tree may appear together in a report. a formula that calculates the values displayed in a table’s columns. Navigation Table The main table in an analysis view that displays measures and dimensions as columns and rows. MySQL An open source relational database management system. and returning cube data for analytical processing. anything residing in the repository. file. dashboard. visit http://www. A standard interface that Java applications use to access naming and directory services. An MDX query is the query that determines the data displayed in an analysis view. For more information. JNDI Java Naming and Directory Interface. report element. Mondrian Connection An analysis client connection that consists of an analysis schema and a data source used to populate an analysis view. Measure Depending on the context: In a report. A join is the relational operation that associates the rows of one table with the rows of another table based on a common value in given field of each table.JasperServer User Guide JavaBean A reusable Java component that can be dropped into an application container to provide standard functionality. or analysis view.net/. a collection of joined tables from the actual data source. Join Tree In Domains. The folders that contain repository objects are also objects.com/. 170 . topic. OLAP On Line Analytical Processing.

TIME. Parameter Named values that are passed to the engine at report-filling time to control the data returned or the appearance and formatting of the report. Schema A logical model that determines how data is stored. Pivot To rotate a crosstab such that its row groups become columns groups and its column groups become rows. An organization has its own user accounts. and LOCATION).Glossary Organization A set of users that share resources and repository objects in JasperServer. In Java. In JasperAnalysis. For example. and root folder in the repository to securely isolate it from other organizations that may be hosted on the same instance of JasperServer. The default organization admin in each organization is the jasperadmin account. where the values described by the dimensions are aggregated using a function such as SUM. In the Ad Hoc Editor. a very low sales figure or a very high number of helpdesk tickets. roles. and indexes. roles. parameters can be mapped to input controls that users can interact with. JasperAnalysis excels at revealing outliers. Such outliers may indicate a problem (or an important achievement) in your business. Outlier A fact that seems incongruous when compared to other member’s facts. Role A security feature of JasperServer. such as its color and label. Administrators use the import and export utilities to back up the repository contents. X and Y axis) for organizing information containing more than two logical dimensions (for example. For example. A report parameter is defined by its name and type. Pivot Table A table with two physical dimensions (for example. schemas are represented in XML design files. and then set access permissions to repository objects based on those roles. such that each physical dimension is capable of representing one or more logical dimensions. CUSTOMER. Administrators create named roles. pivot the crosstab by clicking . PRODUCT. Organization Admin Also called the organization administrator. Pivot tables are used in JasperAnalysis. the schema in a relational database is a description of the relationships between tables. 171 . An organization admin can also create sub-organizations and mange all of their accounts. and resources. repository permissions. which determines certain menu options displayed to those users. The settings determine certain features of the object. Applications can access the repository through the web service API. properties can be set in files listing objects and their settings. Properties are normally editable. For Domains. Repository The tree structure of folders that contain all saved reports. and repository content. views. assign them to user accounts. they are uploaded to the repository as resources. dashboards. Properties Settings associated with an object. analysis views. an OLAP schema is the logical model of the data that appears in an analysis view. and repository objects. In JasperServer. A user in an organization with the privileges to manage the organization’s user accounts and roles. Users access the repository through the JasperServer web interface or through iReport. JasperServer also makes certain functionality available to users based on their roles.

XML eXtensible Markup language. The system admin can create root-level organizations and manage all server settings. with one row for each event and a table column or field for each measure. repository permissions. The account associates the login name with user's full name. 172 .xmla. Topics are stored in the Ad Hoc Components folder of the repository and displayed when a user launches the Ad Hoc Editor. Topic A JRXML file created externally and uploaded to JasperServer as a basis for Ad Hoc reports. A standard language used to access and manipulate data and schemas in a relational database.JasperServer User Guide Set In Domains and Domain Topics.sourceforge. The default system admin is the superuser account. scheduling and user administration tasks. WCF Web Component Framework. relevant to your business.net/ wcf/index. SQL Structured Query Language. Transactional Data Data that describe measurable aspects of an event. roles. XML/A XML for Analysis. such as a retail transaction. Slice An OLAP operation for filtering data rows. A low-level GUI component of JPivot.html. users. see http://www. There are generally three categories of users: administrators who install and configure JasperServer. Web Services A SOAP (Simple Object Access Protocol) API that enables certain features to be managed over the web without running JasperServer. A set can be based on the fields in a table or entirely defined by the Domain creator. The order of items in a set is preserved. and interpreting data for use across any number of XMLenabled applications. The features include repository.org/ XML/A Connection A type of analysis client connection that consists of Simple Object Access Protocol (SOAP) definitions used to populate an analysis view. An XML standard that uses Simple Object Access protocol (SOAP) to access remote data sources. transferring. and repository objects across the entire JasperServer instance. For more information. A user who has unlimited access to manage all organizations. but all items in a set must originate in the same join tree. a named collection of items grouped together for ease of use in the Ad Hoc Editor. and email address. and business users who create and view reports and dashboards. Roles are assigned to user accounts to determine access to objects in the repository. A user account created for a specific person or purpose. Topics are created by business analysts to specify a data source and a list of fields with which business users can create reports in the Ad Hoc Editor. password. see http://jpivot. System Admin Also called the system administrator. Transactional data are often stored in relational databases. For more information. database experts or business analysts who create data sources and Domains. User Depending on the context: A person who interacts with JasperServer to fulfill a goal. A standard for defining.

61 area chart 63 auto-refresh interval in dashboards 21 available content 17 B bar chart 63 basic functions 57 Boolean operators in Domains 69 C calculated fields 57 cascading input controls 33. 49 add function 57 Add New Domain wizard 118 adding a design file as a new Domain 150 adding reports 87 alphabetical ascending 54. 98 CGP 53. 58 summarizing 47 controls. 58 change fields for Domain-based reports 71 chart reports and dashboards 24 compared with table and crosstab 44 display options 63 page size 64 resizing 64 sample Topic 63 summarized vs. 66 alternate group 42. 65 column width 49. 76 collapse group 65 collapse members 66 column-level security in Domains 159 columns column groups 46. 155 Ad Hoc Editor available fields selected in Domain Topic 70 calculated fields 57 custom fields 57 decimal places 58 designing report layouts 43 editing reports created in the Ad Hoc Editor 48 filters 59 formatting reports 48 formulas 57 how to use 41. 66 percent of column group parent 53. 69. 74. unsummarized 63 theme for 112 types of charts 63 unique features 63 Charts Pro 29 Choose Ad Hoc Data wizard 67. 45 input controls 59 limits on reports 78 page properties 43 parametrized queries 59 reports 41 rounding and custom fields 58 saving reports 42.Index INDEX A access grants and scheduled reports 34 Domain column-level 159 Domain row level 157 effect of grants 68. See input controls. 47. 47. count all 66 creating 173 . 49 tool bar 42 Ad Hoc reports and dashboards 24 kinds 43 limits 78 localization 77 saving 42.

58 compared with table 44 drill to details 66 exclude 52. 25 mapping input controls to URLs 20 multiple selection 22. 87. 74.JasperServer User Guide dashboards 17–24 Domain security files 155 Domain Topics 73 reports 73. 79. 22 designer 18 edit 24 HTTP v. 66 switch to column group 51. 103 crosstab reports adding fields 65 and dashboards 24 and dataset size 42 collapse group 65 collapse members 66 column group parent 53. FILE protocol 23 limitations 17. 65 switch to row group 65 unique features 65 custom fields add 57 basic functions 57 date functions 57 default name 58 divide 57 multiply 57 operators 57 overview 57 percent of group parent 57 percent of total 57 rank 57 renaming 58 round 57 special functions 57 subtract 57 swap fields 57 custom URL in dashboards 17. adding as a new Domain 150 editing 141 exporting 140 filters 150 itemGroups element 142 items element 142 joins 144 Oracle schema name 141 resources element 142 schema element 141 schemaLocation attribute 142 structure 141–149 uploading edited file 150 version attribute 141 xmlns attribute 141 XSD 140 Display page 69 distinct count 66 divide function 57 174 . 23 D dashboards adding content 22 adding custom URLs 17 adding logos 17 and Ad Hoc reports 24 and available items 17 and custom URLs 20. 66 hyperlinks 66 keep only 52. 66 Data page 67 data policies 78 data sources. 23 creating 17–24 deleting content 21. 23 overview 17 proportional v. 66 measures 65 percent of group 58 pivoting 65 row and column groups 65 row group parent 53. 24 area 18 auto-refresh interval 21 behavior when content deleted from repository 23 buttons 17 containing other dashboards 22. and scheduled reports 34 datasets 42 datatypes 92. fixed sizing 23 refining the layout 21 saving 18 SuperMart dashboard 16 tips for creating reports 24 title 21 viewing 16 working with 15–25 Data and Design page 118 data formats 49. 25 and parameters 25 and screen size 23. access grants. 100 date functions 57 design files See also Domains. 22. 66 expand group 65 expand members 51. 23 and input controls 19. 58 sample size 66 sample Topic 65 setting data formats 66 sorting 54.

155 exporting designs to XML files 140 filtering data for a report 68 filters 69 Groovy 156 input controls 110 item sets 68. 74. 25 and parametrized queries 59 cascading 33. access grants and scheduled reports 34 Boolean comparison operators 69 defined 115 defined by a new design file 150 design file 139 designing a Domain 117–134 Domain plug-in for iReport 108. 59 limitations 25 mapped to custom URLs 20. 69. 65 H help 9 hide scroll bars 22 hiding detail rows 49 Home page for end users 8 icons 9 I icons export report output 28 Home page 9 input controls 42 adding 90 and dashboards 17. 19. 61. 74. 123 joins 120. 65 filter pane 43. 166 editing 135 effect of access grants 68. 22 pop-up page 31 175 . 52. 51. 59 filters compared to input controls 59 filtering items in Domains 69 in Domain plug-in 110 in Domains 68 in the Ad Hoc Editor 59. Simple Domain 117 Simple Domain Topic 117 SuperMart Domain 117 typical uses 115 using a Domain for a report 67 drill to details 66 dynamic filters 59 E Edit Domain Topic wizard 76 Event Details page 165 exclude 52 expand group 65 expand members 51. 132 locale bundles 161 localization 161 presentation and physical layers 156 principal expressions 156 properties files 161 referential integrity 136 samples 117 saving as Topics. See Domain Topics. 66 exporting Domain designs to XML design files 140 external resources 88 F fields changing for Domain-based reports 71 in crosstab reports 64.Index Domain Designer 118 Domain plug-in input controls 110 installing 166 parametrized queries 110 using in iReport 108 Domain Topics editing 76 effect of access grants 68. 155 saving 73 Domains See also design files. 60 in Topics 59 using 60 Filters page 68 fixed sizing 24 Flash charts 29 folders 106 fonts 88 formats for report output 28 formatting reports 48 formulas 57 Fusion 29 G glossary 167 Groovy 156 groups adding to crosstab reports 64 expanding and collapsing 65 pivoting 42 switching 42. 69. 93 compared to filters 59 date 95 default values 30 display differences in dashboards 25 encouraging reuse of 25 in reports run from Domain plug-in 110 in the Ad Hoc Editor 42. 98 check box 92.

101 localization of Domains 161 Locate Query page 84 logging in 8 M Main JRXML page 81. 87 Maps Pro 29 measures 65 messages about system events 165 Messages page 165 multiple v. 66 O online help 9 Oracle choosing schemas 125. 77. 142 items element in design files 142 J JAR files 87. 50 preview 18 principal expressions 156 print view 17 176 . single controls in dashboard 17 multiply function 57 N Naming page 81 numeric ascending and descending 54. 113 JasperAnalysis 9 Job Details pages 35 Jobs List page 34 jobs. 128 NVARCHAR2 127 schema name in design file 141 synonyms 127 P pages Data 67 Data and Design 118 Display 69 Event Details 165 Filters 68 Home page for end users 8 Input Control 31 Job Details 35 Jobs List 34 Locate Query 84 Main JRXML 81. 59 running a report with parametrized queries 30 passwords 8 percent of group parent functions 57. See scheduling reports. 25 and reports 40 in reports run from Domain plug-in 110 in the Ad Hoc Editor 42. 127. 88. 61.JasperServer User Guide running a report with input controls 30 testQuery 95 text 91 types 90 using 59 installing Domain plug-in 166 JasperServer plug-in 166 iReport adding resources 106 connecting to JasperServer 103 creating reports 105 Domain plug-in 108. joins in Domains 120. 87 K keep only 52 L layouts of reports 43 Liferay 64 line chart 63 locale bundles 161 locales 8. 87 Messages 165 Naming 81 Report 30 Resource List 82 Save Topic 74 Topics and Domains 67 parametrized queries See also filters. adding input controls 90 and dashboards 20. 132 security 156 JRXML files and Domain Topics 73 and Topics 76 external resources 88 field names in 101 field names in Topics 77 in iReport 107 to create a new report 81. 58 percent of total function 57 physical layer 156 pie chart 63 pivoting 42. 65 plug-ins Domain 108. 107 running reports 108 item sets 68. 123 itemGroups element in design files 141. 166 JasperServer 166 portal 64 presentation layer 156 presentation mode 42. 166 JRXML files 107 limits on reports 78 repository 105.

66 sorting 62. 74. 65 running 27. 66 table vs. 58 row groups 46. 20 resolution 24 Resource List page 82 resources adding to iReport 106 and Ad Hoc reports 77 and localizations 101 resources element in design files 141. 105 crosstab layout and formatting options 65 crosstab vs. 79.jrxml 87 sample reports Accounts 28 Freight 30 SalesByMonth 87 sample size 66 sample Topics demo for adhoc 45 foodmart data for crosstab 65 Simple Domain Topic 117 Save Topic page 74 scatter chart 63 scheduling reports See also reports and running reports.jrxml 87 SalesByMonthDetail. 49 saving report output 28 selecting styles 48 setting data formats 49. 66 based on Domains 78 based on JDBC data sources 78 chart layout and formatting options 63 creating 73. 71 designing in the Ad Hoc Editor 41 designing layouts 43 editing labels 47 editing reports created in the Ad Hoc Editor 48 effect of access grants 34. in locale bundles 161 proportional sizing 23. crosstab and chart 43. 103. 50. example 27. 47. 30 Flash charts 29 from iReport 108 in the Ad Hoc Editor 42. 71 validating 86. 66 summarizing rows and columns 47. 108 sample size 66 sample Table report 45 saving in the Ad Hoc Editor 42. 47. 142 RGP 53. 24 Q query resource 84 R rank function 57 recurrence calendar recurrence 39 simple recurrence 38 types 36 redo 42 referential integrity 136 report area 46 report output 42 Report page 30 Report Wizard 81 reports See also scheduling reports and running reports. 58 round function 57 row-level security in Domains 157 rows percent of row group parent 53. 81 logo. 99 with input controls 30 repository in iReport 105.Index properties. 65 summarizing 47 running reports See also reports and scheduling reports. 42.jrxml 80. 155 export icons 28 exporting report output 28 Flash-enabled 29 formatting 48 limits 78 localization 101 report area 46 report output 28 report parameters 40 row and column groups 46. 39. 68. Ad Hoc 41 adding 87 adding fields 46.jpg 80 SalesByMonth. 50 in the background 39 limits 78 on a schedule 35 S sample Domains 117 sample files AllAccounts. 69. table and chart 43. 87. 107 main page 10 manager 117 searching 10 system messages 165 reset 17. access grants and scheduled reports 34 defining a job 35 defining schedules 34 editing a job 38 177 . 74. 65 adjusting column width 49.

Simple Domain Topic 117 uploading 76 Topics and Domains page 67 TrueType fonts 88 U undo 42. 62 spacer 49 summarizing rows and columns 47 text label 17 themes. 54. 20 subtract function 57 summarized vs. 61 T table reports adding fields 46 adjusting column width 49 and dashboards 24 and dataset size 42 column groups 46 compared with crosstab and chart 43. 76 Domain Designer 118 Edit Domain Topic 76 Report 81 X XML Domain design files 140 xmlns attribute in design files 141 XSD of Domain design file 140 178 . 69. 55 undo all 42. 65 switch to row group 65 switching groups 42. multiple controls in dashboard 17 slice 52. 71 designing layouts 43 formatting 48 hiding detail rows 49 sample 45 selecting styles 48 setting data formats 49 showing detail rows 49 sorting 42. 74 filters 150 principal expressions 156 row-level security 157 structure 155 select fields for Domain-based reports 71 showing detail rows 49 Simple Domain 117 Simple Domain Topic 117 single v. for charts 112 time series chart 63 time zones 8 tool bar 42 Topics See also Domain Topics. See Domain Topics. 66 sorting reports 42. screen sizes 24 search expression 13 search field 11 security files column-level security 159 effect of access grants 68. See design files. access grants and scheduled reports 34 as JRXML files 73. 62.JasperServer User Guide recurrence 38 viewing job schedules 34 schema element in design files 141 schemaLocation attribute in design files 142 schemas. 66 spacer 49 special content in dashboards 17. 56 uploading edited design files 150 URLs in dashboards 20 utilities iReport 166 messages 165 V validating reports 86. 20 special functions 57 standard controls in dashboards 17 styles 48 submit 17. 69 fields and data in a Domain Topic 74 scheduled reports 34 W Widgets Pro 29 wizards Add New Domain 118 Choose Ad Hoc Data 67. 76 creating 76 defined 76 field names in 77 JRXML files 73 localization 77 parametrized queries 59 saving Domains as Topics. 99 version attribute in design files 141 viewing dashboards 16 fields and data in a Domain 68. unsummarized charts 63 SuperMart 16 switch to column group 51.