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

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

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

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

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

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

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

Displays only the output from reports that were scheduled or run in the background. views. This filter not only applies to visualization types. For example.3 Refining With Filters The filters below the folder tree let you refine your search using several other resource attributes. Report output can be any of the supported export types (HTML. 12 . every type is displayed. dashboards. but also to resources that are included in reports such as images. PDF. Resources viewed or modified during the previous day ending at midnight. You can set each filter independently of the others. Displays only reports. dashboards. The default filter that includes reports.JasperServer User Guide 1. 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. These are the resources that can be viewed by anyone who has read access. 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. Displays only analysis views (if you implement JasperAnalysis). including today. Displays only data sources. Selects only resources that have been last modified by the currently logged in user. Resources viewed or modified since the previous midnight. Resources viewed or modified during the past 30 days.3. 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. and analysis views. The access time filter has the following settings. etc). images. Displays only Domains. as a result. and other files that only administrators may add to the repository. Resources viewed or modified during the past 7 days. Domains. 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. these filters can help you find your most recently viewed reports. both JRXML reports and Ad Hoc reports. Selects only resources that have been run and viewed by the currently logged in user. report output. Only reports that have scheduled jobs. and data sources. Displays all types except reports. including today. Displays only dashboards. data types. This includes input controls.

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

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

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

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

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

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

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

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

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

