Information Console Developer Guide - Birt - Actuate Corporation

240 Pages·2013·2.94 MB·English

by  Actuate Corporation

Information Console Developer Guide
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 - 2013 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
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 Analytics, The BIRT
Company, BIRT Data Analyzer, BIRT iHub, BIRT Performance Analytics, Collaborative Reporting Architecture,
e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Encyclopedia, Interactive Viewing, OnPerformance, The people
behind BIRT, Performancesoft, Performancesoft Track, Performancesoft Views, ReportEncyclopedia, Reportlet,
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. Amazon Web
Services, Incorporated: Amazon Web Services SDK, licensed under the Apache Public License (APL). Apache
Software Foundation (www.apache.org): Ant, Axis, Axis2, Batik, Batik SVG library, Commons Command Line
Interface (CLI), Commons Codec, Crimson, Derby, Hive driver for Hadoop, Pluto, Portals, 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. Day Management AG: Content Repository
for Java. 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). 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. Jason Hsueth and Kenton Varda (code.google.com): Protocole Buffer.
IDAutomation.com, Inc.: IDAutomation. IDRsolutions Ltd.: JBIG2, licensed under the BSD license. 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). LEAD Technologies, Inc.: LEADTOOLS. The
Legion of the Bouncy Castle: Bouncy Castle Crypto APIs. 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, Sencha Touch. 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. 130131-2-640301 January 23, 2013
Contents
About Information Console Developer Guide . . . . . . . . . . . . . . . . . . . . . . vii
Part 1
Customizing Actuate Information Console
Chapter 1
Introducing Actuate Information Console . . . . . . . . . . . . . . . . . . . . . . . . . . 3
About Actuate Information Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Setting up Actuate Information Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Generating a web archive (WAR) for installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Understanding Actuate Information Console load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Deploying a loadbalancer for an Actuate BIRT iHub cluster . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About using a cluster of application servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About Actuate Information Console architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Using proxy servers with Actuate Information Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
About Actuate Information Console pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Working with Actuate Information Console URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
About Actuate Information Console URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Using a special character in a URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
About UTF-8 encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
About Actuate Information Console functionality levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Customizing functionality levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Customizing functionality level features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Preserving functionality levels and features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Chapter 2
Creating a custom Information Console web application . . . . . . . . . . . . 21
Information Console web application structure and contents . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Understanding Information Console directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Building a custom Information Console context root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Activating a new or custom web application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Configuring a custom Information Console web application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Customizing Information Console configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Setting the default locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Controlling the Message Distribution service load balancing . . . . . . . . . . . . . . . . . . . . . . . 31
Specifying the default Encyclopedia volume and server . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Modifying text and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Customizing Information Console text and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Customizing Actuate BIRT iHub error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
i
Customizing an Information Console web application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Modifying the landing page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Viewing modifications to a custom web application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Locating existing pages and linking in new pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Obtaining information about the user and the session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Customizing accessible files and page structure using templates . . . . . . . . . . . . . . . . . . . . . . .44
Specifying a template and template elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
About the dashboard template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Changing a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Modifying existing content or creating new content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Modifying global style elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Customizing Actuate Information Console using skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Using skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Managing skins using the skin manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Customizing and cloning skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Understanding style definition files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Specifying colors and fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Customizing page styles for BIRT Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Modifying graphic images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Part 2
Actuate Information Console reference
Chapter 3
Actuate Information Console configuration . . . . . . . . . . . . . . . . . . . . . . . 63
About Information Console configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Configuring the Information Console web application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Configuring Information Console using web.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Configuring Information Console using volumeProfile.xml . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Using a volume profile defined in volumeProfile.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Overriding the volume specified in a volume profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Understanding temporary volume profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Configuring Information Console functionality levels with functionality-level.config . . . . .72
Configuring Information Console locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Configuring Information Console time zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Customizing messages and text according to locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Configuring Shindig2.0 for a WAR or EAR deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Configuring the connection to iHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Configuring the BIRT Viewer and Interactive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
Configuring BIRT Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
Configuring BIRT Data Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
ii
Chapter 4
Actuate Information Console URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Actuate Information Console URIs overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Actuate Information Console URIs quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Common URI parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Information Console Struts actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Actuate Information Console URIs reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
about page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
banner page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
browse file page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
calendar page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
channels page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
completed request page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
create folder page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
dashboard page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
delete file status page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
delete job page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
delete status page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
detail page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
drop page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
error page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
execute report page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
general options page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
home page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
index page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
license page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
list page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
login banner page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
login page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
logout page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
My dashboard page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
notification page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116
options page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
output page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
page not found page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
parameters page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
pending page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ping page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
privileges page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
running page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
schedule page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
scheduled job page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
search folders page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
iii
submit job page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Actuate BIRT Viewer URIs reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Chapter 5
Actuate Information Console JavaScript . . . . . . . . . . . . . . . . . . . . . . . . 131
Actuate Information Console JavaScript overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
Actuate Information Console JavaScript reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
Chapter 6
Actuate Information Console servlets . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Information Console Java servlets overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
About the base servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Invoking a servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Information Console Java servlets reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
DownloadFile servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Interactive Viewer servlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Chapter 7
Actuate Information Console custom tags . . . . . . . . . . . . . . . . . . . . . . . 141
Information Console custom tag overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Information Console custom tags quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Information Console custom tag libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Information Console custom tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Information Console custom tags reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
copyFileFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
formatDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
tabBegin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
tabEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
tabMiddle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
tabMiddleSelected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
tabPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
tabSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
Chapter 8
Actuate Information Console JavaBeans . . . . . . . . . . . . . . . . . . . . . . . . 157
Information Console JavaBeans overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
Information Console JavaBeans package reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
Information Console JavaBeans class reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
iv
Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Information Console UserInfoBean class reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Chapter 9
Using Actuate Information Console security . . . . . . . . . . . . . . . . . . . . . 169
About Actuate Information Console security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Protecting corporate data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Protecting corporate data using firewalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Protecting corporate data using Network Address Translation . . . . . . . . . . . . . . . . . . . . . . . 171
Protecting corporate data using proxy servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Understanding the authentication process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Creating a custom security adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Accessing the IPSE Java classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Creating a custom security adapter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Deploying a custom security adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Understanding the security adapter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Creating an upload security adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Accessing the necessary Java classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Creating a custom security adapter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Deploying an upload security adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Understanding the upload security adapter interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Chapter 10
Customizing Information Console online help . . . . . . . . . . . . . . . . . . . . 183
About Actuate Information Console online help files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Understanding the help directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Understanding a help collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Understanding a document root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Understanding context-sensitive help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Understanding locale support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Using a custom help location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Creating a localized help collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Customizing icons, links, and the company logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Changing the corporate logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Changing the additional links footer in help content pages . . . . . . . . . . . . . . . . . . . . . . . 194
Changing the Google translate element in help content pages . . . . . . . . . . . . . . . . . . . . . 196
Changing icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Changing the browser window title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
v
Changing help content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198
Changing existing help content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198
Adding or removing help topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
Adding and removing content files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200
Changing the table of contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
Changing the index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
vi
I n f o r m a t i o n
A b o u t
C o n s o l e D e v e l o p e r
G u i d e
Information Console Developer Guide is a guide to designing, deploying, and
accessing custom reporting web applications using Actuate Information Console.
Information Console Developer Guide includes the following chapters:
■ About Information Console Developer Guide. This chapter provides an overview
of this guide.
■ Part 1. Customizing Actuate InformationConsole. This part describes how to use
Information Console and how to customize its appearance and layout.
■ Chapter 1. IntroducingActuate Information Console. This chapter introduces
Actuate Information Console web applications and explains how Information
Console works.
■ Chapter 2. Creating a custom Information Console webapplication. This chapter
explains how to work with Information Console JSP files to design custom
reporting web applications.
■ Part 2. Actuate Information Console reference. This part describes the code
components that make up Information Console, such as URIs, JavaScript files,
servlets, tags, beans, and security facilities.
■ Chapter 3. Actuate Information Console configuration. This chapter describes the
Information Console configuration files and parameters.
■ Chapter 4. Actuate Information Console URIs. This chapter describes the
Information Console JSPs and URL parameters.
■ Chapter 5. Actuate Information Console JavaScript. This chapter describes the
Information Console JavaScript files.
■ Chapter 6. Actuate Information Console servlets. This chapter describes the
Information Console Java servlets.
About Information Console Developer Guide vii
■ Chapter 7. Actuate Information Console custom tags. This chapter describes the
Information Console custom tag libraries.
■ Chapter 8. Actuate Information Console JavaBeans. This chapter lists the
Information Console JavaBeans.
■ Chapter 9. Using Actuate Information Console security. This chapter introduces
the Information Console Security Extension (IPSE) and explains how to use it.
■ Chapter 10. Customizing Information Console online help. This chapter describes
how to customize the Information Console online help files.
viii Information Console Developer Guide