JASPERREPORTS SERVER ADMINISTRATOR GUIDE RELEASE 5.6.1 http://www.jaspersoft.com Copyright ©2005-2014, TIBCO Software Inc. All rights reserved. Printed in the U.S.A. Jaspersoft, the Jaspersoft logo, Jaspersoft iReport Designer, JasperReports Library, JasperReports Server, Jaspersoft OLAP, Jaspersoft Studio, and Jaspersoft ETL are trademarks and/or registered trademarks of TIBCO Software Inc. 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 0814-JSP56-20 of the JasperReports Server Administrator Guide. TABLE OF CONTENTS Chapter 1 Overview of JasperReports Server Administration 11 1.1 Overview of Organizations 12 1.1.1 Single Default Organization 12 1.1.2 Multiple Organizations 12 1.1.3 Levels of Administrators 13 1.2 Overview of the Repository 14 1.2.1 Folder Structure 14 1.2.2 Resources 14 1.2.3 Sample Data 15 1.2.4 Browsing and Searching 16 1.3 Overview of Users and Roles 17 1.3.1 Administering Users and Roles 17 1.3.2 Delegated Administration 18 1.4 Overview of Security 19 1.4.1 Authentication 19 1.4.2 Authorization Overview 20 1.5 Administrator Login 21 1.5.1 JasperReports Server Heartbeat 21 1.5.2 Administrator Email 21 1.6 Administrator Pages 22 Chapter 2 Organization, User, and Role Management 25 2.1 Managing Organizations 25 2.1.1 Viewing Organization Properties 27 2.1.2 Creating an Organization 27 2.1.3 Default Folders for Organizations 28 2.1.4 Editing an Organization 28 2.1.5 Deleting an Organization 29 2.2 Managing Users 29 2.2.1 Viewing User Properties 30 2.2.2 Creating a User 31 2.2.3 Editing a User 33 2.2.4 Editing Profile Attributes 34 3 JasperReports Server Administrator Guide 2.2.5 Enabling or Disabling Users in Bulk 36 2.2.6 Deleting One or More Users 36 2.3 Managing Roles 36 2.3.1 Viewing Role Properties 38 2.3.2 Creating a Role 39 2.3.3 Assigning Users to a Role 39 2.3.4 Deleting One or More Roles 40 Chapter 3 Repository Administration 43 3.1 Resource Types 44 3.2 JasperReport Structure 45 3.2.1 Referencing Resources in the Repository 46 3.2.2 Absolute References 46 3.2.3 Local Resources and External References 47 3.2.4 References in Subreports 48 3.2.5 Data Snapshots 48 3.3 Managing Folders and Resources 48 3.3.1 Resource IDs 49 3.3.2 Creating Folders 49 3.3.3 Adding Resources 50 3.3.4 Renaming Folders and Resources 51 3.3.5 Copying and Moving 52 3.3.6 Editing Resources 53 3.3.7 Deleting Folders and Resources 54 3.4 Multiple Organizations in the Repository 55 3.4.1 Organization Folders 55 3.4.2 Design Considerations 55 3.4.3 Referencing Resources in the Repository 56 3.4.4 Best Practices 57 3.5 Permissions 57 3.5.1 Inheriting Permissions 58 3.5.2 Cumulative Permissions 59 3.5.3 Administrator Permissions 59 3.5.4 Execute-Only Permission 59 3.5.5 Default User Permissions 60 3.5.6 Setting Permissions 60 3.5.7 Testing User Permissions 62 Chapter 4 Data Sources 65 4.1 JDBC Data Sources 66 4.2 Managing JDBC Drivers 68 4.3 JNDI Data Sources 71 4.4 AWS Data Sources 73 4.5 Cassandra Data Sources 75 4.5.1 Creating a Cassandra Data Source 76 4.5.2 Increasing File Descriptor Limits for Cassandra 77 4.6 Hadoop-Hive Data Sources 78 4 4.7 MongoDB Data Sources 80 4.8 Virtual Data Sources 82 4.8.1 Performance Considerations 85 4.8.2 Logging for Virtual Data Sources 85 4.9 Big Data Connectors for Virtual Data Sources 86 4.9.1 Creating Big Data Connectors 86 4.9.2 Relational Schema for MongoDB Connector 87 4.10 Bean Data Sources 88 Chapter 5 Other Resources in the Repository 91 5.1 Queries 91 5.2 Datatypes 94 5.3 Lists of Values 95 5.4 Input Controls 96 5.5 Query-based Input Controls 99 5.5.1 Creating a Query-based Input Control 99 5.5.2 Built-in Parameters for Query-based Input Controls 103 5.5.3 Domain-based Queries 104 5.6 Cascading Input Controls 105 5.6.1 Parameters in Input Control Queries 106 5.6.2 Creating a Cascading Input Control 107 5.7 File Resources 110 5.7.1 Fonts 111 5.7.2 JAR Files 111 5.7.3 Resource Bundles 111 5.7.4 Creating a File Resource 112 5.7.5 Editing a File Resource 112 Chapter 6 Themes 115 6.1 Introduction to Themes 115 6.2 How Themes Work 117 6.2.1 Theme Files 118 6.2.2 Inheritance Mechanism 119 6.2.3 CSS Priority Scheme and Custom Overrides 120 6.3 Administering Themes 120 6.3.1 Setting the System Theme 121 6.3.2 Setting an Organization Theme 122 6.3.3 Restricting Access to Themes 123 6.4 Creating Themes 124 6.4.1 Creating Theme Folders and File Resources 124 6.4.2 Downloading and Uploading Theme ZIP Files 125 6.4.3 Placing Themes in the Folder Template 127 6.5 Working With CSS Files 127 6.5.1 Theme Development Workflow 127 6.5.2 Firebug Plug-in for Firefox 128 6.5.3 Test Platform 128 6.5.4 Modifying the Appearance of Jaspersoft OLAP 129 5 JasperReports Server Administrator Guide 6.5.5 User Interface Samples 129 Chapter 7 Import and Export 131 7.1 Import and Export Catalogs 131 7.1.1 Setting the Import-Export Encryption Key 132 7.1.2 Importing Unencrypted Catalogs 132 7.2 Import and Export Through the Web UI 132 7.2.1 Exporting From the Repository UI 133 7.2.2 Exporting From the Settings UI 134 7.2.3 Importing From the Settings UI 135 7.3 Import and Export Through the Command Line 137 7.3.1 Exporting From the Command Line 137 7.3.2 Importing From the Command Line 139 7.3.3 Configuring Import-Export Utilities 141 7.4 Alternate Import-Export Scripts 142 7.4.1 Running Import from Buildomatic 142 7.4.2 Running Export from Buildomatic 142 Chapter 8 Application Security 145 8.1 Encrypting Passwords in Configuration Files 146 8.1.1 Encrypting Configuration Passwords on Tomcat (or Spring tcServer) 146 8.1.2 Encrypting Configuration Passwords on Enterprise Servers 147 8.1.3 Encrypting Additional Properties in default_master.properties 147 8.1.4 Password Encryption for External Authentication 149 8.1.5 Encryption Options 149 8.2 Configuring User Password Options 150 8.2.1 Configuring Password Memory 151 8.2.2 Enabling Password Expiration 151 8.2.3 Allowing Users to Change their Passwords 152 8.2.4 Enforcing Password Patterns 152 8.3 Configuring the User Session Timeout 153 8.4 Configuring CSRF Prevention 154 8.5 Configuring Input Validation 154 8.5.1 Customizing Security Error Messages 156 8.5.2 Editing Input Validation Rules 156 8.5.3 Creating Validator Expressions 158 8.5.4 Validating New Input Parameters 158 8.5.5 Query Validation 159 8.5.6 Further Configuration 159 8.6 Restricting File Uploads 160 8.7 Hiding Stack Trace Messages 162 8.8 Defining a Cross-Domain Policy for Flash 162 8.9 Encrypting User Passwords 164 8.9.1 Dropping and Recreating the Database in PostgreSQL 166 8.9.2 Dropping and Recreating the Database in MySQL 166 8.9.3 Dropping and Recreating the Database in Oracle 166 8.9.4 Dropping and Recreating in the Database in Microsoft SQL Server 166 6 8.10 Encrypting User Session Login 167 8.10.1 Dynamic Key Encryption 168 8.10.2 Static Key Encryption 168 Chapter 9 System Configuration 171 9.1 Configuration Settings in the User Interface 172 9.2 Configuration for Using Proxies 175 9.3 Configuration for Session Persistence 176 9.4 Configuring Ad Hoc 178 9.4.1 Ad Hoc Query Settings 178 9.4.2 Ad Hoc Data Policies 179 9.4.3 Ad Hoc Data Policies for Big Data 181 9.4.4 Ad Hoc Templates and Report Generators 181 9.4.5 Ad Hoc Configuration File 183 9.4.6 Ad Hoc Cache Management 184 9.4.7 Ad Hoc OLAP Filter Configuration 189 9.5 Enabling Data Snapshots 190 9.5.1 Global Data Snapshot Configuration 190 9.5.2 Report-level Data Snapshot Configuration 191 9.5.3 Data Snapshots in the Scheduler 192 9.6 Configuring System Logs 192 9.6.1 Managing Log Settings 193 9.6.2 Log Configuration Files 196 9.6.3 Adding a Logger to the Log Settings Page 197 9.7 Configuring Amazon Web Services 197 9.8 Configuring Domains 199 9.8.1 Disabling the Domain Validation Check 200 9.8.2 Optimizing Snowflake Schema Joins 200 9.8.3 Configuring Domain Dependency Behavior 201 9.8.4 Enabling Oracle Synonyms 202 9.8.5 Enabling CLOB Fields 203 9.8.6 Enabling Proprietary Types 204 9.8.7 Extending JDBC Type Mapping 205 9.8.8 Accessing Materialized Views 205 9.9 Configuring JasperReports Library 206 9.9.1 Extending JasperReports Library 206 9.9.2 Changing the Crosstab Limit 207 9.9.3 Setting a Global Chart Theme 207 9.9.4 Disabling Interactivity in the Report Viewer 208 9.9.5 Enabling the XHTML or HTML Exporters 208 9.9.6 Enabling Flash or HTML5 for Pro Charts 209 9.9.7 Configuring a JavaScript Engine for Graphical Report Rendering 210 9.10 Configuring Input Control Behavior 212 9.11 Configuring the Scheduler 213 9.11.1 Configuring the Scheduler Misfire Policy 213 9.11.2 Configuring Scheduler Failure Notifications 214 7 JasperReports Server Administrator Guide 9.11.3 Restricting File System Output 215 9.11.4 Removing Report Scheduling Interval Options 216 9.11.5 Adding a Holiday Exclusion Calendar 216 9.12 Configuring the Heartbeat 218 9.13 Configuring the Online Help 219 Chapter 10 Server Diagnostics 221 10.1 Events Being Audited and Monitored 222 10.2 Configuring Auditing and Monitoring 223 10.2.1 Enabling Auditing and Monitoring 223 10.2.2 Auditing Archive Options 224 10.2.3 Disabling Events and Properties 225 10.3 Using the Audit Data 226 10.3.1 Audit Domain Items 227 10.3.2 Audit Reports and Ad Hoc Views 229 10.4 Using the Monitoring Data 230 10.4.1 Monitoring Domain Items 230 10.4.2 Monitoring Reports and Ad Hoc Views 231 10.5 Importing and Exporting Event Data 232 10.6 Real-Time Diagnostics 233 10.7 Exposing Diagnostics Through Jaspersoft's JMX Agent 233 10.7.1 Connecting to the JMX Agent 233 10.7.2