Configuring BIRT iServer Information in this document is subject to change without notice. Examples provided are fictitious. No part of this document may be reproduced or transmitted in any form, or by any means, electronic or mechanical, for any purpose, in whole or in part, without the express written permission of Actuate Corporation. © 1995 - 2012 by Actuate Corporation. All rights reserved. Printed in the United States of America. Contains information proprietary to: Actuate Corporation, 951 Mariners Island Boulevard, San Mateo, CA 94404 www.actuate.com www.birt-exchange.com The software described in this manual is provided by Actuate Corporation under an Actuate License agreement. The software may be used only in accordance with the terms of the agreement. Actuate software products are protected by U.S. and International patents and patents pending. For a current list of patents, please see http://www.actuate.com/patents. Actuate Corporation trademarks and registered trademarks include: Actuate, ActuateOne, the Actuate logo, Archived Data Analytics, BIRT, BIRT 360, BIRT Data Analyzer, BIRT Performance Analytics, Collaborative Reporting Architecture, e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Encyclopedia, Interactive Viewing, OnPerformance, Performancesoft, Performancesoft Track, Performancesoft Views, ReportEncyclopedia, Reportlet, The people behind BIRT, X2BIRT, and XMLreports. Actuate products may contain third-party products or technologies. Third-party trademarks or registered trademarks of their respective owners, companies, or organizations include: Mark Adler and Jean-loup Gailly (www.zlib.net): zLib. Adobe Systems Incorporated: Flash Player. Apache Software Foundation (www.apache.org): Axis, Axis2, Batik, Batik SVG library, Commons Command Line Interface (CLI), Commons Codec, Derby, Hive driver for Hadoop, Shindig, Struts, Tomcat, Xalan, Xerces, Xerces2 Java Parser, and Xerces-C++ XML Parser. Castor (www.castor.org), ExoLab Project (www.exolab.org), and Intalio, Inc. (www.intalio.org): Castor. Codejock Software: Xtreme Toolkit Pro. Eclipse Foundation, Inc. (www.eclipse.org): Babel, Data Tools Platform (DTP) ODA, Eclipse SDK, Graphics Editor Framework (GEF), Eclipse Modeling Framework (EMF), and Eclipse Web Tools Platform (WTP), licensed under the Eclipse Public License (EPL). Bits Per Second, Ltd. and Graphics Server Technologies, L.P.: Graphics Server. Gargoyle Software Inc.: HtmlUnit, licensed under Apache License Version 2.0. GNU Project: GNU Regular Expression, licensed under the GNU Lesser General Public License (LGPLv3). HighSlide: HighCharts. IDAutomation.com, Inc.: IDAutomation. Jason Hsueth and Kenton Varda (code.google.com): Protocole Buffer. IDRsolutions Ltd.: JBIG2, licensed under the BSD license. ImageMagick Studio LLC.: ImageMagick. InfoSoft Global (P) Ltd.: FusionCharts, FusionMaps, FusionWidgets, PowerCharts. Matt Inger (sourceforge.net): Ant-Contrib, licensed under Apache License Version 2.0. Matt Ingenthron, Eric D. Lambert, and Dustin Sallings (code.google.com): Spymemcached, licensed under the MIT OSI License. International Components for Unicode (ICU): ICU library. jQuery: jQuery, licensed under the MIT License. Yuri Kanivets (code.google.com): Android Wheel gadget, licensed under the Apache Public License (APL). KL Group, Inc.: XRT Graph, licensed under XRT for Motif Binary License Agreement. LEAD Technologies, Inc.: LEADTOOLS. Bruno Lowagie and Paulo Soares: iText, licensed under the Mozilla Public License (MPL). Microsoft Corporation (Microsoft Developer Network): CompoundDocument Library. Mozilla: Mozilla XML Parser, licensed under the Mozilla Public License (MPL). MySQL Americas, Inc.: MySQL Connector. Netscape Communications Corporation, Inc.: Rhino, licensed under the Netscape Public License (NPL). OOPS Consultancy: XMLTask, licensed under the Apache License, Version 2.0. Oracle Corporation: Berkeley DB, Java Advanced Imaging, JAXB, JDK, Jstl. PostgreSQL Global Development Group: pgAdmin, PostgreSQL, PostgreSQL JDBC driver. Progress Software Corporation: DataDirect Connect XE for JDBC Salesforce, DataDirect JDBC, DataDirect ODBC. Rogue Wave Software, Inc.: Rogue Wave Library SourcePro Core, tools.h++. Sam Stephenson (prototype.conio.net): prototype.js, licensed under the MIT license. Sencha Inc.: Ext JS. ThimbleWare, Inc.: JMemcached, licensed under the Apache Public License (APL). World Wide Web Consortium (W3C)(MIT, ERCIM, Keio): Flute, JTidy, Simple API for CSS. XFree86 Project, Inc.: (www.xfree86.org): xvfb. ZXing authors (code.google.com): ZXing, licensed under the Apache Public License (APL). All other brand or product names are trademarks or registered trademarks of their respective owners, companies, or organizations. Document No. 120201-2-530303 June 28, 2012 Contents About Configuring BIRT iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xi Chapter 1 Performing basic configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Understanding Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Launching Configuration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Troubleshooting problems launching the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Using Simple view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Displaying and updating the license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Stopping and starting iServer System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Configuring diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Understanding diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Configuring a diagnostic logging categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Changing the Configuration Console password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Configuring network settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Configuring e-mail notification settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Configuring the URL for e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Using Advanced view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Setting Configuration Console options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Changing server, template, volume, or partition options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 About the servers list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 About the server templates list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 About the volumes list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 About the partitions list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 About the printers list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Viewing release information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Chapter 2 Configuring an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Understanding an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Configuring a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Adding a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Viewing partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Working with databases, schemas, and volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Configuring a metadata database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Configuring a schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Configuring an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Adding an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Editing Encyclopedia volume properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 i Configuring an Encyclopedia volume partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Supporting application-level partitioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Specifying a hyperlink in a PDF document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Configuring events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Configuring advanced volume properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Printing a summary of advanced volume properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Retrying failed asynchronous jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Configuring RSAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Changing the status of an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Taking an Encyclopedia volume offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Disabling an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Enabling an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 Taking an Encyclopedia volume online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 Removing an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Renaming the default Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54 Removing a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 Chapter 3 Using diagnostic, usage, and error logging . . . . . . . . . . . . . . . . . . . . . . . 57 Configuring diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Changing the default log file location in acserverconfig.xml . . . . . . . . . . . . . . . . . . . . . . . . . . .60 Configuring additional iServer diagnostic logging properties . . . . . . . . . . . . . . . . . . . . . . . . .61 About iServer Diagnostic Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61 About Logging for Encyclopedia Database Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Configuring usage and error logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64 Configuring usage logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 About types of recorded events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 About the usage logging extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Understanding a usage log entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Configuring error logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Understanding an error log entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72 Configuring usage and error logging file settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Chapter 4 Configuring e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 About e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78 Adding an SMTP server to the iServer environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78 Using SMTP server load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81 Using multiple SMTP servers in a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81 Specifying the Message Distribution service for e-mail notification . . . . . . . . . . . . . . . . . . . . . . .82 Setting up Microsoft Exchange e-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82 About the e-mail account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83 Registering the e-mail account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83 ii Setting up sendmail e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Configuring the notification list size and To: line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Handling e-mail notification errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Handling SMTP e-mail errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Handling sendmail e-mail errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 About MAPI and sendmail error handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Logging e-mail notification errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Customizing the e-mail message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Sending e-mail notification in a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Sending e-mail notices from nodes using a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Using the e-mail message template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Working with e-mail template elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Using variable attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Using HTML in the e-mail template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Chapter 5 Working with services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 About BIRT iServer and PostgreSQL services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Using iServer services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Configuring service properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Chapter 6 Configuring the View service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Configuring Viewing service settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 About setting Viewing service properties in iServer Release11 . . . . . . . . . . . . . . . . . . . . . . 103 Enabling the Viewing service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 About diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Configuring the message distribution weight for a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Configuring the Viewing service for BIRT documents and spreadsheets . . . . . . . . . . . . . . . . . 105 Configuring Java process communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Configuring Message Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Configuring the thread pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Configuring BIRT document and design caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Configuring spreadsheet caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 Configuring the Viewing service for e.reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 Configuring process management for the Viewing service . . . . . . . . . . . . . . . . . . . . . . . . . . .117 Configuring the maximum number of View processes . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 Configuring the maximum worker threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 Configuring communication for e.reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Configuring request management properties for the Viewing service . . . . . . . . . . . . . . . . . 121 Managing long viewing requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Configuring the generation of DHTML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Configuring Excel data generated by an e.report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 iii Configuring PDF conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128 Configuring render profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135 Configuring Viewing service caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 Configuring report searching for the Viewing service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 Configuring the Viewing service for e.Analysis documents . . . . . . . . . . . . . . . . . . . . . . . .144 Configuring e.Analysis branding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 Configuring general e.Analysis viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 Configuring e.Analysis histograms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147 Configuring e.Analysis labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148 Configuring e.Analysis pie charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150 Configuring the e.Analysis table view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151 Configuring the e.Analysis toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 Configuring the Viewing service for searching DHTML documents . . . . . . . . . . . . . . . . . . .157 Formatting currency and numerical data in search results . . . . . . . . . . . . . . . . . . . . . . . . .157 Configuring search properties for the Viewing service . . . . . . . . . . . . . . . . . . . . . . . . . . . .159 Chapter 7 Configuring the Factory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 About the Factory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164 About setting Factory service properties in iServer Release11 . . . . . . . . . . . . . . . . . . . . . . . .164 Enabling the Factory service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165 About diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165 Configuring the Factory service for general use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165 Configuring the transient document cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Setting the transient document cache location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Setting the transient document cache size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Setting the transient document time-out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Configuring the number of entries in the transient document cache . . . . . . . . . . . . . . . . .167 Configuring the Factory service for synchronous jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168 Configuring the maximum run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169 Configuring the queue size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169 Configuring the queue time-out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169 Configuring the message distribution weight of a node . . . . . . . . . . . . . . . . . . . . . . . . . . .170 Configuring the Factory service for Actuate Basic documents . . . . . . . . . . . . . . . . . . . . . . . . . . .172 Configuring the Actuate Basic design cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172 Configuring Actuate Query image display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174 Configuring the Excel output directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175 Configuring the render profiles directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175 Shutting down and recycling Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176 Configuring the Factory service for BIRT documents and spreadsheets . . . . . . . . . . . . . . . . . .178 Configuring the Factory service base port and range of ports . . . . . . . . . . . . . . . . . . . . . . . . .178 Recycling Java Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180 Configuring BIRT caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181 iv Configuring the data result set buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Configuring the BIRT design cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Configuring the BIRT document cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Configuring the maximum rows in a BIRT chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Chapter 8 Using resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Introducing resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Configuring a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Allocating Factories for a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Limiting Java Factories for a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Setting start arguments for the JRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 Adding a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Using a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 Selecting a resource group for a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Prioritizing a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 About Factory and View service requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Managing loads with resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Understanding the Java View service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Stopping a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Deleting a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Using resource groups programmatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Chapter 9 Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 About a cluster configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 About distributing services to a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 About the configuration home directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 About the primary configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 About acpmdconfig.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 About acserverconfig.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Creating a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211 Creating an initial cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Configuring heartbeat messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Configuring Message Distribution service properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Adding and modifying server templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Modifying a server template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Creating a new server template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Adding a node to a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 About node configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 About cluster configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Testing a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Starting and stopping a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 v About starting a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221 About stopping a cluster or a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223 Removing a node from a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223 Managing a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 Accessing partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 Specifying the Encyclopedia location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225 About cluster option requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225 Handling file system failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226 Configuring the cluster administrator e-mail account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226 Managing console configurations and load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227 Using the consoles directly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227 Using the consoles through a firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227 Using multiple console installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228 About load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228 Deploying load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229 Chapter 10 Configuring Integration and Caching services . . . . . . . . . . . . . . . . . . . . 231 About the Integration service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232 Managing Integration service resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232 Enabling the Integration service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232 About diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233 Setting port numbers for process communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233 Specifying load settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234 Managing Actuate SQL query execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234 Specifying query settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236 Specifying query optimization settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237 Setting resource management properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238 Setting query statistics logging properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 Specifying the default Actuate Query template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240 Using information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240 Setting up caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 About setup in Actuate Information Object Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 About setup in iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 Updating cache files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Licensing Actuate Caching service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 About Actuate Caching service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Configuring the Caching service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244 Enabling the Caching service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245 About diagnostic logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246 Configuring Process Management properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246 Configuring Process Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246 Configuring Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247 vi Configuring Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Configuring Bulk Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 About bulk loading files to the cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Configuring Actuate Caching service and NetOSI file type . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Chapter 11 Configuring iServer security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 Understanding the Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Working with RSSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 About iServer and RSSE application interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Installing iServer using Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Installing iServer with the LDAP Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Installing the RSSE web service application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Using the RSSE application with a service provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Installing an RSSE application on Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Configuring the Encyclopedia volume to run RSSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Configuring Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Specifying RSSE service startup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Understanding LDAP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 Mapping Encyclopedia volume management information to LDAP objects . . . . . . . . . . . 266 Mapping Encyclopedia volume user properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Mapping roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Mapping groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Mapping channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Mapping pass-through security information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 Setting ldapconfig_<volume>.xml parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 Understanding an LDAP directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Mapping LDAP objects to users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 Converting an Encyclopedia volume to use an RSSEapplication . . . . . . . . . . . . . . . . . . . . . 278 Converting internal IDs to external names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 Converting information from external to internal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 Caching external security information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 Working with RSSE page-level security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 About the RSSE page-level security example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 Creating an access control list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Chapter 12 Archiving files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 Understanding online archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 About the online archive driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 About the online archive driver files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 Retaining file attributes during archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 Preserving file dependencies during archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 vii Using the online archive driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .285 Specifying the online archive configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286 Modifying the online archive configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286 Creating and specifying the startup script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289 Managing file purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291 Locating the archived files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292 Chapter 13 Printing documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 Understanding printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294 Printing on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294 Printing on UNIX and Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296 Adding a printer on UNIX and Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296 About the PostScript font utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297 About Xprinter environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297 Installing a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298 Uninstalling a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298 Obtaining the PPD file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298 Sending a document to the printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298 Managing the printing environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299 Changing a path to a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299 Removing a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .300 Configuring advanced printing parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301 Disabling automatic printer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301 Configuring fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301 Understanding PostScript font conversion issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .302 Mapping fonts for charts in documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303 Locating fonts when generating BIRT documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304 Locating fonts when generating Actuate Basic documents . . . . . . . . . . . . . . . . . . . . . . . . . . .305 Configuring font searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305 Filtering font searches to find metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305 Chapter 14 Connecting to data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 About data source connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308 About drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308 About information object connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308 Using a connection configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308 Changing a configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .309 Specifying the location of the connection configuration file . . . . . . . . . . . . . . . . . . . . . . . . . .310 Configuring a cluster to use a connection configuration file . . . . . . . . . . . . . . . . . . . . . . . . . .310 Defining environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311 Connecting to data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312 viii