JasperServer User Guide 26 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3 Tables. Count Sum Date Date Date Date Date ... For instance. and the rows could be grouped by city and product. Change the page orientation.. This option is only available if the table includes grouped columns. 43 . In tables. Change the page size.. Amount Amount Amount Amount Amount . 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 also hide or show the detail rows when the data is summarized.1.. You can: Change whether to display the filter pane. Change whether to display the title. Columns can include both properties and measures. each row represents a something being measured. each column might contain one measurement of the orders. Rows can be grouped by their properties. charts. 4.. Charts.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. in a report on orders. 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 . and Crosstabs The Ad Hoc Editor provides three modes for working with your data—tables.

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

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

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

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

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

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

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. or crosstab. you can: View the report in presentation mode by clicking . chart.1.2.3 Viewing and Running a Report in the Editor When you have created a compelling table.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. or Actual Size) if your table fits one of these formats better. Click and select a page size (Letter. In the Ad Hoc Editor. This section describes: Creating an Initial Layout Focusing on Specific Data Refining the Crosstab 50 . Run the report by clicking . “Running a Simple Report. as described in 3. you can save it in the repository for future use. The following example explores the state sales data in the Foodmart sample data that can be installed with JasperServer. 4.” on page 27. 4. A4. When you run the report. you can also run the report directly from the repository. it is displayed as a Jasper Report.

7.1 1. 6. For example. Right-click the Store Country column group label and select Expand Members. Right-click Customer State and select Switch to Column Group. Review the data in the crosstab. There are a exceptions. Use the scroll bars if necessary. 4. 51 . Customer State into the Row Group area. every cell shows a zero except for the first. click Crosstab. The non-zero values mainly appear in cells where the Store State column group intersects a Store Customer row for the same state. 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. Drag: Store Country into the Column Group area. 3.3. in the BC column group. The location of this Topic may depend on your system configuration. 8. Store Sales as Measure. Store State into the Column Group area. where both the Store State column group and the Customer State row group are BC. It is typically in Ad Hoc Components/Topics. select the foodmart data for crosstab Topic. and specify a location. click Create > Ad Hoc Report. Creating an Initial Layout To set up the crosstab and define its initial layout: After logging into JasperServer. and click Open Report. Create a crosstab. but they are obscured by all the zero values. 5. 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. The Topics and Domains window appears. Right-click the Product Family row group label and select Expand Members. Set the data format: right-click Store Sales in the measure label area and click Change Data Format > ($1234. Product Family into the Row Group area.Working with the Ad Hoc Editor 4. The Ad Hoc Editor appears. Figure 4-5 Crosstab of Foodmart sales totals by state and product family Note that zeroes appear in many of the cells. Click Save > Report enter a name. 2.56).

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

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

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

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

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

the order in which you select fields matters. right-click a numeric field and select Create Custom Field from the context menu. days. such as years. When you right-click and select Create Custom Field > Subtract #. Date functions can calculate the difference between two dates in a number of intervals. For example. consider a report that includes both a Cost and a Revenue field. For example. Create a custom field by selecting an existing field in the list of fields or in the report area of a table report. for example. When working with multiple fields: You can only select basic functions and date differences.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. You can use these functions with a constant (such as multiplying the cost by two to calculate a standard 50% markup). In the list of fields. In this case. create two custom fields. When a custom field is the basis of another field. For example. and division. nor do they support multiple fields. you can’t delete it until you delete the one that builds on it. the Create Custom Field option appears on the context menu when you right-click a numeric field. weeks. and seconds. percent of group. You can multiply or add any number of fields. as this may affect the results. pay special attention to the order in which you create the custom fields. you can create complex calculations. To use more than one function to create the field you need. The Ad Hoc Editor supports three types of functions: Basic functions include addition. but ordered functions (subtract and divide) and date functions can only be used with two fields at a time.Working with the Ad Hoc Editor Is this an isolated incident or a growing trend? If it’s a trend. You could calculate the profit for each record by creating a custom field that subtracts the Cost field from the Revenue field. 57 . Because custom fields can build upon one another. Special functions include round. the Ad Hoc Editor assumes you are subtracting the Cost field from the Revenue field. with one building on the other. For ordered operations. You can always change the order of fields using the context menu’s Swap Fields option. you could divide the Profit custom field in the previous example by the Revenue field to express each record’s margin as a percent. then Ctrl-click Cost. A custom field can only include a single function.4. subtraction. Select multiple fields using Ctrl-click. the columns’ borders change color to indicate that multiple fields are selected. multiplication. To create a custom field based on one field: 1. or you can use them with multiple fields. rounding then multiplying yields different results than multiplying then rounding. to calculate profit in the example above. right-click to open the context menu and create a custom field. percent of total. 4. 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.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. and rank. click Revenue first. These functions don’t take constants.

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

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

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

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

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

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

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

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

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

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

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

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

Expand the Accounts set and drag the Account Name item to the grouping icon. and the list of fields shows the item sets selected in step 4.” on page 48. Click the arrow next to the Spacer item. 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. click Open Report. “Formatting the Appearance of a Table. Figure 4-20 Ad Hoc Editor with Fields Configured for Report As shown in this example.” on page 45 and 4. d.2. Design your report in the Ad Hoc Editor. In this example: c.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. 14.5. e. Drag the Opportunities set to the report area to add all its fields as columns. Notice that all amounts are greater than 10000. 13. They are added (with the display name) in the order you defined on the Display page in step 4. you can save them as a Domain Topic. “Selecting the Content of a Report. 12. The Ad Hoc Editor appears. as determined by the filter you defined.3. “Creating Topics from Domains. f. Expand the Users set and click the arrow next to the Last Name field. 70 . If you want to create different reports with the same settings. as described in section 4. To confirm all the selections made in the Choose Ad Hoc Data wizard and begin creating a report.2.1. as described in section 4.” on page 73.

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

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

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

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

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. filter definitions. click Done.5. and the Domain Topic is created when you subsequently click Done anywhere in the Choose Ad Hoc Data wizard. navigate to the other pages to finish making your settings. Otherwise.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. You can also change the name and description by returning to this Topic page anytime before clicking Done in the wizard.Working with the Ad Hoc Editor Figure 4-22 Entering Information Needed for Saving a Domain Topic 3. 75 . Your Domain Topic name and description are preserved. If your data selections. While its repository type is Domain Topic.3. The new Topic appears in the Ad Hoc Components > Topics folder. and display settings are complete as well.

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

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

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

as well as a discussion of using the using iReport plug-in for JasperServer. along with any other resources the report needs. You can add these reports in two ways: From within JasperServer. 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 . When you upload the report. define the report and use the iReport JasperServer plug-in to upload it. you can create reports outside of JasperServer and add them to the repository. upload a JRXML file to the repository. From iReport. a wizard guides you through each step. This section gives both a simple and a complex example of uploading a report using JasperServer’s wizard.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.

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

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

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

Click Next. Accept the default naming of the image by clicking Next. 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. and cannot be defined in the main JRXML.Adding Reports Directly to the Repository 13. click Upload From File System and browse to the file <js-install>/samples/images/logo. 83 . For the second image resource. 5. in this case JasperServer. in the process of creating a report unit. 15. click Add Now on the Resources List page of the Report Wizard. Click Next to proceed to the Data Source page. you must define a data sources in JasperServer that the report can use. JasperServer uploads the file. 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 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. 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. For AllAccounts_Res2.jpg.4 Defining the Data Source Data sources belong to the report engine.2. Therefore.

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

4. Click Next. Enter the following properties for the example: Name – CanadaAccounts. As with the default data source. we create a query that retrieves only Canadian accounts. Select None to use the report unit’s existing data source.2.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. you can select one from the repository or define a new one. 25. 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. 23. Label – CanadaAccounts. Description – Query for New Simple Report in User Guide. The Edit Query page appears: Figure 5-14 Entering a Locally Defined Query on the Edit Query Page 26. “Defining the Data Source. In this example.” on page 83. 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 . the Report Wizard gives you the opportunity to select a data source that overrides the one associated with the report unit. Selecting None uses the default data source that you selected in section 5. 24. then click Next.

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

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

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

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

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

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

a strict maximum means the value itself is not allowed. in this example choose Number. 92 . click Add Control. select Locally Defined. Type – Determines the format of the data that the user may enter. The number format allows users to enter both integers and decimals. a strict minimum means the value itself is not allowed. 18. but they are visible only when defining the input control: Name – integer_type.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. Click Save. Label – Integer Control. Minimum value and Is strict minimum – The lower bound of the value the user may enter. To add a simple check box input control to the complex report example: 17. Description – An optional description that only appears within the report wizard. Figure 5-27 Added Controls in the Resources List of the Report Wizard 5.JasperServer User Guide 15.2. Leave blank in this example. 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. Leave blank in this example. leave blank in this example. The Resources List page appears with the new TextInput control in the list of resources. On the Resource List page of the report wizard. Maximum value and Is strict maximum – The upper bound of the value the user may enter. 16. Your report must handle both kinds of values when processing the parameter that receives the number.9. On the Locate Input Control page. On the next page.

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

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

Click Next. 34. select Locally Defined. Type – Single Value in this example. so you must enter it exactly as shown: Parameter Name – DateInput in this example.2. click Add Control. 31. On the Resource List page of the report wizard. select From the Repository. 29.2. as well as what value is passed as the corresponding parameter. click Add Control.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.9. On the next page.4 Adding a Date Input Control In this example of adding a date input control. You must configure the query and designate how the results are displayed in the input control. Description – Leave blank in this example. Prompt Text – Date Input Control in this example. 30. Read-only. Mandatory. On the next page. select Locally Defined. On the Resource List page of the report wizard. Select /datatypes/date from the drop-down: Figure 5-34 Locating the Datatype for the Date Input Control 32. Visible – Use the default settings in this example. 5. JasperServer performs a query whose results are used to create the list of choices.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. 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 Resources List page appears with the new DateInput control. The drop-down automatically shows the data datatypes found in the repository.Adding Reports Directly to the Repository 5. On the Locate Input Control page. To add a query-based input control to the complex report example: 33. 95 . On the Locate Input Control page.

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

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

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

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

the maximum value itself is not permitted. edit the report to review your settings. JasperServer enforces the proper format defined for each input control. the minimum value itself is not permitted.JasperServer User Guide 47.2. 5. 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. Clicking OK closes the Report Options window. If checked. The sample report includes a header that displays the value of each parameter received from the input controls. If checked. only values less than the maximum value are permitted. Possible values are Text. The highest permitted value for the field. only values greater than the minimum value are permitted. Date. 100 .11 More about Datatypes A datatype in JasperServer is more than just a classification of the data. If running the new report results in an error. The actual data type. Enter a number and click OK or Apply again. as shown in the righthand figure. The lowest permitted value for the field. clicking Apply keeps it open to easily change values and run the report again. A regular expression that restricts the possible values of the field. The maximum number of characters allowed in the field. The Text Input Control is defined as a numeric type and only accepts valid numbers. If you cannot identify the problem. Any additional information you want to provide about the datatype. or Date-Time. It also includes validation criteria. The label of the datatype. 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. Number. 48. Click OK or Apply to run the report with the selected input. The number of decimal places allowed in 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.

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

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

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

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

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

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

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

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. Click Save Report Unit in the Properties window to make the changes effective in the JasperServer repository. 5.” on page 115. For more information about Domains. The plug-in is installed in iReport by default.5 1. “Creating Domains. 108 . It relies on the JasperServer plug-in to access the repository. If the report does not display. Figure 5-51 Report Parameters Window in iReport The report is displayed in the Report Viewer Window. If the report has input controls.4.JasperServer User Guide Figure 5-50 Editing Parameters of a Report Unit in iReport 5. and it limits the data to that which is appropriate for the audience. 5. 2. the Report Parameters window prompts you for values. The Domain plug-in enables iReport users to generate reports from Domains.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. see chapter 6.4. look for errors or messages in the Report Problems Window at the bottom of the iReport interface.

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

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

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

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

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

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

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

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

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

11. then click a join icon. Type the following query: select * from cases where cases. 10. To specify a join. 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 . For this example. 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. Click Create. Create a derived table as follows: a. A derived table is defined by a query and a selection of the columns in the result. 12. 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. Click Next to proceed to the Joins tab. expand the tables to see column names. Select the same . and rename it to users2. c. in this example: p1cases.priority=1 and cases. d. The new derived table is shown in the list of tables and contains the columns you selected.deleted=false Click Run to see the columns in the result of the query. select a column in the left table list and a column in the right table list. b. Click New and enter a meaningful name in the Query ID field. 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. In the left-hand list. Now there are two table aliases for the users table to avoid circular joins.JasperServer User Guide 9.

and the right outer join includes P1 cases without assigned users. The list of available columns shows all the joined and unjoined tables resulting from the joins you defined.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. but itself was not joined to the other tables. 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. In this example. you can expand the join tree and double-click column names to insert them. '. 121 . In this example. then enter the following details for a calculated field that creates unambiguous city names: Name: city_and_state Type: String Expression: concat( accounts. click Next to proceed to the Calculated Fields tab.billing_address_state ) When entering the expression. '.billing_address_city. Figure 6-6 Calculated Fields Tab of the Domain Designer 14. Click Create Field to begin. the left outer join includes accounts without P1 cases. accounts. 13.

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

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

The Add New Domain dialog appears again. The new Domain is stored in the repository folder named in the Location field and appears in search results. 2009 When used in reports. Set the data format and summary properties on the following items: Opportunity. 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. Date: data format of Jan 01. The example Domain design is finished. Click Done.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. Date: data format of Jan 01. 20. 21. Amount: data format of ($1. 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. Click Save in the Add New Domain dialog. 2009 Opportunity.234) and summary using average P1 Case. 124 . these items will have the data formats and summary functions by default.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.7. For more information. refer to the JasperServer Administrator Guide. refer to section 5. Click Window > JasperServer Repository. or In Linux. The mail server must be manually configured after installation in order for users to send email notifications.4. In Windows. A JasperServer pane appears in the upper left corner of your iReport workspace.7 JasperServer Professional or Enterprise 3.2./iReport. 166 .2 iReport Plug-ins By default. For more information on mail configuration.7 The Domain plug-in is included by default in the Professional version of iReport. “Using the JasperServer Plug-in for iReport. 2. 3. iReport includes JasperServer and Domain plug-ins.5 or greater JasperServer with enabled web services To launch the JasperServer Plug-in in iReport 1. iReport 3. click Start > All Programs > JasperServer Pro > Start iReport. 8.” on page 103. The JasperServer plug-in enables you to move reports between iReport and JasperServer.sh at the command prompt. 8. change to the iReport home directory and enter .1 JasperServer Plug-in The JasperServer plug-in requires: iReport 3.2 Domain Plug-in The Domain plug-in for iReport requires: JasperServer plug-in. Launch iReport.2. iReport opens. 8. The Domain plug-in enables you create reports from Domains in the JasperServer repository.7 Java Sun JDK 1. To launch iReport: 1.

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

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

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

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

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

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

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. unsummarized 63 theme for 112 types of charts 63 unique features 63 Charts Pro 29 Choose Ad Hoc Data wizard 67. 74.Index INDEX A access grants and scheduled reports 34 Domain column-level 159 Domain row level 157 effect of grants 68. 69. 66 alternate group 42. 49 add function 57 Add New Domain wizard 118 adding a design file as a new Domain 150 adding reports 87 alphabetical ascending 54. 66 percent of column group parent 53. 45 input controls 59 limits on reports 78 page properties 43 parametrized queries 59 reports 41 rounding and custom fields 58 saving reports 42. 47. count all 66 creating 173 . 98 CGP 53. 47. 49 tool bar 42 Ad Hoc reports and dashboards 24 kinds 43 limits 78 localization 77 saving 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. 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. See input controls. 58 summarizing 47 controls.

25 and parameters 25 and screen size 23. 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 . and scheduled reports 34 datasets 42 datatypes 92. 103 crosstab reports adding fields 65 and dashboards 24 and dataset size 42 collapse group 65 collapse members 66 column group parent 53. 23 and input controls 19. 23 creating 17–24 deleting content 21. 25 mapping input controls to URLs 20 multiple selection 22. 74. 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. 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. 87. 66 expand group 65 expand members 51. 58 compared with table 44 drill to details 66 exclude 52. 66 Data page 67 data policies 78 data sources. 66 measures 65 percent of group 58 pivoting 65 row and column groups 65 row group parent 53. 79. 66 switch to column group 51. 100 date functions 57 design files See also Domains. FILE protocol 23 limitations 17. 22 designer 18 edit 24 HTTP v. 24 area 18 auto-refresh interval 21 behavior when content deleted from repository 23 buttons 17 containing other dashboards 22.JasperServer User Guide dashboards 17–24 Domain security files 155 Domain Topics 73 reports 73. access grants. 23 overview 17 proportional v. 22. 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. 58 sample size 66 sample Topic 65 setting data formats 66 sorting 54. 66 hyperlinks 66 keep only 52.

69. 155 saving 73 Domains See also design files. 69. 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. 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. 74. 155 exporting designs to XML files 140 filtering data for a report 68 filters 69 Groovy 156 input controls 110 item sets 68. 59 limitations 25 mapped to custom URLs 20. 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. 74.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. 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. 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. 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. 65 filter pane 43. 61. 22 pop-up page 31 175 . 98 check box 92. 25 and parametrized queries 59 cascading 33. 166 editing 135 effect of access grants 68. 123 joins 120. 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. 52. See Domain Topics. 51. 66 exporting Domain designs to XML design files 140 external resources 88 F fields changing for Domain-based reports 71 in crosstab reports 64.

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. joins in Domains 120. 59 running a report with parametrized queries 30 passwords 8 percent of group parent functions 57. 113 JasperAnalysis 9 Job Details pages 35 Jobs List page 34 jobs. single controls in dashboard 17 multiply function 57 N Naming page 81 numeric ascending and descending 54. 58 percent of total function 57 physical layer 156 pie chart 63 pivoting 42. 61. 65 plug-ins Domain 108. 127. 107 running reports 108 item sets 68. 166 JRXML files 107 limits on reports 78 repository 105. 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. 50 preview 18 principal expressions 156 print view 17 176 . 77. See scheduling reports. 166 JasperServer 166 portal 64 presentation layer 156 presentation mode 42. 123 itemGroups element in design files 141. 66 O online help 9 Oracle choosing schemas 125. 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. 101 localization of Domains 161 Locate Query page 84 logging in 8 M Main JRXML page 81. 142 items element in design files 142 J JAR files 87. 87 K keep only 52 L layouts of reports 43 Liferay 64 line chart 63 locale bundles 161 locales 8.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. 88. 87 Maps Pro 29 measures 65 messages about system events 165 Messages page 165 multiple v. 25 and reports 40 in reports run from Domain plug-in 110 in the Ad Hoc Editor 42.

65 running 27. 142 RGP 53.jpg 80 SalesByMonth. 105 crosstab layout and formatting options 65 crosstab vs. 99 with input controls 30 repository in iReport 105. 50. Ad Hoc 41 adding 87 adding fields 46. 49 saving report output 28 selecting styles 48 setting data formats 49. 66 summarizing rows and columns 47. 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. table and chart 43. 103.jrxml 80. 58 round function 57 row-level security in Domains 157 rows percent of row group parent 53. 42. 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. 66 sorting 62. 65 summarizing 47 running reports See also reports and scheduling reports. 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.Index properties. 74. 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. 81 logo. 30 Flash charts 29 from iReport 108 in the Ad Hoc Editor 42. access grants and scheduled reports 34 defining a job 35 defining schedules 34 editing a job 38 177 . 69. 68. 74. 108 sample size 66 sample Table report 45 saving in the Ad Hoc Editor 42. 65 adjusting column width 49. 47. example 27. 79. crosstab and chart 43. 66 based on Domains 78 based on JDBC data sources 78 chart layout and formatting options 63 creating 73. in locale bundles 161 proportional sizing 23. 39.jrxml 87 SalesByMonthDetail. 66 table vs. 47. 87. 50 in the background 39 limits 78 on a schedule 35 S sample Domains 117 sample files AllAccounts.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. 107 main page 10 manager 117 searching 10 system messages 165 reset 17. 58 row groups 46. 71 validating 86.

69. 62. 76 creating 76 defined 76 field names in 77 JRXML files 73 localization 77 parametrized queries 59 saving Domains as Topics. 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 . 99 version attribute in design files 141 viewing dashboards 16 fields and data in a Domain 68. 65 switch to row group 65 switching groups 42. See Domain Topics. Simple Domain Topic 117 uploading 76 Topics and Domains page 67 TrueType fonts 88 U undo 42. for charts 112 time series chart 63 time zones 8 tool bar 42 Topics See also Domain Topics. 66 spacer 49 special content in dashboards 17. 54. 55 undo all 42. 20 special functions 57 standard controls in dashboards 17 styles 48 submit 17. 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. access grants and scheduled reports 34 as JRXML files 73. See design files. multiple controls in dashboard 17 slice 52. 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. 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. screen sizes 24 search expression 13 search field 11 security files column-level security 159 effect of access grants 68. 66 sorting reports 42. 62 spacer 49 summarizing rows and columns 47 text label 17 themes. unsummarized charts 63 SuperMart 16 switch to column group 51. 56 uploading edited design files 150 URLs in dashboards 20 utilities iReport 166 messages 165 V validating reports 86. 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. 20 subtract function 57 summarized vs.JasperServer User Guide recurrence 38 viewing job schedules 34 schema element in design files 141 schemaLocation attribute in design files 142 schemas.