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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

JasperServer User Guide 26 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

the click OK. click Browse. 118 . The Add New Domain wizard opens to the Data and Design page. 3. repository location. You can expand each table to see its individual columns. enter a name. Figure 6-1 Data and Design Page of the Add New Domain Dialog 4. 5.JasperServer User Guide 2. Click Launch Domain Designer on the Create tab under the Design heading. The Domain Designer opens to the Tables tab showing the data source you selected in the previous step. Locate the folder where you want to place the Domain. Under the Properties heading. Right-click the folder and select Add Resource > Domain from the context menu. Under the Data Source heading. and optional description of the Domain. In this example. for example Organization > Domains. expand and select Analysis Components > Analysis Data Sources > SugarCRM Data Source. Figure 6-2 Select a Data Source Dialog for a New Domain 6. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

22 pop-up page 31 175 . 74. 69. 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.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. 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. 166 editing 135 effect of access grants 68. 123 joins 120. 155 exporting designs to XML files 140 filtering data for a report 68 filters 69 Groovy 156 input controls 110 item sets 68. 98 check box 92. 65 filter pane 43. 52. See Domain Topics. 74. 61. 69. 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. 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. 155 saving 73 Domains See also design files. 51. 132 locale bundles 161 localization 161 presentation and physical layers 156 principal expressions 156 properties files 161 referential integrity 136 samples 117 saving as Topics. 66 exporting Domain designs to XML design files 140 external resources 88 F fields changing for Domain-based reports 71 in crosstab reports 64. 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. 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. 25 and parametrized queries 59 cascading 33.

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

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

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