TIBCO Jasperreports® Server Administrator Guide
Total Page:16
File Type:pdf, Size:1020Kb
TIBCO JasperReports® Server Administrator Guide Software Release 7.8 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDER SEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH, THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITH TIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES, AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWN DISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDING TO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THE FOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS. This document is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, the TIBCO logo, Jaspersoft, JasperReports, and Visualize.js are registered trademarks of TIBCO Software Inc. in the United States and/or other countries. Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details. Copyright © 2005-2020. TIBCO Software Inc. All Rights Reserved. Version 0820-JSP78-32 of the TIBCO 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 13 1.1.3 Levels of Administrators 13 1.2 Overview of the Repository 14 1.2.1 Folder Structure 14 1.2.2 Resources 15 1.2.3 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 18 1.5 Administrator Login 20 1.5.1 JasperReports Server Heartbeat 20 1.5.2 Administrator Email 21 1.6 Administrator Pages 21 Chapter 2 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 29 2.1.5 Deleting an Organization 30 2.2 Managing Users 30 2.2.1 Viewing User Properties 31 2.2.2 Creating a User 32 2.2.3 Editing a User 33 2.2.4 Enabling or Disabling Multiple Users 34 2.2.5 Deleting One or More Users 34 2.3 Managing Roles 34 2.3.1 Viewing Role Properties 36 TIBCO Software Inc. 3 TIBCO JasperReports Server Administrator Guide 2.3.2 Creating a Role 37 2.3.3 Assigning Users to a Role 37 2.3.4 Deleting One or More Roles 38 2.4 Managing Attributes 39 2.4.1 Referencing Attributes 39 2.4.2 Attribute Hierarchy 40 2.4.3 Attribute Encryption 40 2.4.4 Attribute Permissions 41 2.4.5 Managing Server Attributes 42 2.4.6 Managing Organization Attributes 43 2.4.7 Managing User Attributes 46 Chapter 3 Repository Administration 49 3.1 Resource Types 49 3.2 JasperReport Structure 51 3.2.1 Referencing Resources in the Repository 52 3.2.2 Absolute References 52 3.2.3 Local Resources and External References 53 3.2.4 References in Subreports 54 3.2.5 Data Snapshots 54 3.3 Managing Folders and Resources 54 3.3.1 Resource IDs 54 3.3.2 Creating Folders 55 3.3.3 Adding Resources 56 3.3.4 Renaming Folders and Resources 57 3.3.5 Copying and Moving 58 3.3.6 Editing Resources 59 3.3.7 Deleting Folders and Resources 60 3.4 Multiple Organizations in the Repository 61 3.4.1 Organization Folders 61 3.4.2 Design Considerations 61 3.4.3 Referencing Resources in the Repository 62 3.4.4 Best Practices 63 3.5 Repository Permissions 63 3.5.1 Inheriting Permissions 65 3.5.2 Cumulative Permissions 65 3.5.3 Administrator Permissions 65 3.5.4 Execute-Only Permission 66 3.5.5 Default User Permissions 66 3.5.6 Setting Permissions 66 3.5.7 Testing User Permissions 68 Chapter 4 Data Sources 71 4.1 Attributes in Data Source Definitions 72 4.2 JDBC Data Sources 74 4.3 Managing JDBC Drivers 76 4.4 JNDI Data Sources 79 4 TIBCO Software Inc. 4.5 AWS Data Sources 81 4.5.1 Creating an AWS Data Source 81 4.5.2 Filtering the Regions For AWS Data Source 84 4.6 Azure SQL Data Sources 84 4.6.1 Uploading an Azure Certificate File to the Repository 84 4.6.2 Creating an Azure SQL Server Data Source 85 4.7 Hadoop-Hive Data Sources 86 4.8 MongoDB Data Sources 87 4.8.1 Creating a MongoDB Data Source with the Native MongoDB Driver 87 4.8.2 Creating a MongoDB JDBC Data Source 89 4.8.3 Using Kerberos Authentication with MongoDB Data Sources 91 4.8.4 Creating a Schema with the Schema Tool 92 4.8.5 Uploading a Schema to the Repository 92 4.9 Virtual Data Sources 92 4.9.1 Performance Considerations 95 4.9.2 Creating Cassandra Data Connectors 95 4.9.3 Logging for Virtual Data Sources 96 4.10 TIBCO Data Virtualization 96 4.11 XLS and XLSX Data Sources 99 4.12 File Data Sources 101 4.13 Bean Data Sources 104 Chapter 5 Other Resources in the Repository 107 5.1 Queries 107 5.2 Datatypes 109 5.3 Lists of Values 110 5.4 Input Controls 111 5.5 Query-based Input Controls 114 5.5.1 Creating a Query-based Input Control 114 5.5.2 Built-in Parameters for Query-based Input Controls 118 5.5.3 Domain-based Queries 120 5.6 Cascading Input Controls 122 5.6.1 Parameters in Input Control Queries 122 5.6.2 Creating a Cascading Input Control 124 5.7 File Resources 128 5.7.1 Fonts 129 5.7.2 JAR Files 129 5.7.3 Resource Bundles 130 5.7.4 Creating a File Resource 130 5.7.5 Editing a File Resource 131 5.7.6 Uploading an SSH Private Key File to the Repository 131 Chapter 6 Themes 133 6.1 Introduction to Themes 133 6.2 How Themes Work 134 6.2.1 Theme Files 136 6.2.2 Inheritance 137 TIBCO Software Inc. 5 TIBCO JasperReports Server Administrator Guide 6.2.3 CSS Priority Scheme and Custom Overrides 137 6.2.4 Propagation 138 6.3 Administering Themes 139 6.3.1 Setting the System Theme 140 6.3.2 Setting an Organization Theme 141 6.3.3 Restricting Access to Themes 142 6.4 Creating Themes 143 6.4.1 Creating Theme Folders and File Resources 144 6.4.2 Downloading and Uploading Theme ZIP Files 144 6.4.3 Placing Themes in the Folder Template 146 6.5 Working With CSS Files 146 6.5.1 Theme Development Workflow 146 6.5.2 Firefox Web Developer Tools 147 6.5.3 Test Platform 147 6.5.4 Modifying the Appearance of Jaspersoft OLAP 148 Chapter 7 Import and Export 149 7.1 Import and Export Catalogs 149 7.2 Dependencies During Import and Export 150 7.3 The Import-Export Encryption Keys 150 7.4 Import and Export Through the Web UI 152 7.4.1 Exporting from the Repository 152 7.4.2 Exporting from the Settings 154 7.4.3 Exporting from Organizations 156 7.4.4 Importing to Organizations 158 7.4.5 Importing from the Settings 160 7.5 Import and Export Through the Command Line 162 7.5.1 Exporting from the Command Line 163 7.5.2 Importing from the Command Line 166 7.5.3 Configuring Import-Export Utilities 168 7.6 Alternate Import-Export Scripts 169 7.6.1 Running Import from Buildomatic 169 7.6.2 Running Export from Buildomatic 170 Chapter 8 System Configuration 171 8.1 Configuration Settings in the User Interface 172 8.1.1 Understanding Persistent Settings 173 8.1.2 Restoring Default Settings 174 8.2 Configuration for Using Proxies 175 8.3 Configuration for Session Persistence 176 8.4 Enabling Compression in Tomcat 178 8.5 Configuring Ad Hoc 178 8.5.1 Ad Hoc Query Settings 179 8.5.2 Ad Hoc Data Policies 180 8.5.3 Ad Hoc Data Policies for Big Data 181 8.5.4 Ad Hoc Templates and Report Generators 182 8.5.5 Ad Hoc Configuration File 183 6 TIBCO Software Inc.