Administering Report System

Administering Actuate e.
Reporting System
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 - 2002 by Actuate Corporation. All rights reserved. Printed in the United
States of America.
Contains information proprietary to:
Actuate Corporation
701 Gateway Boulevard
South San Francisco, CA 94080
http://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 Corporation trademarks and registered trademarks:
Actuate, e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Formula One,
Internet Spreadsheet, Live Report Extension, ReportCast, Report Encyclopedia,
SmartReports, Spreadsheets Everywhere, Tidestone, and XML reports.
Third party trademarks:
ActiveX, Microsoft, Microsoft Access, Microsoft Excel, MS, MS-DOS, MSN, The
Microsoft Network, Windows, Windows 98, Windows 2000, Windows ME,
Windows NT, Windows XP, and/or other Microsoft products are either trademarks
or registered trademarks of Microsoft. Crimson, Tomcat, Xalan, and Xerces are either
trademarks or registered trademarks of Apache Software Foundation. Actuate
products include software developed by the Apache Software Foundation
<http://www.apache.org/>. CT-Library is a trademark of Sybase, Inc. Databeacon is
a trademark of Databeacon, Inc. Digital Creations and DCLC, are trademarks of
Digital Creations, LC. Graphics Server is a trademark of Bits Per Second, Ltd. and
Pinnacle Publishing, Inc. HTML Tidy and tidy.c are either trademarks or registered
trademarks of World Wide Web Consortium. ICU and Lotus 1-2-3 are trademarks or
registered trademarks of IBM Corporation. INFORMIX-ESQL/C is a trademark of
Informix Software, Inc. InstallAnywhere is a trademark or registered trademark of
Zero G Software, Inc. InstallShield is a registered trademark of InstallShield
Corporation. iPlanet, Java and 100% Pure Java, ONC, Solaris, SPARC, Sun, and Sun
Microsystems are either trademarks or registered trademarks of Sun Microsystems,
Inc. iText is a trademark or registered trademark of Bruno Lowagie and Paulo Soares.
JBuilder is a registered trademark of Inprise Corp. LEADTOOLS is a registered
trademark of LEAD Technologies, Inc. Netscape, Netscape Communications,
Netscape Communicator, Netscape Enterprise Server, and Netscape Navigator are
either trademarks or registered trademarks of Netscape Communications
Corporation. NobleNet RPC and Rogue Wave SourcePro are either trademarks or
registered trademarks of Rogue Wave Software, Inc. Oracle Call Interface is a
trademark of Oracle Corporation. Progress is a registered trademark of Progress
Software Corporation. TrueType is a registered trademark of Apple Computer, Inc.
Unicode is a registered trademark of Unicode, Inc. UNIX is a registered trademark of
X/Open Company, Ltd. Visual Cafe is a registered trademark of Symantec
Corporation. WebWorks is a registered trademark of Quadralay Corporation.
XPrinter is a trademark of Bristol Technology, Inc. XPAT, created by James Clark, is
licensed under the Mozilla license agreement.
All other brand or product names are trademarks or registered trademarks of their
respective companies or organizations.
Document No. 020515-2-530301 May 10, 2002
i
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
About Actuate e.Reporting Suite 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
About Actuate e.Reporting System product . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
About Administering Actuate e.Reporting System . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
Online documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Using online manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Using the Actuate online help system. . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Using report-specific online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Typographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Chapter 1
Report server overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Introducing the e.Reporting Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
e.Reporting Server architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
About the e.Reporting Server services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
About the Actuate Process Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Default e.Reporting Server configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the report server cluster configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About controlling a report server cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
About starting up the report server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
About restarting with a default configuration . . . . . . . . . . . . . . . . . . . . . . . . .12
Understanding report server administration . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Administering a report server cluster and nodes . . . . . . . . . . . . . . . . . . . . . . .12
Administering a standalone report server . . . . . . . . . . . . . . . . . . . . . . . . . . .13
About volume administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Removing cluster membership. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Understanding Report Encyclopedia volume configuration. . . . . . . . . . . . . . . . . . .13
Understanding partition configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Adding secondary partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Using partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Removing partitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Working with clustered volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
ii
Chapter 2
e.Reporting Server features overview . . . . . . . . . . . . . . . . . . . . . . 17
Understanding e.Reporting Server configurations . . . . . . . . . . . . . . . . . . . . . . . . . 18
Working with e.Reporting Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
About e.Reporting Server options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
About e.Reporting Server capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
About Actuate engines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 3
Configuring the e.Reporting Server. . . . . . . . . . . . . . . . . . . . . . . . 23
Setting up the report server account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Setting up report server accounts on Windows . . . . . . . . . . . . . . . . . . . . . . . . . 24
Setting up report server accounts on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Maintaining security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Using the Actuate open security feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Accessing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Accessing resources on Microsoft Windows server systems . . . . . . . . . . . . . . . . 26
Accessing resources on UNIX systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Controlling UNIX maximum file size limits . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Controlling UNIX file descriptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Specifying a database configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Specifying an image search path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Controlling Excel data output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Controlling Excel data output directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Controlling searches for fonts used with Excel data . . . . . . . . . . . . . . . . . . . . . 30
Starting the UNIX report server on reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Using automatic disk space checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Finding the report server home directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Displaying the report server version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuring report server processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Configuring Windows Factory process default locale . . . . . . . . . . . . . . . . . . . . . 33
Configuring Factory process to search for report fonts . . . . . . . . . . . . . . . . . . . . . 33
Configuring View process to search for report fonts . . . . . . . . . . . . . . . . . . . . . . 34
Configuring Actuate report server engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Configuring the Actuate e.Spreadsheet Option . . . . . . . . . . . . . . . . . . . . . . . . . 34
Configuring e.Reports Java Edition Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Configuring open server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Configuring Windows open server for SQRIBE . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring Windows open server for Crystal Reports . . . . . . . . . . . . . . . . . . . . 37
Configuring locales. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
About the locale map file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
iii
Configuring year conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Setting up mail notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Setting up mail notifications on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Setting up mail notification on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Printing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
About report encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Font mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Working with fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Font mapping for charts in e.reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Using default fonts for charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Configuring text for languages in graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Configuring the report server to search for fonts. . . . . . . . . . . . . . . . . . . . . . . . . . .46
About the Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
RSSE overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
About open security functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
About page security functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
About the e.Reporting Server applications . . . . . . . . . . . . . . . . . . . . . . . . . . .49
About the RSSE open security application. . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Changing the type of Report Encyclopedia volume security . . . . . . . . . . . . . . . . .50
Controlling external security caches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
About the example RSSE page security application . . . . . . . . . . . . . . . . . . . . . . .51
Using the example RSSE page security application . . . . . . . . . . . . . . . . . . . . . .51
About USERSIDS.txt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Logging RSSE page security application messages . . . . . . . . . . . . . . . . . . . . . .52
Installing an RSSE application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Using an MT-safe RSSE application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Open Security LDAP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Report Encyclopedia volume administration information mapping . . . . . . . . . . . . . .54
Mapping Actuate Report Encyclopedia volume user properties. . . . . . . . . . . . . . .55
Mapping Actuate roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Mapping Actuate groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Mapping Actuate channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Understanding ldap.conf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Setting ldap.conf parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Resolving timeout and performance issues . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Using the LDAP Directory Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Importing and exporting data with open security . . . . . . . . . . . . . . . . . . . . . . . . . .68
Using Report Server open security utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
About the archive driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Installing the example archive driver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
How the example archive driver works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Optimizing e.Reporting Server performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
iv
Optimizing viewing for Actuate DHTML reports . . . . . . . . . . . . . . . . . . . . . . . . . 72
Comparing performance between web browsers . . . . . . . . . . . . . . . . . . . . . . 72
Caching DHTML report pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Searching DHTML reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Downloading PDF files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Compressing DHTML reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Understanding how bundling affects performance . . . . . . . . . . . . . . . . . . . . . . . 73
Optimizing Report Encyclopedia volume performance . . . . . . . . . . . . . . . . . . . . . . 73
About Report Encyclopedia volume structure. . . . . . . . . . . . . . . . . . . . . . . . . . 74
Restructuring the Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . 74
Managing report notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Moving the Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Managing space for the Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . 78
Monitoring disk space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Validating the Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . 78
Understanding the effects of disk I/O speed . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Running the Veritas file system on HP systems . . . . . . . . . . . . . . . . . . . . . . . . . 80
Optimizing report server system performance . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Understanding CPU resource requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
About report generation performance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Sharing a CPU with a database server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Adding Factory processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Adding CPUs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Adjusting operation process timing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Estimating CPU resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Understanding memory resource requirements . . . . . . . . . . . . . . . . . . . . . . . . . 83
Estimating memory resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Understanding how operations affect performance. . . . . . . . . . . . . . . . . . . . . . . 84
Running service aids. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Managing administrative information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Specifying privileges for report files and folders . . . . . . . . . . . . . . . . . . . . . . . 85
Optimizing View process performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Understanding the architecture of the View process . . . . . . . . . . . . . . . . . . . . . . 85
Understanding the converter framework . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Setting up the View process component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Understanding performance features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
About how the report server balances the View process workload . . . . . . . . . . . . . . 88
About how the View process minimizes communication with the report server . . . . . . 88
About how the View process works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Controlling cache resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
v
Chapter 4
Performing system administration tasks . . . . . . . . . . . . . . . . . . . 91
About report server system administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
About report server cluster tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
About report server tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
Logging in as the report server system administrator . . . . . . . . . . . . . . . . . . . . . .93
Displaying system status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Working with an online system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Working with an offline system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
Changing system startup parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Managing a cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
About cluster networking requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
About server option requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Viewing and changing license options . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
Overview of cluster creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
About adding and configuring nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
About report server node configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Preparing a report server to join a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Administering report server nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Starting up and shutting down report server nodes . . . . . . . . . . . . . . . . . . . . . . 108
Removing a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Specifying the location of the configuration file. . . . . . . . . . . . . . . . . . . . . . . . . 110
Changing the cluster manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
About general server administration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
About standalone report server configuration . . . . . . . . . . . . . . . . . . . . . . . . . 112
About creating a standalone report server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Starting and stopping a report server system . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Updating report server system information . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Configuring report server volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Adding and assigning a Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . 115
Assigning backup servers to a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Taking a volume online or offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Performing an administrative volume failover . . . . . . . . . . . . . . . . . . . . . . . . . 120
Moving a Report Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
About Report Encyclopedia volume file types . . . . . . . . . . . . . . . . . . . . . . . . . 122
Configuring report server system partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Using the partition server settings menu item. . . . . . . . . . . . . . . . . . . . . . . . . . 124
Removing a report server system partition . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Removing a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Managing printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Adding a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Removing a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
vi
About general Actuate system administration . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
About the report server IP address and port . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
About volume directory structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
About volume metadata directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
About the volume file directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
About the volume log directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
About the report server system configuration file. . . . . . . . . . . . . . . . . . . . . . . . 128
About the report server cluster configuration file . . . . . . . . . . . . . . . . . . . . . . 128
About the standalone server configuration file. . . . . . . . . . . . . . . . . . . . . . . . 129
Setting locales and time zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Monitoring a report server system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
About e.Reporting Server logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Understanding the system usage log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Understanding the system error log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Using the diagnostic log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Working with the system administration pages . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Viewing system information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Viewing system status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Viewing offline system status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Modifying system startup parameters for an offline system . . . . . . . . . . . . . . . . 136
Creating a cluster from a standalone report server. . . . . . . . . . . . . . . . . . . . . . 137
Viewing general system properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Configuring system usage logging properties . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Configuring system error logging properties . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Configuring default regional settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Displaying and adding system license information . . . . . . . . . . . . . . . . . . . . . . . 143
Viewing system options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Viewing general options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Modifying server list display options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Viewing Management Console and e.Reporting system information. . . . . . . . . . . . . 147
Viewing report server system information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Working with the server list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Adding a new server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Viewing and setting general server properties. . . . . . . . . . . . . . . . . . . . . . . . . . 150
Viewing and setting Message Distribution service properties . . . . . . . . . . . . . . . . . 152
Specifying View service properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Specifying Factory service properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Specifying the primary volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Specifying failover volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Designating partition space for the report server . . . . . . . . . . . . . . . . . . . . . . . . 158
Designating a printer for the report server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Setting advanced server properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Viewing diagnostic log settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
vii
Viewing system properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Changing diagnostic logging settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Changing advanced server properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Working with volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Using the Volumes list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Adding a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Viewing volume information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Assigning primary and backup servers to a volume . . . . . . . . . . . . . . . . . . . . . . 167
Working with Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Specifying a volumes partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Performing a volume failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Changing the online status of a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Removing a volume from the report server system. . . . . . . . . . . . . . . . . . . . . . . 171
Working with partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Using the Partitions list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Adding a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Specifying the path to a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Removing a partition from the report server system . . . . . . . . . . . . . . . . . . . . . . 174
Working with printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Using the Printers list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Adding a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Viewing printer properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Chapter 5
Working with database connections . . . . . . . . . . . . . . . . . . . . . . 179
About database connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
About stored procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Defining environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Connecting to DB2 databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Defining DB2 environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
About Actuate support for XML Extender. . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
About HP-UX shared objects for DB2 clients . . . . . . . . . . . . . . . . . . . . . . . . . . 184
About Sun shared objects for DB2 clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Checking a connection to a DB2 instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Installing Factory server software for DB2. . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Understanding DB2 version 6.1 connection issues . . . . . . . . . . . . . . . . . . . . . . . 185
Connecting to Informix databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Defining Informix environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Specifying the Informix database environment . . . . . . . . . . . . . . . . . . . . . . . . . 186
Supplying Informix account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Using UNIX Factory server software with Informix . . . . . . . . . . . . . . . . . . . . . . 187
Accessing Informix libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
viii
Overriding Informix DLLPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Determining Informix version on Windows . . . . . . . . . . . . . . . . . . . . . . . . . 188
Setting the maximum column length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Connecting to MS/SQL databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Specifying the MS/SQL database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Retrieving data in code pages and in Unicode. . . . . . . . . . . . . . . . . . . . . . . . . . 189
Supplying MS/SQL account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Accessing MS/SQL libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Testing the MS/SQL connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
About driver versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Understanding Db-library limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
About 7.0 compatibility with 6.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Connecting to databases through ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Understanding language encoding considerations . . . . . . . . . . . . . . . . . . . . . . . 193
Using the PeopleSoft ODBC driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Using Red Brick ODBC drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Setting up a Windows NT Red Brick configuration . . . . . . . . . . . . . . . . . . . . . 195
Setting up a UNIX Red Brick configuration. . . . . . . . . . . . . . . . . . . . . . . . . . 195
Checking the connection to Red Brick databases . . . . . . . . . . . . . . . . . . . . . . . 196
Connecting to Oracle databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
About Actuate support for Oracle 9i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
About Actuate support for Oracle 8i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
About Oracle Java stored procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Using the Actuate e.Reporting Server and Oracle clients. . . . . . . . . . . . . . . . . . . . 198
About Oracle connection strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Working with SQL*Net version 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Working with SQL*Net version 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Defining Oracle environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
About the Oracle listener processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Testing the Oracle connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
About Oracle 8 data type support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Connecting to Progress 9.1 databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
About Actuate support for Progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Installing Progress software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Defining Windows environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
About Actuate connection properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Working with Progress 9.1 SQL92 connections . . . . . . . . . . . . . . . . . . . . . . . . . 204
Using stored procedures and triggers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Using the AcProgressConnection connection . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Setting up the UNIX environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
About SunOS setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
ix
About HP-UX setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
About AIX setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Connecting to Progress 8 databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
About Actuate support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Setting the maximum column length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
About Progress software requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Preparing the Progress Client environment . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Setting up a Progress self-service client connection . . . . . . . . . . . . . . . . . . . . . 209
Starting a Progress 8 database and the Progress Open Interface Broker . . . . . . . . . . . 209
Connecting to a Progress 8 database from an e.Report Designer Professional report . . . . 210
Connecting to Sybase databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Understanding Actuate Sybase ASE 12 support . . . . . . . . . . . . . . . . . . . . . . . . 213
Using Sybase 12.5 with Actuate e.reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Defining Sybase environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Supplying Sybase database server information . . . . . . . . . . . . . . . . . . . . . . . . . 214
Supplying Sybase account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Testing the Sybase connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
About UNIX factsrvr database compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Chapter 6
Working with e.Reporting Server utilities . . . . . . . . . . . . . . . . . . 217
Using acacfconvert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Using acexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Exporting files and folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Exporting volume administration information . . . . . . . . . . . . . . . . . . . . . . . . . 220
Exporting users, security roles, and groups . . . . . . . . . . . . . . . . . . . . . . . . . 220
Exporting channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Exporting jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
About the exported volume directories and files . . . . . . . . . . . . . . . . . . . . . . . . 221
Copying the export directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
About acexport options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Using acextern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Using acimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Importing volume information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Importing users, security roles, and groups . . . . . . . . . . . . . . . . . . . . . . . . . 227
Importing directories, files, and file versions. . . . . . . . . . . . . . . . . . . . . . . . . 228
Importing channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Importing printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Importing jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
About acimport options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Using acintern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Using acmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
x
Using actoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Using acupgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
About acupgrade options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Using acverify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Using the UNIX PostScript font utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Installing a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Uninstalling a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Understanding PostScript font conversion issues . . . . . . . . . . . . . . . . . . . . . . . . 244
Chapter 7
Setting e.Reporting Server parameters . . . . . . . . . . . . . . . . . . . . 245
About e.Reporting Server parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
About volume variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
About registry keys and environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Setting registry keys on Microsoft Windows server operating systems. . . . . . . . . . . . 268
Setting environment variables on UNIX systems . . . . . . . . . . . . . . . . . . . . . . . . 269
About environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
About Release 5 variables in Release 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
About obsolete Release 5 variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Chapter 8
Understanding Report Encyclopedia volume
administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Volume administration overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Connecting to a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
About volume administration pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Understanding the banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Using the sidebar menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Setting display options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Searching for data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Searching for strings that contain special characters . . . . . . . . . . . . . . . . . . . . . . 289
Searching for volume data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Filtering volume data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Setting properties for more than one item at a time . . . . . . . . . . . . . . . . . . . . . . . . 293
About the Administrator and the Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Pages available to all users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Pages available to Administrators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Setting volume limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
xi
Chapter 9
Managing Report Encyclopedia volume security. . . . . . . . . . . . 299
About volume security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
About users and passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
About privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Types of privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Setting secure read privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Understanding the volumes default privileges . . . . . . . . . . . . . . . . . . . . . . . 305
Setting privileges on the volumes root folder . . . . . . . . . . . . . . . . . . . . . . . . 306
About security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Strategies for defining security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Defining security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
About the administrator user and security role . . . . . . . . . . . . . . . . . . . . . . . 310
About the Operator security role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
About the All security role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Managing users, privileges, and security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Creating notification groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
About Actuate report page security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Viewing reports with page security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Using the Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Enabling report page security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
About Actuate Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
About external user authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
About external user properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
About external user registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
About externally defined Actuate security roles . . . . . . . . . . . . . . . . . . . . . . . 341
About the All security role and external registration . . . . . . . . . . . . . . . . . . . . 341
About the Administrator security role and external registration. . . . . . . . . . . . . . 342
About the administrator user and external registration. . . . . . . . . . . . . . . . . . . 342
About the Operator security role and external authentication . . . . . . . . . . . . . . . 342
About channels and external authentication . . . . . . . . . . . . . . . . . . . . . . . . . 342
Using the volume administration pages with open security . . . . . . . . . . . . . . . . . . . 343
Log in with open security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
About home folder privileges with externally defined users . . . . . . . . . . . . . . . . 343
About printer properties for externally defined users. . . . . . . . . . . . . . . . . . . . 343
About external properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
About the wildcard character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Chapter 10
Managing printers and print jobs. . . . . . . . . . . . . . . . . . . . . . . . . 345
About e.reporting system printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
About printer properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
xii
Setting up printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Managing print jobs as administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Chapter 11
Managing e.reporting system resources. . . . . . . . . . . . . . . . . . . 351
Administering jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
About scheduled jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
About job priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
About users job priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Administering open server jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Setting a maximum job priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Setting the default job retry policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Setting the volumes default job retry policy. . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Running scheduled jobs after a system restart . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Archiving files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Understanding archiving with autoarchive . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Setting the volumes autoarchive rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Backing up the volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Setting online backup mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Scheduling online backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Chapter 12
Administering the volume in the web environment . . . . . . . . . . 363
Viewing reports configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Specifying report viewing modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Specifying the default web viewing mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Specifying the users viewing mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Setting web browser page caching options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
About channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Viewing channels and their contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Creating and maintaining channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Scheduling jobs for channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Chapter 13
Understanding Actuate e.Reporting Server options . . . . . . . . . 377
About Actuate open server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Using the open server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
About predefined open server file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Specifying open server file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Understanding the File Types page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Using the web server file system for viewing open server files . . . . . . . . . . . . . . . . 388
About the open server for SQRIBE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
xiii
Setting the SQRIBE report printing parameter . . . . . . . . . . . . . . . . . . . . . . . . 389
Using the parameter for bursting web output . . . . . . . . . . . . . . . . . . . . . . . . 389
Working with report level parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
About the open server for Crystal reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Using Crystal reports with a .rpt file extension . . . . . . . . . . . . . . . . . . . . . . . 390
Specifying a mutual exclusion class for Crystal reports . . . . . . . . . . . . . . . . . . . 391
Setting parameters for Crystal reports executable files . . . . . . . . . . . . . . . . . . . 391
Using Crystal web reports with a .rpw file extension . . . . . . . . . . . . . . . . . . . . 391
Printing Crystal reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Understanding the interface between the open server shell and the driver . . . . . . . . . . . 392
About the open server driver interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
About the report generation interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
About the report printing interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Working with AC_STATUS.txt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Working with AC_PARAMETERS.txt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Understanding open server framework Unicode compliance . . . . . . . . . . . . . . . . . . 399
Administering e.Spreadsheet reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Setting parameters for e.Spreadsheet reports. . . . . . . . . . . . . . . . . . . . . . . . . 401
Using e.Reports Java Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
About e.Report Java Edition data source connection requirements . . . . . . . . . . . . . . 405
Using parameters with e.Report Java Edition . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
xiv
I n t r o d u c t i o n xv
I n t r o d u c t i o n
About Actuate e.Reporting Suite 6
Actuate is the leading provider of information delivery solutions for Global
2000 companies and packaged application software vendors. Our customers
use Actuate e.Reporting Suite 6 to retrieve business information from
corporate databases and deliver it as interactive web pages and Excel
spreadsheets to their customers, partners, and employees. Actuates customer
list includes pacesetters in aerospace, commercial banking, defense,
entertainment, federal government, financial services, health care, high
technology, insurance, life sciences, pharmaceuticals, retail, securities, and
telecommunications.
Our infrastructure software provides the foundation for applications that
support business analysis, customer relationship management, desktop
reporting, e.billing, e.procurement, executive dashboards, human resources,
key performance indicators, portals, service automation, supply chain
management, and systems management. In the e.Business environment, our
structured content technology seamlessly integrates into corporate web sites
and packaged applications. Actuate 6 supports information delivery in both
print and online formats and through data exchange with other applications.
By providing easy information access to millions of users, our customers gain
increased revenue, reduce IT spending, and improve customer service.
Because of the growing international requirements of our customer base,
Actuate 6 provides an unprecedented level of support for multilingual
reporting including full Unicode and an extensive list of supported locales.
This release features a highly scalable, highly available, high performance
server that further extends our lead in implementing enterprise-class
information delivery systems. Enhanced integration capabilities support
personalized and customizable portal development, web services, and
spreadsheet reporting.
xvi A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g S y s t e m
e.Business in the enterprise environment requires four primary technology
platforms. Actuate is the primary information delivery platform that provides
the content users need in the format in which they need it, in a secure, timely,
and cost-effective manner. In addition there are three e.Business platforms for
which Actuate provides the information delivery solution.
Actuate e.Reporting Suite 6 continues to offer core solutions for fundamental
enterprise reporting challenges.
Platform Function Purpose
Databases Organize data Access, manage, and
update data
Content management
systems
Manage unstructured
content
Publish unstructured
content such as
electronic catalogs
Application servers Deploy online
applications
Conduct complex
transactions, manage
supply chains, and
interact with customers
Challenge Actuate solution
Deliver high resolution information Solve complex data access problems
across a broad range of data sources
View structured content Support viewing DHTML reports in
standard browsers to eliminate plug-
in installation for millions of users
Meet varied information display
requirements
Provide template-based design and
display
Provide complex formatting
capabilities
Provide spreadsheet reporting
Meet exploding requirements for
web-based content delivery
Support over a million hits per day
per CPU
Deliver personalized secure
information
Provide open security directory
integration and page security
Reuse existing integrated content Open server provides access to
content from other applications
Maintain data integrity between
online and hard copy
Provide high-resolution printed copy
in postscript and PDF
I n t r o d u c t i o n xvii
The following summary describes the products in Actuate e.Reporting Suite 6.
Actuate End User Desktop
An application used by end users to request, generate, view, and print report
documents. The ReportQuery capabilities enable seamless transfer of data
from an Actuate report to any productivity or analysis tool.
Actuate e.Report Designer
An application that complements e.Report Designer Professional and supports
business users in designing and distributing a variety of reports. These reports
require no programming. This application supports both modifying complex
reports and using sophisticated components from libraries.
Actuate e.Report Designer Java Edition
A report development application used by Java developers to design and
distribute a variety of reports. 100% Java compliant, the e.Report Designer
Java Edition includes both AWT and Swing APIs.
Actuate e.Report Designer Professional
An object-oriented application used by professional developers of structured
content to design, build, and distribute report object designs for delivery on
the web. The Actuate Basic Language and Actuate Foundation Class Library
support extensive customization capabilities.
Actuate Client Integration Technology is part of Actuate e.Report Designer
Professional and consists of the following:
I Actuate ActiveX Controls embed Actuate reporting functionality into
custom applications.
I Actuate Requester API accesses attributes and values of report parameters,
changes the values of report parameters, controls how and when a report
generates, displays and prints reports, and configures report print setup.
Access the Requester API using Actuate Basic, Visual Basic, C, or C++.
I Actuate search extension API supports developing search extensions to
transfer data to any third-party productivity or analysis tool.
Transfer information among
applications
Provide XML output to support
access to data across applications
Meet increasing requirements for
server-based reporting
Provide clustering and failover
support
Challenge Actuate solution
xviii A d mi n i s t e r i n g A c t u a t e e . R e p o r t i n g S y s t e m
Actuate e.Reporting System
A server application that generates Live Report Documents, manages them in
the Report Encyclopedia volume, and makes them available to users.
Actuate e.Reporting System supports managing a cluster consisting of
multiple reports servers. Actuate e.Reporting System includes the following:
I Actuate Active Portal and Actuate ReportCast transform the Report
Encyclopedia volume into a dynamic, secure web site. They provide the
foundation for Channels and seamless integration with other web sites.
I Management Console, an application for system and network
administrators to manage and control one or more Actuate report servers.
I Actuate Server Integration Technology
I Actuate Information Delivery API integrates Actuate web services into
existing corporate applications, automates routine or time-consuming
report server tasks, and implements new feature groupings for custom
business processes. Actuate Information Delivery API is based on XML
and supports the SOAP messaging protocol.
I Actuates Report Server API implements common Report Encyclopedia
volume functionality using C++.
I Actuate Report Server Security Extension supports the use of third-
party security tools.
I Actuate archive driver supports the use of third-party archiving
software and hardware
Actuate e.Reporting System supports the following options:
I Actuate e.Analysis Option
An application used to transform data from an Actuate e.report into
interactive information. Users can view and analyze data to determine
relationships and trends.
I Actuate e.Report Option
A Basic and Java option that provides Report Encyclopedia volume
functionality for e.Report Designer, e.Report Designer Java Edition, and
e.Report Designer Professional.
I Actuate e.Spreadsheet Option
An open server application that generates Excel spreadsheets from
e.Spreadsheet Designer files. With this product customers manage
spreadsheet reports and analysis within the Actuate e.Reporting Server
and save Actuate reports as richly formatted Excel spreadsheets.
I Multi-Application Option
Multi-Application supports using more than one Report Encyclopedia
volume on the e.Reporting System.
I n t r o d u c t i o n xix
I Page Level Security Option
Page level security supports personalizing viewing privileges at the user
level for reports and parts of reports.
I Progress Option
A server application that supports working exclusively with Progress
databases that generates Live Report Documents, manages them in the
Report Encyclopedia volume, and makes them available to users.
Actuate e.Spreadsheet Designer
An application that supports designing, creating, and distributing custom
spreadsheets over the web. Users can dynamically generate richly formatted
Excel and spreadsheet-based reports from Actuate e.Reporting Server. These
spreadsheets can be part of an application, an applet, or a JavaBean.
Actuate Live Report Extension (LRX)
An application for end users that works with both Microsoft Internet Explorer
and Netscape Navigator to support report viewing and printing on the Web.
Actuate Live Report Extension (LRX) is included with all products except
Actuate e.Report Designer Java Edition and Actuate e.Spreadsheet Designer.
Actuate Viewer
An application for end users to find, view, and print report documents. The
ReportQuery capabilities are also part of the Actuate Viewer. Actuate Viewer
is included with all products except Actuate e.Report Designer Java Edition
and Actuate e.Spreadsheet Designer.
About Actuate e.Reporting System product
Actuate e.Reporting System documentation includes printed manuals,
installation guides, online help, user documentation in PDF and HTML
format, and release notes. Information about the product that could not be
included before the book printing deadline is in the release notes.
The Actuate web site, http://www.actuate.com, contains late-breaking news
about the product and its features, as well as product update information. To
obtain the password necessary to access the portion of the web site available
only to customers, telephone Actuate Customer Support. The engineers in
Actuate Customer Support can also help you with technical questions about
the product according to your service contract. The Customer Support
telephone number, fax number, and e-mail information can be found among
the printed materials in the product box.
xx A d mi n i s t e r i n g A c t u a t e e . R e p o r t i n g S y s t e m
The printed documentation includes the following manuals.
For information about See the following
Installation
Upgrading
Installation guide
Upgrading guide
Late-breaking information about the
software and documentation
Release notes
Overview of Actuate e.Reporting
System architecture
e.Reporting System configuration
and administration
Database connections
Report Encyclopedia volume
administration
Users, groups, privileges, and roles
Printers and printing requests
Overview of the Actuate Information
Delivery API, web services and
SOAP messages
Developer information and examples
Overview of the Actuate report
server API
Overview of Actuate Autoarchive
API, Open Server interface, and
Report Server Security Extension
Information Delivery API data types
and messages
Administering
Actuate
e.Reporting
System
Programming
Server
Applications
Information
Delivery API
Reference
I n t r o d u c t i o n xxi
Accessing, viewing, running,
printing and searching reports
Formatting report data for multiple
locales
Understanding report encoding
Designing reports with right to left
orientation
Actuate Active Portal, Active Portal
JavaServer Pages, JavaScript files,
cascading stylesheets, custom tags,
and security
Actuate ReportCast, ReportCast
templates, URL directives, scripting
language, security and user
authentication facilities
Terminology map
Glossary
Using
e.Reports
e.Reporting
for Multiple
Locales
Customizing
e.Reporting
Web
Applications
Actuate
e.Reporting
Suite 6
Glossary
xxii A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g S y s t e m
About Administering Actuate e.Reporting System
Administering Actuate e.Reporting System discusses how to administer a
standalone report server, a report server cluster, and a Report Encyclopedia
volume.
I Introduction. This chapter provides an overview of this guide, the Actuate
e.Reporting Suite, and the typographical conventions used.
I Chapter 1. Report server overview. This chapter introduces the e.Reporting
Server and discusses e.Reporting Server architecture and configuration.
I Chapter 2. e.Reporting Server features overview. This chapter contains
discussions of starting and stopping a report server, clearing items and
queues, and backing up and restoring the Report Encyclopedia.
I Chapter 3. Configuring the e.Reporting Server. This chapter discusses how to
set up the report server account and how to configure report server
processes, engines, open security, and fonts. This chapter also discusses
how to optimize e.Reporting Server performance.
I Chapter 4. Performing system administration tasks. This chapter discusses how
to use the system administration console to administer a cluster, configure
a Report Encyclopedia volume, manage printers, and view the error logs.
I Chapter 5. Working with database connections. This chapter discusses how to
configure your database clients to work with the e.reporting system.
Analyzing, viewing, customizing,
and exporting data
Customizing e.Analysis
Actuate report server API and
archive functions
Using
e.Analysis
Report
Server API
Reference
I n t r o d u c t i o n xxiii
I Chapter 6. Working with e.Reporting Server utilities.This chapter discusses
how to use the e.Reporting Server utilities to import, export, and upgrade
Report Encyclopedia volume data, as well as how to install a PostScript
font.
I Chapter 7. Setting e.Reporting Server parameters. This chapter discusses how
to use the system administration console to set e.Reporting Server
parameters as well as registry keys and environment variables.
I Chapter 8. Understanding Report Encyclopedia volume administration. This
chapter discusses how to connect to a Report Encyclopedia volume, how to
use the volume administration console, and the Administrator and
Operator security roles.
I Chapter 9. Managing Report Encyclopedia volume security. This chapter
discusses how to create Report Encyclopedia users and security roles and
how to apply privileges to Report Encyclopedia files and folders. This
chapter also discusses how the volume behaves under open security.
I Chapter 10. Managing printers and print jobs. This chapter discusses how to
set up printers and how to manage print jobs.
I Chapter 11. Managing e.reporting system resources. This chapter discusses how
to administer jobs, archive files, and back up the Report Encyclopedia
volume.
I Chapter 12. Administering the volume in the web environment. This chapter
discusses how to set web browser page caching options, create channels,
and schedule jobs for channels.
I Chapter 13. Understanding Actuate e.Reporting Server options. This chapter
discusses how to generate and print Actuate open server reports,
e.Spreadsheet reports, and Java Edition reports.
Online documentation
The information in the printed manuals is also available as online books in
Adobe Acrobat PDF format and in the online help system for Actuate
products. For products without a Windows interface, such as Actuate
e.Reporting System, Actuate e.Report Designer Java Edition, and Actuate
e.Spreadsheet Designer, we provide HTML help files. The HTML files install
automatically with the product. These files can be viewed with standard web
browsers.
xxiv A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g Sy s t e m
Using online manuals
The online manuals install automatically with the product. You can also find
the online manuals on the product CD in the Manuals directory. The items in
the table of contents and the page numbers in the index both contain links to
the appropriate topics in the text. In the index, you access the link by
positioning your cursor over the page number, not the topic.
Online help
Actuate products provide both context-sensitive online help about the product
and report-specific online help about the report you are viewing. Actuate
e.Reporting Suite makes it possible for developers to create customized report-
specific online help.
Using the Actuate online help system
Use two windows to access and view information in the e.Reporting Suite help
system. The window on the left displays the table of contents or the index of
the online help system. The window on the right displays the contents of the
online help topics.
The tabs at the top of the left window access different views. Use these tabs to
switch views among the Table of Contents, Index, and Search. The Table of
Contents provides an overview of the help file contents. For example, in the
preceding window, you see the documentation for Accessing a Report
Encyclopedia volume using Actuate Active Portal. Search accesses any word
in the help files.
Choose Index to view a list of help topics
Choose Search to access any word in help files
Choose Contents to view a list of help topics
I n t r o d u c t i o n xxv
The following two illustrations show an example of the Index and the result of
an Index search.The following illustration shows the result of the search as it
appears in the window on the right.
To view the topic choose the topic in the list. The topic displays in the window
on the right.
Use Search to find all instances of a keyword in the help files. The following
illustration shows the results of a search for the keyword, searching. The topics
containing the keyword appear under Search. Choose a topic in the Search list
to display the topic in the right window.
Use the Index tab to view the topics
Select a topic to search the Index
Select a topic from
the search results
xxvi A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g Sy s t e m
Using report-specific online help
During the design phase, report developers have the option to include report-
specific online help. For example, the report developer can add comments to
provide details about specific report objects or to explain calculations.
For detailed information about report-specific online help, see Chapter 3,
Viewing e.reports, in Using e.Reports.
Typographical conventions
The following table describes the typographical conventions in this guide.
Report-specific online help
Item Convention Example
Code examples Sans serif Dim Text1 As String
File names Initial letter capitalized,
except e. Report
Designer Java Edition,
where file names are
case sensitive
Detail.roi
I n t r o d u c t i o n xxvii
Syntax conventions
The following table describes the symbols used to present syntax.
Key combination A + sign between keys
means to press both
keys at the same time
Ctrl+Shift
Menu items Capitalized, no bold File
Submenu items Separated from the
main menu item with a
small arrow
FileNew
User input or user
response
Sans serif M*16*
User input in XML and
Java code
Italics chkjava.exe
cab_name.cab
Item Convention Example
Symbol Description Example
[ ] Optional item [Alias<alias name>]
Array subscript matrix[ ]
< > Argument you must
supply
<expression to format>
Delimiter in XML <tr>
{ } Groups two or more
mutually exclusive
options or arguments,
when used with a pipe
{While | Until}
Defines array contents {0, 1, 2, 3}
Delimiter of code block public ACJDesigner( )
{
}
| Separates mutually
exclusive options or
arguments in a group
Exit {Do | For |
Function | Sub}
Java OR operator int length |4
xxviii A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g S y s t e m
Ch a p t e r 1 , R e p o r t s e r v e r o v e r v i e w 1
C h a p t e r
1
Chapter1Report server overview
This chapter contains the following topics:
I Introducing the e.Reporting Server
I e.Reporting Server architecture
I Configuration overview
2 A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g S y s t e m
Introducing the e.Reporting Server
In the Actuate Reporting System, developers and users perform tasks such as
designing, generating, distributing, viewing, and printing reports. While
performing reporting tasks, they work with a variety of report items. These
items, along with related data such as access privileges and requests for report
generation or printing, are stored in a Report Encyclopedia volume. The
services that manage the information and manage the requests are known
collectively as the Actuate e.Reporting Server.
Individual report servers can be configured to be a node (a member) of a
report server cluster. Each cluster node can support report viewing,
scheduling, execution, printing, and notification to users. Actuate
administrators can enable specific services on a node to perform specific
functions. For example, a node with the Actuate Encyclopedia service enabled
can perform functions such as scheduling and notification. Other services
augment capabilities of users connected to the report server cluster and
support the use of the servers machine resources to reduce the load on users
computers. Each report server can handle many client requests concurrently.
For example, when a user attempts to view a report or creates a request to
print or generate a report document, the report server services verify user has
the appropriate privileges, connects to the data source, and schedules and
executes the request.
Actuate administrators use a browser-based Actuate Management Console to
configure e.Reporting Server clusters, individual nodes in a cluster or
standalone report servers. After installing Management Console on a web
server, administration can be performed remotely with no other software
installation required. Both cluster management and individual Report
Encyclopedia volume management use only a browser. For information about
administering a volume, see Chapter 8, Understanding Report Encyclopedia
volume administration.
e.Reporting Server architecture
Actuate e.Reporting Server Release 6 uses a server executable that consists of
these services:
I The Encyclopedia service controls Report Encyclopedia volume
administration and manages content such as reports, users, roles,
notification groups and manages report generation and print requests.
I The View service processes viewing requests on an Actuate e.report .roi file
using the View process to render the report. The View service lets a user
view and search through an Actuate e.report in DHTML format when
viewing the report using a web browser.
I The Factory service processes report generation requests and printing
requests that use printers connected to the report server machines.
I The Message Distribution service dispatches Actuate Information Delivery
API requests coming into the e.Reporting Server system from clients or
applications. The Message Distribution service authenticates each message
and forwards it to the proper report server service. Report server cluster
load balancing is part of the Message Distribution service.
For more information on the services see About the e.Reporting Server
services, later in this chapter.
All services require the report server executable. The Actuate administrator
enables one or more services of the report server executable. For example, to
create a standalone report server that can store, run and print reports, an
administrator enables the Encyclopedia and Factory services. If the View
service is not enabled, users cannot view the reports in DHTML format.
The Actuate Process Manager controls report server services. In the cluster
configuration, Process Manager also reports the status of the report server
executable to the cluster. For more information about Process Manager, see
About the Actuate Process Manager, later in this chapter.
To communicate with the report server, applications use the Actuate
Information Delivery API, a Simple Object Access Protocol (SOAP) based
interface. Applications that use the Information Delivery API can
communicate with report server nodes in the cluster environment as well as
with standalone report servers.
The report server also supports older applications that use the Report Server
API (RSAPI). Applications that use the RSAPI can communicate directly only
with the report server that has the Encyclopedia service enabled and running
and is managing a specific Report Encyclopedia volume.
Each report server can handle many client requests concurrently.
Configuration overview
Actuate e.Reporting Server Release 6 supports two configurations:
I Standalone configuration is a single machine configuration with all report
server services.
The default configuration for a standalone report server supports
administration of a Report Encyclopedia volume and other report server
functionality such as report generation, printing, and viewing.
I Cluster configuration is usually a multiple report server machine
configuration. One report server node controls the configuration of the
other machines in the report server cluster. One or more nodes have the
Message Distribution service. The Message Distribution service routes user
requests to access a volume or view or print a report to nodes.
Report server nodes can have one or more services enabled.
The following types of e.Reporting Server systems are used in the two
configurations:
I A standalone report server is a single machine that has the e.Reporting
Server installed. A standalone report server is not part of a report server
cluster. A standalone report server processes requests sent directly to the
report server running on the machine.
An administrator uses a standalone report server to create cluster of one or
more report servers.
I A report server node is a single machine that has the e.Reporting Server
installed and is part of a report server cluster.
On both the standalone report server and the report server node, the Actuate
Process Manager controls the report server. For information about Process
Manager, see About the Actuate Process Manager, later in this chapter.
The following illustration of an example standalone report server shows the
relationships of a report server with its Encyclopedia volumes, application
servers, and an RDBMS server.
Report
Encyclopedia
volumes
Application
databases
Application
servers,
Actuate Active
Portal and
Management
Console
Application
server
Server
Actuate
e.Reporting
Server
Application
server
In the illustration the report server manages two volumes. The report server
supports multiple volumes with the Actuate Multi-application option
installed.
The following illustration of an example cluster shows the relationships of an
Actuate e.Reporting Server cluster with its Encyclopedia volumes, application
servers, and an RDBMS server. The cluster uses a network router to create a
single virtual IP address to distribute the requests coming into the cluster to
two report servers that handle load balancing for the cluster.
In the illustration, the Actuate e.Reporting Server cluster is divided into three
sections. Based on this design of the report server cluster, the following items
describe the cluster sections:
I In the Actuate load balancing section, report servers perform Actuate
request routing and load balancing for the report server cluster. Report
server request messages are routed to the appropriate report server.
I In the e.Reporting Servers section, report servers support report generation
and viewing.
Actuate load
balancing
e.Reporting
Servers
Report
Encyclopedia
volumes
Router
Server
Application
databases
Server Server
Actuate
e.Reporting
Server cluster
Application servers,
Actuate Active
Portal and
Management
Console
Application
server
Application
server
Server
Server Server Server
I In the Report Encyclopedia volumes section, report servers maintain
Report Encyclopedia volume administration information and control
access to the volumes. The Report Encyclopedia volumes can be on
machines that are not running a report server but are accessible to the
report server.
In the illustration, separate machines handle separate functions. These
functions can be combined on one machine. Also, the report server cluster
manages multiple volumes. The report server nodes support multiple
volumes with the Actuate Multi-application option installed.
About the e.Reporting Server services
An e.Reporting Server can provide any combination of the following services:
I Message Distribution service handles requests sent from users or
applications to a report server cluster or stand alone report server.
The Message Distribution service authenticates each message and forwards
it to the proper report server service. Report server cluster load balancing is
part of the Message Distribution service.
I Encyclopedia service controls one or more Report Encyclopedia volumes
and manages each volumes content, such as users, roles, and reports. The
service also secures access to the volume and its contents.
The Encyclopedia service manages Report Encyclopedia volume
administration functions such as request validation for requests such as
log-in requests, and report generation jobs before routing the job. The
Encyclopedia service also performs volume tasks such as creating and
deleting volume folders and adding, moving and removing files in the
Report Encyclopedia volume.
The Encyclopedia works with the Message Distribution service to manage
requests and dispatch the request to the appropriate agent such as a
Factory service or View service, or another part of the Encyclopedia service.
The Actuate e.Reporting Server supports the use of third-party security
information to control validation of users and requests.
I View service processes viewing requests on an Actuate e.report document
.roi file using a report server View process.
The View service lets a user view and search through an Actuate report in
DHTML format when viewing the report using a web browser. The user
logs into a Report Encyclopedia through a web server and Actuate Active
Portal. A report servers View process handles a users requests to view an
Actuate report.
The View service supports conversion of Actuate report document data to
XML for use with other web applications and PDF for printing.
I Factory service processes several types of requests:
I Requests to generate a report or requests to print a report.
I Requests that require real-time interaction and requests that are
background jobs and do not require real-time interaction.
Report execution requests can be real-time requests or background jobs:
I Report generation jobs are scheduled report generation requests. These
requests are scheduled and batched. The schedules are stored in the
Report Encyclopedia volume. The requests are dispatched by the report
server with the Encyclopedia service.
I Actuate temporary reports are real-time report requests to run and view
a report with real-time user interaction. These requests are not stored as
jobs in the Report Encyclopedia.
In a cluster configuration, the Message Distribution service dispatches
requests.
A temporary report requires Encyclopedia, Factory, and View services.
Printing requests are background jobs:
I Printing jobs are batched printing requests whose schedules are stored
in the Encyclopedia volume. The printing requests could be dispatched
by the report servers with the Encyclopedia service when a request is to
run and then print the report or by report server with the Request
service.
One of the following operations processes executes a request:
I A Factory process generates reports from Actuate report executables
and manages the printing of reports using printers connected to a report
server.
I An Open Server process generates or prints a third-party, open server
report.
The following illustration shows the relationships among the report servers
services and processes running on a single machine.
On each report server, the services are controlled by the Actuate Process
Manager. For more information about Process Manager, see About the
Actuate Process Manager, later in this chapter.
About the Actuate Process Manager
The Actuate e. Reporting Server executable is managed by Actuate Process
Manager. Process Manager supports the following functionality:
I Provides support for node administration:
I Join or leave a cluster on a request from Management Console.
I Start and stop the servers on a request from Management Console and
report server cluster manager.
Factory
service
Encyclopedia
service
Actuate e.Reporting Server
Factory
process
Active
Portal and
Management
Console
Actuate
desktop
software
Web
browsers
View
service
Open server
process
Message
Distribution
service
RS API
interface
SOAP
interface
View
process
Application
Server
Folders
Report files
Jobs, notifications
Users, groups, roles
Report
Encyclopedia
Actuate
ReportCast
I Send report server node status information to report server cluster
manager.
I Detect the availability of the nodes network connection to ensure fail
over handling in the cluster.
I Accesses and modifies the configuration of the report server on requests
from Management Console and report server cluster manager.
Process Manager is a service on the Windows server platforms and a daemon
on the UNIX platforms. Process Manager can be configured to start
automatically when the machine boots up or manually started.
Default e.Reporting Server configurations
By default, the standalone e.Reporting Server configuration enables all the
services on the machine.
The minimum cluster configuration is a single node that is configured with the
report server services. If the cluster consists of two nodes, the cluster must
have the Message Distribution service enabled on at least one node. The
cluster can optionally contain additional nodes with other services enabled.
In a report server cluster, different report server nodes can be configured with
specific services that allow the nodes to provide different functionality and
process different types of requests. The node configuration can be based on
characteristics such as processing power, and access to hardware and software
resources such as printers and database drivers.
Administrators can change the report server cluster as needed. For example,
administrators can reconfigure the cluster to:
I Add more report server nodes with Factory and View services handle an
increased workload
I Host additional applications by adding nodes with the Encyclopedia
service enabled.
I Implement fail over by adding nodes that can take over for a node that
fails.
When a cluster is created, the cluster manager is configured with the Message
Distribution service. If you create a cluster with multiple nodes, stop all the
machines, and then restart the machines. The first cluster machine with the
Message Distribution service enabled to start up becomes the cluster manager.
About the report server cluster configuration
In an e. Reporting Server cluster, the report server services can be distributed
among report server nodes. Report server nodes are machines in the cluster.
The following illustration shows an e.Reporting Server cluster configuration.
In the e.Reporting Server cluster illustration, each node is a computer system
running e.Reporting Server. The e.Reporting Server services are represented
by one of four letters: M, V, F, and E:
I M is Message Distribution.
I V is View.
I F is Factory.
I E is the Encyclopedia service for Report Encyclopedia Volume RVn.
A bold letter in a box represents an enabled service. The other letters represent
disabled services. When you enable or disable the services, a report server
node plays different roles in the cluster.
F M V E2
F M V E
M V F E1
M V F E
e.Reporting Server Cluster
Router
Server
RV 1 RV 2 RV 3
Application
servers
Internet
Network
Router
M V F E
F M V E3
Server Server
Ch a p t e r 1 , Re p o r t s e r v e r o v e r v i e w 11
There are two nodes with the Message Distribution service enabled for the
e.Reporting server cluster. In this example, they share one Virtual IP address
through a virtual IP address, load balancing router, such as Cisco Local
Director or Windows Load Balancer. All requests to the e.Reporting Server
cluster first go to one of these two redirector nodes and are dispatched to other
nodes in the cluster based on based on message type and cluster load. The
server node with the bold outline is the cluster manager.
Actuate supports multiple report servers on one physical machine. Each report
server must have a unique configuration, for example, different TCP/IP port
numbers and transient store disk space.
About controlling a report server cluster
To control a report server cluster, the report server cluster manager node
manages the cluster configuration and one or more nodes manage request
message routing. The following describes report server nodes that perform
these functions.
Cluster manager is the report server node that manages the report server
cluster configuration. The cluster manager is the node that is used to create the
cluster.
Cluster manager successors are the backup nodes to the cluster manager. The
successors are specified as a list of report server nodes that have the Message
Distribution service enabled. They are ordered by the sequence of joining the
cluster. When the cluster manager fails, the first cluster manager successor in
the list takes over control of the cluster configuration.
In a cluster, one or more nodes are running a Message Distribution service. A
node running the Message Distribution service can be the cluster manager, but
need not be.
About starting up the report server
The default behavior when starting a standalone report server is for Process
Manager to start the report server and enable services. This behavior is
optional and can be configured.
The default behavior when starting a report server node is for Process
Manager not to start the report server. This behavior can be configured by
changing the message used to add the report server to the cluster.
About restarting with a default configuration
The following items describe how a report server restarts with the default
configuration:
I If a report server node with the default configuration crashes and
automatically reboots.
While the node is down, it is failed. After rebooting, the node automatically
rejoins the cluster and is online, but by default the services are not running.
I If a standalone report server with the default configuration crashes and
automatically reboots.
While the report server is down, it is failed. After rebooting, the report
server is online and the services are running.
Understanding report server administration
An report server system administrator uses the Actuate Management Console
for system administration of a report server cluster, report server nodes, and
for a standalone report server. The Actuate Management Console also
supports Report Encyclopedia volume administration for both a report server
cluster and a standalone report server.
Management Console is a browser-based application installed on a web server.
The web server must have access to the report server cluster or standalone
report servers.
Administering a report server cluster and nodes
The Actuate administrator controls the configuration of the cluster and of each
node in the cluster. The Actuate administrator configures:
I System-wide services and settings
I Services and settings on a node
I Report servers to join a cluster or nodes to leave a cluster
I Report server services
Management Console sends configuration messages to the Message
Distribution service. The Message Distribution service routes the message to
the correct node. A custom application that uses the Information Delivery API
to administer a report server node also sends Information Delivery API
messages to the clusters Message Distribution service.
C h a p t e r 1 , Re p o r t s e r v e r o v e r v i e w 13
Administering a standalone report server
The Actuate administrator controls the configuration of standalone report
server in a manner similar to administering a single node on a cluster.
A custom application that uses the Information Delivery API to administer a
standalone report server can send the message directly to the report server
without logging into the Actuate Management Console application.
About volume administration
The Actuate volume administrator controls a Report Encyclopedia volume,
and manages the volumes administrative information such as users and
users properties, security roles, notification groups, and channel membership.
The Actuate administrator also controls the volumes contents, such as reports,
files and folders. The administrator also controls access to the volume and its
contents. For information about administering a volume, see Chapter 8,
Understanding Report Encyclopedia volume administration.
Removing cluster membership
A report server node can be turned into a standalone report server by
changing the nodes configuration. In this case, Process Manager modifies the
configuration to indicate that the report server is not part of any cluster. The
report server cluster manager drops this node from the cluster membership
list.
If you remove a report server node from a cluster, the report server will run as
a standalone report server only if the server machine was installed as a
standalone report server. If the report server was installed as a cluster node,
the report server will not start as a standalone report server.
Understanding Report Encyclopedia volume
configuration
Each Report Encyclopedia volume is controlled by an Encyclopedia service.
The Encyclopedia service processes requests related to the volume, such as
browsing in the volume, adding, moving, and deleting objects in the volume,
validating access to objects in the volume, and finding dependencies among
objects in the volume.
An Encyclopedia service can be configured to manage multiple volumes if the
e.Reporting System has the Multi-application option. Each volume has only
one primary Encyclopedia service that manages the volume. An Encyclopedia
service can be configured as a fail-over service for a Report Encyclopedia
volume. When the primary node fails, the Encyclopedia service on the
fail-over node takes over management of the Encyclopedia volume.
The Encyclopedia service dispatches the volume-related requests to the
appropriate agent such as a Factory service or View service, or another part of
the Encyclopedia service but still manages the request.
To enable the Encyclopedia service, an administrator assigns a report server to
a Report Encyclopedia volume.
The default location for the Report Encyclopedia volume data is a specific
location in the Actuate e.Reporing Server installation directory. The Actuate
administrator can change the configuration of the volume to reside in a
different location.
The Actuate administrator can add Report Encyclopedia volumes at any time.
Users can access the volume as soon as it is added.
An Actuate administrator can remove volumes at any time. Once the volume
is removed, any attempt to access references to the removed volume result in
an error.
To move a Report Encyclopedia volume, an administrator must take the
volume offline. Once the volume is offline, the administrator can move it to
another location.
Understanding partition configuration
A Report Encyclopedia volume consists of one or more partitions, a primary
partition and optional secondary partitions. Each partition is a file system
directory, a physical disk location that the report server uses store to Report
Encyclopedia volume data.
The primary partition is required. The default location of the primary partition
is the <server_home>/encyc/volume directory where <server_home> is the
report server installation location. The primary partition contains
volume-specific information (metadata) and cannot be removed.
Administrators can change the location of the primary partition.
Secondary partitions provide extra storage for report executables and
documents. Secondary partitions can be added and removed.
Adding secondary partitions
An Actuate administrator can add secondary partitions. The report server
automatically divides volume content among partitions.
Using partitions
The report server automatically uses a secondary partition assigned to a
volume. As new files are added to the Report Encyclopedia volume, the report
server automatically chooses a partition on which to store the file. The report
server uses the partition with the most free space.
C h a p t e r 1 , Re p o r t s e r v e r o v e r v i e w 15
For example, the report server starts with a primary partition. As the partition
becomes full, the administrator adds a secondary partition located on another
disk. Files added to the volume are added to the secondary partition until both
partitions have an equal amount of free space. After that point, the report
server evenly distributes files to the two partitions.
Removing partitions
An administrator can remove a secondary partition by changing the
configuration for that partition to indicate that the partition will be removed.
The server starts a background process of moving files from this partition onto
other partitions.
The administrator can monitor the report server progress using Management
Console. This operation will fail if, by moving files, the other partitions would
drop below their minimum free space limit.
When the server completes moving the files, the state of the partition changes
to inactive. At this point, the administrator can remove the partition.
Working with clustered volumes
In an e.Reporting Server cluster, the Actuate administrator can use Report
Encyclopedia volumes to support application-level partitioning by
configuring different applications to use different Report Encyclopedia
volumes. In some cases, such as when an application service provider hosts
services, a separated physical structure is part of the logical design for
business reasons, for example, keeping billing information separate from sales
information. To use a multiple Report Encyclopedia volumes without
changing the logical design of the application, an application designer can use
links in the application folder structure to redirect users to the appropriate
Report Encyclopedia volume.
As another example, to make two volumes work as a single unit, an
administrator needs a single source of user administration information such as
user names, passwords, and role membership. The application designer can
externalize Report Encyclopedia volume user information using the Actuate
Open Security feature and centralize the user information in an external
security source. For example, the Report Encyclopedia volume users can be
stored in an LDAP server and multiple volumes can use the user information
from the LDAP server.
Ch a p t e r 2 , e . R e p o r t i n g S e r v e r f e a t u r e s o v e r v i e w 17
C h a p t e r
2
Chapter2e.Reporting Server
features overview
I Understanding e.Reporting Server configurations
I About e.Reporting Server capabilities
I About Actuate engines
Understanding e.Reporting Server configurations
The e.Reporting Server Release 6 configurations consist of an e.Reporting
Server and various report server options.
Working with e.Reporting Server
The Actuate e.Reporting Server supports management of a Report
Encyclopedia volume, controlling access to the volume and documents in the
volume, open server architecture, security including open security, clustering,
and volume failover.
The e.Reporting Server provides support for storing report documents in the
Report Encyclopedia volume, viewing report documents from the volume,
and for handling report requests. Users can view Actuate report documents,
files, Java report documents, Excel spreadsheets, or third-party documents
that are copied into a volume.
The e.Reporting Server supports report generation and server-side printing of
third-party reports such as Crystal and SQRIBE.
For information about the capabilities of a report server when combined with
one or more options, see About e.Reporting Server capabilities, later in this
chapter.
The Actuate e.Reporting Server Release 6 supports two system configurations:
I Stand-alone configuration is a single machine configuration with all report
server services.
I Cluster configuration is usually a multiple report server machine
configuration. One report server node controls the configuration of the
other machines in the report server cluster. One or more nodes have the
Message Distribution service. The Message Distribution service routes user
requests to access a volume or view or print a report to nodes.
For information about the report server system configurations, see Chapter 1,
Report server overview.
About e.Reporting Server options
Customers can purchase options that add capabilities to an e.Reporting Server.
For example, if the Multi-application option is installed on an e.Reporting
Server, the report server supports multiple Report Encyclopedia volumes.
Without the Multi-application option, the report server supports a single
volume.
The following table describes the e.Reporting Sever options.
The following table lists the options compatible with the e.Reporting Server
report types.
The e.Reporting Server also supports multiple-CPU machines when used
either as a standalone report server or as a report server cluster. The number of
CPUs is the total number of CPUs in the standalone machine or the total
number of CPUs in the cluster.
Customers can upgrade the number of CPUs allowed in either a standalone
report server or in a report server cluster.
Option Description
e.Analysis Provides content viewers with easy to use
analytical capabilities beyond that of Actuate's
e.Reports.
e.Report Provides content generation capabilities for
Actuate Basic and Java reports. Actuate Basic
reports are developed with Actuate e.Report
Designer or e.Report Designer Professional; Java
reports are developed with e.Report Designer
Java Edition.
e.Spreadsheet Provides content generation capabilities for
e.Spreadsheet. Actuate e.Spreadsheets are
developed with e.Spreadsheet Designer.
Multi-application Provides support for multiple Report
Encyclopedia volumes managed by a single
e.Reporting Server system.
Page Level Security Provides Page Level Security capabilities.
Progress-only Database
Connection
Supports Actuate report executable .rox files that
use only the Progress connection.
Option
Actuate
Basic
reports
Java
reports
e.Spreadsheet
reports
Third-party
reports
e.Analysis X
Multi-application X X X X
Page Level
Security
X
Progress X X X X
About e.Reporting Server capabilities
The following table lists the features and capabilities of the e.Reporting Server
when combined with report server options:
e.Reporting Server feature Configuration
Store third-party reports, such as
Crystal reports
Yes
Store e.Spreadsheets Yes
Store e.Reports Java Edition. Does
not include Demand Paging, Table
of Contents or report searching.
Yes
Store Actuate Basic reports.
Includes Demand Paging, Table of
Contents and report searching.
Yes with
e.Report option
View third-party reports, such as
Crystal reports
Yes
View e.Spreadsheets Yes
View e.Reports Java Edition. Does
not include Demand Paging, Table
of Contents or report searching.
Yes
View Actuate Basic reports.
Includes Demand Paging, Table of
Contents and report searching.
Yes
Print third-party reports, such as
Crystal reports
Yes
Generate third-party reports, such
as Crystal reports
Yes
Generate e.Spreadsheets Yes with
e.Spreadsheet option
Generate e.Reports Java Edition Yes with
e.Report option
Generate Actuate Basic reports Yes with
e.Report option
Support Page Level security with
Actuate Basic reports
Yes with
e.Report option and
Page Level Security option
Perform server-side printing of
Actuate Basic reports
Yes with
e.Report option
About Actuate engines
Actuate supports two reporting engines for customers to use independently
with third-party Java application servers. Each engine is a collection of class
libraries that provide a run-time environment for execution of reports
developed with an Actuate report designer. These engines are:
I Actuate e.Reporting Engine Java Edition provides a run-time environment
for the execution of reports developed with the e.Report Designer Java
Edition.
I Actuate e.Spreadsheet Engine provides a run-time environment for the
execution of reports developed with e.Spreadsheet Designer.
For information about the Actuate engines, see Chapter 13, Understanding
Actuate e.Reporting Server options.
Perform analysis on report data
from Actuate Basic reports
Yes with
e.Report option and
e.Analysis option
Store report data in multiple
Report Encyclopedia volumes
Yes with
Multi-application option
Java Edition reports
Not supported
e.Spreadsheets
Not supported
e.Reporting Server feature Configuration
Ch a p t e r 3 , C o n f i g u r i n g t h e e . R e p o r t i n g S e r v e r 23
C h a p t e r
3
Chapter3Configuring the
e.Reporting Server
I Setting up the report server account
I Finding the report server home directory
I Configuring report server processes
I Configuring Actuate report server engines
I Configuring open server
I Configuring locales
I Configuring year conversion
I Setting up mail notifications
I Printing on UNIX
I Font mapping for charts in e.reports
I Configuring the report server to search for fonts
I About the Report Server Security Extension
I Open Security LDAP configuration
I Importing and exporting data with open security
I About the archive driver
I Optimizing e.Reporting Server performance
I Optimizing viewing for Actuate DHTML reports
I Optimizing Report Encyclopedia volume performance
I Optimizing report server system performance
I Optimizing View process performance
Setting up the report server account
This section describes setting up report server accounts on Microsoft Windows
server operating systems such as Windows NT and Windows 2000, and UNIX
systems.
Setting up report server accounts on Windows
During installation, the e.Reporting Server setup program uses the account of
the user running the setup program and the current machine name to register
the report server Process Manager as a service. If necessary, the report server
administrator should work with the Microsoft Windows server system
administrator to change the account used by the Actuate Process Manager and
report server applications after the software is installed. The Microsoft
Windows server system administrator should set up an account for the report
server services. The account should have the appropriate privileges and access
to the required software, such as database connectivity software, and
hardware, such as remote database servers and printers.
When you set up an account for the report server, you should consider one of
these items:
I The report server cannot be run in the systems Administrator account
I The report server account must be able to interact with the desktop if you
use OLE Automation or other utilities that interact with the desktop
Then you can run the report server in an account with one of the
configurations that allow interaction with the desktop:
I The report server runs in an account that is a member of the
Administrators group
I The report server runs in an account that belongs to a group and a member
of the group is logged in when the report server is running
I The report server runs in a users account that is logged in when the report
server is running
If the server machine has user accounts that are controlled by a domain server
as well as user accounts controlled by the local machine, install the e.Reporting
Server from a user account controlled by the local machine and not a user
account controlled by a domain server.
Setting up report server accounts on UNIX
Like all UNIX processes, the processes that perform report server tasks run
under a specific account. You must set up this account appropriately to ensure
that it functions correctly and preserves the level of security you expect.
You should work with your UNIX system administrator to set up the account
for the report server. The account should have the appropriate UNIX
privileges and access to the required software, such as database connectivity
software, and hardware such as remote database servers and printers.
Maintaining security
Your choice of an account to run the report server directly affects the security
of your system and your report server. To maintain the optimum balance of
security and convenience, you should consider this choice carefully when
deciding how to apply your sites account conventions.
In most cases, the best option is to create a special account for the report server.
This approach simplifies report server administration by ensuring that the
server account is associated only with report server-specific issues and events.
If you exert control over the report server account at a level equivalent to the
control your site exercises on system administrator or root accounts, you can
maintain an equivalent level of security for the report server. If you choose this
option, you must ensure that Windows sever system facilities, such as those
that manage electronic mail and ODBC connections, are aware of the special
report server account. Otherwise, features that require those facilities, such as
e-mail notification, will be unavailable.
To run the report server, an account must have the appropriate access
privileges to the servers directory hierarchy, which contains all the report
server files and folders. As a result, you must control access to the account to
maintain a secure server. For example, you can maintain security on UNIX
systems by installing the server under the root account. One issue with this
approach is that many sites restrict or prohibit the use of root processes to run
externally obtained software for security reasons.
Using the Actuate open security feature
As administrator, if you plan to use an Actuate Open Security application to
control access to a Report Encyclopedia volume, the report server and Report
Server Security Extension (RSSE) application need appropriate access to the
external security source. A system administrator might need to migrate the
Report Encyclopedia volume for use with the Open Security application. For
information about migrating a volume for use with Open Security, see Using
Report Server open security utilities, later in this chapter.
For information about the Actuate Open Security feature and the Open
Security application that ships with the e.Reporting Server, see Chapter 9,
Managing Report Encyclopedia volume security. For information about
configuring the report server for use with the Actuate Open Security
application that ships with the e.Reporting Server, see Open Security LDAP
configuration, later in this chapter.
Accessing resources
The account that runs the report server must have access to resources such as
data sources and hardware devices in order to provide this access to report
server clients. For instance, if a network printer is available and accessible to
the server account, you can make it accessible to clients. If the printer is not
accessible to the server account, it is not accessible to clients.
For the latest information about supported printers and printing, see the latest
version of Actuate Supported Products Matrix which can be found on the
Actuate web site at the following URL http://www.actuate.com.
Actuate supports connecting to remote drives using only the Universal
Naming Convention (UNC) syntax. For example on a Microsoft Windows
server operating system, to specify a partition the directory
\files\master-encyc on a machine named foxtrot, use the following UNC
syntax:
\\foxtrot\files\master-encyc
Accessing resources on Microsoft Windows server
systems
On Microsoft Windows server operating systems, use Printers in the Control
Panel to make printers accessible on your system.
There is a problem in Microsoft Windows NT 4.0 with respect to Actuate
report server processes accessing network printers. This problem occurs when
the report server is installed specifying a User Account with automatic startup.
The work-around is to create a local printer on the NT system that uses the
network printer. Using the Printer Administration Wizard, create a local
printer and add a port. Specify the location of the network printer as the port.
For example, create a local printer called Rainbow_local that specifies the
network printer \\Prntsrvr2\Rainbow as the port. From the report server, use
the printer Rainbow_local to print to the network printer Rainbow.
For more information about the Microsoft Windows NT 4.0 problem, see the
Microsoft Knowledge Base article Q137631 available at
www.support.microsoft.com.
Accessing resources on UNIX systems
For printing and displaying reports on UNIX systems, the account running a
report server must have access to a machine running X Windows system, an X
Windows server, and the report server accounts DISPLAY environment
variable must point to that X Windows server. To start, the report server must
have access to an X Windows server. For example, if the report server machine
is running X Windows, you can set DISPLAY to the local machine:
# setenv DISPLAY :0.0
Actuate includes and supports a virtual X server xvfb as part of the Actuate
e.Reporting Server on UNIX. The virtual X server satisfies the e.Reporting
Server requirement for access to an X server. The installation and
configuration of the xvfb application is an option of the e.Reporting Server
installation.
If you are using another machine as the X Windows server, specify the
machine name. This example sets DISPLAY using the machine Bermuda as the
X Windows server:
# setenv DISPLAY bermuda:0.0
Actuate supports X Server version X11R4 and higher. For information about
the X Windows system, see the X.Org web site at www.x.org.
For a printer to be recognized by the report server:
I On Solaris systems, the printers name must appear as a subdirectory of the
/etc/lp/printers directory. On Solaris 2.6 and later, the report server also
uses printers listed using the command lpget list.
I On HP systems, the printers name must appear as an entry in the
/etc/lp/member directory.
I On IBM systems, the printers name must appear as an entry of the
/etc/qconfig file.
Controlling UNIX maximum file size limits
The report server can create large files on the report server system. If the report
server generates large files, a system administrator might need to increase the
maximum file size allowed on the system and restart the report server.
Use the UNIX command ulimit to find system resource limits. For information
about resource limits, the ulimit command, and how to change system
resource limits, see your UNIX system documentation.
Controlling UNIX file descriptors
Setting the e.Reporting Servers maximum number of file descriptors on UNIX
parameter controls the maximum number of file descriptors the report server
can have open. For information about setting report server advanced
parameters, see Changing advanced server properties in Chapter 4,
Performing system administration tasks.
The default value for the parameter maximum number of file descriptors on
UNIX is 32768. The number of file descriptors the report server can have open
is the lower of either 32768 (32 K) file descriptors or the system hard limit on
nofiles (descriptors).
If the maximum number of file descriptors on UNIX parameter is set, the
maximum number of file descriptors the report server can have open is the
lower of either the system hard limit or the value of the parameter. For
example, if the system hard limit is 4096 and the parameter value is the
default, the descriptor limit for the process is 4096. If the system hard limit is
unlimited, and the parameter value is the default, the maximum number of
file descriptors for the process is 32768. If the system hard limit is unlimited,
and the parameter is set to 65536, the maximum number of file descriptors is
65536. If the system hard limit is 4096 and the parameter is set to 2048, the
effective descriptor limit for the process is 2048.
Use the UNIX command ulimit -aH to find the system hard limit on nofiles.
For information about file descriptors and the ulimit command, see your
UNIX system documentation.
ReportCast process control the maximum number of open file descriptors with
the environment variable AC_SERVER_UNIX_FD_MAX.
Specifying a database configuration file
An Actuate configuration file provides database connections and data sources
that are used in Actuate reports. To specify a configuration file with
e.Reporting Server, set the report server Set the Configuration File For
Connections parameter. For information about setting report server advanced
parameters, see Changing advanced server properties in Chapter 4,
On Windows server operating systems, the configuration file for connections
parameter can specify a path and file name or URL, for example,
\\server1\configs\serverconfig.xml or
http://myserver/configs/testconfig.xml.
On UNIX platforms, the parameters value can be a path and file name. The
parameter cannot point to a URL.
If the parameter is not defined, Actuate uses the database connection
properties that are stored with the report executable .rox file.
In the configuration file, the report server uses only valid ConnectOptions
values. The other values in the file apply to the Actuate Desktop products and
are ignored by the report server. For information about the configuration use
and syntax, see Designing e.Reports.
For the ConnectOptions values, the report servers Factory process reads the
configuration file when the process starts. Factory processes running when the
configuration file is changed do not use the new information. Only Factory
processes started after the configuration file is changed use the new
information. To ensure report executables use updated configuration file
information, an administrator can check that no reports are active and stop
currently running Factory processes. The report server starts a Factory process
for the next report request.
Specifying an image search path
Set the report server search path for images parameter for Actuate reports that
include images when viewing, running, or printing the report. The parameter
specifies the directories to search for report images. For information about
setting report server advanced parameters, see Changing advanced server
properties in Chapter 4, Performing system administration tasks.
On Microsoft Windows server operating systems, the value of the search path
for images parameter is a semicolon-separated list of directory paths. For
example, to set the image search path to the directories
C:\Web\Report\Images and C:\Web\Images use:
C:\Web\Report\Images;C:\Web\Images
On UNIX systems, the value of the search path for images parameter is a
colon-separated list of directory paths. For example, add this line to set the
image search path to the directories /web/report/images and /web/images:
/web/report/images:/web/images
Controlling Excel data output
Actuate report developers can create Actuate report .rox files that send report
data to a Microsoft Excel file. When running the report from a volume, you can
specify parameters to control:
I Excel data output directory
I Excel font usage
Controlling Excel data output directory
When running the report from a volume, the report server sends the Excel file
to the Excel directory in the report server home directory. For example:
C:\Actuate6\Server\Excel
The default Excel directory is created during the report server installation.
To change the location where the report server sends the Excel file, specify the
directory with the report server Output Directory for Runtime-generated Excel
parameter. As the value, enter a fully-qualified path to the directory.
For information about setting report server advanced parameters, see
Changing advanced server properties in Chapter 4, Performing system
administration tasks.
Controlling searches for fonts used with Excel data
The report server uses the report executable .rox files font information when
generating and formatting Excel data. By default, the report server uses font
information only from the report executable. The report server supports using
font information from the report executable master_fonts.rox when running a
report that generates Excel data. By default, the report server does not use the
master_fonts.rox file.
The system administrator can configure the report server to search through
master_fonts.rox to find the font information if the report generating the Excel
data specifies fonts that are not in the .rox file. For information about
configuring the report server to use the master_fonts.rox file, see Configuring
the report server to search for fonts, later in this chapter.
Starting the UNIX report server on reboot
To start the Actuate e.Reporting Server as part of UNIX system initialization,
Actuate supplies the script update_reload.sh in AC_SERVER_HOME/bin. As
root, run update_reload.sh to update the system startup script to start the
Actuate e.Reporting Server whenever the system restarts.
Using automatic disk space checking
While the report server is running, it checks report server partitions for
available, unused disk space using the values set with the Actuate parameters
Volume data store directory minimum space and Database log directory
minimum space. The report server uses the values:
I Volume data store directory minimum space value. When the free disk
space in the volumes primary partition falls below this value, the report
server sets the volume offline.
I Database log directory minimum space. When the free disk space for the
volumes transaction log partition falls below this level, the report server
sets the volume offline. The Fatal DiskSpace Level parameter value is also
checked when the report server starts.
The report server will not set the volume online until there is enough free disk
space in the partition.
Because a volume tends to grow over time, it is always a good practice to
update these values when the capacity planning is done. In a production
environment, it is always advisable to ensure that there is adequate free space
on the report server system.
If a volume user tries to create a file in a partition with less than the free disk
space specified in the parameter Warning Threshold for Low Partition Disk
Space (MB), the report server displays an error. The default is 512MB. File
creation requests in partition fail if partition space is less than the amount
specified in Minimum Partition Disk Space Required for File Creation (MB).
The default is 128 MB.
Finding the report server home directory
Many of the procedures described in this chapter refer to the location
AC_SERVER_HOME, the top-level directory where the server software is
installed.
If you use the C Shell on UNIX systems, for example, your .cshrc file should
contain a line similar to this:
$ setenv AC_SERVER_HOME /usr/local/actuate
How to find the Windows report server home directory
To find the report servers home directory:
1 Choose StartRun.
2 In Run, type:
regedit.exe
3 Choose OK.
Registry Editor presents a hierarchical list of Registry keys.
4 Under HKEY_LOCAL_MACHINE\Software\Actuate\Actuate
e.Reporting Server\6, locate the AC_SERVER_HOME entry.
The value of the AC_SERVER_HOME entry is the report servers home
directory.
The report server creates all the server related temporary files in the
AC_SERVER_HOME\Tmp directory. UNIX report server start scripts also set
TMPDIR to $AC_SERVER_HOME/tmp. Any report server operation that
creates a temporary file is responsible for deleting that file.
When the report server restarts, it deletes all the files, except for the files with
the extension .lock, in AC_SERVER_HOME\Tmp. This mechanism removes
temporary files that remain in the AC_SERVER_HOME\Tmp directory from
the previous report server shut down.
Actuate report servers support temporary reports. The default location for the
temporary report files is AC_SERVER_HOME\Tmp. If a report server stops
abnormally, the report server deletes all temporary report files the same way
as AC_SERVER_HOME/tmp. If the administrator stops and starts the report
server, the report server maintains the temporary report files. For example, ff
the administrator changes the location of the transient store directory and
stops and starts the server, the report server changes the transient store
location and moves any temporary files to the new location.
Displaying the report server version
This section describes how to see the report server version number.
How to display the Windows report server version
To see the report server version number on NT and Windows 2000 systems,
use Microsoft Explorers File Properties for a report server process.
1 Start Microsoft Windows Explorer.
2 Go to the Actuate report servers Bin directory, for example,
C:\Actuate6\Server\Bin.
3 Select one of the report server executables, encycsrvr6.exe,
processmgmt.exe, and right-click to display the files context menu.
4 Select Properties.
5 In Properties, select the Version tab to display the files version
information.
How to display the UNIX report server version
To see the UNIX report server version number, run one of the report server
executables using the v option.
1 Open a command window.
2 Go to the Actuate report servers bin directory, for example,
\Actuate\Server\bin.
3 Run a report server executable such as encycsrvr6 with the v option; for
example:
# encycsrvr6 -v
The version number appears in the command window.
Configuring report server processes
When processing report jobs, the report server starts and stops Factory
processes to generate reports. After a Factory process starts, the report server
waits two seconds before trying to use the Factory process. After a Factory
process starts, the report server waits one second between attempts to
communicate with the process. If a report server machine is being used
heavily by applications, these settings might not allow enough time for a
Factory process to start or to reply after it has started. You can adjust the
Factory process timing.
Configuring Windows Factory process default
locale
The default system locale for Microsoft Windows server operating systems
report server processes is the C locale. To change the report server process
default locale to ENU, use the report server Use C Locale as Default on NT
parameter and set the value to FALSE. The value of the parameter is either
TRUE or FALSE. Using C enhances Factory performance. For information
about setting report server advanced parameters, see Changing advanced
server properties in Chapter 4, Performing system administration tasks.
Configuring Factory process to search for report
fonts
The report server Factory process uses a report executable .rox files font
information when generating an e.report document .roi file to format the data
in the e.report document. By default, the report server uses font information
only from the report executable. When the report executable .rox file contains a
dynamic text control. The report server supports using font information from
the report executable master_fonts.rox when generating. By default, the report
server does not use the master_fonts.rox file.
A dynamic text control contains variable length text that either is in HTML or
RTF format or is plain text. For example, the data be textual note from a
database that is in RTF format. The report server can use the HTML or RTF
information to format the data when generating the report document. For
more information about using the dynamic text control, see Chapter 12,
Working with dynamic text controls, in Developing Advanced e.Reports that
ships with e.Report Designer Professional.
The HTML or RTF formatting information can contain font information that is
not stored in the .rox. The system administrator can configure the report server
to search through master_fonts.rox to find the font information if the report
executable contains a dynamic text control that uses fonts that are not in the
.rox file. For information about configuring the report server to use the
master_fonts.rox file, see Configuring the report server to search for fonts,
later in this chapter.
Configuring View process to search for report
fonts
Actuate Active Portal and Actuate ReportCast use a report servers View
process to display Actuate e.report document .roi files in a browser. The View
process can display reports in various formats including DHTML and PDF.
The View process uses the reports font information to format and display
report data. By default, the View process uses font information only from the
report documents .rox file and does not use the master_fonts.rox file.
The report server supports using fonts in the report executable
master_fonts.rox file when using a View process to view an Actuate e.report in
DHTML format or to generate PDF. For information about configuring the
report server to use the master_fonts.rox file, see Configuring the report
server to search for fonts, later in this chapter.
Configuring Actuate report server engines
Actuate supports optional e.Reporting Server engines used to generate reports.
I Actuate e.Spreadsheet Option provides a run-time environment for the
execution of reports developed with e.Spreadsheet.
I Actuate e.Reporting Java Edition provides a run-time environment for the
execution of reports developed with the e.Report Designer Java Edition.
The following sections describe configuration requirements when using the
engines.
Configuring the Actuate e.Spreadsheet Option
To use the Actuate e.Spreadsheet .vts or .vtf files requires the Actuate
e.Spreadsheet option. The e.Spreadsheet Option is an Actuate open server
application available for Windows and UNIX report servers. The e.Spreadsheet
Option installs only on Actuate e.Reporting Server 5 Service Pack 2 or above.
The Actuate e.Spreadsheet Option open server application requires Java 2
Standard Edition (J2SE) v1.2.2. or higher. For optimal performance Actuate
recommends J2SE v.1.3.1.
For e.Spreadsheet template .vts files or template package .vtf files that require
access to external data sources, the system administrator must configure the
proper environment on the report server machine. For example, if the
e.Spreadsheet .vts file accesses external data using Java database connectivity
(JDBC) the administrator must configure the report server environment and
the report servers machine. If the spreadsheet requires special .jar files to
connect to a data source, you can specify the location of the .jar files using the
e.Spreadsheet parameter AC_JDRV _CLASSPATH. Callback classes and addin
function classes conform to the e.Spreadsheet API requirements. For templates
using e.Spreadsheet API callback classes, add the fully qualified class name of
Java class implementing BookModelCallback interface to the e.Spreadsheet
parameter AC_SS_POPULATION_CLASS. For information about the
e.Spreadsheet Option open server parameters, see Administering
e.Spreadsheet reports, in Chapter 13, Understanding Actuate e.Reporting
Server options.
See the Actuate e.Spreadsheet Designer documentation for information about
using data sources with e.Spreadsheet files.
Configuring e.Reports Java Edition Engine
Actuate e.Reporting Servers support generation of Actuate e.Reports Java
Edition. For information about the capabilities of Actuate e.Reports Java
Edition in a Report Encyclopedia volume, see Using e.Reports Java Edition,
in Chapter 13, Understanding Actuate e.Reporting Server options.
When running e.Reports Java Edition from the e.Reporting Server, Actuate
recommends using Java 2 Standard Edition (J2SE) v1.2.2 or J2SE v.1.3.1.
The following registry keys on NT and Windows 2000 systems or environment
variables on UNIX systems must be configured correctly:
I CLASSPATH must include %jre_home%/lib/rt.jar and the current
directory, a period. For example, the CLASSPATH environment variable
must contain:
%jre_home%/lib/rt.jar;.
The default jre_home directory on Windows is c:/jdk1.x.y/jre. where x and
y are version numbers.
I PATH on Windows servers must include the directory containing jvm.dll.
The jvm.dll must be the one installed with JRE 1.2.2 or higher. For example,
the path might be c:/jdk1.x.y/jre/bin/classic where x and y are version
numbers.
On UNIX, the JVM file is libjvm.so for Solaris, libjvm.sl for HP-UX, and
libjvm.a for AIX. The directory containing the JVM file must be specified in
the following environment variables:
I LD_LIBRARY_PATH variable for Sun SOLARIS 2.x
I LIBPATH variable for IBM AIX 4.3.3.0
I SHLIB_PATH variable for HP-UX
On UNIX systems, if the JRE path was not specified during the e.Reporting
Server installation, a report server administrator can set CLASSPATH, PATH,
and library path environment variables in the startup script start_srvr.sh.
The DCP_OTHER_LIBS parameter for open server e.Reports Java Edition
must list client stubs and any Application Server EJB Connectivity (JNDI)
client classes to connect to an EJB data source successfully. On UNIX, separate
items using a colon. On Windows, separate items using a semicolon.
For information about using e.Reports Java Edition in a Report Encyclopedia
volume, see Using e.Reports Java Edition, in Chapter 13, Understanding
Configuring open server
When generating or printing an open server report, the report server looks in
the report servers \Drivers directory and the directories specified in the
operating systems shared library environment variable to find shared
libraries.
On Microsoft Windows server operating systems, the report server uses the
PATH variable. For the default installation, the report server also looks in the
following directory:
C:\Actuate6\Server\Drivers
On UNIX the open server driver uses the paths specified in these environment
variables:
I LD_LIBRARY_PATH (SunOS)
I LIBPATH (AIX)
I SHLIB_PATH (HP-UX)
and also looks in the $AC_SERVER_HOME\drivers directory.
You can either add the path names to the PATH variable that point to the
required libraries or copy required third-party shared libraries or DLLs to the
report servers \Drivers directory.
If a path is specified for an open server driver, the path is relative to the report
servers \Drivers directory.
In a report server cluster, the open server driver and third party software must
be available and executable from any report server node.
Configuring Windows open server for SQRIBE
To use the NT or Windows 2000 Actuate open server with SQRIBE reports, the
SQRIBE client product is required. The Actuate open server driver for SQRIBE
reports Acsqrdrv.exe uses the SQRIBE client software as well as some specific
SQRIBE DLL files. DLL files are installed in C:\SQRIBE\Sqr\Odb\Binw. To
enable access to DLLs, either add the directory to the PATH or copy the
following SQRIBE DLLs to the <server_home>\Drivers:
I Stimages.dll
I Sqrwt.dll
I Libsti32.dll
I Bclw32.dll
The report server uses the following Actuate open server files that are in the
drivers directory:
I Acsqrdrv.exe
I Sqrext.dll
Using the SQRIBE interface, the open server driver cannot redirect output to
different printers. The default report server printer is used. For printing SPF
files, the Sqrwp.exe program is assumed to be in the following location:
C:\SQRIBE\Sqr\ODB\Binw\Sqrwp.exe
Users can set a parameter to specify a different path. The string parameter is
SQRIBE_SQRWP_PATH. In most cases, this parameter can be set as a file type
parameter for Report Encyclopedia volume .spf file type definition.
Configuring Windows open server for Crystal
Reports
To use the NT or Windows 2000 Actuate open server with Crystal reports, the
Crystal Reports 7 or Crystal Reports 8 client product is required. The report
server uses the Crystal Reports client software and the following Actuate open
server driver in the report servers \Drivers directory:
accrpdrv.exe
The open server driver uses the Crystal Report Engine to generate or print
Crystal Reports. The Crystal Report Engine is part of the Crystal Reports 7 or
Crystal Reports 8 installation. To use the Crystal Report Engine, you need to
install the appropriate Crystal files: required runtime files, database files,
export files, and library files. See the Crystal Reports documentation for
information about the Crystal Report Engine and its use.
When printing a Crystal open server report, printing is sent to the default
printer. Use the AC_PRINTER_NAME parameter to specify a different printer
name. Enter the parameter as an open server file type system parameter. The
printer must be available to the report server machine.
When printing Crystal report files, the open server driver also uses the
number of copies parameter.
For information about creating an open server file type system parameter in
the Report Encyclopedia volume, see Specifying open server file types, in
Chapter 13, Understanding Actuate e.Reporting Server options.
Configuring locales
This section discusses configuring locale-specific settings and the Actuate
localemap file.
About the locale map file
The locale map file is named localemap.xml and resides in
$AC_SERVER_HOME/etc/. In a cluster environment, the same file has to
exist on every machine to achieve consistency among servers. If the
localemap.xml file is updated, the administrator has to restart the servers for
the new file to take effect.
Actuate ships a default localemap.xml file including all the supported locales
as well as a default locale. Values in the default locale correspond to those in
the C locale.
The localemap.xml file is in XML format, and supports UTF-8 encoding only.
For UTF-8, Actuate supports only the characters present in the UCS-2
character set. While customized locales may use different conventions in
naming, the locale names, the usage of format chars (such as m for month)
used in Actuate predefined locales, follow ICU standards.
It is the customer's responsibility to make sure the localemap.xml file is in
correct encoding and are stored correctly.
A locale defined in the localemap.xml file does not need to specify all fields.
For omitted fields, Actuate uses the values in the default locale. If the default
locale does not exist, we use hard-coded values from C locale.
For information about the localemap.xml file, see Chapter 2, Formatting
report data for multiple locales, in e.Reporting for Multiple Locales.
Configuring year conversion
When generating a report, the report server converts two-digit year values
into four-digit years when the two-digit values are used for scheduling jobs in
the Report Encyclopedia volume, or in Actuate Basic functions or Actuate
QBE. For example, if a user enters date 01/01/14 in a QBE expression, Actuate
converts the date to 2014-01-01.
You can control how Actuate interprets two-digit years by setting the value of
the report server century break parameter. Check with your Actuate report
developer to see whether you need to set the parameter.
For information about how Actuate converts two-digit years into four-digit
years, see Chapter 7, Using query data streams, in Developing Advanced
e.Reports.
Setting up mail notifications
This section describes how to set up mail notifications on Windows server
operating systems.
Setting up mail notifications on Windows
The report server sends all electronic-mail notifications from a single account,
which must be listed in the system Registry. When the report servers mail
account is registered, it sends normal mail messages using standard tools.
Therefore you can test the servers ability to notify a particular user by sending
mail to that user from the servers account.
To use Windows messaging, Windows messaging must be installed on the
report server machine and the report server must have a mail account. The
report server must use a Microsoft Exchange profile. For information about
installing and configuring Windows messaging, see the Microsoft
documentation.
On Windows servers, you must set up a profile before registering the report
servers mail account. Use the Mail icon in the Control Panel folder to create a
profile. For more information about profiles, see the Microsoft Exchange
documentation.
To ensure that users are notified by electronic mail, their addresses must be
correctly registered with the report server using the Actuate Management
Console. If an address is not properly registered, the report servers attempts
to send mail to that address fail and the unsent mail returns. For more
information about creating and modifying user accounts, see Managing
users, privileges, and security roles, in Chapter 9, Managing Report
Encyclopedia volume security.
How to register the report server mail account
1 Run the mailinst program, which is stored in the report servers bin
directory.
Actuate Report Server Email Notification appears prompting for a profile
name and a password, as shown in the following illustration.

2 Select a Microsoft Exchange profile name.
3 Type the password and choose OK.
Mailinst modifies the Registry to reflect the information you have
provided.

To use Microsoft Exchange and the report server e-mail notification, you have
to configure both the report server and Exchange Server if they are on different
domains. You must set up an Actuate report server account with these
properties:
I The account running the Actuate report server must also be an account on
the Microsoft Exchange Server.
I The passwords for the account on the Actuate report server and the
account on the Microsoft Exchange Server must be the same.
For example, if the report server is on a machine in the domain Marketing and
is running in the account ActuateRS and the Exchange Server on a machine in
the domain Postoff, the machine running the Exchange Server must have an
account named ActuateRS and the password must be the same on both
machines.

Setting up mail notification on UNIX
The report server sends all electronic-mail notifications from the report
servers user account. You can test the servers ability to notify a particular
user by sending mail to that user from the servers account.
To send electronic mail from UNIX systems notifying users that a request has
been processed, assure that the account that runs the report server has access
to the sendmail program. The sendmail program is located in
/usr/lib/sendmail.
To ensure that users are notified by electronic mail, their addresses must be
correctly registered with the report server using the Administrator Desktop. If
an address is not properly registered, the report servers attempts to send mail
to that address fail and the unsent mail is returned to the mailbox of the report
server account. To check for such errors, log in to the account that runs the
report server and look for returned mail. Monitoring of this kind provides
early information about problems with account registration and mail
notification.
Microsoft
Exchange Server
Account: ActureRS
Password: Actuate6
Actuate
e.Reporting
Server
Account: ActureRS
Password: Actuate6
Domain
Postoff
Domain
Marketing
For more information about creating and modifying user accounts, see
Managing users, privileges, and security roles, in Chapter 9, Managing
Report Encyclopedia volume security.
How to test mail notification
1 Log in to the account that runs the report server.
2 Assuming that your test message is in the file message.txt, use the
following command to send it, replacing mail-address with the users
account name as registered with the report server:
$ /usr/lib/sendmail mail-address < message.txt
If your message arrives, the account is set up correctly and mail
notifications will succeed. If the message does not arrive, perform some or
all of the following steps:
I Check the spelling of the mail address.
I Log in to an account other than the one used for report server mail and
try sending mail to the user in question.
I Compare the users account name that is registered with your mail
facility with the account name registered with the report server. These
two account names must match exactly.
If you determine that none of these problems affect your situation, and you
still cannot send mail to the user from the report server account, contact
Actuate support for assistance.
Printing on UNIX
Report server printing on UNIX systems is based on Adobe Type-1 font
technology.
In Actuate 6, printing on UNIX systems does not support PCL.
About report encoding
The reports encoding affects printing on UNIX systems. For more information
about report encoding, see Chapter 3, Understanding report encoding, in
e.Reporting for Multiple Locales.
Font mapping
The UNIX report server ships a configuration file that contains entries in the
following comma-separated format:
Windows Font, Unix Font , afm file, pfa file, afm character encoding ID
The following table describes the fields.
The configuration file will be in the following directory:
$AC_SERVER_HOME/operation/print/fonts/fonts.supported
The following steps determine the text language:
I Using the text font name, the report server uses the configuration file. If the
font is supported and the language field is specified as one of the 4 CJK
values, the report server uses the value for text language.
I If the font is supported, but the language field is not specified as any of the
CJK languages in the configuration file, the report server use an algorithm
to determine the text language.
If the algorithms output is a single language, the report server uses the
language
If the algorithms output is no language, the report server uses English. If
the algorithms output is multiple languages, and server language is one of
the languages, the server language will be used. Otherwise, English will be
used.
I If the font is not supported, the report server use the algorithm determine
text language. If the algorithms output is a single language, the report
server uses the default font for that language. Otherwise, the report server
uses the default font for English.
Field Description
afm character encoding
ID
Specifies the code page used for specifying
characters in AFM file. For example, the code page
932 is for Japanese.
AFM file AFM font file name,
PFA file PFA font file name. For CJK languages, the PFA
file name can be an empty string
Unix font The corresponding UNIX font name. For example,
the Windows font name Times New Roman on
might be mapped to Times on a UNIX system.
Windows font Windows font name in the report.
Working with fonts
The e.Reporting Server ships with the following Latin-1 fonts:
Arial Black
Arial Black Italic
Arial
Arial Bold
Arial Italic
Arial Bold Italic
Arial Narrow
Arial Narrow Bold
Arial Narrow Italic
Arial Narrow Bold Italic
Courier New
Courier New Bold
Courier New Italic
Courier New Bold Italic
Verdana
Verdana Bold
Verdana Italic
Verdana Bold Italic
Times
Times Bold
Times Italic
Times Bold Italic
Frutiger-Roman
Palatino Italic
Johnny-Bold
The above fonts and their AFM files are installed on UNIX systems. In
addition, for each non-CJK language we support, we supply at least one font
set consisting of the normal, italic, bold, and bold-italic variations. For
non-CJK languages, the font is localized version of a font type similar to the
Arial font, and both the AFM and PFA files are installed.
For the CJK languages, Actuate supports the following fonts but does not
supply them. The customer must purchase a license for the font files and
install the font files.
Language Font 1 Font 2
Chinese (Simplified) SimSun SimHei
Chinese (Traditional) MingLiu MS Hei
If you add a CJK font to the file fonts.supported, the font name must be in the
native language. The fonts afm file is required. Chinese, Japanese, or Korean
fonts (CJK fonts) are not embedded. This means that the PostScript file must
be printed on a printer that has the font installed.
The fonts PFA file is required if the font is embedded, for example a
non-Chinese, Japanese, or Korean font. For non-CJK fonts, the UNIX font
name should be the same as the font name in the PFA file (FontName).
On UNIX systems, Actuate supplies a utility to install fonts. For information
about the utility, see Using the UNIX PostScript font utility, in Chapter 6,
Working with e.Reporting Server utilities.
Font mapping for charts in e.reports
For charts in e.reports, developers can specify fonts for chart text components
such as the title, data points, and axis label. To render charts properly, the fonts
specified in the chart must be made available to the report server JVM. Making
fonts available differs by platform.
I On Windows, install fonts the standard fonts folder for the operating
system. For example, on Windows NT use Fonts from the Control Panel.
Choose Fonts and then FileInstall new font.
I On UNIX, copy fonts into the $JAVA_HOME/jre/lib/fonts directory.
Using default fonts for charts
A default font is selected for those chart elements that do not have font
information explicitly specified. The default font is dependent on the locale
specified when generating the chart. These default fonts are listed below. For
UNIX and Windows output to look identical, these default fonts must be
available to the JVM if the default fonts are used in the chart.
Default font for languages other than CJK:
arial.ttf
arialbd.ttf
arialbi.ttf
ariali.ttf
times.ttf
Japanese Mincho Gothic
Korean Batang Dotum
Language Font 1 Font 2
timesbd.ttf
timesbi.ttf
timesi.ttf
Default fonts for Chinese (Traditional):
mingliu.ttc
Default fonts for Chinese (Simplified):
simsun.ttc
Default fonts for Japanese
msgothic.ttc
msmincho.ttc
Default fonts for Korean
gulim.ttc
batang.ttc
Configuring text for languages in graphs
When using Actuate e.reports containing graphs using text with non-Latin1
languages, the system administrator must set report server language
parameters. You need to set these items only when a report uses an Actuate
graph control derived from the Actuate AcGraph class such as a summary or
detail graph.
Using Japanese as an example, in the Actuate shell script pmd6.sh set the
LANG variable:
I On Solaris systems, set LANG to ja or japanese
I On HP-UX systems, set LANG to ja_JP.eucJP
I AIX systems, set LANG to ja_JP.IBM-eucJP
If the report is a Release 5 or earlier report, you must also set the report server
default encoding to EUC-JP the Actuate encoding value for Japanese.
Configuring the report server to search for fonts
The Actuate system administrator configures the report server to search
through master_fonts.rox to find the font information:
I When a report server View process displays an Actuate e.report in DHTML
format or generates PDF and the fonts are not in the .rox. For information
about how the View process uses fonts, see Configuring View process to
search for report fonts earlier in this chapter.
I When a report server runs a report executable .rox file that uses a dynamic
text control. For information about generating reports using dynamic text
controls, see Configuring Factory process to search for report fonts
earlier in this chapter.
I When a report executable .rox file generates Excel data and the data uses
fonts not in the .rox file. For information about Actuate report .rox files
generating Excel data, see Controlling Excel data output earlier in this
chapter.
To enable searching for fonts in the master_fonts.rox file:
I Place the master_fonts.rox file in the $AC_SERVER_HOME/etc directory if
necessary. In a cluster environment, place the master_fonts.rox file on every
report server with the View service or Factory service enabled.
I Set the report servers UseExternalizedFonts parameter to search for fonts
in the master_fonts.rox file.
The following table describes the UseExternalizedFonts parameters values:
The master_fonts.rox file that ships with Actuate includes standard Microsoft
Windows fonts. To modify the master_fonts.rox file, Actuate ships the report
design file master_fonts.rod in the e.Report Designer Professional and
e.Report Designer examples directory.
About the Report Server Security Extension
The following sections describe the Report Server Security Extension, RSSE
applications that are used with report server volumes. For a description and
the features of the Report Sever Security Extension, see About Actuate Open
Value Description
no Don't use externalized fonts. The report servers View
process does not use externalized fonts. The View
process uses the fonts in the .rox. This is the default
primary Look for the font in master_fonts.rox first. If the font
cannot be found in master_fonts.rox, look for the font
in the .rox file.
secondary Look for the font in the report executable .rox file first.
If the font cannot be found in .rox file, look for the font
in the master_fonts.rox file.
Security in Chapter 9, Managing Report Encyclopedia volume security. For
information about the RSSE API, see Chapter 10, Using the Report Server
Security Extension, in Programming Server Applications, distributed with the
Actuate Server Integration Technology product.
RSSE overview
Actuate supports two types of security integration:
I Open security
I Page security
About open security functionality
Actuate open security is available with the e.Reporting Server. Using open
security, Actuate developers create an interface to an external security source
such as the Lightweight Directory Access Protocol (LDAP) or Microsoft Active
Directory. Using the interface, the Report Encyclopedia volume uses
information from the external security source to control access to a Report
Encyclopedia volume.
Using the Report Server Security Extension, developers can also create a
custom login application used with the Actuate Desktop products, the Actuate
Viewer, End User Desktop, and e.Report Designer. The login application can
be used to collect extended credentials which would then be passed, by the
Desktop product, to the report server for authentication.
The developer needs to create an installation program that installs and
configures the login application on the user machine that has the Desktop
application. For information about creating the login application, see
Chapter 10, Using the Report Server Security Extension, in Programming
Server Applications.
About page security functionality
Using the RSSE and Actuate report page security, developers can create an
RSSE application that associates security IDs in a reports access control list
(ACL) to one or more Report Encyclopedia volume users or roles. For
example, a report developer can create an Actuate report that contains the
security ID Demo in some of the reports ACLs. Using an RSSE application,
Demo does not have to be a Report Encyclopedia volume user or role. The
RSSE application can take the security ID Demo and map it to a set of Report
Encyclopedia volume users or roles. When a user associated with Demo views
the report, that user can see the report pages where the pages ACL contains
Demo.
In addition to the ACL provided by the RSSE application, the report server
always adds the user name and any roles of which the user is a member. Even
if the RSSE application returns an empty string, therefore, the ACL used by the
report server always contains the volumes name and roles.
Administrators can install and use an RSSE page security example application
if they have purchased and installed the Page Level Security option for the
report server. For information about the RSSE interface and creating an RSSE
application, see Chapter 10, Using the Report Server Security Extension, in
Programming Server Applications.
The example RSSE application is designed to demonstrate the use of an RSSE
application with page security. While it is an example, it is designed as a
subset of a production RSSE application.
About the e.Reporting Server applications
With the e.Reporting Server, Actuate supplies two applications:
I An open security application that uses a Netscape Directory Server, an
LDAP server, to manage access to the Report Encyclopedia volume.
The RSSE open security application that uses LDAP is installed and
configured with the volume when an administrator chooses the Custom
installation option. For information about the open security application, see
About the RSSE open security application, later in this chapter.
I A page security example that controls access to an Actuate report based on
page security.
Administrators can install and use the RSSE page security example
application if they have purchased and installed the Page Level Security
option for the report server. For information about the page security
application, see About the example RSSE page security application, later
in this chapter.
About the RSSE open security application
The RSSE open security application uses a Netscape Directory Server, which is
an LDAP security database, to specify security for users logging into a Report
Encyclopedia volume. This application is used by the e.Reporting Server when
an administrator selects the Custom installation option during installation.
To use an LDAP security source, the security source must be configured and
populated with the appropriate security information.
The e.Reporting Server volume parameters must be configured properly.
Specify the DLL or shared library you are using in the Actuate Management
Console volume properties open security page. See Installing an RSSE
application later in this chapter for information about volume properties
open security. See Using an MT-safe RSSE application, later in this chapter
for using a mutlithread safe application.
If you install the e.Reporting Server with the external security application, the
registry entries or environment variables are configured by the installation
process.
Changing the type of Report Encyclopedia volume
security
If you have an existing Report Encyclopedia volume that contains user, role, or
group administration information, you need to use the acextern or the acintern
utility before you can change the type of security used with the volume.
For example, if the volume uses the default Actuate volume security and you
want use an RSSE application that accesses an external security source, you
need to use acextern to prepare the volume for use with the RSSE application:
I Acextern updates administration information used with the default
Actuate volume security for use with an RSSE application that uses an
external security source. For information about acextern options, see
Using acextern, in Chapter 6, Working with e.Reporting Server
utilities.
I Acintern updates administration information used with an RSSE
application that uses an external security source for use with the default
Actuate volume security. For information about acintern options, see
Using acintern, in Chapter 6, Working with e.Reporting Server
utilities.
Controlling external security caches
When using the external security application, the report server processes cache
external security source information. This information includes:
I External user properties
I Roles of a user under external user registration
Administrators can control the maximum time the cache holds the information
by setting open security parameters.
The RSSE cache timeout parameter controls the maximum length of time the
cache stores information. The time is set in minutes and defaults to 60.
For information about the volume properties open security page and the
parameters, see Working with Open Security in Chapter 4, Performing
system administration tasks.
About the example RSSE page security
application
The e.Reporting Server includes an example RSSE application designed to
demonstrate page security functionality that can be used with the Page Level
Security option. The example RSSE application uses a text file Usersids.txt that
maps Report Encyclopedia volume user names to other external security IDs.
The RSSE application can be used as a basis for a custom RSSE application.
To control the pages available to a user when viewing an Actuate report while
report page security is enabled, the report server compares the user ID and all
the Report Encyclopedia volume roles of which the user is a member with an
access control list (ACL) from the report document. The report document ACL
is the list of Security IDs for a report documents page. The report server gives
the Report Encyclopedia volume user access to only the pages where the user
ID or role is also on the report page ACL.
The RSSE application uses the Usersids.txt file to translate a volume user ID or
role to one or more security IDs, which the report server uses to check against
the Actuate report page ACL when page security is enabled for a report.
For example, you can create a Usersids.txt file with the following line:
murphy|region10, region12, region13
When murphy tries to read an Actuate report with page security enabled, the
RSSE application returns a list of security IDs that contain murphy, murphys
roles, region10, region12, and region13. The report server checks the user ID,
roles, and RSSE list against the Actuate report page ACL. The report server lets
murphy view any report page where a security ID returned from the RSSE
application matches a report page security ID.
Using the example RSSE page security application
To use the sample RSSE, you must complete the following tasks:
1 Install the e.Reporting Server with the Page Level Security option.
2 Stop the report server.
3 Create the Usersids.txt file in the Actuate report server /etc directory.
4 Enable open security and set the volumes open security parameters. Set
the RSSE library name parameter to the page security application. For
example on Windows NT, the value of the parameter is:
/Actuate6/Server/bin/rsse.dll
5 Restart the server.
You can modify the Usersids.txt file without restarting the report server, the
RSSE application picks up changes at the next user log on. If you modify the
security IDs for a user who is currently logged on to the server, the report
server will not pick up the changes until the user logs out of the server and
logs back on.
The default maximum length of an ACL is 64KB. If you use an ACL longer
than 64KB, specify a longer maximum length using the open security RSSE
max ACL buffer size parameter.
About USERSIDS.txt
The example RSSE application uses a file in the report server /etc directory
called Usersids.txt. The file has a very simple format for a user name and a list
of security IDs separated by commas:
userName|sid1, sid2, ... sidn
The userName field is the Report Encyclopedia volume user name. Each user
name in the file must be unique, the user name can be specified only once in
the file.
The vertical bar separates the user name from the security ID list.
The report page security ACL can contain zero, one, or more security IDs. If
there is more than one security ID, then they must be separated by commas.
White space before or after the user name, and before or after the security ID
list is ignored. The list can contain users that do not actually appear in the
volume. The information for these users will simply never be used.
The file can contain blank lines and comment lines. Comment lines must use #,
the pound sign character, as the first non-space character.
The example RSSE application loads the user list when the report server first
needs to access the information. The application reloads the list whenever the
Usersids.txt file changes on disk.
Logging RSSE page security application messages
The example page security RSSE application also provides simple logging. The
log file is called Rsse.log and resides in the report server /Log directory. To
turn on logging, simply create an Rsse.log file. To turn off logging, delete or
rename the file.
Installing an RSSE application
To install an RSSE application for a report server volume, use the Actuate
Management Console to enable open security and specify the open server
application and set the parameters in the volume properties open security
page.
For information about volume properties open security, see Working with
Open Security in Chapter 4, Performing system administration tasks.
Using an MT-safe RSSE application
By default, the RSSE application is not multithread-safe and all calls to get the
user ACL are serialized. The serialization can be turned off, however, by
enabling the open security RSSE multithread safe parameter.
Open Security LDAP configuration
When an Actuate e.Reporting Server volume is configured to use the Actuate
open security application that ships with the e.Reporting Server, the report
server uses the open security application and a Netscape Directory Server, an
LDAP server, to get Report Encyclopedia volume user information.
The report server uses the Actuate open security application to communicate
with the LDAP server and uses information from the LDAP directory for
Report Encyclopedia volume user administration. The following sections
describe how the Actuate open security application determines the mapping
between the LDAP directory information and the volume administration
information. This information is specific to the open security application that
ships with the e.Reporting Server.
When using the open security application, volume users defined in the LDAP
directory must have a password and the user information in the LDAP
directory:
I Must be in a single LDAP organization
I Must be in the appropriate LDAP object classes
The mapping between volume user information and LDAP information is
defined by the Actuate ldap.conf file.
In general, volume user administration information is mapped to LDAP
information in the following manner:
I The Actuate volume users, groups, and roles are mapped to LDAP object
classes. For example, a system administrator can specify Actuate users are
mapped to the LDAP object class inetorgperson and Actuate roles and
groups are mapped to the LDAP object class groupofuniquenames.
I Individual Actuate users, roles, and groups are defined as LDAP objects.
For example, once the system administrator specifies Actuate users are
mapped to the LDAP object class inetorgperson of an organizational unit, a
system administrator creates LDAP users based on the object class
inetorgperson. In LDAP, the system administrator creates users named
MBarajas and JThompson, based on the inetorgperson object class.
MBarajas and JThompson are volume users.
I Actuate user properties such as e-mail address and home folder are
specified in LDAP attribute-value pairs of the LDAP object class. For
example, once the Actuate users are based on inetorgperson object class,
the system administrator can specify the Actuate e-mail is mapped to the
mail attribute of the LDAP inetorgperson object class. An administrator can
create object class attributes to store Actuate user properties.
In LDAP, system administrators can also create different sets of volume users,
groups, and roles by creating the LDAP objects within different LDAP
organizational units and specifying LDAP distinguished names to point to the
different LDAP organizational units.
For information on how LDAP categorizes and stores information, see the
LDAP documentation.
Report Encyclopedia volume administration
information mapping
The Actuate e.Reporting Server Open Security application using LDAP uses a
mapping file ldap.conf to map the Report Encyclopedia volume
administration information to LDAP objects and object attributes. The
ldap.conf file defines defaults for some volume administration information.
The file is in the report server \etc directory. Misconfigured or missing
parameters in the ldap.conf file might prevent the report server from
functioning.
Mapping Actuate Report Encyclopedia volume user
properties
Actuate users and their properties such as login name, password, e-mail
address, and default privilege template are mapped to attributes of an LDAP
object. For example, if the Actuate user information is mapped to an LDAP
inetorgperson object class, the user properties are mapped to the LDAP
inetorgperson object class attributes. All LDAP user object attributes are string
attributes. To specify multiple values, the LDAP user object attribute used for
privilege template and report server volume channel membership information
must be multivalued. For example, to specify that a user belongs to multiple
volume channels in LDAP, the user object Actuate volume channel attribute
must be multivalued with an Actuate channel name per value.
The Report Encyclopedia volume login name is the LDAP user object user ID
attribute the uid attribute, and the volume password is the LDAP user object
password attribute. When using the Actuate open security application, a user
logging in to volume requires a password.
To specify an Actuate user as a member of an Actuate role or an Actuate
notification group, add the LDAP Actuate user as a member of the appropriate
LDAP Actuate group or role.
The Actuate user property defaults specified in ldap.conf are used when the
LDAP user object attribute is not defined in the LDAP server or the LDAP
attribute for a user object does not contain any values.
Mapping Actuate roles
Actuate Report Encyclopedia volume roles are mapped to an LDAP object
class such as groupofuniquenames. The name Actuate displays is the LDAP
objects common name attribute, the LDAP cn attribute.
When using the Actuate Open Security application with an LDAP server, no
nesting of roles is allowed. Roles are an LDAP object with no Actuate-specific
attributes. To specify an Actuate user is a member of one or more Actuate
roles, add the LDAP Actuate user object as a member to the LDAP Actuate
roles.
The report server uses the members specified in the LDAP Actuate role objects
when performing authorization functions for Actuate roles. The report server
also uses the LDAP role objects when listing roles used to specify privileges.
To specify privileges on a file or folder in the volume for an LDAP role object,
first create the Actuate role object in the LDAP directory, then in the volume,
specify privileges for the Actuate role on the volume file or folder.
Mapping Actuate groups
Actuate Report Encyclopedia volume groups are mapped to an LDAP object
such as groupofuniquenames. The name Actuate displays in the volume is the
LDAP object cn attribute.
If the e-mail notification group is mapped to the LDAP object class
groupofuniquenames, the LDAP group objects do not require Actuate-specific
attributes. To specify an Actuate user as a member of a Report Encyclopedia
volume group, create an LDAP group object and add the LDAP user object as
a member of the LDAP group object.
Mapping Actuate channels
Channel names are stored in the Report Encyclopedia volume. The list of
channels that an Actuate user subscribes to is specified as an LDAP user object
attribute. Administrators must ensure the channel names and values in the
LDAP user object channel attribute match. The Open Security application does
not verify that the volumes channel names match the LDAP user object
channel attribute values.
Understanding ldap.conf parameters
The Actuate e.Reporting Server Open Security application that ships with the
e.Reporting Server uses a mapping file ldap.conf to map the Report
Encyclopedia volume administration information to LDAP objects and object
attributes. The following table describes the parameters in the ldap.conf file.
ldap.conf parameter Description
ADMIN_ROLE_NAME The value that must be in the LDAP
user object Actuate role attribute to
perform Report Encyclopedia volume
administrator operations.
ALL_ROLE_NAME The LDAP role object name used in
the Report Encyclopedia volume as
the All role. The All role is used to
grant privileges to all volume users.
GROUP_BASE_DN The LDAP distinguished name used
to locate the LDAP Actuate
notification group object.
An example is "ou=Actuate Groups,
o=actuate.com"
GROUP_OBJECT The LDAP object class the Actuate
Open Security application uses to
find Actuate notification group
names.
GROUP_TO_NOTIFY Specifies an LDAP notification group
name the Report Server sends all
notifications to. The base DN of this
group name is obtained from the
GROUP_BASE_DN parameter.
An example is "AdminGroup."
When combined with the
GROUP_BASE_DN value, specifies
the LDAP Actuate notification group
object the Report Server uses to notify
Actuate LDAP notification. For
example "cn=AdminGroup,
ou=Actuate Groups, o=actuate.com."
OPERATOR_ROLE_NAME The LDAP role object name used as
the Report Encyclopedia volume
Operator role.
PORT Internet port the LDAP server listens
on. Default is 389.
QUERY_ACCOUNT LDAP account used for query
operations to the LDAP server. The
Open Security application uses this
account to validate users, roles,
ACLs, and other Report Encyclopedia
volume user information.
An example is "uid=admin,
ou=Administrators,
ou=TopologyManagement,
o=NetscapeRoot"
QUERY_PASSWORD Password for the LDAP account used
for query operations. The LDAP
account specified by the
QUERY_ACCOUNT parameter.
ROLE_BASE_DN The LDAP distinguished name used
to locate the LDAP role object, for
example, "ou=Actuate Roles,
o=actuate.com"
ROLE_OBJECT The LDAP object class the Actuate
Open Security application uses to
find Actuate role names.
SERVER Name of the LDAP server used by the
Default is the report server machine.
USER_BASE_DN The LDAP distinguished name used
to locate the LDAP user object, for
example, "ou=People, o=actuate.com"
USER_CHANNEL_LIST_ATTR LDAP attribute that specifies the
channels the Actuate user is
subscribed to.
In LDAP, the attribute is multivalued
with a single channel name per value.
USER_CHANNEL_LIST_DEFAULT Default value when the
USER_CHANNEL_LIST_ATTR
attribute value is not specified in
LDAP.
In Ldap.conf the value is a comma
separated lists of channel names, for
example, "portfolio update, sales
forecasts"
USER_DEFAULT_PRIV_ATTR The LDAP attribute that specifies the
Actuate users privilege template.
The privilege values are r for read, w
for write, e for execute, d for delete, v
for visible, s for secure read, and g for
grant.
The format for set of user privileges is
a user login name followed by =, an
equals sign, followed by zero or more
permission characters. A role
permission is a role name followed by
~ , a tilde, followed by zero or more
privilege values.
To specify a privilege template that
lists multiple users or roles in LDAP,
the attribute must be multivalued
with a single user or role per value.
USER_DEFAULT_PRIV_DEFAULT Default value when the
USER_DEFAULT_PRIV_ATTR
LDAP.
Value is a comma separated list of
user or role privileges.
The example specifies read and
visible privilege to a role called
viewing only, while read, write,
execute, and delete privileges are
given to user "jbob".
An example is "viewing only~rv,
jbob=rwed"
USER_EMAIL_FORM_ATTR The LDAP attribute that specifies the
Actuate users preferred form of
email notification. Value is either
included to attach a report if possible,
or linked to specify a link to the
report.
USER_EMAIL_FORM_DEFAULT Default value when the
USER_EMAIL_FORM_ATTR
LDAP. Value is either included or
linked.
Value in ldap.conf is linked.
USER_EMAIL_ID_ATTR The LDAP attribute that specifies the
Actuate users e-mail address.
For some object classes such as
inetorgperson, an e-mail attribute
exists in the standard LDAP schema.
USER_EMAIL_WHEN_ATTR The LDAP attribute that specifies
when to notify the Actuate user of a
report completion using e-mail. Value
is either never to not notify,
always to notify of both failures
and successes, failures to notify of
failures only, or successes to notify
of successes only.
USER_EMAIL_WHEN_DEFAULT Default value when the
USER_EMAIL_WHEN_ATTR
LDAP. Value is either never, always,
failures, or successes.
Value in ldap.conf is never.
USER_FAIL_NOTICE
_EXPIRATION_ATTR
The LDAP attribute that specifies
how long the report server keeps a
users failed completion notices in the
Report Encyclopedia volume
completed notice folder.
The number is measured in minutes.
Using 0, zero, means dont keep
failed notices. Using -1 means keep
notices forever.
USER_FAIL_NOTICE
_EXPIRATION_DEFAULT
Default value when the
USER_FAIL_NOTICE_EXPIRATION
_ATTR attribute value is not specified
in LDAP.
Value in ldap.conf is -1.
USER_FOLDER_WHEN_ATTR The LDAP attribute that specifies
when to notify the Actuate user of a
report completion by placing a notice
in the Report Encyclopedia volume
completed notice folder. Value is
either never to not notify, always
to notify for both failures and
successes, failures to notify of
failures only, or successes to notify
of successes only.
USER_FOLDER_WHEN
_DEFAULT
USER_FOLDER_WHEN_ATTR
LDAP. Value is either never, always,
successes, or failures.
Value in ldap.conf is always.
USER_HOME_FOLDER_ATTR The LDAP attribute that specifies the
users Report Encyclopedia volume
home folder.
USER_MAX_COMPLETED_ATTR LDAP attribute that specifies the
maximum number of user report
notifications to keep in the Report
Encyclopedia volume notification
folder.
In LDAP, the attribute value is a non-
negative integer.
USER_MAX_COMPLETED
_DEFAULT
USER_MAX_COMPLETED_ATTR
LDAP.
USER_MAX_PRIO_ATTR The LDAP attribute that specifies the
Actuate users maximum request
priority. The value is the maximum
request priority the user is allowed to
set when creating a report print or
generation request in the Report
In LDAP, the attribute value must be
an integer between 0 and 1000.
USER_MAX_PRIO_DEFAULT Default value when the
USER_MAX_PRIO_ATTR attribute
value is not specified in LDAP.
Value in ldap.conf is 500.
USER_OBJECT Specifies the LDAP object class the
Actuate Open Security application
uses to find Actuate user names.
An example of an LDAP object class
is inetorgperson.
USER_SUCCESS_NOTICE
_EXPIRATION_ATTR
The LDAP attribute that specifies
how long the report server keeps a
users success completion notices in
the Report Encyclopedia volume
completed notice folder.
The number is measured in minutes.
Using 0, zero, means dont keep
success notices. Using -1 means keep
notices forever.
Setting ldap.conf parameters
In the Actuate ldap.conf file, the syntax for the parameters is:
<parameter-name>, <value>
A comma separates the parameter name and value. The parameter name is
one of the valid parameter names specified in Understanding ldap.conf
parameters, earlier in this chapter. The value is a text string. If the value
contains spaces the value is enclosed in double quotes.
If a default value can be specified, the default parameter syntax is:
<default-name>, <value>
The value is a text string. If the value contains spaces the value is enclosed in
double quotes ( ).
The # character indicates comments. Any text between the # and the end of the
line is ignored.
The following is series of parameters and sample values used in the ldap.conf
file followed by a description of the valid settings. The values are based on
Netscape Directory Server 4.2.
SERVER, helium.actuate.com"
Name of the LDAP server used by the RSSE Open Security application and the
Actuate e.Reporting Server. This name must be fully qualified with the
domain name included. The servers IP address can be used.
USER_SUCCESS_NOTICE
_EXPIRATION_DEFAULT
USER_SUCCESS_NOTICE_EXPIRAT
ION_ATTR attribute value is not
specified in LDAP.
USER_VIEWING_PREF_ATTR LDAP attribute that specifies the
Actuate user default viewing
preference. Value is either default, lrx,
or dhtml.
USER_VIEWING_PREF_DEFAULT Default value when the
USER_VIEWING_PREF_ATTR
LDAP.
Value in ldap.conf is default.
PORT, 389
This internet port is the one the LDAP server is listening on.
USER_BASE_DN, "ou=People, o=actuate.com"
The base LDAP distinguished name dn used for queries of users. When the
user's name is added as a prefix to a base distinguished name, the resulting
name uniquely identifies the user in the external data source. Most base
distinguished names consist of the organizational unit or a series of
organizational units and an organization.
QUERY_ACCOUNT, "uid=actuate, ou=People, o=actuate.com"
QUERY_PASSWORD, "xxxxxx"
LDAP account used for query operations to the LDAP server when validating
users, roles, and other Report Encyclopedia volume user information.
USER_OBJECT, inetorgperson
The LDAP object class the Actuate Open Security application uses to find
Actuate user names.
ROLE_BASE_DN, "ou=Groups, o=actuate.com"
The base distinguished name dn used for queries of roles.
ROLE_OBJECT, groupofunqiuenames
Actuate role names.
GROUP_BASE_DN, "ou=Groups, o=actuate.com"
The base distinguished name dn used for queries of notification group names.
GROUP_OBJECT, groupofuniquenames
Actuate notification group names.
ALL_ROLE_NAME, actuateAll
The role name used in the Actuate Report Encyclopedia volume in order to
grant privileges to all users.
GROUP_TO_NOTIFY, specialGroup
Specifies the group that receives notification of all report server requests in the
manner of the administrator user when the Report Encyclopedia volume is
using default, internal security. The base DN of this group name is obtained
from the GROUP_BASE_DN parameter.
OPERATOR_ROLE_NAME, actuateOperator
The role name that a user must have in order to perform Report Encyclopedia
volume Operator functions such as volume online backups.
ADMIN_ROLE_NAME, actuateAdmin
The role name that a user must have in order to perform Report Encyclopedia
volume administrator functions.
USER_EMAIL_ID_ATTR, mail
Specifies the name of the LDAP user attribute that is read when the report
server wants to send mail to a Report Encyclopedia volume user.
USER_HOME_FOLDER_ATTR, actuateHomeFolder
The LDAP attribute that specifies the users Report Encyclopedia volume
home folder. There is no default value.
USER_EMAIL_FORM_ATTR, actuateEmailForm
USER_EMAIL_FORM_DEFAULT, included
The LDAP attribute that specifies the Actuate users preferred form of email
notification. The e-mail can contain either a copy of the report or a link to the
report. Default value can be either included or linked.
USER_EMAIL_WHEN_ATTR, actuateEmailWhen
USER_EMAIL_WHEN_DEFAULT, failures
This LDAP user attribute specifies when to notify the user using e-mail at
report completion time. Choices are:
USER_FOLDER_WHEN_ATTR, actuateFolderWhen
USER_FOLDER_WHEN_DEFAULT, failures
This LDAP user attribute specifies when to notify the user by placing a
completed notice in the Report Encyclopedia volume completed notice folder
at report completion time. Choices are:
never dont notify
always notify of failures and
successes
failures notify of failures only
successes notify of successes only
never dont notify
always notify of failures and
successes
USER_SUCCESS_NOTICE_EXPIRATION_ATTR,
actuateSuccessNoticeExpiration
USER_SUCCESS_NOTICE_EXPIRATION_DEFAULT, 4320
This LDAP attribute specifies how long the report server keeps success
completion notices in the Report Encyclopedia volume completed folder. The
number is measured in minutes. 4320 minutes is 3 days. A 0, zero, means dont
keep success notices. A -1, minus one, means keep notices forever.
USER_FAIL_NOTICE_EXPIRATION_ATTR, actuateFailNoticeExpiration
USER_FAIL_NOTICE_EXPIRATION_DEFAULT, 14400
This LDAP attribute specifies out how long the report server keeps failure
completion notices in the Report Encyclopedia volume completed folder. This
number is measured in minutes. 14400 minutes is 10 days. A 0, zero, means
dont keep success notices. A -1, minus one, means keep notices forever.
USER_DEFAULT_PRIV_ATTR, actuateDefaultPriv
USER_DEFAULT_PRIV_DEFAULT, "viewing only~rv, jbob=rwed"
This LDAP attribute specifies Report Encyclopedia volume users default
privilege template that is used to assign privileges to newly created Report
Encyclopedia volume files or folders created by the user.
For the default value, the privilege template is specified as a comma-separated
list of user and role permissions.
A user permission is a user login name followed by "=" followed by zero or
more permission characters. A role permission is a role name followed by "~"
followed by a zero or more permission characters. The permission characters
and their meanings are:
The example gives read and visible permissions to a role called "viewing only",
while read, write, execute, and delete permissions are given to user "jbob".
failures notify of failures only
successes notify of successes only
r read
w write
e execute
d delete
v visible
s secure read
g grant
USER_MAX_PRIO_ATTR, actuateMaxPriority
USER_MAX_PRIO_DEFAULT, 0
This LDAP attribute specifies the maximum priority a user can use when
creating a Report Encyclopedia volume report generation or print job. The
value must be an integer between 0 and 1000.
USER_MAX_COMPLETED_ATTR, actuateMaxCompleted
USER_MAX_COMPLETED_DEFAULT, 10
This LDAP attribute specifies the maximum number of report notifications to
keep in the Report Encyclopedia volume completed notification folder. The
value is a positive integer. 0 removes notices immediately. -1 never removes
notices.
USER_VIEWING_PREF_ATTR, actuateViewingPref
USER_VIEWING_PREF_DEFAULT, dhtml
This LDAP attribute specifies Report Encyclopedia volume users default
viewing preference. The default value can be default, lrx, or dhtml.
USER_CHANNEL_LIST_ATTR, actuateChannelList
USER_CHANNEL_LIST_DEFAULT, "portfolio update, sales forecasts"
This LDAP attribute specifies the channels to which the user is subscribed. The
default list of channel names is a comma-separated list of channel names.
Resolving timeout and performance issues
If the report server is using a Netscape LDAP server, an LDAP administrator
might have to make some configuration changes to the Netscape LDAP server
for timeout and performance reasons. When dealing with large LDAP servers,
LDAP administrators can set a time limit on a query, a maximum number of
entries that are searched, and cache sizes.
For information about tuning an LDAP server, see the Netscape LDAP
documentation.
For example, using the Netscape console 4.1, an LDAP administrator can
change both timeout and performance settings.
1 Open the Netscape console.
2 Choose the Console tab.
3 Expand the tree to show the Directory Server (server name) branch.
4 Double click the Directory Sever branch to display the Directory Server
window.
5 Choose the Configuration tab to display the Configuration page.
The following are some LDAP configuration settings that can enhance LDAP
server performance when the LDAP server is used with the report server:
I From the Configuration page, select the Root Node in the tree view of the
directory server window. Select the Performance tab. Administrators can
change the Size limit to return a smaller number of entries. For example,
reduce the number to 500 from the default 2000 entries. Administrators can
also change the maximum time the LDAP server spends performing a
search to a number such as 80 seconds.
I From the Configuration page, select the Database node in the tree view of
the directory server window. Select the Performance tab. Administrators
control the look-through limit found in the Performance tab. The
look-through limit specifies the maximum number of entries the LDAP
server checks when performing searches. The default is 5000. This page is
where LDAP administrators also set the maximum cache size and
maximum number of entries in the cache.
I From the Configuration page, select the Database node in the tree view of
the directory server window. Select the Indexes tab. Creating a substring
index for the uid attribute can increase search performance. In the
additional indexes list box, scroll down to the uid Attribute name and
enable substring index. Once this index has been created, searches over
large databases using a search string that narrows the search sufficiently,
produces good response times.
Using the LDAP Directory Manager
The following describe issues if you use the LDAP Directory Manager to
communicate with the LDAP server. The LDAP Directory Manager is
configured by default during installation as the unrestricted Directory Server
user (cn=directory manager). Using the Directory Manager as the unrestricted
Directory Server user has the following implications:
I Directory Manager ignores all access control instructions (ACIs) in the
database.
I Operations performed by Directory Manager ignore all Performance
Tuning parameters.
The following problems could occur if an administrator misuses the Directory
Manager user:
I Searches performed by Directory Manager ignore the lookthroughlimit
setting which could result in the entire database being searched for
unindexed and allidsthreshold-hit search conditions.
I Every possible search result gets returned because the sizelimit setting is
ignored.
I The Directory Server uses up more of the system resources.
The following are two workarounds Netscape suggests for avoiding problems
related to the Directory Manager:
I Bind as the Admin user entry.
I Create a user in the database strictly used for binding against the Directory
Server.
Importing and exporting data with open security
Report Encyclopedia volume administrators cannot import data from an
externalized volume to an internalized volume using acexport and acimport.
Also, except when using the acimport option -admindata, an administrator
cannot import data from an internalized volume to an externalized volume
using acexport and acimport. An externalized Report Encyclopedia volume
uses the Actuate RSSE application and administration information from an
external LDAP directory. An internalized Report Encyclopedia volume uses
the administration information stored internally in the volume. For
information about acexport and acimport, see Using acexport, and Using
acimport, in Chapter 6, Working with e.Reporting Server utilities.
Using Report Server open security utilities
The two report server open security utilities updates administration
information in a Report Encyclopedia volume so the user, role and group
information can be used by different Report Encyclopedia volume security
configurations.
I Acextern updates volume administration information used with the
default Report Encyclopedia security for use with an RSSE application that
uses an external security source. For information about acextern options,
see Using acextern, in Chapter 6, Working with e.Reporting Server
utilities.
I Acintern updates volume administration information used with an RSSE
application that uses an external security source for use with the default
Report Encyclopedia security. For information about acintern options, see
Using acintern, in Chapter 6, Working with e.Reporting Server
utilities.
When the report server is configured to use the default Actuate Report
Encyclopedia volume security, all information is stored within the volume, the
report server uses an identifier ID and does not use the name of the user, role,
or group when assigning privileges and setting other administrative options.
To use the Actuate open security RSSE application and an external security
source, the internal IDs must be replaced with the user, role, or group name.
Acextern replaces references to Actuate user, role, and group IDs with their
corresponding names. Acextern performs this conversion on the following
Report Encyclopedia volume administration information:
I Privilege rules, or Access Control Lists, on folders and files in the volume
I Privilege rules in scheduled requests
I Privilege rules on a volumes channels
I Report Request notification settings
I Scheduled Requests
I Completed Requests
After the conversion, the Actuate RSSE application can match the users, roles,
and groups in the volume to users, roles, and groups in the external security
source.
The Acintern utility modifies the same references as Acextern. For each user
name reference in the volume, Acintern looks up the corresponding Report
Encyclopedia volume ID and changes the reference to an ID. If there is no
corresponding ID that reference is removed.
For information about the Actuate open security RSSE application that ships
with the e.Reporting Server, see Chapter 9, Managing Report Encyclopedia
volume security.
If the acextern -RSSE option is used, Acextern uses the RSSE application to
validate each Actuate name in the Report Encyclopedia volume. If the name
does not exist in the external security source, the reference to the user or role is
removed from the volume.
How to convert from internal IDs to external names
To convert existing Report Encyclopedia volume administration information
such as users, roles, groups, and privilege information that is stored internally
to a form usable by the Actuate open security application, do the following:
1 Shut down the report server.
2 Use Acextern to convert the Report Encyclopedia volume references from
internal users, roles, and groups to the corresponding external names.
3 Change the RSSE configuration to enable external registration of users.
4 Start the report server.
How to convert a Report Encyclopedia volume to use internal user
information
1 Shut down the report server.
2 Use acintern to convert the Report Encyclopedia volume references from
external users, roles, and groups to the corresponding internal names.
3 Change the RSSE configuration to disable external registration of users.
4 Start the report server.
About the archive driver
Using Actuate software, developers can create an archive driver to archive
files in the Report Encyclopedia volume using external archiving software and
hardware. The archive driver software is an interface between the report
server and the archiving software and hardware. For information about the
archive driver interface and creating an archive driver, see Chapter 11, Aging
and archiving Report Encyclopedia items,in Programming Server Applications.
To demonstrate how an archive driver works, the Actuate e.Reporting Server
includes an example archive driver in the report servers /examples directory.
This example takes files from the Report Encyclopedia volume and places
them in a directory on the report server machines native file system. Within
the native file system directory, the archive driver creates a folder hierarchy
similar to the one in the Report Encyclopedia volume and places the file in the
hierarchy.
On Microsoft Windows server operating systems, the archive driver is
Archive.dll. On UNIX systems, the archive driver is a shared library.
Installing the example archive driver
For information about configuring the Report Encyclopedia volume to use an
archive driver and for information about setting autoarchive rules for
archiving files, see Chapter 11, Managing e.reporting system resources.
To configure and install the archive driver for a volume, you must:
I Configure the volume to use the archive driver. For information about
specifying an archive driver, see Viewing volume information, in
Chapter 4, Performing system administration tasks.
I Set AC_ROOT_FOLDER, an environment variable on UNIX and Microsoft
Windows server operating systems. The value is the directory on the report
server machine where the archive driver places files removed from the
Report Encyclopedia volume. Set this environment variable on the report
server machine managing the volume.
On Microsoft Windows server operating systems, AC_ROOT_FOLDER is a
system environment variable not a user environment variable.
To have the report server use the variables, stop and restart the report server.
How the example archive driver works
When the report server performs auto archiving on the Report Encyclopedia
volume, the example archive driver copies volume files that are marked for
archival before deletion into the folder in the report servers native file system
specified in AC_ROOT_FOLDER. The archive driver creates the same
directory structure for the files in the native file system that is in the Report
For example, if the AC_ROOT_FOLDER folder is C:/a1, and the file path
name in the volume is /abc/def/xyz, and the file version is 1, the archive
driver constructs a directory path to file C:/a1/abc/def/xyz.1.
The example archive driver does not save any volume file dependency
information when archiving the files. However, you can create an archive
driver that saves this information using the Actuate Software Development
Kit.
The example archive driver uses the file Archive.log as the log file. If a file
named Archive.log exists in the report servers /log directory, the archive
driver appends data to it while archiving files.
If there is no log file, no logging is done. To turn logging on, create a file
named Archive.log. To turn off logging, either rename or remove the file.
When logging is on, the file is opened and closed for each message. This
allows you to immediately see any messages, and ensures that the most recent
message is in the log file in the event of a crash.
Optimizing e.Reporting Server performance
The following sections discuss optimizing e.Reporting Server performance in
the following areas:
I Optimizing viewing for Actuate DHTML reports discusses DHTML,
web browser, and report performance issues.
I Optimizing Report Encyclopedia volume performance discusses volume
folder and file organization performance issues.
I Optimizing report server system performance discusses report server
machine performance issues.
I Optimizing View process performance discusses View process
performance issues.
Optimizing viewing for Actuate DHTML reports
The time required to view Actuate DHTML reports consists of the time to
render the report in DHTML plus the time to display DHTML in the users
web browser.
Comparing performance between web browsers
Actuate has determined that the performance of different web browsers varies
significantly:
I Microsoft Internet Explorer 5 performs faster than Internet Explorer 4.
I Microsoft Internet Explorer is faster than Netscape Navigator.
I Netscape Navigator performance is more sensitive to the number of
components on a DHTML report page to be displayed than is Microsoft
Internet Explorer. This difference in sensitivity is because the size of
DHTML files in Netscape Navigator is larger than in Microsoft Internet
Explorer. Style sheets compress about 20% to 30% of the data.
Caching DHTML report pages
Allow caching on users web browser to improve viewing for frequently
accessed DHTML report pages. To take advantage of client-side caching, the
report server administrator must enable browser-side caching of DHTML
reports on the Report Encyclopedia volume.
For more information about setting web browser caching options, see Setting
web browser page caching options in Chapter 12, Administering the volume
in the web environment.
Searching DHTML reports
Users can search reports for controls with the Searchable property set to
SearchWithIndex or SearchNoIndex. The View process sets an upper limit on
the amount of search time allowed for a search operation. The report server
Search Timeout parameter is the number of seconds used as the time-out for a
View process search operation. If users are experiencing search timeouts,
increase this value to allow for longer times for searches. The default is 180
seconds, or 3 minutes.
Downloading PDF files
The View process creates a compressed PDF file to be downloaded to the
users workstation. The View process converts images in report documents to
Adobe JPG format. The View process first writes any text to the PDF file and
then converts each image into the JPG format supported by Adobe PDF.
Converting one image to JPG format might take as long as 15 seconds.
Compressing DHTML reports
The View process can stream report pages to Actuate Active Portal and the web
server in GZIP compressed DHTML format. To use GZIP compressed DHTML
format, system administrators must ensure that these conditions are satisfied:
I The web browser supports GZIP encoding.
I Actuate Active Portal requests DHTML, DHTMLLong, or DHTMLRaw
format.
System administrators and users can set report server CompressDHTML
Content parameter to enable compression and DHTML Compression Level
parameter to set the compression level.
Understanding how bundling affects performance
To simplify report distribution, Actuate provides the capability to bundle the
ROX file with the ROI file. Bundling works well if the distributed report runs
on the client workstation. Users viewing large bundled reports on the report
server may experience long network wait times or time outs before the report
is displayed because the view server extracts the ROI file for every request.
Actuate does not recommend bundling large reports.
Optimizing Report Encyclopedia volume
performance
These sections discuss the following topics related to Report Encyclopedia
volume tuning:
I About Report Encyclopedia volume structure
I Restructuring the Report Encyclopedia volume
I Managing report notices
I Moving the Report Encyclopedia volume
I Managing space for the Report Encyclopedia volume
I Understanding the effects of disk I/O speed
I Running the Veritas file system on HP systems
About Report Encyclopedia volume structure
The volume stores report items and administration information including the
following:
I e.Report executable (.rox) files
I e.Report document (.roi) files
I e.Report parameter values (.rov) files
I e.Report Java Edition (.jod) files
I e.Spreadsheet (.vtx) files
I Users and roles
I Channels
I Jobs
I Notifications
The report server keeps track of the relationships between report items. For
example, each time a report runs on the report server, a new report document
is generated and any relationships to other report files, such as the report
executable and their folders, are updated.
Restructuring the Report Encyclopedia volume
The Report Encyclopedia volume folder structure should be designed to
reduce the number of relationships between folders and report items. Folders
having more than 1000 items or subfolders increase report server
administrative overhead and force users to view, navigate through, and
manipulate long lists of folders and documents. To improve the structure of
the volume, do the following:
I Create additional folders containing a small number of report items or
subfolders.
I Copy report executables into multiple folders to reduce the number of
relationships between the report executable and the report documents.
The following example illustrates how to restructure the volume to for easier
maintenance, user navigation, and reduce the amount of administrative
overhead. In this example, the major report, Report.rox, is a parameterized
report that runs several times a month for certain users. The report contains
information about specific clients. The application report name is composed of
a user name, and run date. The illustration shows a simple volume folder
structure with one folder, ReportExecutables, that contains the report
executable file, Report.rox, and another folder, Reports, that contains the
report documents created from Report.rox.
The following illustration shows the contents of the ReportExecutables folder.
The following illustration shows the contents of the Reports folder.
As more reports run, report documents accumulate in the Reports folder. To
improve viewing performance, the restructured volume contains subfolders
for each year, month, and day that contain the report documents. Also,
application folders for each year and month contain the report executable file,
Report.rox. Now, the restructured volume contains fewer relationships
between single report items and folders and between report documents and
the report executable. The following illustration shows the restructured
volume.
Managing report notices
Persistent completed notification records are created if the users Completed
Folder box is checked in the user definition on the volume. Users are notified
when jobs to run or print reports complete on the report server. Notified users
include the following:
I The user who submitted the job
I Administrator
I Users belonging to groups to be notified
I Report server API connections belonging to the user
The accumulation of long lists of completed notices affects user viewing
performance. To reduce the number of persistent completed notices:
I Generate report server completed notices box only when needed.
I Purge persistent completed notices on a regular basis.
Notification settings for jobs a user creates are defined for each user. For
information about setting user properties, see Managing users, privileges,
and security roles, in Chapter 9, Managing Report Encyclopedia volume
security.
Notification settings can also be set when scheduling a job. For information
about the job is scheduled to run. For information about scheduling jobs, see
Administering jobs, in Chapter 11, Managing e.reporting system
resources.
Moving the Report Encyclopedia volume
To move the Report Encyclopedia volume to a different report server, use the
report server online backup facilities to back up the contents of the volume.
Use the Actuate acverify utility with the -check restore option when restoring
a volume that has been backed up in online backup mode.
For information about using online backup, see Backing up the volume, in
Chapter 11, Managing e.reporting system resources. For information about
acverify, see Using acverify, in Chapter 6, Working with e.Reporting Server
utilities.
When the report server is running, do not alter, update, or move the Report
Encyclopedia volume directories.
Managing space for the Report Encyclopedia
volume
Actuate helps system administrators provide sufficient space for the Report
Encyclopedia volume by providing these services:
I Monitoring for disk space
I Validating the Report Encyclopedia volume
Monitoring disk space
The Actuate report server checks for available, unused disk space using the
values set with the Actuate parameters. See Using automatic disk space
checking, earlier in this chapter.
Validating the Report Encyclopedia volume
To improve Report Encyclopedia volume performance, run the acverify utility
if the report server has performance problems. For information about acverify,
see Using acverify, in Chapter 6, Working with e.Reporting Server
utilities.
Understanding the effects of disk I/O speed
The report server stores a volumes documents, metadata, and transaction
information on disk. Rapid access to these volume items improves report
generation throughput. Improving the performance characteristics of the disk
subsystem containing the volume may yield improved report server
performance.
The following items describe the types of report server information and how
the report server uses the information:
I Volume documents such as report executable .rox files report document .roi
files and other files added to a volume are stored in or more report server
partitions. The report server partitions are directories on the machines
hard disk. The report server process and Factory and View processes on
each report server in a cluster must access these files to generate reports
and view documents.
The partitions containing the volume documents should be physically
mounted on the report server machine, and must be available to other
report servers in the cluster.
For information about report server partitions, see Configuring report
server system partitions, in Chapter 4, Performing system administration
tasks.
I Volume metadata includes volume administration information about users,
groups, security roles, files, folders, jobs, and completion notices and is
stored in the volumes primary partition. The report server manages this
information using a page buffer pool.
As a general rule, make the buffer pool as big as possible to stay in report
server machines memory and not in the machines disk swap space. When
the buffer pool is in memory, the report server does not read data from disk
as often during volume administration operations and the report server
can write data to disk asynchronously not waiting for disk output to
complete.
A report server system administrator adjusts the buffer pool size in the
volume properties server assignments page. For information about volume
properties server assignments, see Assigning primary and backup servers
to a volume, in Chapter 4, Performing system administration tasks.
I Volume transaction log records updates to the volumess data. The report
server records every volume update operation in the transaction log, and
every update message must wait for the writes to this file to be written to
disk. The volume transaction log is in a report server system partition. The
report server uses the transaction log during recovery to restore the volume
to a consistent state after a crash.
As a standard optimization technique for systems that use a log file,
Actuate recommends putting the transaction log on a separate file system
from the rest of the volume to use separate I/O channel for the transaction
log updates. Putting the transaction log file on a separate device means that
log updates don't compete for the disk with other volume disk I/O. The
transaction log should be located on a high-speed disk subsystem. The
speed of transaction log file system affects the speed of update operations.
A report server system administrator changes the transaction log partition
in the volume properties general page. For information about volume
properties general page, see Viewing volume information, in Chapter 4,
To improve disk I/O speed for the volume, do the following:
I Place the volume on a disk volume with the best performance, such as
Redundant Array Inexpensive Disk (RAID) level 0, 0+1, or 5.
I Use disk striping on the Report Encyclopedia volumes disk volume.
I Avoid storing the Report Encyclopedia volume on a disk device managed
by a Network File System (NFS).
Allocate the Report Encyclopedia volume across multiple disk volumes using
disk striping. Stripe the Report Encyclopedia volume across four disk
spindles. Using disk striping allows I/O operations for the Report
Encyclopedia volume to be done concurrently.
Avoid storing the Report Encyclopedia volume on RAID level 5 devices. RAID
level 5 devices improve availability by mirroring data. Additional writes to
support mirroring degrade disk I/O performance, though.
Avoid storing the Report Encyclopedia volume on a disk managed by an NFS.
Storing the Report Encyclopedia volume on an NFS-mounted volume
significantly reduces report server performance because of the administrative
overhead from the network connection between the NFS client and NFS server
machines.
Running the Veritas file system on HP systems
Disk write sizes of greater than 1MB create report server performance
problems. You must set the size of the write buffer for the Veritas file system
running on HP systems to limit the size of disk writes. The environment
variable AC_RCBF_WRITE_BUFFER_SIZE limits the size of disk writes.
Specify the disk write size in bytes to a value of 1MB or less. For example, to
set the write size to 512,000 bytes, set the variable as follows:
setenv AC_RCBF_WRITE_BUFFER_SIZE 512000
Optimizing report server system performance
Before you read these sections, you should be familiar with the architecture of
the report server. For more information about the report server architecture,
see e.Reporting Server architecture, in Chapter 1, Report server overview.
These sections discuss contains the following topics related to report server
machine performance:
I Understanding CPU resource requirements
I Understanding memory resource requirements
I Understanding how operations affect performance
Understanding CPU resource requirements
The Actuate e.Reporting Server system is designed to function as cluster of
report server machines. Each report server machine can also exploit the
performance and scalability of multiprocessor systems. The report server CPU
should be able to operate, on average, at 95% processor utilization without
performance degradation.
The report server process and operation processes and implement
multiprocessor support in different ways. The report server process uses
multithreading to implement multiprocessor support. A single process serves
multiple requests concurrently by creating a thread of execution within the
process. Operations processes use a multiple process approach, multiple
Factory and View processes can run concurrently on a multiprocessor.
About report generation performance
Report generation performance improves in proportion to CPU speed, or clock
rate, in the same CPU architecture when there are no other resource
bottlenecks, such as memory or disk input or output.
Report generation time for aggregate reports usually takes longer than for
detail reports. Detail reports display one line for each database row. Aggregate
reports display summarized information from many database rows.
Aggregate reports require more report generation time because Actuate makes
multiple passes for data to compute the summary totals.
Sharing a CPU with a database server
To provide for sufficient resources for both servers, place the report server on a
different CPU from the database server. Both report generation on the report
server and database server tasks are CPU-intensive. If you cannot place the
report server and database server on separate CPUs, plan for additional CPU,
memory, and disk resources to support the report server. Do not lock the
report server Factory process or database process into a specific CPU. To
optimize resource utilization, allow the operating system to decide where to
run report server or database processes.
Adding Factory processes
For an individual report server that either is part of a cluster or is a standalone
report server, the optimum number of Factory processes depends on the speed
of the CPU running the report server workload and the mix of reports in the
workload.
The administrative overhead of managing multiple Factory processes is more
significant on slower processors, such as Pentium II class processors, than on
faster processors, such as Pentium III class and 4 class processors. Actuate
recommends that you initially configure two Factory processes on a Pentium
III class processor and six Factory processes on a Pentium 4 class processor.
Adding CPUs
Additional CPU and Factories can improve the overall throughput on the
report server, not the performance of individual applications. In a single CPU
environment, one Factory process can consume most of a CPU when a report
is actively running. Adding CPUs to your report server configuration can
increase throughput because multiple Factory processes can run concurrently
on separate CPUs.
As report server system administrator, you can add a report server machine to
a report server cluster to increase report generation and report viewing
capacity. When adding the report server, enable and configure the report
servers Factory and View service. The report server cluster master updates
the report server system configuration and uses the additional report
generation and viewing capacity.
When adding a report server to a report server cluster, the report server being
added:
I Must have the same options installed as the other report servers in the
cluster.
I Must have access to the appropriate system resources such as printers,
database software, and other third-party software.
In addition, the CPU limit of the e.Reporting Server system license must be
high enough to support the addition of the new report server.
For information about managing report server clusters, see Managing a
cluster, in Chapter 4, Performing system administration tasks.
Adjusting operation process timing
When you run a large report server workload, the standard amount of time
that the report server waits between starting and using a Factory or View
operation process may be too short. Also, the wait time between the report
servers attempts to communicate with the operation process may be
insufficient. You can change these report server wait times by setting the
report server delay after creating operation process parameter and the delay
between contacting operation process parameter.
Estimating CPU resources
Report server performance depends on the operating systems ability to
handle the workload as well as the CPU speed. You can estimate the impact of
CPU speed on performance only when you are comparing CPU speeds in the
same operating system environment. For example, report server throughput
on UNIX and Windows NT running on processors having the same speed can
vary significantly. Also, scalability depends on the operating system features
because the number of CPUs supported varies with the operating system.
To accurately estimate the CPU resources, benchmark the workload.
Understanding memory resource requirements
All operating systems supported by the report server use virtual memory to
enable applications to use more memory than is available in the processors
RAM. The operating system moves blocks of memory called pages from RAM
to disk to make RAM available for active tasks.
The processors paging rate indicates how the operating system is managing
virtual storage. If the rate is too high, the operating system reduces CPU
activity by swapping or suspending processing of some tasks until the paging
rate has decreased. High paging rates cause performance degradation because
of the extra operating system overhead.
Paging rates vary depending on the report server workload. As a general rule,
a report server running a large amount of report generation shows very low
paging activity and a report server running many viewing tasks shows higher
paging rates because of the interaction between the user and report server.
The report server stores volume metadata in a data store. The data store is
organized into pages. The report server volumes page buffer pool works
similarly to a virtual memory manager. The report server stores the most
recently used buffer pool pages in memory. A large buffer pool improves
performance by increasing the chance that the desired volume metadata is in
memory. A buffer pool that is too small causes the report server to frequently
read data from disk, slowing performance.
As a general rule, make the buffer pool as large as possible to stay in memory
and avoid swapping the buffer pool to disk. If the buffer pool is swapped to
disk, the report server is substituting the machines virtual memory I/O for
report server I/O. The ideal size ensures that the report server process fits in
physical memory.
Specify the volume buffer pool size in the volume properties server
assignments page. For information about volume properties server
assignments, see Assigning primary and backup servers to a volume, in
The report server also attempts to optimize the use of memory by restarting
the Factory processes periodically based on the number of requests. The
Factory processes run and print reports. You can disable automatic restarts by
setting the report server Recycle Processes parameter to False. Also, you can
adjust the minimum number of restarts between automatic restarts by
changing the integer value of the report server Number of Requests Before
Recycling Processes parameter. For information about setting the parameters,
see Changing advanced server properties, in Chapter 4, Performing system
Estimating memory resources
Configuring adequate physical and virtual memory on the report server is
critical to good report server performance. In general, report server memory
usage is determined by the buffer pool size and maximum number of threads
used by the report server process and the Factory and View processes.
The report server process has some amount of additional overhead on top of
the buffer pool that includes program executable size and stack size for the
message threads and other items. As a simple example, a volume configured
with a 100 MB buffer pool grows in size to 130 MB on a Windows NT system.
The difference between the buffer pool size and the process size is the process
overhead.
For example, on a server with 1 GB of physical memory, the volume buffer
pool size could be configured in the range of 500 MB depending on the other
software running on the machine. Use a system performance tool to compare
total memory used to physical memory on the system. On a Microsoft
Windows server operating system, use a tool such as the task manager to
compare total memory used to physical memory on the system and
Performance monitor to monitor disk and memory usage.
Track memory and disk usage during normal and peak load periods to
determine if you have enough memory for both activity periods. If the report
server is frequently swapping between virtual and physical memory you
might need more memory to reduce swapping and increase performance.
Allocate the same amount of virtual memory as physical memory on your
report server machine.
Understanding how operations affect performance
Report server operations and administrative commands can affect report
server performance. These areas of operations and administration can
adversely affect performance:
I Running service aids
I Managing administrative information
I Specifying privileges for report files and folders
Running service aids
When you are running the report server in a production mode, turn off the
logging service aid. Logging should be active only when you are debugging a
report server problem under the direction of Actuate Customer Support.
Logging uses CPU and disk resources that could be used more productively.
Managing administrative information
As volume administrator, when you create users, security roles, notification
groups, and channels in a volume, you create relationships among the various
administrative items. These relationships have recommended and hard limits.
If you adhere to the recommended limits, the appearance, behavior, and
performance of the volume administration pages is acceptable. The hard limits
are imposed by the web browser. For information about these limits, see
Setting volume limits, in Chapter 8, Understanding Report Encyclopedia
volume administration.
Specifying privileges for report files and folders
Navigating, using, and maintaining long lists of users and roles is difficult.
When specifying privileges to a file or folder, minimize the number of users
and roles specified on the item.
To set the same set of privileges for a large number of users and roles on a file
or folder, nest the roles and users in another role. Create a new role. Set the
original users and roles to inherit from the new role. Then assign privileges for
the new role on the item.
Optimizing View process performance
These sections discuss the following topics:
I Understanding the architecture of the View process
I Setting up the View process component
I Understanding performance features
Understanding the architecture of the View
process
The View process is a component of the report server with the primary task of
delivering Actuate DHTML reports to a users web browser. The View process
works with the following components:
I Actuate e.Reporting Server
I Actuate Active Portal and Management Console
I Actuate ReportCast
I Web server
Users can view reports as DHTML reports. The View process provides the
basic engine, intra-report security, and converter framework to support
DHTML reports. Users can view reports directly with their web browser and
receive support for page or table of contents viewing and report searching
from the View process.
View process lets a user view and search through an Actuate report in DHTML
format when viewing the report using a web browser. The user is logged into a
Report Encyclopedia volume through a web server and Actuate Active Portal
or ReportCast. The report server starts a View process when the user selects an
Actuate report.
The View process can also convert Actuate report document data to XML for
use with other web applications and to PDF for printing.
Factory
service
Encyclopedia
service
Factory
process
Active
Portal and
Management
Console
Actuate
desktop
software
Web
browsers
View
service
Open server
process
Message
Distribution
service
RS API
interface
SOAP
interface
View
process
Application
Server
Folders
Report files
Jobs, notifications
Users, groups, roles
Report
Encyclopedia
Actuate
ReportCast
Understanding the converter framework
The converter framework is an Actuate report server architecture that
supports rendering from XML to other formats. To support DHTML reports,
the converter framework renders XML into DHTML for Netscape Navigator
or Microsoft Internet Explorer. The converter framework considers the
differences between the web browsers when rendering DHTML. Also, the
converter framework renders XML to Adobe PDF format when users request
report content to be downloaded to their workstation.
Setting up the View process component
Initially, use the default of two View process to run on report server machines.
Monitor CPU use on servers running the View process. Configure additional
View processes if one View process does not use a CPU during peak times. For
information about configuring the report server to support multiple View
processes, see Specifying View service properties, in Chapter 4, Performing
system administration tasks.
The report server maximum number of threads per process parameter is the
number of concurrent service threads allowed in the View process before the
reactor slows down the process of picking up new messages. This limit affects
the internal behavior of the View process. On a Microsoft Windows server
operating systems with fewer than four CPUs, the number of threads should
be fairly small, between 8 and 16, to avoid thrashing. The number does not
affect how many requests can be sent to the View process simultaneously. The
default is 4.
Understanding performance features
Optimizing View process performance consists of allocating resources and
adjusting View process tuning parameters to keep the View process busy and
avoid a backup of requests for View process service.
To improve viewing performance, the View process maintains caches for
reports and report executables. As administrator, you can set report server
parameters configure cache sizes, timeout values, and other View process
parameters. In most cases, you do not have to change the values for these
parameters from the default values.
Actuate designed the View process architecture to scale from a few users to
tens of thousands of users. To ensure good performance:
I The View process implements multithreading to support scalability on
systems with multiple CPUs.
I The report server balances the View process workload.
I The View process caches ROX files to minimize communication overhead
between the report server process the View process.
About how the report server balances the View
process workload
When you install Actuate e.Reporting Server, the process configuration is set
to start one View process component. If you define additional View processes,
the report server can start and communicate with multiple View processes.
The report server can route connections to different View processes to
maintain a balanced workload. Unless you are running the report server on an
operating system that does not support multithreading, accept the defaults for
the process group information.
About how the View process minimizes
communication with the report server
The View process stores session information in a cache. Increasing cache size
can improve View process performance when cache size is a limiting resource.
Cache is used to store ROX files and view session information.
When a user logs on, the View process creates a view session object that holds
the user name and ROI name including version number. The View process
uses the view session object to track requests. After the view session object is
created, the View process communicates with the report server process only if
the ROX or ROI file changes. The View process uses cached versions until the
files change or the cache times out.
Session caching benefits users viewing the same report concurrently because
the View process loads the ROX file only when the first user requests to view
the report. The View process maintains the consistency between related ROX
and ROI files by invalidating cache entries that are not used within a
user-specified time.
About how the View process works
The View process does the following:
I The user logs on to the Report Encyclopedia volume and requests to view a
report.
I The Request process communicates with the View process to create a new
thread in the View process. The report server routes the request to the View
process that is least busy.
I The View process stores information on a per report, session, and user basis
in the view session cache.
I The View process stores the ROX file in an ROX cache.
I The View process stores the ROI file in a view session cache.
Controlling cache resources
The following two report server parameters control the behavior of the Sender
ID cache:
I Maximum cached sessions per process parameter defines the maximum
number of view sessions (user and .roi files) in the view session cache. The
default is 4096.
I Session cache timeout parameter is the number of seconds before
invalidating the contents of a view session cache. It is used to synchronize
the cache contents with Report Encyclopedia volume data. In an
environment in which the Report Encyclopedia volume data is read-only,
this variable should be set to a large number. The default is 3600 seconds,
or one hour.
The following string registry entries set other View process parameters:
I Maximum File Cache Size Per Process parameter is the maximum total size
of files in the cache directory for all the cached files. The default is 50 for 50
MB.
I Timeout for Process File Cache parameter controls the timeout of the file
cache.
I Maximum Total Size of Cached ROX Files parameter is the maximum total
size of ROX files cached in the View process ROX cache. The default is 64
MB.
I Maximum timeout for cached ROX files parameter is the value used as the
timeout for a View process ROX cache. The default is 15 minutes.
Ch a p t e r 4 , Pe r f o r mi n g s y s t e m a d mi n i s t r a t i o n t a s k s 91
C h a p t e r
4
Chapter4Performing system
administration tasks
I About report server system administration
I Managing a cluster
I About general server administration tasks
I Configuring report server volumes
I Configuring report server system partitions
I Managing printers
I About general Actuate system administration
I Monitoring a report server system
I Working with the system administration pages
I Viewing system information
I Viewing report server system information
I Working with volumes
I Working with partitions
I Working with printers
About report server system administration
The following report server administration tasks can be performed on a report
server cluster, report server nodes, and standalone report servers. As
administrator, before you can manage a report server, you must:
I Log in to report server system using the Actuate Management Console.
I Start a report server system, if necessary.
About report server cluster tasks
As an Actuate e.Reporting Server system administrator, the tasks you perform
for a report server cluster include:
I Creating a report server cluster.
I Starting an existing report server cluster.
I Adding and configuring report server nodes.
I Configuring cluster for volume failover.
I Removing a node.
About report server tasks
As an Actuate administrator, the tasks you perform for both a report server
cluster or a standalone report server include:
I Adding and configuring a Report Encyclopedia volume.
I Configuring report server parameters.
I Adding and configuring Report Encyclopedia volumes.
I Adding and configuring a disk partition.
I Removing a disk partition.
I Removing a volume.
I Moving volumes.
I Adding and configuring third-party software and hardware.
Logging in as the report server system
administrator
As an Actuate e.Reporting Server system administrator, you must log into a
standalone report server or report server cluster to administer the e.Reporting
system.
Enter a URL to display the e.Reporting Server system login page. For example,
the following URL displays the login page for the report server system:
http://oxen:8080/acadmin/login.jsp?serverurl=http://urup:8000&
daemonurl=http://urup:8100
For the serverurl and daemonurl, enter valid URLs pointing to the systems
report server and process manager.
Log into the e.Reporting Server cluster using the Volume log in page. Choose
System Administration from the list of volumes.
The following table describes the login fields:
As Actuate system administrator, specify the default login to volume in
system general properties. For information about system general properties,
see Viewing general system properties later in this chapter.
Field Description
Language Specify the language used when viewing
Management Console pages.
Login to The Actuate system or volume.
Password The users password. Enter the administrators
password. The default is no password.
Time zone Specify the language used when viewing
administration pages
User name The Actuate administrator name. The default is
administrator.
Displaying system status
After logging in to System Administration, the system status page displays the
system status and supports cluster level management and cluster creation. The
system is either online or offline.
The following are possible report server system states:
Working with an online system
If the report server system is online, the system status displays as online and
the page displays as follows.
The system status pages displays:
I The e.Reporting system name and the current status.
I The version and build number of Actuate report server.
I The version of the web server being used.
I The name and version of the application server running the Actuate
Management Console.
State Definition
failed If the report server system has failed during some
point in the startup routine or has crashed during
normal operation.
offline The report server system has successfully completed
shutdown routine.
online The report server system has successfully gone
through the startup routine. If the report server is part
of a cluster, it has joined the cluster.
starting A transition state for the report server system. The
report server is going through the startup process.
stopping A transition state for the report server system. The
report server is going through its shutdown routine.
From this page, an administrator accesses the following functionality:
I Stop stops the report server system. When stopping a cluster, the cluster
manager stops each node before shutting down. A Confirmation dialog
box displays after the Administrator chooses Stop. After the administrator
confirms the action, the system goes offline.
I Properties displays the general system properties page to view and modify
the system properties. For information about system properties, see
Viewing general system properties later in this chapter.
I Create Cluster displays the general system properties page to create a new
cluster. For information about creating a cluster, see Creating a cluster
from a standalone report server later in this chapter.
If the report server is already part of a cluster, this button is disabled. If the
node running the Message Distribution service is already part of a cluster, a
message displays stating that creating a new cluster is not possible with
this server as the cluster manager.
Working with an offline system
If the report server system is offline, the system status displays as offline and
the page displays as follows:
From this page, an administrator can access the following functionality:
I Modify Start Parameters links to system startup parameters page for the
current server. For information about startup parameters, see Changing
system startup parameters, later in this chapter.
I Start starts the report server system. Choosing start produces different
results based on the configuration of the report server you accessed:
If the report server is a standalone report server, starting the system starts
the report server.
If the report server is a cluster manager, starting the system starts the report
server that becomes the cluster manager. After starting the cluster manager,
you can start the other report servers in the cluster.
If the report server is a cluster node not a cluster manager, and has access to
the cluster configuration, the system does not start.
If the report server is installed as a standalone server that becomes a cluster
node that is not a cluster manager, and does not have access to the cluster
configuration file, the report server starts as a standalone report server. The
report server uses the standalone configuration file on the report server
machine.
Changing system startup parameters
Selecting modify startup parameters when the report server system is offline
displays the startup parameters similar to the following illustration.
I For a standalone server, only the system IP, System port, and License Key
fields appear.
I For a report server cluster, all the fields appear.
Enter values to change parameters before starting the system and choose Start.
The values are used to start the system and are saved in the system
configuration file for future system startups.
The system name and license key are for the report server system. For
information about the system name, see Viewing general system properties
later in this chapter. For information about the Actuate license key, see
Viewing and changing license options, later in this chapter.
The Message Distribution parameters are used for cluster communication. For
information about the Message Distribution parameters, see Viewing and
setting Message Distribution service properties, later in this chapter.
The system heartbeat parameters are use for accessing node status when the
cluster is running. For information about the system heartbeat parameters, see
How to create a cluster, later in this chapter.
Managing a cluster
As Actuate e.Reporting Server system administrator, you configure an
e.Reporting Server cluster after creating a cluster.
About cluster networking requirements
This section describes networking requirements for a cluster.
Actuate report server systems supports both unicast and multicast cluster
communication. Use unicast where a multicast group address is not available.
For example, a network used as a demonstration or a prototype might not
support multicasting. However, most production networks support multicast.
For example, the Weblogic application server cluster requires multicasting.
Resources used by the cluster must be accessible to all cluster nodes. For
example, to use a partition, the directory containing a partition must be
accessible to all nodes in the cluster. A printer used by the cluster must be
accessible to all nodes in the cluster.
As an example, use a two machine cluster consisting of node1 and node2 and a
partition named part1 on the node1 disk drive. The directory containing part1
must be accessible to node2.
To specify the location of a volume to the cluster, you must specify the location
relative to each cluster node. If the directory on node1 is c:\server\part1 and
the shared location on node2 is n:\part1, you must specify:
I For node1, partition part1 is at c:\server\part1
I For node2, partition part1 is at n:\part1
About server option requirements
All e.Reporting Servers in a cluster have the same options as the cluster
manager. Any server added to the cluster has the same options as the cluster
manager. For example, if an Actuate administrator adds a standalone
e.Reporting server that has page level security installed to a cluster that does
not have page level security, the new e.Reporting Server node has the same
options installed as the other servers in the cluster and does not support page
level security.
To support multiple Report Encyclopedia volumes in a report server cluster
requires the Actuate Multi-application option. Without the Multi-application
option, there can be only one volume per cluster or standalone machine.
If two standalone report servers each have an volume, an administrator cannot
create a cluster with the two report servers and maintain the two volumes on
the two report servers. This cluster configuration requires the Multi-
application option.
Viewing and changing license options
In system properties license, display and change the license key to enable and
disable options supported by the Actuate e.Reporting Server.
If the report server system is offline, you can enter a license key as a system
startup parameter. For information about system startup parameters, see
Changing system startup parameters, earlier in this chapter.
Overview of cluster creation
When you as Actuate system administrator create a cluster, you create a
single-machine cluster. After creating the cluster, you configure the cluster and
add report servers and volumes to the cluster.
When creating a cluster, the machine you use to create the cluster becomes the
cluster manager. Creating a cluster automatically enables the Message
Distribution service on the cluster manager and creates a default configuration
file.
The cluster managers Message Distribution service processes requests sent to
the cluster consisting of the cluster manager node and additional nodes you
add to the cluster. A Message Distribution service requires both an IP address
and port.
The following steps describe how to create a report server cluster:
1 Install e.Reporting Server system software on each machine used in the
cluster.
2 Install Actuate Management Console on a machine that can access the
cluster machines.
3 Use the Management Console to log into a report server as the Actuate
system administrator.
4 Start the standalone e.Reporting Server system.
5 Create the initial cluster on a single machine. The machine you use to create
a report server cluster becomes the cluster manager.
6 Add resources such as report servers, report server partitions, Report
Encyclopedia volumes, and printers to the cluster. The cluster
configuration is stored in the report servers configuration file.
To support cluster manager successors, each node that is a cluster manager
successor must have access to the configuration file and must have the
Field Description
Licensed
options
Lists the status of licenses for the options supported by the
Actuate e.Reporting Server system and the maximum
number of CPUs licensed for the system.
Update
license
Enter the key for the Actuate option license.
100 A d mi n i s t e r i n g A c t u a t e e . R e p o r t i n g S y s t e m
Message Distribution service enabled. By default, the location of the
configuration file is not in a partition. For information about specifying a
configuration file location, see Specifying the location of the configuration
file, later in this chapter.
How to create a cluster
1 Log into the report server system administration as Administrator.
2 Start the server from the system status page if it is offline.
System status appears.
3 Choose Create Cluster on the system status page.
Create cluster appears.
4 Enter the information in create cluster. The tables at the end of this section
describe the create cluster parameters.
C h a p t e r 4 , Pe r f o r mi n g s y s t e m a d mi n i s t r a t i o n t a s k s 101
5 If necessary, set the cluster parameters on the create cluster page.
6 Choose OK.
You have created a single-machine report server cluster. The machine is the
cluster manager that controls the cluster configuration.
The following table describes the report server IP and port information.
The following table describes the cluster communication information.
Report server field Description
Internal server IP IP address the report server uses for
communication with other report server nodes in
the cluster
Internal server port Port number the report server uses for
communication with other report server nodes in
the cluster
Communication field Description
Heartbeat failure period The time in seconds between the system
monitoring responses. If a response is not received
within this period it will be assumed that the node
is down. Default is 90 seconds.
Heartbeat send period The time in seconds after which the Message
Distribution service sends a request for system
health information from all the cluster servers.
Default is 30 seconds.
Multicast TTL If using Multicast, the maximum number of point-
to-point links (hops) allowed in a packets
transmission path. Default is 1 hop.
System Multicast
address
If using Multicast, the multicast IP address to
which all servers must belong in order for the
system to be multicast enabled
System Multicast port If using Multicast, the port to which all the servers
in the system listen for multicast.
UDP port If using UDP, the UDP port specified for unicast. If
this parameter is specified then the multicast
address, multicast port and the multicast TTL will
be ignored.
About adding and configuring nodes
As Actuate system administrator, you add an e.Reporting Server to a cluster
and configure the report server node. When you add a node, you add an
individual report server to the cluster. When adding a report server to a
cluster, the report server must have the same options installed as the other
nodes in the cluster. When you add a report server to a cluster, you must
configure the report server after it becomes part of the cluster. The cluster does
not use any individual report server configuration information. For example,
if you add a standalone report server to a cluster, the cluster ignores any
configuration information you added to the standalone server.
The following illustration shows a cluster with three report server nodes.
Adding a node requires some configuration. After adding a node, additional
configuration can require changing report server properties, such as:
I Adding or removing one or more services: Message Distribution, Factory,
View, and Encyclopedia service.
I Modifying service properties.
I Assigning volumes the report server node.
I Assigning to printers accessible to the report server node.
I Specify paths to system partitions.
I Changing IP addresses and ports.
I Adding report server options.
I Modifying advanced server parameters.
After a report server node is part of a cluster you can start and stop the node.
When you start a report server node:
I The node joins cluster and its status is online.
I Services configured for the node are available to the cluster.
I Volumes assigned to the node are taken online.
I When logging into the cluster, users can access the volumes assigned to the
node.
A flag appears in the status column when a server requires a restart due to
updates to the server configuration.
The following table defines the report server status values.
For information about starting and stopping a node, see Starting up and
shutting down report server nodes, later in this chapter.
About report server node configuration
In a cluster, report server tasks are sent to an appropriate node in the cluster.
Running a report server in a cluster might require additional configuration in
order for the node to handle a task sent to it. In order for a node generate or
print reports properly in a cluster, ensure the following requirements are met:
I Printers are configured and accessible to all nodes with the Factory service
configured to print reports.
I Open server driver and related software are installed on all nodes with
Factory service
I Database access on all nodes with Factory service
In some cases some advanced configuration might be necessary for some
items, such as:
I Database connection information for Actuate reports. For information
about Actuate database connections, see Specifying a database
configuration file in Chapter 3, Configuring the e.Reporting Server.
I External images used in Actuate reports. For information about searching
or images, see Specifying an image search path in Chapter 3,
Configuring the e.Reporting Server.
I Open server drivers. For information about open server, see Configuring
open server in Chapter 3, Configuring the e.Reporting Server.
Status Definition
master The report server is the cluster manager and is
started and stopped from system status.
offline The report server has successfully completed
shutdown routine.
online The report server has successfully gone through the
startup routine.
stopping A transition state for the report server. The report
server is going through its shutdown routine.
I Open security application used with a volume. For information about
Actuate open security, see Using the Actuate open security feature in
Chapter 3, Configuring the e.Reporting Server.
Preparing a report server to join a cluster
Before a report server can join a cluster, as administrator confirm the
following:
I The server must have the same options installed as the cluster.
If the report server is a standalone report server before joining the cluster,
the report server might have different options than the cluster manager.
After joining the cluster as a node, the report server has the same options as
the cluster manager.
To see the options license status, log into the System Administration and
go to the system properties license. For information about viewing a
systems license options, see Viewing and changing license options,
I Report server cluster must have the Actuate Multi-application option
installed to manage multiple Report Encyclopedia volumes.
I The servers machine must have access to the appropriate system resources
such as printers, database systems, and disk storage systems.
I The servers machine must be configured with the appropriate hardware
and software, such as printer drivers, fonts, and DBMS software.
In order for a report server join a cluster, it must be offline. For information
about stopping a report server, Starting and stopping a report server
system.Starting and stopping a report server system, later in this chapter.
How to add a node to a cluster
1 Go to the Servers page.
2 Choose Add a Server.
New Server appears.
3 To add a report server to a cluster, enter the required information in the
following pages:
In General:
I Host name or process manager IP address
I Process Manager daemon listen port
I Server IP address
In Message Distribution Service:
I Message Distribution IP address if you enable the Message Distribution
service
In Partitions:
I Path the new node uses to access existing report server system
partitions.
Each partition in the cluster must be accessible to the new node. For
each partition, enter a path the node uses to access the partition.
The information is the minimum required. The report server system
supplies defaults for the other node parameters. For information about the
parameters in the pages, see Adding a new server, later in this chapter.
4 If required, enter non-default values or for other parameters of the report
server being added to the cluster.
You can set report server parameters now or change report server
parameters later.
5 Choose OK.
The node appears in the list of cluster servers.
Administering report server nodes
Choose servers from list of icons to display the list of servers in the cluster.
From this page, an administrator can:
I View the current status and configuration of report servers
I Add a node to the cluster
I Configure the services available on a node
I Start and stop a report server node
I Check the Actuate report server system CPU limit
To display the maximum number of CPUs licensed for the report server
system, choose check CPU limit. To change the limit, you must change the
Actuate license key. For information about changing the license key, see
Viewing and changing license options, earlier in this chapter.
From the list of servers, choose a report server to display the servers
properties.
From the Servers properties pages, as administrator you configure report
server IP address and port information and services on the report server. From
the Servers pages, you control the Message Distribution, View, and Factory
services.
You control the Encyclopedia service by adding a volume and setting the
volume online. For information about configuring volumes, see Configuring
report server volumes, later in this chapter.
Even if a service is not enabled, as administrator you can change property
values for the service. The properties values are updated in the system and
used when the service is enabled.
From the Servers properties pages, as administrator you configure report
server IP address and port information and services on the report server. From
the Servers pages, you control the Message Distribution, View, and Factory
services.
I The parameters of General properties are described in Viewing and
setting general server properties, later in this chapter.
I Message Distribution Service parameters are described in Viewing and
I View service parameters are described in Specifying View service
properties, later in this chapter.
I Factory service parameters are described in Specifying Factory service
I Primary volume parameters are described in Specifying the primary
volume, later in this chapter.
I Backup volume parameters are described in Specifying failover volumes,
I Partitions parameters are described in Designating partition space for the
report server, later in this chapter.
I Printers parameters are described in Designating a printer for the report
server, later in this chapter.
I Advanced parameters are described in Setting advanced server
Starting up and shutting down report server
nodes
As Actuate administrator, you start up and shut down servers in the system
from the servers page.
Before stopping a node, if volume assigned to the node is configured with a
backup server, you must fail over the volume to the backup server. The backup
server takes control of the volume. If the volume does not have a backup
server, you must take the volume offline.
When you stop a node:
I The node leaves the cluster and its status is offline.
I Services configured for the node are not available to the cluster.
To shut down a cluster or a standalone server, use Stop on the System page.
For information about the system page, see Viewing system information,
How to start up or shut down servers in a cluster
1 Choose the servers from the server list.
2 From servers, display the systems Act on selected servers menu and
choose Start up or Shut down.
How to start up or shut down a single node
1 From servers, display the nodes menu.
2 Choose Start up or Shut down.
Removing a node
When you remove a node from the cluster:
I The report node information is removed from cluster configuration
information.
I When logging into the cluster, Actuate system administrators cannot access
the node.
Before removing a report server node, you as administrator need to
reconfigure the system to handle functionality assigned to the node before
taking it offline. For example:
I Ensure that remaining nodes in the system can handle services performed
by the node to be removed.
I Report server Message Distribution, View, Factory.
I Volumes managed by the node.
I Reassign volumes assigned to the node as a backup volumes.
To remove a node from a cluster:
I Shut down the node
I Remove the node from the system
When you take the node offline, the nodes services are no longer available to
the cluster.
Machine-level configuration is not changed or disconnected from the report
server system.
I Printers configured on the machine are available to the cluster
I Partitions based on machine drives are available the cluster
Specifying the location of the configuration file
In a report server cluster, the configuration file contains the configuration of
each node in the cluster. The default location of the configuration file is in etc
directory in the report server cluster managers home directory. The default on
a Microsoft Windows system is c:\Actaute6\server\etc.
To specify a different location for the cluster configuration file choose the
partition in system properties general. Changing the location of the
configuration file might change report server system startup. For information
about report server system startup, see Working with an offline system,
earlier in this chapter. For information about system properties general, see
Viewing general system properties, later in this chapter.
The partition is cluster partition and the offset is a path to a directory from the
root of the partition.
For information about creating a partition, see Configuring report server
system partitions, later in this chapter. For information about system
properties general, see Viewing general system properties, later in this
chapter.
Changing the cluster manager
Ensure the node to be the cluster manager meets the following conditions:
I The node is part of the cluster.
I The Message Distribution service is enabled on the node.
I The configuration home partition is accessible to the node.
To change the cluster manager, you must complete the following tasks:
1 Shut down the servers in the cluster.
2 Shut down the system.
3 Using the Management Console, log out of the current system and log into
the report server machine by specifying the serverURL and daemonURL
parameters for the machine.
For example, log out of the old cluster manager:
log into the new cluster manager:
http://oxen:8080/acadmin/login.jsp?serverurl=http://ellis:8000&
daemonurl=http://ellis:8100
4 Start the system.
The cluster starts with the new machine specified as the master in servers
list.
About general server administration tasks
When configuring a report server, tasks you perform for both a cluster system
and a standalone report server include:
I Modifying service properties to override the current or default settings.
I Modifying other server properties to override the current or default
settings.
I Specifying paths to file systems.
To administer a report server as Actuate administrator, you must log in to the
report server system administration using the report server system password.
The report server system administrator password is different from the volume
administrator password.
About standalone report server configuration
The following items describe standalone report sever configuration settings:
I When a standalone report server starts, the default is to take the volume
online.
I When adding file system entries, specify fully qualified paths.
I When configuring the report server, the report server stores the
information in the report server machines configuration file.
About creating a standalone report server
The following are the general steps to create a standalone report server:
1 Install the standalone server. As part of installation, you:
1 Configure the server.
2 Specify server and volume settings other than defaults.
2 Start the Actuate Process Manager. The default configuration starts the
Process manager.
3 Start the e. Reporting Server. The default configuration starts the Process
Manager on system startup. The Process Manager starts the e. Reporting
Server services.
If necessary, use the Actuate Management Console to specify the machine
to start the e. Reporting Server
4 Login to the server for further configuration if necessary.
Starting and stopping a report server system
Using the Management Console, log into System Administration for the report
server system.
From system status, choose Stop.
For a cluster, each report server in the cluster stops. For a standalone report
server, the report server stops.
The system status changes to offline after the system stops.
Updating report server system information
Use the Management Console log to into the report server system to update
system parameters.
This information applies to the e.Reporting System and includes parameters
for:
I Usage logging
I Error logging
I Regional settings
If you log into a cluster manager, configure report server system information,
such as:
I Cluster administration password.
I Cluster SOAP endpoint (IP address and port).
I Cluster status parameters for the cluster heartbeat.
I Cluster configuration file location.
For information about report server system information, see Viewing general
system properties, later in this chapter.
Configuring report server volumes
As Actuate Administrator you can configure and add volumes to a report
server system. Adding a second Report Encyclopedia volume requires the
Actuate Multi-application option.
I For a standalone report server, the default installation configures a volume
on the report server machine.
I For report server cluster, the default configuration configures a volume on
the cluster manager.
Once the volume is online, the report server accepts requests to access volume
content. Volume users can login, generate and view reports, and access
volume information.
If a single report server is managing multiple volumes, only one volume has
the Report Server API (RSAPI) enabled. By default, the volume with RSAPI
enabled is the first volume added to the server. For example if a report server
is managing a volume named sales and you add a volume named production,
RSAPI applications can access only the sales volume. RSAPI applications
cannot access the production volume.
To specify a different volume to be the RSAPI enabled, set the report server
parameter Volume used by the Requester and Report Server APIs. For
information about setting report server advanced parameters, see Changing
advanced server properties in Chapter 4, Performing system administration
tasks.
For more information about the RSAPI, see Part 2, Introduction to the report
server API, in Programming Server Applications.
Adding and assigning a Report Encyclopedia
volume
In order to add and assign a Report Encyclopedia volume to a report server, as
administrator you need to:
I Specify the volumes primary partition parameters.
I Assign a report server to manage the volume.
I Specify one or more report server system partitions to hold the volumes
files.
Before adding a volume, the report server system must have an unused
partition available. A partition is used by only one volume. A volume can use
multiple partitions. For information about adding partitions, Configuring
report server system partitions, later in this chapter.
Adding a volume requires some configuration. After setting up a volume,
configuring the volume can require the following system modifications:
I Specify additional partitions
I Specify list of secondary backup servers
I Specify an Actuate RSSE open security application
I Specify an archive library for use with the volumes auto archiving
function
For information about the volumes pages, see Viewing volume information,
After adding a volume and setting the server online, the Actuate volume
administrator configures the volumes contents. For information about volume
administration, see Chapter 8, Understanding Report Encyclopedia volume
administration..
Report servers can also be assigned as a volumes backup server. For
information about report server volume backup properties see Specifying
failover volumes, later in this chapter. Volumes use report server partitions to
store data. For information about partition information used in volume
parameters, see Specifying a volumes partitions, later in this chapter.
How to add and configure a volume
1 Go to the system volumes page.
The page displays the clusters volume information.
2 Choose Add volume to display Add Volume General with no values.
3 Enter the information in the volume properties page to add a volume to the
cluster.
The following is the required configuration information:
I In the new volume general, enter a volume name, select the primary
partition and the partition for the volumes transaction log files.
To create a volume, you can specify the specify the same partition as the
primary partition and for the transaction log files.
I In new volume server assignments, assign a report server as the
primary server.
I In new volume partitions, assign a partition and start the partition. This
partition becomes the volumes primary partition.
4 If the new volume is a Sample Application volume, select Is Sample App.
Volume.
5 If required, specify additional parameters for the volume. For information
about the volumes pages, see Viewing volume information, later in this
chapter.
6 Choose OK.
The system volumes page displays the updated list of volumes.
Assigning backup servers to a volume
After a Report Encyclopedia volume is added to the cluster, as an
administrator you can assign one or more backup report servers to the
volume.
The report server cluster automatically uses a backup report server if the
volumes primary report server fails.
The Report Encyclopedia volumes primary server appears at the top of the
page.
The left and right arrows move report servers between the list of available
server and the assigned backup servers lists. The up and down arrows change
the order of the selected report servers. The order of the assigned list specifies
the search order for a backup report server if the primary server fails.
Buffer pool size used by the report server in megabytes. The default is 10.
You can assign report servers as primary or backup servers. For information
about a servers primary and backup volume parameters, see Specifying the
primary volume and Specifying failover volumes, later in this chapter.
How to assign backup servers to a volume
1 Go to the system volumes page.
2 Choose the volume for which you want to set the failover policy.
3 Go to server assignments.
4 Select an machine from Available servers and using the right arrow move
the machine to Assigned backup servers.
You can reorder the Assigned backup servers set the order in which
machines are assigned to handle the volume in a failover situation.
5 If necessary, change the volume information log option and the buffer pool
size for the machine you added.
6 Click OK.
Taking a volume online or offline
From the volumes page, use the popup menu to take a volume online or
offline. Taking a volume online enables the Encyclopedia service for the report
server managing the volume.
When you take a volume online:
I The primary server takes volume online.
I The cluster accepts requests to access volume content.
I Volume users can login, generate and view reports, and access volume
information.
When you take a volume offline:
I The primary server takes volume offline.
I The cluster rejects requests to access volume content.
I Volume users cannot login to the volume.
Performing an administrative volume failover
After you as administrator configure a Report Encyclopedia volume with one
or more backup report servers, you can force an administrative failover of a
volume by choosing Administrative failover from the volume's drop-down
menu.
Server to failover to lists the available nodes that to be used as failover. Choose
a node that takes over in the event of failover.
Grace period is the number of seconds before the Report Encyclopedia volume
is switched over to the failover Encyclopedia service.
Moving a Report Encyclopedia volume
To move a volume, move the partitions used by the volume. All the report
server volumes files are contained in the partitions used by the volume.
Volume partitions lists the partitions used by a volume, as shown in the
following illustration.
For information about the volume directory structure, see About volume
directory structure, later in this chapter.
As an Actuate administrator, you can also use the report server utilities
acexport and acimport to move data between volumes. For information about
export, see Using acexport in Chapter 6, Working with e.Reporting Server
utilities. For information about acimport, see Using acimport in Chapter 6,
How to move a volume
1 Set up one or more new partitions if necessary.
2 Set the volume in offline mode.
3 For each partition used by the volume, copy the volume files from the old
partition to the new partition location. If part of a cluster, the partition
locations must to be accessible to the cluster.
4 For each partition, change the partition location in partitions server
settings.
You must ensure the proper locations are mapped correctly. For example,
for two partitions, partition_1 with location \old\dir1 and partition_2 with
location \old\dir2, move and specify the correct partitions directories. If
you move \old\dir1 to \new\dir1 and \old\dir2 to \new\dir2, you must
specify the partitions: partition_1 with location \new\dir1 and partition_2
with location \new\dir2
5 Change other server properties as needed.
6 Set the volume in online mode.
About Report Encyclopedia volume file types
If a report server volume administrator defines an executable file type in a
volume, you as system administrator must also specify the file type in server
properties Factory service.
Add the file type as a parameter in File types this report server can generate
and print. For information about server properties Factory service, see,
Specifying Factory service properties, later in this chapter.
A Report Encyclopedia volume file type is defined in a volume. In a default
configuration, the report server defines a set of file types such as report
document .roi files, report executable .roi files and HTML document .html
files. For information about volume file types, see Specifying open server file
types in Chapter 13, Understanding Actuate e.Reporting Server options.
Configuring report server system partitions
Administrators configure disk space for use with a Report Encyclopedia
volume using partitions. The partitions pages displays the systems partitions.
From this page an Administrator can:
I Add a partition to the system.
I Configure partition properties.
I Remove a partition from the cluster.
Each partition in the cluster must be accessible to every node in the cluster. As
administrator, you need to specify a path to the partition for each node in the
cluster. The path specifies a directory in a storage device. To specify paths to
the partition, see Using the partition server settings menu item, later in this
chapter.
A partition cannot be shared by more than one volume. If a partition is
assigned to a volume, it will not be available for selection to be assigned to
another one.
Report server volumes use report server partitions to store data. For
information about partition information used in volume parameters see,
Viewing volume information and Specifying a volumes partitions, later
in this chapter.
server operating system, to specify a partition the directory \files\master-
encyc on a machine named foxtrot, use the following UNC syntax:
How to add a report server system partition
1 Go to the system partitions page.
Partitions displays the clusters partitions.
2 Choose Add Partition to display partition properties page with no values.
partitions add partition appears.
3 Enter the information to add a partition to the cluster:
1 Enter the partition name, the name used in cluster administration.
2 Enter the partition path for each report server node. The path is the fully
qualified path to the root directory of the partition. A path for all report
server cluster nodes must be specified before the partition is added to
the system.
4 Choose OK.
After adding a partition, an administrator can configure a Report
Encyclopedia volume to use the partition as secondary storage.
Using the partition server settings menu item
For an existing partition, an administrator can display the partition
information from the popup menu or by choosing the partition name.
You must specify a path for each report server node to the partition.
Choose Test to test the accessibility of the specified partition from the server.
The report server confirms the location can be read, there is a volume at the
location, and the report server can write to the location. The report server
displays a test result message.
Removing a report server system partition
Before removing a cluster partition you must remove it from report server
systems volume assignments. In the partitions list, the partition status must
not be assigned to a volume and the partition must be unused.
If the partition is unused from the partition in the list, select delete partition
from the popup menu.
If the partition is the volumes primary partition. You need to ensure that the
volumes information has been taken care of. The information has been
migrated, backed up, or is no longer needed. For information about removing
a volume, see Removing a volume, later in this chapter.
If the partition is not the primary partition, go to the volumes properties
partitions. Select the partition in selected partitions, select Stop, and choose
OK.
The partition is set to phase out. The Encyclopedia service moves data from
the partition to other available volume partitions. After phaseout is complete
the partition is set as unused.
A failure message displays if there is not enough room to store the data from
the partition being deleted.
Once the partition is unused, move the partition from selected partitions to
available partitions.
Go to Partitions. The partition is not assigned to a volume and is unused.
From the partitions menu, delete the partition.
Removing a volume
To completely remove a Report Encyclopedia volume from an report server
system you complete the following tasks:
1 Take the volume offline.
2 Remove the volume from the system.
Before removing volume from the system, note the partitions used by the
volume in the volume partition.
3 Remove partitions associated with the volume from the system.
When you remove a Report Encyclopedia volume:
I Report Encyclopedia volume users no longer see the volume in the list of
cluster volumes.
I Volume users cannot login, the report Server rejects requests to access
volume content.
I The volume is removed from report server systems configuration file.
I The partitions assigned to the volume are not automatically deleted from
the report servers configuration.
I The partitions assigned to the volume are not automatically deleted from
the machines file system.
Managing printers
As Actuate system administrator, you can add and remove printers that are
used by the report server system.
When adding a printer to a cluster, you specify the printer parameters for each
report server node in the cluster.
Adding a printer
During report server installation, the installation process adds printers
configured on the machine as report server system printers. To add a printer to
the report server system after installation:
1 Add and configure the printer on the machine.
2 Add the printer as a report server system printer.
3 Add the printer to the report server system.
Removing a printer
To remove a report printer from the report server system:
1 If the printer is the default for the printer for a volume in the cluster,
reassign the default.
2 Remove the printer as a report server system printer.
About general Actuate system administration
The following sections contain information used when administering an
e.Reporting Server.
About the report server IP address and port
The System IP Address and the System Port specify the address and port that
users and applications use to communicate with e.Reporting Server system.
The System IP Address and Port must be specified whether the system is a
standalone or a cluster system.
The Server IP Address and Server Port specify the address and port used by a
report server to communicate internally within the system. For example, the
report server uses this port to receive heartbeat messages.
The Daemon IP Address and Daemon Port specify the address and port used
by the Actuate Process Manager software.
About volume directory structure
A Report Encyclopedia volume is completely self contained. All the files that
make up the volume and describe the volumes state are located in a set of
directory structures that are independent from the e.Reporting Server
executable files. The following sections describe the volumes directory
structure.
About volume metadata directories
The volumes metadata directories hold the metadata for the volume, which
describes the volumes security configuration, file organization, job
information and other administrative data.
The location of these directories is in the primary partition specified in volume
properties general. For information about volume properties general, see
Viewing volume information, later in this chapter.
The default volume directory is $AC_SERVER_HOME/encyc/. The Metadata
directories are:
I The db directory contains volume configuration and administrative
information.
I The fileType directory stores images and property files for Actuate file
types.
About the volume file directory
The report server stores the content of volume files directly as files in the
operating system's file system. All volume files are stored with the .dat
extension in the file system regardless of their Actuate file type. The location of
the root directory for volume files is defined by the partition and offset
specified in volume properties partitions. For information about volume
properties partition, see Specifying a volumes partitions, later in this
chapter.
By default, the directory is $AC_SERVER_HOME/encyc/file/.
Operating systems have limits on the number of files that can effectively be
stored and managed in a directory. The volume supports use of multiple
partitions. Using multiple partitions an administrator can distribute the
volumes files among multiple physical devices. The allocation of files among
partitions is transparently managed by the report server.
About the volume log directory
The volume log directory stores the Encyclopedia Database log file. The
location is defined by the partition specified in Transaction log path of volume
properties general. For information about volume properties general, see
Viewing volume information, later in this chapter.
By default, the directory is $AC_SERVER_HOME/encyc/transLog.
About the report server system configuration file
The report server system handles system configuration for both a cluster and a
standalone system. The default location for the configuration file is in
$AC_SERVER_HOME/etc. For example, on an NT system that uses the
default installation the location of the configuration file is C:\Actuate6\
Server\etc.
You can change the location of the configuration file by specifying a report
server partition in system properties. For information about specifying
configuration file location, see Specifying the location of the configuration
file, earlier in this chapter.
When the Process Manager starts a server, it supplies the configuration file
location to the server. A standalone server will read the configuration file to
configure itself. For the cluster server, the Process Manager will supply
additional arguments to the server specifying the cluster manager, so that the
server can join the cluster.
About the report server cluster configuration file
The configuration file for the cluster is owned by the cluster manager. The
configuration file holds the configuration information for all servers and
volumes in the cluster. The cluster servers get their configuration from the
cluster manager.
For a cluster server, the configuration information related to the services
offered by the server, such as volume owned by the server, enabled services
and other parameters, are sent to the server by the cluster manager.
To support cluster manager successors, each node that is a cluster manager
successor must have the Message Distribution service enabled and must be in
report server partition. By default, the location of the configuration file is not
in a partition. For information about setting the cluster manager see,
Changing the cluster manager, earlier in this chapter. For information about
specifying a configuration file location, see Specifying the location of the
configuration file, earlier in this chapter.
About the standalone server configuration file
The configuration file for a server is owned by the server itself. The
configuration file holds the configuration information for the server and the
volumes the server manages. The configuration information includes the
configuration information for the Message Distribution, Factory, View, and
Encyclopedia services controlled by the server and includes partition, open
security, and printer information for the volumes managed by the server.
Setting locales and time zones
There are three locations for setting time zones.
I Login page controls the locale and time zone when the user logs into the
report server system. This overrides the options general setting.
I Options general controls the page controls the browsers default locale and
time zone. This setting is stored on the browsers machine.
I System properties regional settings. Controls the report server systems
regional settings.
Monitoring a report server system
Actuate supports capturing monitoring and error information in log files to
help understand e. Reporting Server resource usage for efficient management
and utilization and to help resolve report server problems.
Using log files affects report server performance. Writing more detailed
information to log files decreases report server performance and increases disk
space usage by creating larger log files.
About e.Reporting Server logging
This section discusses the following topics about the Actuate report server log
files:
I Understanding the system usage log
I Understanding the system error log
I Using the diagnostic log
The report server system usage and system error logging is based on the
Actuate server monitoring framework. This framework uses an application
programming interface API to create applications that can monitor the report
server. Developers can use the framework to integrate information with
system monitoring tools such as Windows 2000 performance monitor. For
more information about the monitoring framework, see Chapter 9, Using the
report server API, in Programming Server Applications.
Understanding the system usage log
The system usage log supplies either standard or detailed information about
user activity. The user can specify up to four types of activity:
I Viewing logs report viewing activity.
I Factory logs report generation activity.
I Printing logs report server printing activity.
I Deletion logs report server deletion activity.
For viewing, deletion and printing activity, there is no difference between
detail and standard information in the Actuate default implementation.
For Factory logs, detailed information includes report parameters. Logging
detailed Factory information results in performance degradation compared to
using the standard option.
For information about setting diagnostic logging see Configuring system
usage logging properties, later in this chapter.
The following table lists the system usage information recorded:
Attribute Description
ClusterName Name of the cluster processing the request.
FinishRequestProcessing The time in seconds since 00:00:00 Jan. 1, 1901
GMT when the report server finished
processing the request.
NumberOfPagesPrinted Only for server side printing.
NumberOfPagesViewed If the transaction type is to download a report
- the number of pages that were downloaded
after viewing.
PrintTime Time taken to print.
Report Name Full path of the report being accessed.
Understanding the system error log
The report server system error log supplies information about report server
errors. The Actuate default error logging implementation supports four levels
of logging. The following table describes the error log levels.
Report Version Version of the report being accessed.
ReportParameters Parameters which the server would use to
execute the report.
Request Status Status of the transaction/request. Failure or
success.
ServerName Name of the Server processing the request.
SizeOfReport Size of the report that was accessed.
StartRequestProcesing The time in seconds since 00:00:00 Jan. 1, 1901
GMT when the report server started
processing the request.
Submit Timestamp Time in seconds since 00:00:00 Jan. 1, 1901
GMT when the report server received the
transaction or request.
Transaction Type Type of the transaction such as Print, Execute,
View, download, report deletion/update,
Update report properties, server shutdown/
restart, update server configuration.
UserName Name of the person carrying out the
transaction.
ViewedPageNumbers If the transaction type is to download a
report, the page numbers that were
downloaded
ViewFormat Format in which reports were viewed before
downloading.
Logging level Description
Fatal Critical error from which the server can't recover
and might abort execution.
Information Informational message useful for tracing server
behavior.
The following table lists the information log information.
For information about setting error logging see Configuring system error
logging properties, later in this chapter.
Using the diagnostic log
Actuate support uses the information in the diagnostic log files to solve report
server problems.
The file name is generated by the report server using the process name, a
report server generated integer, and the date and time. The following is an
example view server diagnostic log name.
viewsrv6.exe.1824.2002FEB08_09_35_02_Pacific_Standard_Time.1.log
The default log level is 8000 to log warnings and errors. A higher number logs
only errors, a lower number logs includes diagnostic trace information.
Severe Errors that might not cause the server to abort
execution right away but if such an error is not
rectified immediately it might result in server
abort.
Warning A warning is generated but it might not impact
the normal server operation.
ClusterName Name of the cluster on which the source of error
occurred
ErrorDescription Brief description of the error
ErrorID Error code of the error
ErrorSeverity Severity level of the error
ServerName Name of the server on which the source of error
occurred
ServiceName Name of the service/subsystem: Factory service,
Encyclopedia service, View service, Request
service
Timestamp Time in seconds since 00:00:00 Jan. 1, 1901 GMT
when the error occurred
UserName Name of the user who caused the error
Actuate recommends using Actuate usage logging error and logging. For
information about Actuate system usage logging, see Understanding the
system usage log, earlier in this chapter. For information about Actuate
system error logging, see Understanding the system error log, earlier in this
chapter.
For information about setting diagnostic logging parameters, see Changing
diagnostic logging settings, later in this chapter.
Working with the system administration pages
The following sections show the system administration pages used by the
Actuate Management Console and lists the fields in the pages. When
configuring the report server system, the pages display standard OK, Apply
and Cancel buttons:
I Choose OK to accept the changes and return to the System Status.
I Choose Apply to accept the changes and refresh the page with the updated
values.
I Choose Cancel to discarded the changes and return to the System Status
page.
To display the Management Console login page, enter an Actuate system URL
in your browser. For example, the following URL displays the login page for
the manager server system:
For the serverurl and daemonurl, enter valid URLs pointing to the systems
report server and process manager.
Choose System Administration from the log into list and enter the System
Administration password. For report server system administration the user ID
is Administrator.
In Password, enter the password. If you are using the product for the first
time, leave the password blank.
In Language, select the language used when viewing administration pages.
In Time zone, select the language used when viewing administration pages.
Viewing system information
After logging into the report server system, you see system status information.
From this page, you see the current system status and can configure the report
server system.
The following table shows the possible report server system states.
State Definition
failed If the report server system has failed during some
point in the startup routine or has crashed during
normal operation.
offline The report server system has successfully completed
shutdown routine.
online The report server system has successfully gone
through the startup routine. If the report server is part
of a cluster, it has joined the cluster.
starting A transition state for the report server system. The
report server is going through the startup process.
stopping A transition state for the report server system. The
report server is going through its shutdown routine.
Viewing system status
The system status page displays the system status and supports cluster level
management and cluster creation.
The system status pages displays:
I The current e.Reporting Server system status.
I The version and build of Actuate report server.
I The version of the web server being used.
I The name and version of the application server running the Actuate
Management Console.
I Stop stops the entire cluster.
A Confirmation dialog box appears after the Administrator chooses Stop.
After the administrator confirms the action, the cluster manager takes all
the report server nodes offline.
I Properties displays the general system properties page to view and modify
the system properties. The page also contains links to Usage Logging, Error
Logging, Regional Settings, system properties pages.
I Create Cluster displays system create cluster to enter parameters to create a
cluster. If the node running the Message Distribution service is already part
of a cluster, a message displays stating that creating a new cluster is not
possible with this server as the cluster manager.
Viewing offline system status
If the system is offline, the system status is displayed as offline and a page
appears similar to the following illustration.
I Start starts the system.
I Modify Start Parameters link displays system startup parameters page for
the current server.
Modifying system startup parameters for an offline system
Selecting modify startup parameters when the report server system is offline
displays the startup parameters similar to the following illustration.
For a standalone report server, only the Message Distribution service IP
address, Message Distribution port, and license key fields appear. For a report
server cluster, all the fields appear. Enter values to change parameters before
starting the system and choose Start. The values are used to start the system
and are saved in the system configuration file for future system startups.
I The Message Distribution IP address and port are address and port used by
the systems Message Distribution service. For information about the
Message Distribution parameters, see Viewing and setting Message
Distribution service properties, later in this chapter.
I The system heartbeat parameters are by the report server system to check
on the status of report servers nodes in the system. For information about
the system heartbeat parameters, see Creating a cluster from a standalone
I The Actuate license key enables and disables Actuate e.Reporting Server
options.
For information about starting a report server system, see Working with an
offline system, earlier in this chapter.
Creating a cluster from a standalone report server
Choosing create cluster from system status of a standalone report server
displays the following page.
To create a report server cluster using the standalone report server, enter the
cluster information.
Enter the report server communication information, as shown in the following
table.
Viewing general system properties
When a system is online, choosing properties from system status displays the
systems general properties.
Report server fields Description
Internal server IP IP address the report server uses to communicate
with other report server nodes in the cluster.
Internal server port Port number the report server uses to
communicate with other report server nodes in
the cluster.
Communication fields Description
Heartbeat failure
period
The time in seconds between the system
within this period it will be assumed that the
system is down. Default is 90 seconds.
Multicast address If using Multicast, the multicast IP address to
system to be multicast enabled
Multicast port If using Multicast, the port to which all the servers
UDP port If using UDP, the UDP port specified for unicast. If
address, multicast port and the multicast TTL will
be ignored.
The other pages accessible from this page are described in the following
sections.
For standalone server the system IP and System port fields and the
Configuration home partition fields appear. A cluster system displays all the
fields.
The following table describes all the fields.
Report server fields Description
System name The e.Reporting Server system name.
System password System password.
System password
confirm:
System password.
The following table describes the report server cluster communication
parameters.
The system default volume specifies the system volume used as the default
volume displayed in the systems login.
The Configuration home partition parameter specifies the partition storing the
report server system configuration information. If no partition is specified,
default is the AC_SERVER_HOME/etc directory. The location of the
configuration affects how a report server system starts. For information about
report server system startup, see Working with an offline system, earlier in
this chapter.
Configuring system usage logging properties
Configure usage log settings for report viewing, printing, generation, and
report deletion on Usage Logging, as shown in the following illustration.
Communication fields Description
Heartbeat failure
period
The time in seconds between the system
within this period, the system is down. Default is
90 seconds.
System multicast
address
If using Multicast, the multicast IP address to
system to be multicast enabled.
System multicast port If using Multicast, the port to which all the servers
System UDP port If using UDP, the UDP port specified for unicast. If
address, multicast port, and the multicast TTL is
ignored.
From the usage logging page the Actuate Administrator can configure these
types of logs:
I View log records report viewing events that use a View process.
I Printing log records report printing events.
I Factory log records report generation events.
I Deletion log records volume deletion events.
Each log file can be configured to store either standard or detailed log
information.
The Usage logging extension name is the name of the .dll or shared library the
report server uses to generate the log files. The default name is
UserActivityLoggingExt. Enter the name of the .dll or shared library without
the extension. For example on Windows systems, if the .dll is
CustomUsage.dll, enter CustomUsage. The default location for the extension
is $AC_SERVER_HOME/bin the report servers bin directory.
The name of the log file is usage_log.csv.
For information about usage logging, see Understanding the system usage
log, earlier in this chapter.
Configuring system error logging properties
Configure e.Reporting Server system error log settings.
From the error logging page the Actuate Administrator configures the error
log settings.
The following table describes error log levels.
The Error logging extension name is the is the name of the .dll or shared
library the report server uses to generate the log files. The default name is
ErrorLoggingExt. Enter the name of the .dll or shared library without the
extension. For example on Windows systems, if the .dll is CustomError.dll,
enter CustomError. The default location for the extension is
$AC_SERVER_HOME/bin the report servers bin directory.
The default name of the log file is error_log.csv.
For information about error logging, see Understanding the system error
log, earlier in this chapter.
Fatal Critical error from which the server can't recover
and might abort execution.
Information Informational message useful for tracing server
behavior.
Severe Errors that might not cause the server to abort
execution right away but if such an error is not
rectified immediately it might result in server
abort.
Warning A warning is generated but it might not impact
the normal server operation.
Configuring default regional settings
Configure default regional and time settings for the e.Reporting Server cluster.
The Locale parameter specifies the locale used by the report server system.
The Encoding parameter specifies the default code page used by the report
server system.
For more information about locales and encoding, see Chapter 2, Formatting
report data for multiple locales, and Chapter 3, Understanding report
encoding, in e.Reporting for Multiple Locales.
Displaying and adding system license information
Use the page shown in the following illustration to display and add licenses
for options supported by the Actuate e.Reporting Server.
Viewing system options
The options page, as shown in the following illustration, specifies language,
time zone and columns displayed when viewing a list of cluster servers. From
Management Console System, select Options.
Field Description
Licensed
options
Lists the status of licenses for the options supported by the
Actuate e.Reporting Server system and the maximum
number of CPUs licensed for the system
Update
license
Enter the key for the Actuate option license
Viewing general options
The options general page specifies report server system locale and time zone
Field Description
Locale Locale selected by the user during log in. This locale is
displayed in the login page. If this locale is not specified as
parameter, the locale is read from the users browser cookie.
Time zone Time zone selected by the user during login. This time zone
is displayed in the login page. If the time zone is not
specified as parameter, the locale is read from the users
browser cookie.
Modifying server list display options
Use the options servers page, as shown in the following illustration, to
configures the columns displayed when viewing the list of servers in the
cluster.
The left and right arrows select and deselect columns displayed in the servers
page. The up and down arrows change the order of the selected columns.
The following table describes the columns available for display.
Column name Description
Actuate version The report server version.
Current requests Current number of active jobs.
Description Description field of server definition
Name Required. Name of server.
Operating system and
version
The server machines operating system and
version.
Status Required. Current status of server. Status can be
master, online, stopping or offline. Lists the
services configured for the server. M for Message
Distribution service, F for Factory service, V for
View service, and E for Encyclopedia service.
A flag appears when the server requires a restart
due to updates to the server configuration.
Viewing Management Console and e.Reporting
system information
The options about page displays information about the Actuate Management
Console and the e.Reporting Server system.
Viewing report server system information
The servers page displays the report server system information. Actuate
system administrators view and configure report servers from this page.
Working with the server list
The servers page lists the report servers in the system.
From this page, an administrator can:
I View the current status and configuration of report servers
I Add a node to the cluster
I Configure the services available on a node
I Configure volume, partition, printer, and advanced parameters
I Start and stop a report server node
I Check the Actuate report server system CPU limit
The following table defines the report server status values.
A flag appears in the status column when a server requires a restart due to
updates to the server configuration.
To check the maximum number of CPUs licensed for the report server system,
choose check CPU limit. A message appears if the system is using more CPUs
than the license allows.
Adding a new server
From the servers page, choose Add Server to display the add server page.
Status Definition
master The report server is the cluster manager and is started
and stopped from system status.
offline The report server has successfully completed
shutdown routine.
online The report server has successfully gone through the
startup routine.
stopping A transition state for the report server. The report
server is going through its shutdown routine.
New server general appears. Enter the report server information to add a new
report server to the system.
Select other pages to enter additional parameters for the new report server.
The properties in the pages are described in the sections in the following list.
I The Hostname or daemon IP address parameter is the report server
machines IP address. The other parameters of General properties are
described in Viewing and setting general server properties, later in this
chapter.
I Message Distribution Service properties are described in Viewing and
I View service properties are described in Specifying View service
I Factory service properties are described in Specifying Factory service
I Partitions properties are described in Designating partition space for the
I Printers properties are described in Designating a printer for the report
server, later in this chapter.
I Advanced properties are described in Setting advanced server
For information about adding a node to a cluster see About adding and
configuring nodes, earlier in this chapter.
Viewing and setting general server properties
When you choose a server from the list of servers on the Servers page, server
properties general appears. View and set general report server properties.
The following table shows the report sever machine information that appears
as part of the servers listing.
The following table describes report server machine communication
information.
The following table describes report server services configuration. Enable and
disable report server services as required.
Field Description
Description Optional description of report server
Machine name Report server machine name
Operating system Machines operating system and version
Communication Description
Daemon listen IP
address
Actuate Process Manager IP address
Daemon listen port Actuate Process Manager port
RPC listen base RS API port base
RPC listen count Number of report server RS API ports
Server IP address Report server services IP address
Server port Report server services IP port
Server port base Report server base port used for internal report
server communication
Server port count Maximum number of report server ports available
for internal report server communication starting
from port specified in server port base
Services Description
Factory service Factory service supports report generation and
report printing requests.
Message Distribution
service
Message Distribution service accepts incoming
requests and routes requests within the report
server cluster.
View service View service supports user viewing requests for
Actuate report .roi files in DHTML format and
other formats such as PDF and XML.
If any of the services have diagnostic logging enabled, a warning is displayed
next to the appropriate checkbox to indicate that diagnostic logging is on.
Viewing and setting Message Distribution service
properties
View and set the report servers Message Distribution service properties.
The following table describes the fields for the Message Distribution service
properties.
Specifying View service properties
Specify the report servers View service properties as shown in the following
illustration.
Property Description
Max concurrent SOAP
requests:
The maximum number of concurrent Message
Distribution service requests for the report server.
Default is 1000.
IP Address
IP address used by report server machine running
the Message Distribution service
Port
Port used for the Message Distribution service
The following table describes the fields for the View service properties.
View service property Description
Max cache size Maximum total size of files in the cache
directory for all the cached files. The default is
128 for 128 MB.
Max cache timeout Controls the timeout of the cache. Maximum
time in seconds before the cache file is cleared.
Max concurrent requests Maximum number of concurrent view server
requests.
Max Excel pages Maximum number of Excel pages to generate
per job.
Max View processes Maximum number of concurrent view server
processes.
Min View processes Minimum number of view server processes
Specifying Factory service properties
Specify the report servers Factory service properties.
The Factory service page controls the Factory and Actuate temporary report
settings.
The following table describes the properties for report generation and report
printing for scheduled and synchronous jobs.
Factory processes Description
Max Factory processes Maximum number of concurrent report Factory
processes. Default is 4.
Number of factories to
reserve for synchronous
jobs
Number of processes used for synchronous jobs.
Default is 2.
The following table describes the Actuate temporary report properties.
Actuate Report Encyclopedia volume file type classification for report
generation and printing from a report server printer. For example, an Actuate
report executable (.rox) can be generated by a report server and an Actuate
report document (.roi) can be printed from a report server printer.
Specifying the primary volume
The server primary volume specifies the Report Encyclopedia volume
managed by the report server.
Support of multiple volumes in a report server cluster requires the Actuate
Multi-application option.
Temporary report
settings Description
Max synchronous job
processes
Maximum number of concurrent synchronous
jobs.
Max synchronous job
queue size
Maximum number of synchronous or temporary
jobs allowed in the queue. Default is 100.
Max synchronous job
queue wait time
Maximum time in seconds a synchronous or
temporary job can stay in the queue. Default is
600.
Transient report cache
location
Location of temporary report cache.
Transient report cache
size
Maximum size of cache use for temporary reports
in megabytes. Default is 100MB.
Transient report timeout Maximum number of minutes before the files
used for the temporary report are deleted from
the cache. Default is 30 minutes.
File type Description
File types this server
can generate and print
File types specified in cluster volumes that are
used to generate and print a report. Comma-
separated list of file types.
Buffer pool size in megabytes. The default is 10.
To make the volume available to users, the volume must be online. For
information about taking a volume online, Taking a volume online or
offline, earlier in this chapter.
Before assigning a volume to a report server you must add the volume to a
cluster. For information about adding a volume to a cluster see Configuring
report server volumes, earlier in this chapter.
Specifying failover volumes
The server failover volume specifies the report servers backup responsibilities
for Report Encyclopedia volumes.
A report server node can be used as a backup for Report Encyclopedia
volumes if the primary report server node fails. To support multiple volumes,
a report server system requires the Actuate Multi-application option.
The left and right arrows move volumes between the Available volumes and
Assigned volumes columns.
Buffer pool size in megabytes. The default is 10.
Before assigning a volume to a report server you must add the volume to a
cluster. For information about adding a volume to a cluster see Configuring
report server volumes, earlier in this chapter.
Designating partition space for the report server
Server properties partitions specifies the locations of partition space available
to the report server.
In server properties partitions, the partition name is the name of the cluster
partition. Partition path is the fully qualified path to the cluster partition.
Designating a printer for the report server
Server properties printers specifies the printers available to the report server.
The following information appears for each printer defined in the system:
I For printers on Microsoft Windows server operating systems and UNIX
operating systems, the Printer path parameter appears.
I For printers on UNIX operating systems, the PPD File name and Spool
command parameters appear.
The following table describes the parameters.
The report server system maintains printer information used by each report
server. For information about report server system printer parameters, see
Working with printers, later in this chapter.
Field Description
PPD File Name The PPD file for UNIX operating systems.
Printer name The system name of the printer
Printer path Path to the printer from the server.
Spool command The spool command for UNIX operating
systems.
Setting advanced server properties
Server properties advanced properties specifies diagnostic log settings and
report server system properties.
View and change diagnostic log settings and server properties from this page.
Viewing diagnostic log settings
Choose Change to view and change the cluster diagnostic log options. For
information about diagnostic log settings, see Changing diagnostic logging
settings.
Viewing system properties
Choose Printable summary to display the systems properties and current
value.
From the property types drop down list, select the types of properties
displayed in the list box:
I All Properties
I View service properties
I Factory service properties
I Message Distribution service properties
Select a property in the properties list and choose Edit to view and change the
property currently selected. For information about changing server properties,
see Changing advanced server properties.
Changing diagnostic logging settings
From Server properties, advanced properties, choose Change to display
diagnostic logs. Enable and disable logging and change diagnostic log
settings.
The Actuate Administrator configures the following logs:
I General
I Factory
I Viewing
The following table describes logs properties.
For other types of logs see, Configuring system usage logging properties
and Configuring system error logging properties.
Changing advanced server properties
From the Server properties, advanced properties, select a property in the
properties list and choose Edit to view and change the property currently
selected. Choosing edit displays the Server Property.
The following table describes the property fields.
Choose the Default to set the property to the default value.
Log property Description
Directory Location of log file
Level Amount of information recorded in log file
Number of log files Maximum number of log files
Size Maximum size of log file
Property field Description
Field Description/Help
Text
Description of the property.
Property name Name of property.
Property value Current value of the property.
Type Data type such as, String, Integer, Numeric.
Working with volumes
The Actuate Management Console volumes pages displays the clusters
volume information.
Using the Volumes list
The volumes page displays the report server systems volumes.
From the volumes page, an administrator can:
I Add a Report Encyclopedia volume to the cluster
I Configure volume properties
I Set a volume online or offline
I Remove a volume from the system
Choose Add volume to display volumes properties page with no values
Adding a volume
When adding a volume, a page similar to the following appears. Specify
volume location information in the general page.
Enter the information to add a volume to the cluster.
I Except for volume name, volume general parameters are described
inViewing volume information, later in this chapter. Enable is sample
app. volume if the new volume is an Actuate Sample Application volume.
Volume name is required and is the name of the volume used by the report
server system. The name appears in the first field of the Volumes list and in
other pages.
Primary partition and Transaction log path lists the partitions available to
the report server for creating a new volume. Choose a partition as the
volumes primary partition and for the volumes transaction logs.
I Volume server assignment parameters are described inAssigning primary
and backup servers to a volume, later in this chapter.
I Volume open security parameters are described inWorking with Open
Security, later in this chapter.
I Volume partition parameters are described inSpecifying a volumes
partitions, later in this chapter.
Viewing volume information
When viewing an existing volumes properties, a page similar to the following
appears.
Settings for Report Encyclopedia volume transaction logging and job and
notification deletion.
Partition information consists of four parameters:
I Primary partition displays the volumes primary partition.
I Minimum free disk space required in primary volume partition. If the
partitions free space is below the specified amount, the report takes the
volume offline. The default is 128 MB.
I Transaction log path specifies the partition containing the volumes
transaction log files. The default is the volumes primary partition.
I Minimum free disk space required in volume transaction log file partition.
If the partitions free space is below the specified amount, the report takes
the volume offline. Default is 128 MB.
Archive library name lists location and name of the Report Encyclopedia
archive driver. The default location for the library is the report servers bin
directory $AC_SERVER_HOME/bin.
The report server supports two e-mail notification options:
I Choose use Actuate Active Portal for e-mail notifications when hypertext
links in email sent to users for report completion notifications use Actuate
Active Portal.
I Use ReportCast for e-mail notifications when hypertext links in email sent
to users for report completion notifications use Actuate ReportCast.
Enter the URL prefix to be added to the hypertext link in the e-mail.
Is Sample App. Volume indicates whether the volume is an Actuate sample
application.
Partition property Description
Description Optional parameter describing the volume.
Interval before purging
dead requests
Minimum time to wait before purging scheduled
jobs that have passed their end date.
Schedule for purging
notices
The time at which to delete notices. The format is
a list of times separated by semicolons, in
ascending order, using a 24-hour format. For
example, 03:15;16:15.
Assigning primary and backup servers to a
volume
Volume properties server assignments specifies report servers backup
responsibilities for volume.
The left and right arrows assign backup report server machines to the volume.
The up and down arrows change the order of the selected machines.
Assigned machines are either primary or backup. Primary specifies the
machine with the active Encyclopedia service assigned to the volume. Backup
specifies the machines that are used as the backup Encyclopedia service.
Buffer pool size used by the report server in megabytes. The default is 10.
You can assign primary and backup servers to a volume. For information
about report server primary and backup volume parameters, see Specifying
the primary volume and Specifying failover volumes, earlier in this
chapter.
Working with Open Security
Volume properties, open security enables and disables open security and
specifies open security properties.
Enable or disable Open Security.
When Open Security is enabled, specify the Open Security properties. The
following table describes the Open Security properties.
Open Security property Description
RSSE cache size Maximum size of open security library cache.
RSSE cache timeout Maximum time in minutes before the open
security library cached data is deleted.
Minimum is 1 minute.
RSSE library name Path and name of open security library. The
default location for the library is the report
servers bin directory
$AC_SERVER_HOME/bin.
RSSE max ACL buffer size Maximum length of ACL passed between open
security library and the Encyclopedia service.
RSSE multithread safe Specifies whether the open security library is
multithread safe.
Specifying a volumes partitions
Volume properties partitions specifies the volumes partitions.
Available partitions lists the cluster partitions. Selected partitions lists the
partitions used by the volume.
A volumes primary partition is marked with the word Primary. Active
partitions are marked with the work Active.
The left and right arrows assign additional partitions to the volume from a list
of available partitions. The up and down arrows change the order of the
selected partitions.
Below selected partitions, start using and stop using changes the partition
state.
I Start using sets the partition state to active. The partition can be used by a
report server system volume.
I Stop using sets the partition state to phasing out or not in use. The partition
cannot be used by a report server system volume.
For each partition, you can specify the free disk space parameters:
I For Low Free Space, the report server displays a warning if a user tries to
create a file in a partition with less than the specified free disk space. File
creation succeeds. Default 512 MB.
I For Min Free Space, the report server does not perform file creation
requests in a partition if partition space is less than the specified free disk
space. Default is 128 MB.
Performing a volume failover
As Actuate administrator, you can force a report server to take over
management of a volume. Before perform failover, you must assign a
secondary server to the volume.
From volumes, display the volume popup menu and choose Administrative
failover.
A page similar to the following illustration appears.
The following items describe the administrative failover page:
I Server to failover to lists the available nodes that to be used as failover.
Choose a node that takes over in the event of failover.
I Grace period is the number of seconds before the Report Encyclopedia
volume is switched over to the failover Encyclopedia service.
I Choose Failover to start the failover process.
Changing the online status of a volume
As Actuate administrator, you can put a volume online and take a volume
offline.
From volumes, display the volumes popup menu and choose either Take
offline or Put online.
The menu option changes depending on the state of the volume. After
selecting the menu item, the volume switches state either from offline to online
or online to offline.
Removing a volume from the report server system
As Actuate administrator, you can remove a volume from the report server
system.
From volumes, display the volumes popup menu, and choose Remove from
system.
A dialog box similar to the one in the following illustration appears.
Choose OK, to remove the volume from the system.
Working with partitions
The Actuate Management Console volumes pages displays the clusters
partition information
Using the Partitions list
Partitions lists the report server systems partitions.
From the partitions page, an Administrator can:
I Add a partition to the cluster
I Configure partition parameters
I Remove a partition from the cluster
For partitions assigned to a volume, the following table defines the partition
state values.
Volumes use partitions and some volume parameters use partitions. For
information about volume parameters, see Viewing volume information,
earlier in this chapter. For information about volume partition parameters, see
Specifying a volumes partitions, earlier in this chapter.
State Definition
Active The volume is using the partition.
Phaseout The volume is in the process moving data out of the
partition.
Unused The partition is assigned to the volume but is not
active.
Adding a partition
Choose Add partition to display partition properties page with no values.
Enter the information to add a partition to the system:
I Enter the partition name, the name displayed by the Management Console.
I Enter the partition paths to from the report server systems to the partition
directory. The path is the fully qualified path to the root directory of the
partition. Specify a path for each report server in the system.
To make a partition available to a report server system, you must specify a
partition path for all report servers in the system. All report servers must have
access to the partition.
server operating system, to specify a partition the directory \files\master-
encyc on a machine named foxtrot, use the following UNC syntax:
Specifying the path to a partition
Partitions server settings specifies the report server systems paths to the
partition, as shown in the following illustration.
The following items describe the pages fields and parameters:
I Server name is the report server.
I Partition path is the fully qualified path from the report server to the root
directory of the partition.
To make a partition available to a report server system, you must specify a
partition path for all report servers in the system. All report servers must have
access to the partition.
Removing a partition from the report server
system
As Actuate system administrator, you can remove a partition from the report
server system.
From partitions, display the partitions popup menu and choose Remove from
system. A dialog box similar to the following illustration appears.
Choose OK to delete the partition from the system.
Working with printers
The Actuate Management Console volumes pages displays the systems
printer information.
Using the Printers list
Printers lists the report server systems printers.
From the printers page, an Administrator can:
I Add a printer to the system
I Configure printer properties
I Remove a printer from the system
Each report server maintains properties for printers. For information about
report server printer properties, see Designating a printer for the report
server.
Adding a printer
Choose Add printer to display printer properties page with no values.
For each server in the system, enter the printer information:
I For printers on Microsoft Windows server operating systems and UNIX
systems, the Printer path parameter appears.
I For printers UNIX operating systems, the PPD File name and Spool
command parameters appear.
The following table describes the parameters.
To make a printer available to a report server system, you must specify the
information for all report servers in the system. All report servers must have
access to the printers.
Field Description
systems.
Viewing printer properties
For each server in the system, the following printer information appears.
Field Description
Server name Name of server in the system
systems.
C h a p t e r 5 , Wo r k i n g w i t h d a t a b a s e c o n n e c t i o n s 179
C h a p t e r
5
Chapter5Working with database
connections
I About database connections
I About stored procedures
I Defining environment variables
I Connecting to DB2 databases
I Connecting to Informix databases
I Connecting to MS/SQL databases
I Connecting to databases through ODBC
I Connecting to Oracle databases
I Connecting to Progress 9.1 databases
I Connecting to Progress 8 databases
I Connecting to Sybase databases
I About UNIX factsrvr database compatibility
About database connections
Some reports can be generated without database information; others require
information from several databases. Reports that use information from
databases must connect to the databases to obtain the information.
Actuate uses database client software to connect to the database server. For
example, when connecting to an ODBC-compliant database, Actuate uses the
ODBC client drivers to connect with the ODBC database. In order for the
report server to connect to a database, the report server must have access to
the appropriate database client software.
When connecting to a database, users must supply a user name and a
password. Databases from most vendors require additional information that is
specific to the vendor; for example, many databases need definitions for
environment variables. To supply the user name and password, developers
edit a connection component with the Component Editor in e.Report Designer
Professional. For information about using the Component Editor, see
Chapter 7, Using query data streams, in Developing Advanced e.Reports.
In most cases, the report server and the database run on different computers
for load-balancing purposes. This division is not required, however. You can
run the report server on the database host if you want to use that computers
resources to improve performance of some report server tasks.
On UNIX platforms, the database client software can require an operating
system patch to work with Actuate products. See the database documentation,
operating system documentation, and the Actuate Supported Products and
Obsolescence Policy document for information on database and operating
system requirements. The Actuate document is on the Actuate web site at
http://www.actuate.com and is updated frequently.
For Actuate report executables .rox files that access databases with data in one
or more languages, the report server administrator must configure the
database clients to support retrieving and viewing of data in those languages.
Most databases support the UTF-8 code page a Unicode encoding. Actuate
recommends setting this code page as the database client code page. For
UTF-8, Actuate supports only the characters present in the UCS-2 character
set.
The report server uses the database clients locale settings when establishing a
connection with the database server. If the database client locale settings
including a particular code page are configured, the report server
communicates using those setting. The following describes how the report
server finds the database client locale information:
I The database client provides an API to access the locale information.
The report server retrieves the locale information from the database client
code page and locale settings using the API. The database client sends
information such as the code page in which database clients talk with the
database server, the localized date format, and collation information.
I The database client uses locale environment variable values or
configuration file values to specify code page and locale information.
Actuate retrieves the database client environment variable values or
configuration file values.
I The database client does not specify locale information.
The report server assumes the database client uses the operating system's
locale setting. The report server uses the local system locale settings and
expects data in the local system code page.
For information about database-specific language and locale support, see your
database documentation.
About stored procedures
When you use the following Actuate connections:
I ODBC connection on Microsoft Windows server operating systems
I Sybase ctlib
I Oracle 8 client and server
I Progress 9.1
Actuate supports stored procedures with the stored procedure data source
component. In e.Report Designer Professional, you use a stored procedure
data source and Stored Procedure Data Source Builder to specify the stored
procedure used in your report. For information about using stored procedures
and the Stored Procedure Builder, see Chapter 7, Using query data streams,
in Developing Advanced e.Reports.
Using the stored procedure data source, Actuate supports only single data sets
returned to Actuate. If a complex result set is returned, Actuate uses only the
first data set. For information about processing multiple result sets, see
Chapter 9, Using stored procedure data sources, in Programming e.Reports.
Defining environment variables
Many of the database connections described here require you to define
environment variables. Two important considerations apply when you create
these definitions.
If your report server runs on UNIX, insert the definitions in the file pmd6.sh,
which is in the directory $AC_SERVER_HOME/bin. For example, add the
following lines to your pmd6.sh file if you use a Sybase database:
export SYBASE
SYBASE=/usr/local/sybase
UNIX environments use library path environment variable, The library path
variable name is different on each UNIX platform:
I LD_LIBRARY_PATH variable for Sun Solaris
I LIBPATH variable for IBM AIX
I SHLIB_PATH variable for HP-UX
If your report server runs on Microsoft Windows server operating systems,
you must define system environment variables rather than user environment
variables. Defining a user environment variable is not equivalent; report
server processes are system processes, and cannot access your user
environment.
In some cases, a database's environment variables or Registry entries affect
Actuate's ability to display reports in different languages.
Connecting to DB2 databases
The Actuate e.Reporting Server works with DB2 (IBM Database 2) on UNIX,
Windows NT, and Windows 2000. To connect with DB2 databases, you must:
I Define appropriate environment variables
I Specify the database environment
I Supply an account name and password
I Specify the protocol your site uses
I On UNIX, install the proper Factory server software
For more information about installing and using DB2 with the DB2 Client
Application Enabler software, CAE, see your DB2 documentation.
The Actuate e.Reporting Server works with DB2 databases using runtime
client versions 6.1, 7.1, and 7.2.
Defining DB2 environment variables
For UNIX and Microsoft Windows server operating systems, you must define
the environment variables DB2INSTANCE, and DB2DIR in order to connect to
a DB2 instance. DB2INSTANCE specifies the instance name, and DB2DIR is
the path to the DB2 client installation.
On Windows NT and Windows 2000, use the System applet from the Control
panel to check and set the environment variables. On UNIX, use the setenv
command to check and set environment variables.
For Microsoft Windows server operating systems and UNIX operating
systems, Actuate uses DB2CODEPAGE to determine the DB2 database's client
locale. On Windows systems, DB2CODEPAGE is a registry setting. On UNIX
systems, DB2CODEPAGE is an environment variable. At execution time when
Actuate connects to a DB2 database, the active code page is in effect for the
duration of the connection. All data is interpreted based on this code page.
If this variable is not set, Actuate's DBMS module will determine the client
locale setting from the operating system locale.
DB2CODEPAGE is a DB2-specific environment variable. Use db2set to set
DB2CODEPAGE. For example, the following command sets the DB2 database
client to retrieve data in UTF-8 format:
db2set DB2CODEPAGE=1208
For information about DB2CODEPAGE and db2set, see the DB2
documentation.
The DB2 Factory server on AIX uses the DB2 library libdb2.a. The library
libdb2a is part of the DB2 client installation. Ensure that the library path
DB2DIR/lib is part of the environment variable LIBPATH. DB2DIR is the path
to the DB2 client installation. For information on UNIX library environment
variables, see Defining environment variables, earlier in this chapter.
On HP-UX11 in the SHLIB_PATH environment variable, the path to ODBC
and DB2 libraries must be before the AC_SERVER_HOME path. For example,
if $ODBC/lib and $DB2DIR/lib are paths to the ODBC and DB2 libraries, use
a SHLIB_PATH similar to the following:
SHLIB_PATH=$ODBC/lib:$DB2DIR/lib:$AC_SERVER_HOME/lib:usr/local/bin:
The following order of paths in the SHLIB_PATH environment variable does
not work:
SHLIB_PATH=$AC_SERVER_HOME/lib:$ODBC/lib:$DB2DIR/lib:usr/local/bin:
For more information about setting environment variables, see your system
documentation.
About Actuate support for XML Extender
XML Extender, available with DB2 version 7.1.0, supports storing XML
documents and DTDs. DB2 stores an XML document as either an XML column
or XML collection. Actuate retrieves the XML column data as string data. DB2
stores an XML collection as a set of tables. Actuate retrieves data from the set
of DB2 tables.
For information about XML Extender, see the IBM web site.
About HP-UX shared objects for DB2 clients
The shared object file for DB2 supplied with the report server for HP-UX,
libdb2.sl, is for DB2 version 6.1. The shared object is in the
$AC_SERVER_HOME/lib directory. If the server machine is using a different
version of the DB2 client, the user must copy the libdb2.sl shared object from
the DB2 client installation directory to the $AC_SERVER_HOME/lib directory.
About Sun shared objects for DB2 clients
The shared object file for DB2 supplied with the Report Server for Sun,
libdb2.so, is for DB2 version 6.1. The shared object is in the
$AC_SERVER_HOME/lib directory. If the server machine is using a different
version of the DB2 client, the user must copy the libdb2.so shared object from
the DB2 client installation directory to the $AC_SERVER_HOME/lib directory.
Checking a connection to a DB2 instance
To check that a connection exists between the report server machine and the
DB2 instance, use the command-line utility db2. This utility comes with the
DB2 software. The db2 utility is available for both UNIX and Windows.
To use the db2 utility, open a command-line window and enter db2 at the
command prompt to start the utility. At the DB2 prompt, enter the command
to connect to a DB2 database:
connect to <database> user <user name>
The <database> is the name of the DB2 database, and <user name> is the DB2
database user. You will be prompted for a password. Enter enter the password
for the user. DB2 displays the connection information in the command
window when a connection is made. Enter quit to terminate the session.
Installing Factory server software for DB2
Actuate uses DB2 clients V5.2 and newer to connect to DB2 servers V5.2 and
newer. On AIX, DB2 is incompatible with ODBC. If your report server runs on
AIX, you must replace the Factory server software with the DB2 Factory
server. The DB2 Factory server is factsrvr.db2 and is in the directory
$AC_SERVER_HOME/operation.
First, back up the existing fctsrvr6 file, then you can either move or copy
fctsrvr6. To replace the Factory server software, copy factsrvr.db2 to fctsrvr6 so
the report server uses the DB2 Factory server process.
Understanding DB2 version 6.1 connection issues
The DB2 connection class AcDB2Connection has the property
MaximumStringLength to accommodate the increased maximum length of the
VARCHAR in DB2 version 6.1. This property is displayed in the
AcDB2Connection class Properties dialog box. The default maximum column
length Actuate uses with DB2 version 6.1 databases is 8000 characters.
Developers can change this property value when designing an Actuate report.
Problems might occur when generating an Actuate report if the report uses a
DB2 database column with a large column length.
The MaximumStringLength parameter can also be specified in an Actuate
configuration file. If specified in a configuration file, MaximumStringLength,
overrides the value specified in the report design. To support more than 8000
characters, change the MaximumStringLength parameter in the connection
component or in the configuration file. For configuration file information, see
Specifying a database configuration file in Chapter 3, Configuring the
e.Reporting Server.
Connecting to Informix databases
The Actuate e.Reporting Server works with Informix databases of version 7.3
and later using Informix Connect 2.60 or Informix Connect 2.40. Actuate does
not support using the 64-bit version of Informix client connection software to
connect to an Informix database.
If you are using an earlier version of Informix client connection software,
Informix recommends you upgrade to the latest version. See the Informix web
site for more information.
To connect with Informix databases, you must:
I Define appropriate environment variables
I Specify the database environment
I Specify the protocol your site uses
I Specify the proper client connection
On UNIX systems, the installation script asks for the Informix information
during report server installation and uses this information to create report
server startup scripts in the $AC_SERVER_HOME/bin directory and to
update the systems startup file. On Solaris systems, this file is the Rc.local file.
Defining Informix environment variables
If your report server runs on Windows NT or Windows 2000, you must define
the system environment variables INFORMIXDIR to point to the directory
where the Informix product is installed and INFORMIXSERVER to specify the
name of the database. Defining a user environment variable is not equivalent;
report server processes are system processes, and cannot access your user
environment.
If your report server runs on UNIX, you must define two environment
variables, INFORMIXDIR and INFORMIXSERVER. As on Windows NT and
Windows 2000, INFORMIXDIR points to the directory where the Informix
product is installed. INFORMIXSERVER is the name of the database obtained
from the Informix services file as described in following section.
Informix uses the following environment variables to specify locale settings:
I CLIENT_LOCALE specifies the client application locale. The default is US
English.
I The database locale specifies the locale of the data in a database.
A database locale is used to determine the code set for data in database
objects such as in character columns, db object identifiers, and
NVARCHAR columns.
I The server locale identifies the locale that the database server uses for its
server-specific files. This is used by Informix db server only and is of no
concern to the DBMS module.
When connecting to an Informix database, Actuate expects data from the
Informix database server to be in the locale specified by CLIENT_LOCALE. If
CLIENT_LOCALE is not set, Actuate uses the value specified by the DBNLS
variable or the LANG variable to determine the client machine's locale setting.
The DBNSL exists for backward compatibility with older Informix NLS
products.
For the list of applicable locale names for different platforms, see the Informix
documentation.
Specifying the Informix database environment
The Informix database environment specification includes the database name
and the Informix server name in the following format:
dbname@servername
Both the database name and the server name must match entries in the file
named services. On Microsoft Windows server operating systems, this file is in
<Win32>\system32\drivers\etc, where <Win32> represents the directory in
which the Windows operating system is installed. To modify this file, use the
Informix program setnet32. On UNIX, this file is in /etc. To modify the file, use
your favorite text editor.
Supplying Informix account information
Indicate the account your report server uses to connect to the database by
supplying its user name and password.
Using UNIX Factory server software with Informix
If your report server runs on Solaris, AIX, or HP-UX, you might need to
change the Informix client version specified in the Actuate reports connection
component DLLPath property. For information about specifying the
appropriate connection, see Accessing Informix libraries, later in this
chapter.
Informix Connect 2.60 supports Solaris 8. Informix Connect 2.40 does not.
To display Informix version installed on the system, use the Informix ESQL
utility with the -V option to display the ESQL version:
esql -V
Accessing Informix libraries
If your report server runs on Windows servers, you must ensure that the
proper dynamic link libraries for Informix are in the path. See the Informix
documentation on the libraries used with client applications. The dynamic link
library used depends on the Informix client software installed.
For Windows and UNIX, you also need to specify the proper ACINFX* in the
DLLPath property when you create a database connection component.
ACINFX* library files are part of the Actuate software. The default library is
ACINFX240. Use this DLL with Informix client software that uses Informix
Connect 2.60 or Informix Connect 2.40. The following illustration shows the
DLLPath property as ACINFX240.
Overriding Informix DLLPath
To override the Informix DLLPath property when running a report on a report
server using a different Informix client, specify the DLLPath property in the
Actuate configuration file. For configuration file information, see Specifying a
database configuration file in Chapter 3, Configuring the e.Reporting
Server.
Determining Informix version on Windows
To find the client version information on Windows, use the Informix utility
SETNET32. The information in the About SetNet32 page shows Informix
version numbers.
Setting the maximum column length
The default maximum column length Actuate uses with Informix databases is
4000 characters. Problems can occur when generating an Actuate report if the
report uses an Informix database column with a large column length. You can
use a registry setting on Windows NT, Windows 2000 or an environment
variable on UNIX to set a smaller maximum column length used by Actuate.
To change the maximum character length:
I On Windows NT and Windows 2000, change the value of the string value
name MaxVarLen. The value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Informix
I On UNIX, set the environment variable
AC_DBMS_INFORMIX_MAXVARLEN
Connecting to MS/SQL databases
The Actuate e.Reporting Server works with MS/SQL databases on Windows
NT and Windows 2000.
Actuate release 6.0 supports Microsoft SQL Server 7.0.
To connect with MS/SQL databases, you must:
I Identify the database server
I Indicate the dynamic link library (DLL) the report server uses to establish
the connection
Specifying the MS/SQL database server
To indicate the database server, supply the name that is defined with the SQL
Client Configuration Utility. This name is usually the name of the host
computer, but other names are allowed.
Retrieving data in code pages and in Unicode
To retrieve data in code pages only, use the native DB-Library interface. To
retrieve both Unicode (UCS-2) and data in code pages from Microsoft SQL, use
ODBC client version 3.7 or later. Actuate supports connecting to Microsoft
SQL Server through either the DB-Library or the ODBC interface. Actuate uses
the Microsoft DB-Library as the native database connection to Microsoft SQL
Server.
When enabled, the Automatic ANSI to OEM Conversion option converts a
character set if a client code page is different from the server's code page.
Conversion is enabled by default in DB-Library Options of the SQL Server
Client Network Utility.
On Microsoft Windows server operating systems, the client locale is specified
by the Microsoft Windows regional settings.
The following describes how DB2 handles data:
I The DB-Library is considered an ANSI client and character set translation
is necessary when the database data contains international characters
greater than code 127.
I DB-Library is non-Unicode client library. The database servers SQL Server
7.0 and SQL Server 2000 are Unicode Servers capable of storing Unicode
data. Unicode data retrieved using DB-Library is converted and displayed
as ? question mark characters.
Supplying MS/SQL account information
Accessing MS/SQL libraries
The Component Editor supplies a default library name of NTWDBLIB, which
you should accept. You must also ensure that the PATH environment variable
includes the location of the library.
Testing the MS/SQL connection
If you suspect problems with the connection to your database, use the
program isqlw to test it. To run this program, click the icon labeled ISQL_W, or
enter a command of the following form:
$ isqlw <server> -u <username> -p <password>
For <server>, <username>, and <password>, substitute the information you
supplied to the Component Editor.
This test uses the same information and connection mechanism employed by
the report server. A positive connection test indicates that the problem lies
elsewhere.
About driver versions
Microsoft SQL Server 7.0 includes an updated SQL ODBC Server version 3
driver that is compliant with the Open Database Connectivity 3.5 specification.
The SQL Server ODBC driver fully supports SQL Server 7.0 and 6.x servers.
Understanding Db-library limitations
Version 7.0 of the Db-library API has the same functionality as the 6.5. That is,
the Db-library 7.0 has not been upgraded to support all new features. There is
a possible limitation for Actuate products that use the Db-library API interface
to the database. The SQL Server ODBC driver, however, has been upgraded to
version 3.7x or higher and can be used to exploit some of the new features of
SQL Server 7.0.
Even though char and varchar datatypes have an increased length of 8000
characters, Actuate can only display 255 characters.
Unicode implementation of text is ntext. The Db-library is unable to retrieve
data of such type because it is considered a pre-7.0 client. It generates an error
message:
ntext message can't be sent to pre 7.0 clients
DB-library supports only Latin 1 characters. If the database data contains
characters from any other code page, it will be corrupted by the DB connection
library. To access Unicode data, use the SQL Server ODBC driver.
About 7.0 compatibility with 6.5
If a user does not want not to use any of the SQL Server 7.0 features in new
databases, it is necessary to change the compatibility level setting by executing
the sp_dbcmptlevel system stored procedure. The compatibility level setting
can be set to 6.5 to ensure backward compatibility by executing the
sp_dbcmptlevel system stored procedure with a compatibility level setting of
6.5. This setting does not affect the Actuate products, as it is transparent to the
client being 6.5 or 7.0.
Connecting to databases through ODBC
The Actuate e.Reporting Server works with the DataDirect Connect ODBC 3.7
drivers for UNIX, Windows NT, Windows 2000, and the Microsoft ODBC
32-bit drivers on Windows. The Actuate e.Reporting Suite 6 DataDirect ODBC
3.7 interface supports ODBC version 3.52. For information about capabilities
and limitations of the DataConnect ODBC drivers see the DataDirect
documentation and read.me file supplied with the DataDirect products.
To connect to a database through ODBC you must create an ODBC data source
that includes the information needed to connect to the database.
When you connect to databases through ODBC, you must supply all the
requirements for the target database type, plus a few pieces of information
needed by the ODBC layer. For example, you must define the same
environment variables, indicate the same library names, and so forth, when
connecting to an Oracle database through ODBC as when connecting to the
database directly. In addition, all of the applicable conditions in the following
list must be met:
I You must have installed ODBC on the host running the report server.
I You must have installed the appropriate client-interaction software on the
database host: SQL*Net for Oracle, Open Client for Sybase.
For Sybase ASE on Windows NT and Windows 2000, a Sybase client is not
required. On Solaris, AIX, and HP-UX DBLIB is not required for MS SQL
server 7.0.
I The report server host must have the appropriate information in the ODBC
initialization file. On UNIX, this file is .odbc.ini. The file should be in the
home directory of the account running the report server. To modify
.odbc.ini, use your favorite text editor. On Windows NT, and Windows
2000 the file is named odbc.ini. The file should be in the Windows directory.
To modify odbc.ini, use the ODBC Administrator.
I To access ODBC data sources, Actuate e.Reporting Server on Windows
must be configured to run as a user account, not as the system account.
I The proper version of the report server Factory executable is required for
an ODBC connection. For example on UNIX platforms, using the ODBC
Informix driver requires the proper version of the Informix report server
Factory executable. For information on Factory server executables, see
About UNIX factsrvr database compatibility, later in this chapter.
I For UNIX systems make sure the report and report server system are
configured properly. For example, for a DataDirect ODBC connection:
I Set DLLPath to ODBC32 in the Component Editor for report design.
I Confirm that a symbolic link exists between the ODBC32 file under
$AC_SERVER_HOME/lib and DataDirect ODBC manager library file.
For example, $AC_SERVER_HOME/lib/odbc32.so -> libodbc.so for the
Solaris platform.
When these conditions are met, you can connect to your database as usual. The
Component Editor expects a user name and password for the database, an
indication of the database server, and a connection string. To indicate the
database server, use a data-source name from the initialization file. In these
examples from an .odbc.ini file showing a pair of Sales data sources, the
data-source names are enclosed in brackets:
[Sales1]
Driver=/usr2/local/qe-odbc/odbc/dlls/qesyb08.so
ServerName=sales1srv
Description=Sybase 10
LogonID=
[Sales2]
Driver=/usr2/local/odbc/drivers/vsorac.so.1
Server=t:sales2srv:orcl
Description=
UID=
The connection string includes any optional parameters you want to add for
the current session. You can use the connection string to supplement or
override the options declared in the ODBC initialization file.
The default maximum column length Actuate uses with ODBC databases is
8000 characters. Problems might occur when generating an Actuate report if
the report uses an ODBC database column with a large column length. You can
use a registry setting on Microsoft Windows server operating systems or an
environment variable on UNIX to set a smaller maximum column length used
by Actuate.
I On Microsoft Windows server operating systems, change the value of the
string value name MaxVarLen. The value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Odbc
I On UNIX, set the environment variable AC_DBMS_ODBC_MAXVARLEN.
Understanding language encoding considerations
Most ODBC driver managers such as Merant try to detect the code page or the
Unicode encoding in which the database communicates with the driver.
Use the environment variable AC_DBC_ENCODING if the driver manager
fails to detect the appropriate code page or the Unicode encoding. The driver
manager might use an incorrect default value and send or receive garbled
data.
The environment variable AC_DBC_ENCODING specifies the code page or
the Unicode encoding used by the ODBC driver manager while interpreting
data from the driver. The AC_DBC_ENCODING value can be UCS-2, UTF-8,
or ANSI. The ANSI value indicates the currently set code page of the OS
locale.
For example, if the database client encoding is UTF-8, set
AC_DBC_ENCODING to UTF-8.
Actuate's ODBC interface, allows customers to use ODBC drivers without a
driver manager. If the ODBC interface does not use a driver manager, the
ODBC interface detects whether the driver supports Unicode or not by
making a call to SQLConnectW( ). If the driver supports this method, the
ODBC interface uses the driver's Unicode methods with a 'W' suffix. If the
driver does not have the Unicode version of the methods, the Actuate ODBC
interface assumes the driver is a non-Unicode ANSI driver and calls the ODBC
API methods without the W suffix.
Using the PeopleSoft ODBC driver
You create a connection to a PeopleSoft database using a PeopleSoft ODBC
data source on Windows NT. In e.Report Designer Professional, you use a
stored procedure data source component and the Stored Procedure Data
Source Builder with the PeopleSoft ODBC connection.
PeopleSoft supports either a three-tier or two-tier architecture to connect to
databases. The three-tier architecture uses an application server. The two-tier
architecture does not. For more information about the PeopleSoft
architectures, see the PeopleSoft documentation.
Using either the two-tier or three-tier architecture, when you create an Actuate
report that uses a PeopleSoft database, you need to specify only the PeopleSoft
data source in the report.
On the client machine, the PeopleSoft three-tier architecture requires only a
data source using the PeopleSoft ODBC data source.
On the client machine, the PeopleSoft two-tier architecture, requires two data
sources. One data source uses the PeopleSoft driver, and another data source
uses the native database ODBC driver. For example, if your PeopleSoft
software uses a Microsoft SQL Server database, you need to create two data
sources, a PeopleSoft ODBC data source and a Microsoft SQL Server data
source.
To use the PeopleSoft ODBC database driver with Actuate software, you need
to complete the following tasks:
I Install the Microsoft ODBC 3.0 Administrator.
I Install and configure the PeopleSoft software using the PeopleSoft
Configuration Manager Pscfg.exe. For more information about using the
Configuration Manager, see your PeopleSoft documentation.
1 Setup the machine as a PeopleSoft client machine using the PeopleSoft
Configuration Manager.
2 Install the PeopleSoft ODBC driver using the PeopleSoft Configuration
Manager dialog box Client Setup tab.
I Set up an ODBC data source for the PeopleSoft ODBC driver using the
ODBC Administrator Odbcad32.exe.
I If you are using a two-tier configuration, set up an ODBC data source for
the database containing the data using the ODBC Administrator
Odbcad3.exe.
For more information about support for stored procedures, see About stored
procedures, earlier in this chapter.
Using Red Brick ODBC drivers
The Actuate e.Reporting Server uses ODBC to connect to Red Brick database
version 5.1.5. To connect with Red Brick databases:
I On Windows NT:
I Install the Red Brick ODBC dynamic load libraries (DLL).
I Configure the ODBC DSN.
I On UNIX:
I Define appropriate environment variables.
I Specify the database environment.
I Install the proper Factory server software.
Setting up a Windows NT Red Brick configuration
If your report server runs on Windows NT, you must ensure that the dynamic
link libraries for Red Brick version 5.1.5 ODBC drivers are installed. Use the
Windows ODBC32 Administrator to verify the version number and to specify
an ODBC DSN. In the ODBC configuration Set Advanced Options dialog,
verify the proper server name and port number.
The Red Brick ODBC DLLs are supplied by Red Brick and are installed using
the Red Brick software.
Setting up a UNIX Red Brick configuration
When you configure the report server on a UNIX system to connect to a Red
Brick database you must, define Red Brick environment variables, specify the
database environment, and install the proper Factory server software.
Defining Red Brick environment variables
If your report server runs on UNIX, you must define two UNIX environment
variables, RB_PATH defines the path to the Red Brick software and
RB_CONFIG defines the path to the Red Brick configuration information.
These environment variables must be set in the account that runs the report
server.
Setting up the Red Brick database environment
On UNIX systems verify that the information for the Red Brick DSN in the
.odbc.ini file is correct. The following example is a sample Red Brick DSN
section from an .odbc.ini file:
[RBDSN]
SERVER=bigmachine:5050
RB_CONFIG=/net/testmachine/sun6/testusr/redbrick
DATABASE=redbrdata
UID=system
PWD=manager
On Sun machines, from AC_SERVER_HOME/lib create a symbolic link
between ODBC32 and $RB_PATH/lib/librbodbc.so.
On HP-UX machines, from AC_SERVER_HOME/lib create a symbolic link
between ODBC32 and $RB_PATH/lib/librbodbc.sl.
Installing Factory server software for Red Brick
First, back up the existing fctsrvr5 file. Then, move or copy the Red Brick
fctsrvr5. For AIX, HP-UX, and Solaris platforms, rename factsrvr.redbrick to
fctsrvr5.
Checking the connection to Red Brick databases
On UNIX, to check the connection to a Red Brick database use the utility
rb_client from a command line window:
$> rb_client
The utility prompts for log in information: a DSN, User Name, and password.
After entering logging into the database you can enter a simple SQL query to
check the connection between the client and the database.
On NT, use the Red Brick utilities Risql.exe or Rbwping.exe to test connectivity
to the database server.
Connecting to Oracle databases
The Actuate e.Reporting Server works with Oracle databases of version 7.0
and later. The Actuate interface to Oracle 8 clients supports stored procedures.
From the Stored Procedure Data Source Builder in e.Report Designer
Professional, or e.Report Designer, developers can use Oracle 8 server stored
procedures to retrieve data to generate reports. For more information about
stored procedures, see About stored procedures, earlier in this chapter.
To connect with Oracle databases, you must:
I Install the proper software to connect to the Oracle client
I Supply a connection string
I Define the appropriate environment variables
I Ensure that a listener process is running on the database host
In Actuate e.reports, the default DBInterface for AcOracleConnection is
acorcl90. To use the Oracle 9i connection, the server running the report must
have the Oracle 9i Client installed on the machine.
About Actuate support for Oracle 9i
When using the AcOracleConnection component, Actuate can use the acorcl81
library built with Oracle8.1.6 OCI client to connect to the Oracle 9i servers.
Actuate supports the Oracle 9i Database Client. The 32-bit versions of Oracle
Database 9i are supported on Windows, Solaris, and Linux. (Linux is for Java
Technology only.) In addition, 64-bit versions of Oracle 9i are supported on
Solaris, AIX and HP-UX.
Actuate supports calling Oracle8 stored procedures and retrieval of Oracle8
stored procedure result sets using Actuate Basic or Actuate Stored Procedure
Data Source Builder.
Actuate supports connecting to an Oracle 9i database server using an Oracle 8i
client.
For information about the AcOracleConnection, see About Actuate support
for Oracle 8i, later in this chapter.
About Actuate support for Oracle 8i
The following information describes the Oracle-specific AcOracleConnection
connection properties used in Actuate reports.
The AcOracleConnection property DBInterface replaces the property
DllPath. The DllPath property is in previous versions of
AcOracleConnection. The default value of DBInterface is acorclxx where xx
stands for the shared object version 7, 80, 81:
I acorcl7 library built with Oracle7 OCI client.
I acorcl80 library built with Oracle8.0.4 OCI client
I acorcl81 library built with Oracle8.1.6 OCI client
For an Actuate 5 report object design (ROD) the DBInterface value is
acorcl81. An appropriate error message is raised if the DBInterface value is
not compatible with the installed Oracle client software. For a previous
version report executable, the connection property DBInterface does not
exist, and Actuate uses acorcl80. In previous releases, the default is
OCIW32.
If the previous version .rox is run with an Oracle7 or 8.1.6 OCI client,
Actuate generates an error message because the default DBInterface library
is Oracle8.0.4 OCI client. To avoid this error, open the ROD in the current
version of Actuate development tool, change the DBInterface property
value to the correct value, and rebuild the report design with the current
Actuate product.
I The property MaximumStringLength specifies the maximum possible
length for a VARCHAR2 or NVARCHAR2 datatype. The default value of
this property is 4000. Developers can change this property value when
designing an Actuate report.
Users can specify a value in the configuration file as a global setting for the
parameter. The MaximumStringLength value in the Oracle Connection
property found in the configuration file overrides the value specified in the
report design.
configuration file. If specified in a configuration file, the
MaximumStringLength value overrides the value specified in the report
design. For configuration file information, see Specifying a database
In previous releases, an administrator can define the maximum length of a
string datatype using the string value Maxvarlen in the registry key
HKEY_CURRENT_USER\Software\Actuate\DBMS\Oracle.
Administrators can change the string value to specify a custom maximum
length for a string datatype.
To ensure backward compatibility, Actuate's interface to Oracle checks to
see if MaximumStringLength property value is other than the default
value. If MaximumStringLength is the default value, Actuate checks to see
if the registry key exists or not. If it does not exist, Actuate uses the value
specified by MaximumStringLength. If the registry key value is other than
the default value and MaximumStringLength property value is set to
default value, Actuate uses the value specified by the registry entry. The
MaximumStringLength property value overrides any other setting if it is
not the default value. The report server does not create a registry entry.
I The Oracle failover feature is not supported.
About Oracle Java stored procedures
Oracle does not support returning a result set from Java stored procedures in
Oracle8i release 8.1.5.
Using the Actuate e.Reporting Server and Oracle
clients
The Report Server Oracle DLLs are different from the one used in the client
products. You cannot mix the Windows NT client and server DLLs.
About Oracle connection strings
The report server connects to Oracle databases using SQL*Net version 1 or
version 2. The information it needs to make the connection, the connection
string, takes different forms depending on the version of SQL*Net you use.
Working with SQL*Net version 1
For version 1, the connection string consists of three fields separated by colons:
network-prefix:host:SID
The network-prefix field identifies the type of network connection. For Oracle
databases on UNIX platforms, the network-prefix is t (for TCP/IP). For
databases on NT, network-prefix can be t or p (for named Pipe).
The host field identifies the network node running the database you want to
reach.
The system identifier, or SID, is a unique identifier used by Oracle processes to
distinguish an individual database. This identifier is needed because a single
host can run multiple databases concurrently.
Working with SQL*Net version 2
For version 2, the connection string is a symbolic name that serves as an index
into the file $ORACLE_HOME/network/admin/tnsnames.ora. The symbolic
name provides a means of grouping properties such as connection type and
database host under a convenient identifier. Any name defined in
tnsnames.ora is a legal connection string.
Defining Oracle environment variables
For Oracle databases on UNIX platforms, the account running report server
processes must have a definition for the standard Oracle environment variable
ORACLE_HOME. You can provide this definition in a login script such as
.cshrc or .profile, or you can include it in the scripts that start the report server
processes. For more information about the report server scripts, see Starting
and stopping a report server system in Chapter 4, Performing system
For Oracle databases on NT, you must also ensure that the definition of the
environment variable PATH indicates the location of the dynamic link library
that selects the proper database. For version 7.0, this library is named
ora7nt.dll, and for version 7.1 its name is orant71.dll. If your database is
version 7.2 or later, you should use ociw32.dll because this library finds the
latest available SQL*Net library and uses it to connect to the database.
The Oracle UNIX environment variable and Windows registry setting
NLS_LANG specifies the Oracle locale, that consists of the language, territory,
and character set. The default value for NSL_LANG is
American_America.US7ASCII. Administrators must ensure the NLS_LANG
setting is correct for the information in the Oracle database. For more
information on NLS_LANG, see the Oracle documentation.
On UNIX systems, an administrator must add the NLS_LANG environment
variable to the pmd6.sh script, the report server request server startup script.
On Windows servers, the Oracle installer configures NLS_LANG.
The following example sets NLS_LANG for simplified Chinese on a UNIX
system:
export NLS_LANG
NLS_LANG="Simplified Chinese_China.ZHS16GBK"
Double quotes are required when setting a value that contains spaces.
On Microsoft Windows server operating systems, set the NLS_LANG registry
value in the key HKEY_LOCAL_MACHINE \Software\Oracle\Home.
For information about the NLS_LANG values, see the Oracle documentation.
About the Oracle listener processes
The report server interacts with an Oracle database through the Oracle listener
process. The listener process is managed by a controller process, which is
called tcpctl for SQL*Net version 1 and lsnrctl for version 2. Both versions of
the controller process have arguments named start, stop, and status, which
respectively start, stop, and report the current status of the listener process. If
your report server is having trouble communicating with the Oracle database,
the link to the listener process might have failed. You can frequently solve such
problems by stopping the listener process, if it is still running, and starting it
again.
Testing the Oracle connection
If you suspect problems with the connection to your database, use the Oracle
program sqlplus to test it. Enter a command of the following form:
$ sqlplus <username>/<password>@<connection-string>
For <username>, <password>, and <connection-string>, substitute the
information you supplied to the Component Editor. Use the appropriate
connection string based on your version of SQL*Net.
elsewhere.
About Oracle 8 data type support
The following table lists Oracle 8 data types supported by Actuate.
Oracle 8 Datatype Notes
NCHAR This datatype is new in Oracle 8.
NVARCHAR2 This datatype is new in Oracle 8.
The default maximum column length Actuate uses with Oracle databases is
report uses an Oracle database column with a large column length. You can
use a registry setting on Windows or an environment variable on UNIX to set a
smaller maximum column length used by Actuate.
I On Windows, change value of the string value name MaxVarLen. The
value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Oracle
AC_DBMS_ORACLE_MAXVARLEN.
Connecting to Progress 9.1 databases
Actuate supports Progress 9.1 databases using the Actuate connection
component AcProgressSQL92Connection. The Actuate interface to Progress
9.1 supports stored procedures. From the Stored Procedure Data Source
Builder in e.Report Designer Professional, developers can use Progress 9.1
stored procedures to retrieve data to generate reports. For more information
about stored procedures, see About stored procedures,earlier in this chapter.
Progress 9.1 incorporates many new features. Among the new features are:
I Use of Embedded SQL and SQL-92
I Support for new datatypes
I Support for stored procedures and triggers
The Actuate interface with Progress 9.1 uses Embedded SQL-92 (ESQL).
Progress 9.1 supports stored procedures and triggers. The stored procedures
ROWID ROWID must be bound to Actuate Basic string
datatype. With Oracle 8 databases, Actuate
support restricted ROWID only. Actuate does not
support extended ROWID.
VARCHAR This datatype is available in older version of
Oracle. In the newer versions, all the VARCHAR
columns are automatically changed to
VARCHAR2.
Oracle 8 Datatype Notes
and triggers are implemented in Java and stored inside the database. Stored
procedures are executed by the database and the results may be returned to
the client in the form of output parameters or in the same manner that query
results would be fetched.
Stored triggers are defined on a table or column and automatically executed
when the conditions for its execution are met.
To use Progress SQL 92 on HP-UX 11 systems, the machines must have
General Patch Release XSWGR1100 (B.11.00.47.05) or higher installed. See the
HP documentation and web site for more information on HP-UX patches.
The Progress documentation also contains information about connecting to
Progress databases using Actuate software.
About Actuate support for Progress
Actuate software release 4.0 and higher supports the Progress 9.1 database
interface and Progress 9.1 stored procedures.
The Actuate e.Reporting Server with the Progress Database Connection option
supports Actuate report executable .rox files that use only the Progress
connection. Customers requiring use of connections to other databases should
contact Actuate Corporation.
Installing Progress software
You must install the following Progress software to connect to Progress
databases:
I SQL Client Access to connect to a Progress 9.1 database
I Java Development Kit (JDK) for stored procedures and triggers
Defining Windows environment variables
The following environment variables must be set to connect from Actuate to a
Progress 9.1 database.
Ensure that the following registry key is set to the JDK installation directory:
HKEY_LOCAL_MACHINE\Software\PSC\PROGRESS\9.0X\JAVA\JDKHOME
Variable Value
DLC Progress 9.1 installation directory.
JDKHOME This must be set to the JDK installation directory.
PATH %DLC%/bin and %DLC%/jre/bin must be added
to this variable.
Set the Progress environment variable SQL_CLIENT_CHARSET to use an
SQL-92 client code page that is different from the client operating system.
Specify a Progress code page. When SQL_CLIENT_CHARSET is set to a code
page, the SQL-92 server converts text data that is sent from the server to the
client to the code page. The SQL-92 server also uses this code page when
converting text data sent from the client to the server to the server code page.
The following are example values for SQL_CLIENT_CHARSET:
I IBM866 for the Russian language
I SHIFT-JIS for Japanese language
I UTF-8 for Unicode UTF8 encoding
For information about Progress code page values, see the Progress
documentation.
About Actuate connection properties
The Progress 9.1 connection component AcProgressSQL92Connection uses the
following properties.
The values for Host, Service or Port, Database, and FetchRowBufferCount are
retained between sessions.
FetchRowBufferCount determines the array size used when fetching data
from the database. The FetchRowBufferCount is the same for all query objects,
which use the connection.
Property Format Description
Database string Progress database name.
Dllpath string Acprg9.dll.
FetchRowBufferCount string Number of rows to be fetched. Value
must be less than 65000.
Host string Database host computer name.
Password string Progress database users password
ReadOnlyQuery Boolean Sets the transaction isolation level. If set
to TRUE, the default value, the level is
set to READ UNCOMMITTED.
Otherwise, the level is set to
REPEATABLE READ.
Service or Port string Registered TCP socket name or port
number that connects to the database
UserName string Progress database user name
Working with Progress 9.1 SQL92 connections
You must use multiple instances of AcProgressSQL92Connection class to log
on to multiple databases.
Progress 9.x client software permits two types of connections. The connection
can either be to a local database where the database files are accessed directly
or to a remote database where the database is accessed through a database
server and the server directly accesses the database files on behalf of its clients.
If you connect to a local database, only the database name is required. If you
connect to a remote database, in addition to the database name, the host name
or network address and the service name or port number for the database
must be given.
If the database is on the local machine and has a database server running, the
database must be accessed using a remote connection.
Using stored procedures and triggers
Actuate supports calling Progress 9.1 stored procedures. Single or multiple
result sets, and input, output, or input/output parameters are supported.
Actuate can describe the result set as well as parameter information.
You must install JDK to execute Progress Java stored procedures and triggers
from the database. For information about using JDK with Progress, see the
Progress 9 documentation.
Using the AcProgressConnection connection
The Progress SQL-89 interface is available and compatible with Progress 9.0
and 9.1. Actuate reports using the Progress connection class,
AcProgressConnection, use the SQL-89 interface to connect to Progress 9.0 and
9.1 databases. If AcProgressConnection is used, and the database version is 9.x
database, the following views and tables are excluded:
I Tables not owned by PUB
I Views created in SQL92 engine
To connect Actuate Reports to Progress 9.0 databases you must use the
AcProgressConnection.
Connecting to a Progress 9.x database using AcProgressConnection is the
same as connecting to Progress 8 database. The configuration and setup
information for connecting to Progress 8 database is still valid for Progress 9.
During the Progress 9 installation, users must make sure that while installing
Progress9 database they also install the SQL89 engine. The Progress client
software that connects to a SQL89 engine must also be installed on the report
server machine.
For more information about connecting to a Progress 9.x database using a
Progress 8 connection, see the Progress documentation.
Setting up the UNIX environment
For all UNIX platforms, the following environment variables must be set to
connect from Actuate to a Progress 9.1 database.
Set the environment variable SQL_CLIENT_CHARSET to use an SQL-92 client
code page that is different from the client operating system. Specify a Progress
code page. When SQL_CLIENT_CHARSET is set to a code page, the SQL-92
server converts text data that is sent from the server to the client to the code
page. The SQL-92 server also uses this code page when converting text data
sent from the client to the server to the server code page.
The following are example values for SQL_CLIENT_CHARSET:
I IBM866 for the Russian language
I SHIFT-JIS for Japanese language
I UTF-8 for Unicode UTF8 encoding
For information about Progress code page values, see the Progress
documentation.
On UNIX, Actuate does not use the default Progress password set in the
DH_PASSWD environment variable. Actuate always uses the password
entered in the AcProgressSQL92Connection connection component.
On UNIX, Actuate uses the shared library name Acprg9.so or Acprg9.sl for the
Progress 9 interface. The Actuate installation process creates a symbolic link
from Acprg9.so or .sl to the Progress 9 library. These are the library names for
the UNIX platforms.
Variable Value
DLC Progress 9 installation directory
JDKHOME This must be set to the JDK directory
PATH %DLC%/bin and %DLC%/jre/bin must be added
to this variable
Platform Library
AIX libacprg9_share.a
HP-UX libacprg9.sl
SunOS libacprg9.so
For example, on SunOS a symbolic link is created betweenAcprg9.so to
libacprg9.so. If the link is broken, the system administrator must create a link
between Acprg9.so or Acprg9.sl. and the appropriate Progress 9 library.
About SunOS setup
The following Progress directories must be added to the LD_LIBRARY_PATH
environment variable:
%DLC/lib;%JDKHOME/lib
The Progress 9 shared library libacprg9.so is found in
$AC_SERVER_HOME\lib.
About HP-UX setup
The following Progress directories must be added to the SHLIB_PATH
The Progress 9 shared library libacprg9.sl is found in
About AIX setup
The following Progress directories must be added to the LIBPATH
The Progress 9 shared library libacprg9_share.a is found in
Connecting to Progress 8 databases
The following two sections describe the system requirements for using
Actuate software and the Progress 8 database interface.
The Progress documentation also contains information about connecting to
Progress databases using Actuate software.
About Actuate support
The Actuate e.Reporting Server with the Progress Database Connection option
supports Actuate report executable .rox files that use only the Progress
connection. Customers requiring use of connections to other databases should
contact Actuate Corporation.
The default maximum column length Actuate uses with Progress databases is
report uses a Progress database column with a large column length. You can
use a registry setting on Windows or an environment variable on UNIX to set a
smaller maximum column length used by Actuate.
I On Windows, change value of the string value name MaxVarLen. The
value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Progress
AC_DBMS_PROGRESS_MAXVARLEN.
About Progress software requirements
You need this software to connect to Progress databases:
I Progress Client software version 8.2. The Actuate interface with the
Progress interface connects to Progress server software version 8.2 and
higher.
I For Windows 98 or NT, Esql32.dll. The default directory for Esql32.dll is
C:\Dlc\Bin. The Actuate interface to Progress databases requires Esql32.dll
on the client computer where you generate Actuate reports that access a
Progress database.
Preparing the Progress Client environment
Follow these steps to prepare the Progress Client environment before
attempting to connect to a Progress database from the Actuate software.
How to prepare the Progress Client environment on Windows 98 or
Windows NT machines
1 Set the following environment variables:
I PROCFG=C:\DLC\PROGRESS.CFG
I PROMSGS=C:\DLC\PROMSGS
I PROSTARTUP=C:\DLC\STARTUP.PF
I DLC=C:\DLC
Add the directories C:\DLC;C:\DLC\BIN to the systems PATH statement.
On Windows NT, make these changes with the System applet in the
Control Panel. On Windows 98, make the changes in the Autoexec.bat file.
2 Ensure that the file Esql32.dll is installed on the client machine.
3 Define at least two TCP/IP ports on both the client and server machines,
using the exact same syntax and values on both machines.
On the client machine:
I Add a TCP entry to the SERVICES file for the Progress Open Interface.
I Add a TCP entry to the SERVICES file for the Progress Client.
On the server machine:
I Add a TCP entry to the SERVICES file for the Progress OID.
I Add a TCP entry to the SERVICES file for the Progress Client.
The following are sample entries from a SERVICES file:
progoid 4096/tcp
sports 4098/tcp
The SERVICES file is an ASCII file located in /etc/ on UNIX systems or
\<WindowsDir>\System32\Drivers\Etc\ on Windows 98 or NT systems.
Contact your Progress database administrator for more information about
defining TCP/IP ports and setting environment variables.
4 Test the client connection to the Progress database before attempting to
connect from Actuate software.
How to prepare the Progress Client environment on UNIX
machines
On UNIX machines, you can use Progress Client software with the Actuate
e.Reporting Server to access Progress databases from the report server.
After you have installed the Progress Client software and e.Reporting Server
on your UNIX system, you need to perform these steps.
1 Set environment variables DLC, PROTERMCAP, PROMSGS, and
PROCFG. For example:
setenv DLC /net/myserver/export/dbms/progress
setenv PROTERMCAP $DLC/protermcap
setenv PROMSGS $DLC/promsgs
setenv PROCFG$DLC/progress.cfg
Add the directories $DLC and $DLC/bin to the systems PATH
environment variable.
2 Create entries in the SERVICES file on the client and server machines. See
step 3 in the previous section.
Contact your Progress database administrator for more information about
defining TCP/IP ports in your SERVICES file and setting environment
variables.
Setting up a Progress self-service client connection
If you do not have Client Networking installed on your NT Server, you must
specify a connection as a self-service client. In the e.Report Designer
Professional DatabaseList property, do not use the -S, -N, and -H parameters.
For example, to connect to the sports database on your machine as a self-server
client, enter this value as the DatabaseList property:
-db sports
Do not include the path to the sports database.
The StartUpParameters property remains the same.
Starting a Progress 8 database and the Progress
Open Interface Broker
When you start a Progress database and OIB, you specify startup parameters.
On Windows NT and Windows 2000 you must also set environment variables.
For information about the Windows environment variables, see Setting
Progress environment variables on a database server, later in this chapter.
When you start the Progress OIB and you are using Actuate with the Progress
database interface, you must specify Small Client behavior with the -SV
parameter. If you create reports that generate long Progress statements, you
can use the -inp parameter to increase the OIB buffer space.
The command-line parameters are shown below for starting a Progress
database server and the Progress OIB.
On UNIX:
proserve -db <database-name> -S <db-port> -N <protocol> -H <db-host>
prooibrk -SV -S <broker-port> -N <protocol> -H <broker-host>
On Windows:
_mprosrv -db <database-name> -S <db-port> -N <protocol> -H <db-host>
oibrkr32.exe -SV -S <broker-port> -N <protocol> -H <broker-host>
The following table describes the parameters used with the Progress database
server.
Database parameter Description
-db <database-name> Database name.
-H <db-host> Database host computer name.
-N TCP Connection protocol, TCP specifies TCP/IP.
-S <db-port> Registered TCP socket name. Must be different from
<broker-port>.
The following table describes the parameters used with the Progress OIB.
Setting Progress environment variables on a database server
You must set the PROOIDRV and PROOIBRK environment variables on a
UNIX or Windows server machine. For example, using the Progress default
directory on Windows:
PROOIBRK=C:\DLC\BIN\OIBRKR32.EXE
PROOIDRV=C:\DLC\BIN\OIDRVR32.EXE
The broker will start without the environment variables, but you will not be
able to connect from a client.
Connecting to a Progress 8 database from an
e.Report Designer Professional report
When using e.Report Designer Professional, you must specify connection
parameters for both the database itself and a Progress Open Interface Broker
(OIB). You specify the information when you set up a reports connection
component. Enter the database connection parameters in the components
DatabaseList property and the OIB connection parameters in the components
StartUpParameters property.
The following illustration is an Actuate report Component Editor dialog box
for a Progress connection. It shows the Progress database connection
parameters in the DatabaseList property and the OIB connection parameters in
the StartUpParameters property.
OIB parameter Description
-H <broker-host> OIB host computer name.
-inp <size> Maximum number of characters in a Progress
statement. The default is 4096 and the maximum is
32,000.
-N TCP Connection protocol, TCP specifies TCP/IP.
-S <broker-port> Registered TCP socket name. Must be different from
<db-port>.
-SV Specifies Small Client behavior. This parameter must
be the first parameter for the OIB.
For the Progress database connection properties, you must specify a database
list and the startup parameters to connect to a Progress database.
If Progress Security is active, you can use the following optional DatabaseList
parameters to specify a user name and password:
I -U <username> User name registered to Progress Security
I -P <password> Users password
Property Parameter Description
DatabaseList -db
<database-name>
Database name.
-S <db-port> Registered TCP socket name. Must be different
from <broker-port>.
-N TCP Connection protocol, TCP, specifies TCP/IP.
-H <db-host> Database host computer name.
Dllpath ESQL32.DLL Actuate/Progress interface software.
Password Users Progress database password.
StartUpParameters -SV Specifies Small Client behavior. This parameter
must be the first parameter.
-S <broker-port> Registered TCP socket name. Must be different
from <db-port>.
-N TCP Connection protocol, TCP, specifies TCP/IP.
-H <broker-host> OIB host computer name.
Username Login name for the Progress database.
You can log in to multiple databases using different user name and password
combinations. For example, you can enter this string for the DatabaseList
parameter to log in to the sports and mktg databases:
-db sports -H ahost -S asvc -U aname -P apass -db mktg -H bhost -S bsvc -U
bname -P bpass
Entering a user name or password in the connection dialog box is equivalent
to using the -U and -P parameters in the DatabaseList property. e.Report
Designer Professional uses the name and password for each database in the
DatabaseList. For example, if you enter:
I DatabaseList: -db mktg -H ahost -S asvc -db sport -H bhost -S bsvc
I Username: fred
I Password: apass
e.Report Designer Professional creates this database list string:
-db mktg -H ahost -S asvc -U fred -P apass -db sport -H bhost -S bsvc -U fred
-P apass
For a self-service client, do not use the -S, -N, and -H parameters in the
DatabaseList property. For example, when OIB is started in same directory as
the mktg database on your machine, use this string in the DatabaseList
property:
db mktg
Connecting to Sybase databases
The Actuate e.Reporting Server uses the Open Client mechanism to connect to
Sybase ASE (Adaptive Server) database versions 12.0, and 12.5. To connect
with Sybase databases, you must:
I Define the SYBASE environment variable.
I Identify the database server.
I Supply an account name and password.
I Indicate the Actuate dynamic link libraries the report server uses to
establish the connection.
When you use a Sybase ctlib connection, Actuate supports stored procedures
with the stored procedure data source. For more information about support
for stored procedures, see About stored procedures, earlier in this chapter.
Understanding Actuate Sybase ASE 12 support
Actuate supports calling Sybase stored procedures and retrieval of Sybase
stored procedure result sets using Actuate Basic or the Actuate Stored
Procedure Data Source Builder.
Actuate products on Unix require Sybase Open Client 11.1.1 Patch EBF 8744,
or Patch EBF 9284 and higher. Patch EBF 8957, Patch EBF 9065 and their
equivalents are explicitly not supported.
Both 32-bit and 64-bit versions of Sybase 12.5 client and server are supported.
The describes Actuates support for the Sybase interface:
I DBInterface can have acsyb1111 or acsyb12 as a value:
I acsyb1111 library used with the Sybase Open Client 11.1.1
I acsyb12 library used with the Sybase Open Client 12.0 and 12.5
Actuate displays an error message for incompatibility for the following
conditions:
I The DB interface library is acsyb12 and the Sybase Open Client version
is not 12.0 or 12.5.
I The DB interface library is not acsyb12 and the Sybase Open Client
version is 12.0 or 12.5.
Users can specify a value in the configuration file as a global setting for the
DBInterface parameter. The value in the in the configuration file overrides
the value specified in the report design.
I The Sybase connection class has the property MaximumStringLength to
accommodate Sybase datatypes such as TEXT and LONGBINARY. The
default maximum column length is 4000 characters. Developers can change
this property value when designing an Actuate report.
configuration file. If specified in a configuration file, the
MaximumStringLength value overrides the value specified in the report
design. For configuration file information, see Specifying a database
I The Sybase failover feature is not supported.
I If a previous version .rox is run with Actuate products, the new property
DBInterface does not exist in the .rox. Actuate uses acsyb1111 as a default.
If the previous version .rox is run with Sybase Open Client 12.0, Actuate
generates an error message since the default DBInterface library used is
acsyb1111. To avoid this error, open the report design in the current version
Actuate product, change the DBInterface property value to acsyb12, and
rebuild the report design with the current Actuate product.
I Sybase Open Client 12.0 is installed in a subdirectory under the $SYBASE
directory, and is specified in a new environment variable $SYBASE_OCS.
The PATH and Library Path must be adjusted to include the relevant
subdirectories: $SYBASE/$SYBASE_OCS/bin and
$SYBASE/$SYBASE_OCS/dll (NT) or $SYBASE/$SYBASE_OCS/lib on
UNIX platforms.
Using Sybase 12.5 with Actuate e.reports
Actuate supports the Sybase 12.0 functionality in Sybase 12.5. To access Sybase
12.5 server running on Windows server operating systems, Solaris systems,
HP-UX, and AIX systems, Actuate e.reports use the Actuate Sybase 12.0
DBInterface property acsyb12.
Sybase changed some library names in Sybase 12.5 on the AIX 4.3 platform. To
use Sybase 12.5 libraries with Actuate e.report .rox files on AIX 4.3 and higher,
system administrators create a symbolic link for Sybase libraries libcomn,
libcs, libct, libintl, libtcl in the Sybase OCS_12-5/lib directory. For example, the
following ln commands create a symbolic link to an .so.a file from the .so
library that ships with Sybase 12.5:
ln -s libcomn.so libcomn.so.a
ln -s libct.so libct.so.a
ln -s libcs.so libcs.so.a
ln -s libintl.so libintl.so.a
ln -s libtcl.so libtcl.so.a
Defining Sybase environment variables
If your report server runs on Windows, you must define the system
environment variable SYBASE. Defining a user environment variable is not
equivalent; report server processes are system processes and cannot access
your user environment.
For Sybase connections, Actuate determines the client locale using the
LC_ALL environment variable.
To use multiple languages, set the environment LC_ALL variable to a Unicode
encoding. Sybase supports UTF-8. You can set LC_ALL to us_english.utf8.
Supplying Sybase database server information
To indicate the database server, supply a name that is defined in the file
$SYBASE/interfaces on UNIX, or $SYBASE/INI/SQL.INI on Windows. To
modify this file, use the Sybase utility sybinit on UNIX or the client
configuration program sqledit on Windows.
If your report server is running on a UNIX host, the name of the database
server is interpreted by UNIX software, which is case-sensitive. You must use
the correct case of characters when entering the name of a UNIX report server
host regardless of the computer on which you enter the name. Failure to do so
prevents successful connections.
Supplying Sybase account information
Testing the Sybase connection
If you suspect problems with the connection to your database, use the
program isql to test it. Enter a command of the following form:
$ isql -s <server> -U <username> -P <password>
For <server>, <username>, and <password>, substitute the information you
supplied to the Component Editor.
elsewhere.
About UNIX factsrvr database compatibility
The UNIX platforms must use different Factory servers based on the database
connections. The following chart lists the database connectivity options
available with the Actuate Factory servers. For the latest information, see the
Actuate Supported Products Matirx on the Actuate web site at
www.actuate.com.
The Factory servers are in the report servers operation server. The Factory
server used by the report server is named fctsrvr5. The database-specific
Factory servers are named factsrvr.<database name>. For example, the Factory
server for Red Brick is factsrvr.redbrick. Actuate ships and installs the default
Factory server. To use a database-specific Factory server, save and move or
rename the original fctsrvr5 file, and rename the database-specific Factory
server to fctsrvr5. These changes must be done while the report server is not
running.
OS and
Factory
server DB2
Informix
Connect
2.40
ODBC
Data-
Direct Oracle Progress Sybase
Red
Brick
AIX
default
factsrvr
x x x x x
db2 x x x x x
redbrick x x x x x
HP-UX 11
default
factsrvr
x x x x x x
redbrick x x x x x x
Solaris
default
factsrvr
x x x x x x
redbrick x x x x x x
C h a p t e r 6 , Wo r k i n g w i t h e . R e p o r t i n g S e r v e r u t i l i t i e s 217
C h a p t e r
6
Chapter6Working with e.Reporting
Server utilities
I Using acacfconvert
I Using acexport
I Using acextern
I Using acimport
I Using acintern
I Using acmode
I Using actoc
I Using acupgrade
I Using acverify
I Using the UNIX PostScript font utility
Using acacfconvert
The acacfconvert utility retrieves files from an Actuate .acf file. To retrieve
needed files from Actuate .acf export files, acacfconvert converts .acf files to
Release 6 format export files. The .acf file must be created by from Actuate
Release 3, 4, or 5 acexport utility.
The acacfconvert utility requires the following executables: acimport5,
acupgrade, and acexport.
The acacfconvert utility uses a temporary directory. This directory should have
free space that is at least twice the size of the .acf file. An administrator can
specify the temporary directory to use.
The acafcconvert utility uses the Actuate ICU library. You might need to
specify the location of the library with the ICU_DATA environment variable.
The Actuate installation process sets ICU_DATA for the report server.
The following table lists the acacfconvert options
This example converts the export file c:\exports\sales.acf to Release 6 format
data in a directory. The directory containing the Release 6 version exported
volume is c:\exports\v6\sales.
acacfconvert c:\exports\sales.acf c:\exports\v6\sales
Option Description
-external Specify an externalized Report Encyclopedia volume.
-help Display option information.
-input <input_file> Required parameter specifies the .acf file to convert.
-output
<output_dir>
Required parameter specifies the output export
directory. This directory must not already exist. The
default is the current directory.
-password
<password>
Specify the password of the administrator user in the
.acf file Report Encyclopedia. Default is the empty
password.
-RSSE <library> Optional parameter specifies the location of an RSSE
library to use to validate existing references to users
and roles. Used with the -external option.
-temp <temp_dir> Specify a temporary directory to be used for
intermediate acacfconvert files. The default is the
current directory.
This example converts backup_feb_2001.acf into Release 6 format data in the
subdirectory backup_v6_feb_2001 in the current directory. Acacfconvert uses
the directory d:\temporary files to store temporary files.
acacfconvert backup_feb_2001.acf backup_v6_feb_2001 -temp "d:\temporary
files"
Using acexport
The acexport command-line utility exports Report Encyclopedia volume data
to an export directory. Exported data is in a platform-independent format. The
export directory contains version information for the format of the export and
the version of the report server. The export directory contains report
executables, report documents, and other objects that might contain
proprietary or sensitive information. For information about the export
directory, see About the exported volume directories and files, later in this
chapter.
Use acexport to export information from a current release Report
Encyclopedia volume. Use acimport to import the volume information that is
exported in the current release format. To upgrade from pre-Release 6 Report
Encyclopedia volume use acupgrade. For information about acupgrade, see
Using acupgrade, earlier in this chapter.
Because acexport works directly with volume files, back up your existing
volume before using the utility.
Acimport and acexport cannot be used to transfer information between a
volume that uses the open security and one that does not use open security.
For information see Importing and exporting data with open security in
Acexport creates a log file containing information such as missing dependency
information, and dropping, and warning messages. The log file is
AcDBUtil.log in the AC_SEVER_HOME/log directory.
The acexport utility uses the Actuate ICU library. You might need to specify
the location of the library with the ICU_DATA environment variable. The
Actuate installation process sets ICU_DATA for the report server.
Exporting files and folders
Acexport allows the administrator to export the contents of the entire Report
Encyclopedia volume, or only files and folders within one or more specified
subdirectories. For each subdirectory, the export may or may not be recursive.
Exclusion of subdirectories from the export is also allowed.
In all cases, information about file and folder ownership is maintained in the
export directory. Privilege information, users, and roles that have various
access rights to the objects is also maintained.
The administrator can request that all versions of files be exported or that only
the latest versions of files be exported.
Executable files also retain the set of users and groups that are to be notified
when a related job completes.
Files that are exported can depend on other files in the volume. For example,
an .roi generated from an .rox depends on the .rox. The following illustration
of a files Dependency page in Properties shows that the file depends on the
file test-xls.rox.
When exporting files with dependencies, acexport tries to maintain the
dependencies during export. Acimport tries to maintain them during import.
Exporting volume administration information
The following sections discuss exporting different types of volume
information.
Exporting users, security roles, and groups
The program allows the administrator to export all roles and users or no roles
and users. The program also allows the administrator to export all groups or
no groups.
Exporting channels
The administrator can export all or no channels.
Exporting jobs
Completed, pending, and scheduled report generation jobs related to report
executable and report document objects can be exported.
When exporting jobs, acexport also exports related input and output files.
A warning will be generated if the same job name existed. At the same time,
UserID and ScheduleTaskID will be set using the newly generated ID from ID
map file.
About the exported volume directories and files
The acexport utility creates a directory that contains four types of files:
I TOC file what.txt contains a description of the other exported files.
I Metadata export files contain the volumes exported metadata.
I Metadata ID files contain metadata ID information acimport uses to map
names and IDs.
I Report Encyclopedia volume content files are the actual report executables
and documents.
The content files are placed in subdirectories of the export root directory.
Copying the export directory
To copy the exported Report Encyclopedia volume to another location, a
system administrator can copy the directory and all the subdirectories to
another location or onto backup media such as tape or CD-ROM.
The administrator can use archiving tools such as tar on Unix systems or Zip
on Windows systems to consolidate and compress and the exported volume to
a single file.
About acexport options
The following table lists the acexport options.
Export option Description
ADMINISTRATION
INFORMATION
-eadmin Export all administration information.
Equivalent to -eusers -egroups -eprinters
-epgroups -echannels.
-echannels Export all channels.
-efiletypes Export all filetypes.
-egroups Export all groups.
-eusers Export all users and roles.
FILES AND FOLDERS
-bf <folder1>
<folder2>
Block (exclude) files from listed folders from
export. Specify fully qualified path from the
volume root folder, for example,
/user1/test.
-rbf <folder1>
<folder2>
Recursively block (exclude) items from specified
folder from export. Specify fully qualified path
from the volume root folder, for example, /user1/
test.
-efiles Export all files and folders. Identical to -ref /.
-ef <folder1>
<folder2>
Export files in listed folders. Specify fully
qualified path from the volume root folder, for
example, /user1/test.
-latest Export only the most recent version of each
exported file. By default, all versions of files are
exported.
-meta Exports volume metadata only. The actual
contents of the files are not exported. The -meta
option is useful when used with the efiles or all
options.
-ref <folder1>
<folder2>
Recursively export items in listed folders, such as
export items in subfolders. Specify fully qualified
path from the volume root folder, for example, /
user1/test.
-type <file_type1>
<file_type2>
Export files of specified file types. Valid file types
are file types defined in the volume. By default, all
files are exported.
If any exported file depends on another file, the
other file is exported regardless of its file type.
GENERAL
-acf Use with the all option to export a Report
Encyclopedia volume to single Actuate export .acf
file. When exporting to an .acf file, you must use
the all option with the output option and
specify the fully qualified path and file name of
the output file. Use only the all option with the
output option with the acf option.
-all Exports all information from the volume.
Equivalent to the options
-ref / -eadmin -ejobs.
-config <path to
configuration file>
Specify the path to the report server system
configuration file. The -path option is used with
the -vol option. If using acexport a non-master
server node, the -path option specifies
configuration file.
-home <directory> Specify the location of the volume to export. The
volume must be in the directory encyc in the
specified directory. The default is the current
directory. Cannot be used with -vol option.
-vol <volume name> Specify the name the volume to export. The name
must reference a valid volume in the server
configuration file. Acexport exports the volume
based on the report server system configuration.
The name must be a valid report server volume.
Use the -path option to specify a configuration
file. The -vol option cannot be used with -home
option.
JOB
INFORMATION
-ejobs Export all scheduled, pending, and completed
jobs.
-erequests Export all scheduled, pending, and completed
jobs. Identical to -ejobs option.
OUTPUT
-output <directory> Specifies the root directory that holds the exported
volume information. The default directory is ./
export, the directory export in the current
directory.
Acexport creates the root directory named export if it does not exist. The
default output location is ./export. Specify the export directory name using
the -output option.
The -type option allows specifying any registered file type.
Privilege and notification information is maintained for each exported object.
Use either the -vol and -path options or the -home option to specify the Report
Encyclopedia volume to export. To find the volumes directory, use the
Actuate Management Console to display the report server systems volumes
and associated partitions and display the directory assigned to the partition.
If you do not specify a volume, acexport exports the default volume for the
current node. The default volume is the volume managed by the report server
node on the machine running acexport.
The default option for export is -all.
This example exports the administration information and two directories
/western and /midwest from the volume regions and places the exported
information in the directory newdir:
acexport -vol regions -config /configs/cluster1 e-admin -ref /western /midwest
-output newvol
An administrator can import the exported information into a new volume.
This example exports all of the volume data in the directory
D:\Marketing\Acserver. The export directory is named Daily and is placed in
C:\Backup:
acexport -all -home d:\marketing\acserver -output c:\backup\daily
This command exports all the administrative information and just the latest
version of items in the volume. The export directory is C:\mytemp\cleanup:
acexport -eadmin -latest -ref -output c:\mytemp\cleanup
This example exports users, roles, groups and channels to the default export
directory encyc in the current directory:
acexport -eusers -egroups -echannels
Using acextern
The command-line utility acextern converts existing user administration
information in a Report Encyclopedia volume for use with an RSSE
application that uses an existing external security source.
Use the acextern utility when changing the volume security scheme from
using the default Report Encyclopedia volume security where the
administration information is stored internally to using the Actuate open
security RSSE application that uses an existing external security source.
Because acextern works directly with Report Encyclopedia volume files, back
up your existing volume before you use the utility.
The acextern utility uses the Actuate ICU library. You might need to specify
If you are using an RSSE application with a new volume without any users,
roles, or other report objects, you do not need to use this utility.
The systems user account that runs acextern must have the appropriate
permissions to access the volume files and the RSSE library. You must take the
volume offline before using acextern.
The following are acextern options.
Option Description
-adminRole <role> Optional parameter specifies the name of
the role that will be the administrator role.
-adminUser <user> Optional parameter specifies the name of a
user that will represent the administrator
user.
-allRole <role> Optional parameter specifies the name of
the role that will be the all role.
-config <path> Optional parameter specifies the path to
the directory holding the report server
configuration file. The default is the local
machines configuration file directory
<server home>/etc.
-operatorRole <role> Optional parameter specifies the name of
the role that will be the operator role.
-restore Optional parameter used only for
recovering when the acextern aborts or
exits without completing conversion. The
files before conversion are restored.
-RSSE <library> Optional parameter specifies the location
of an RSSE library to use to validate
existing references to users and roles. If this
option is not used, all users, roles, and
groups are externalized without validation.
If the acextern -RSSE option is used, acextern uses the RSSE application to
validate each Actuate name in the Report Encyclopedia volume. If the name
does not exist in the external security source, the reference to the user or role is
removed from the volume. The acextern utility validates the following
information:
I Privilege rules (access control lists) on folders and files in the Report
Encyclopedia volume
I Privilege rules in scheduled jobs
I Privilege rules on channels
I Report job notification settings
Using acimport
Acimport imports report volume administration information such as user and
role information and a volumes files and folders from a valid volume export
directory. Acimport is release specific and is used with the same version
volumes. For example, acimport shipped with Actuate Release 6 creates
volumes in Release 6 format. To upgrade from pre-Release 6 Report
Encyclopedia use acupgrade. For information about acupgrade, see Using
acupgrade, earlier in this chapter.
Use acimport to import information from a directory that contains Release 6
volume information to a target volume. A report volume consists of an encyc
directory and files and folders in the directory. If you specify a location that
does not contain an encyc directory, acimport creates the encyc directory and
any required files and folders in the directory before importing the volume
information.
-server <server name> Optional parameter specifies the report
server name in the report server
configuration file. The default to the local
machine name.
-vol <volume name> Optional parameter specifies the report
server volume name to convert. Default is
the first volume managed by the report
server. The name must be a valid volume in
the report server configuration file. See the
-config option for information about
specifying the configuration file.
Option Description
If the administrator user of the exported Report Encyclopedia volume has a
password, you must use the -password option and enter the administrator
password when importing data from the volume. If the administrator has a
password and the -password is not used, a prompt is displayed stating the
passwords do not match. If the administrator has no password, or the
administrator user was not saved in the exported volume, a password is not
required.
Because acimport works directly with volume files, back up your existing
volume before using the utility.
The acimport utility uses the Actuate ICU library.You might need to specify
Acimport and acexport cannot be used to transfer information between a
volume that uses the open security and one that does not use open security.
For information, see Importing and exporting data with open security in
Acimport creates a log file containing information such as missing
dependency information, and dropping, and warning messages. The log file is
AcDBUtil.log in the AC_SEVER_HOME/log directory.
Importing volume information
The administrator can set options to specify what data is imported into a
Report Encyclopedia volume. The administrator has control over information
such as user, roles, and volume folders, reports, and other files.
Importing users, security roles, and groups
The administrator can specify that users, roles, and groups be imported to the
target volume and specify what to do when information conflicts. The options
are either to override the existing information or keep the existing information.
Importing information from an export directory does not change any
Administrator settings or passwords of users in the target volume. For
example, the volume Administrators password and e-mail settings do not
change. Even if you specify overriding information using the force option,
the Administrator settings and passwords of users are not changed. You can
use the force option to change user properties such as the users e-mail
address.
If a user creates a new Report Encyclopedia volume using acimport, the
Administrator user information from the export directory is not used. An
volume Administrator user is created in every new volume before acimport
adds the data to the new volume and acimport does not change the volume
Administrator information when importing data. The volume Administrator
user in the new volume has the default settings, no password, and no role or
group information.
Importing directories, files, and file versions
The administrator can import all or part of the data from an export directory.
The administrator can specify which folders can be imported from the export
directory. Dependencies are maintained where possible. For information about
exporting and dependencies, see Using acexport, earlier in this chapter.
I Requesting that imported files and folders whose names match existing
files and folders replace the existing ones. Note that in this case, existing
files in the target server that depend on the replaced file will have their
dependencies broken. The import program issues a warning.
I Requesting that imported files and folders whose names match existing
ones become new versions of existing files and folders.
I Requesting that if any naming conflicts exist between files and folders in an
existing directory and imported files and folders that the imported ones be
placed in a parallel subdirectory. The name of the subdirectory is the name
of the original directory with string _Copynnn appended. The nnn is a
three-digit number.
Privileges are created for imported files and folders only if the privileges
involve roles and users already present in the target volume or involve roles
and users created during import. The administrator is assigned ownership and
privileges if the existing associations cannot be made for the imported files
and folders in the target volume.
The administrator has the option of turning off the import for all or any subset
of the subdirectories exported.
Importing channels
The administrator can import all or no channels.
Importing printers
The administrator can request that exported printers be imported. Printing
architectures or environments may not be compatible between the source and
target servers. The program warns the administrator when such a problem
arises.
Importing jobs
The administrator can request that scheduled, pending, and completed jobs
corresponding to imported files be imported as well. When importing jobs,
acimport also imports related input and output files. Acimport replaces the
existing jobs and files.
About acimport options
The following table lists the acimport options.
Import option Description
ADMINISTRATION
INFORMATION
-iadmin Import all administration information from
export directory.
-ichannels Import channels from the export directory.
-iusers Import users and roles from the export directory.
-ifiletypes Import filetype information from the export
directory.
-igroups Import groups from the export directory.
-iprinters Import printers from the export directory.
FILES AND FOLDERS
-all Import entire exported volume.
-iallf Import all files and folders from exported volume.
-if <export_f1>
<export_f2>
Import files exported from specified folders.
Specify fully qualified path from the volume root
folder, for example, /user1/test.
-mf <old_dir1>
<new_dir1> <old_dir2>
<new_dir2>
Import objects exported from given folders in
source repository, but move (rename) objects to
reside in different folders. Specify fully qualified
path from the volume root folder, for example,
/user1/test.
-rename If an imported folder contains any items whose
names conflict with existing items, the imported
folder is renamed and the imported objects are
placed in the renamed folder.
-replace Imported files and folders replace any existing
items with the same name. If a replaced file has a
dependency, a warning is issued, the dependency
is broken, and the file is replaced.
-type <file_type1>
<file_type2>
Import objects of given file types.
-version Imported files and folders become new versions
of existing items with the same name. This is the
default among -replace, -version, and -rename.
GENERAL
-acf Optionally use the acf option with the all option
to import a Report Encyclopedia volume to single
Actuate export .acf file. The .acf file must be
created with the same version acimport utility.
When importing data from an .acf file you must
use all option with the output option and
specify the fully qualified path and file name to
the .acf file. Use only the all option and the
output option when importing data from an .acf
file.
-all Import all information. Equivalent to
-allf -admin -jobs.
Administrator settings are not changed. For
example, the Administrators password and
e-mail are not changed.
-config <path to
configuration file>
Specify the path to the report server system
configuration file. The -config option is used with
the -vol option. If using import on a non-master
server node, the -config option specifies the
configuration file.
-force When importing administration information, if
conflicts exist between existing and imported
information, imported information takes
precedence over the existing information. By
default, existing information takes precedence.
Administrator settings are not changed. For
example, the Administrators password and
e-mail are not changed.
-home <directory> Specify the location of the target volume that
receives the volume data. If the location does not
contain an encyc directory, acimport creates the
encyc directory and any required volume files and
folders in before importing the volume
information. The default is the current directory.
Cannot be used with -vol option.
Use either the -vol and -path options or the -home option to specify the target
Report Encyclopedia volume that receives that volume data. If you do not
specify a target volume, the default volume is the volume managed by the
report server node on the machine running acimport.
To find the volumes directory, use the Actuate Management Console to
display the report server systems volumes and associated partitions and
display the directory assigned to the partition.
This example imports all the volume information from C:\Backup\Test and
overwrites any conflicting administration information and versions any
duplicate volume items. The target volume is assumed to be in the current
directory:
acimport -all -force -version -from c:\backup\test
This example imports all report items into the volume in the directory D:\
Marketing\Acserver. Any duplicate files are overwritten. The export directory
is named daily and is in C:\Backup:
acimport -allf -replace -home d:\marketing\acserver -input c:\backup\daily
-input <directory> Specify the directory containing the exported
volume data. When importing data from a single
.acf file, you must specify the fully qualified path
and the .acf file name.
-password <password> Specify the password for the exported Report
Encyclopedia volume administrator user. A
prompt is displayed if the administrator user has
a password and the -password is not used.
-vol <volume name> Specify the name of the target volume that
receives the volume data. The name must
reference a valid volume in the server
configuration file. Use the -path option to specify
a configuration file. Acimport imports the
information to the volume based on the report
server system configuration. The name must
reference a valid report server volume. Cannot be
used with -home option.
JOB
INFORMATION
-ijobs Import all scheduled, pending, and completed
jobs.
-irequests Import all scheduled, pending, and completed
jobs. Identical to -ijobs option.
This command uses the export directory newdir and imports two directories
/region/western and /region/midwest into a Report Encyclopedia:
acimport -if /region/western /region/midwest -from newdir
The following example, assumes you created the export directory Admin-defs
that contains the volume user, role, and group definitions.
acimport -home c:\actuate6\server -iadmin -from admin-defs
Using acintern
The command-line utility acintern converts existing Report Encyclopedia
volume user administration information for use with the default Actuate
Report Encyclopedia volume security. Use the acintern utility when changing
the volume security scheme from using the Actuate open security RSSE
application that uses an existing external security source to using default
Report Encyclopedia volume security where the administration information is
stored internally.
Because acintern works directly with volume files, back up your existing
volume before you use the utility.
The acimport utility uses the Actuate ICU library. You might need to specify
For each name reference in the volume, acintern looks up the corresponding
volume ID and changes the reference to a volume internal ID. If there is no
corresponding internal ID the name reference is removed.
The systems user account that runs acextern must have the appropriate
permissions to access the volume files and the RSSE library. You must take the
volume offline before using acintern. The following are acintern options:
Option Description
-adminUser <user> Optional parameter changes name specified in
adminUser to administrator
-config <path> Optional parameter specifies the path to the
directory holding the report server
configuration file. The default is the local
machines configuration file directory <server
home>/etc
The acintern utility modifies the same volume information as acextern. The
option -restore is provided for acintern. This option is used only for recovery
-forceGroup Remove group information. References to
groups in volume used with External
Registration are deleted. This option deletes
volume administration information, use this
option with caution.
-forceRole Force conversion of role list to only the internal
roles administrator, operator and all.
References to other roles in the volume used
with External Registration are deleted. This
option deletes volume administration
information, use this option with caution.
-forceUser Force conversion of user list to only the
administrator. This option deletes references to
other all users when converting to internal
information. Ownership of all objects created
by other users under External Registration
transferred to the administrator user. This
option deletes volume administration
information, use this option with caution.
-restore Restore data files from back up if acintern
aborts or exits without completing conversion
of volume data.
-RSSE <library> Optional parameter specifies the location of the
RSSE library used to validate existing
references to users and roles. If this option is
not used all users, roles, and groups are
converted to internal users, roles, and groups
without validation.
-server <server name> Optional parameter specifies the report server
name in the report server configuration file.
The default to the local machine name.
-vol <volume name> Optional parameter specifies the report server
volume name to convert. Default is the first
volume managed by the report server. The
name must be a valid volume in the report
server configuration file. See the -config option
for information about specifying the
configuration file.
Option Description
when the acintern aborts or exits without completing conversion. The files
before conversion are restored.
Using acmode
The command-line utility acmode places an online Report Encyclopedia
volume in and out of online backup mode, or to check the mode of a volume.
Actuate e.Reporting Server online backup mode is a report server state in
which the volume remains in a consistent state so that an external application
can make back up a snapshot of the volume. A system administrator can use
the backup to restore a working volume.
Since only Actuate volume users assigned to the operator role can change the
state of the server. Running acmode requires the user name and password of
an Actuate volume user who is a member of the operator role.
The acmode utility uses the Actuate ICU library.You might need to specify the
location of the library with the ICU_DATA environment variable. The Actuate
installation process sets ICU_DATA for the report server.
The following table lists acmode options.
Option Description
-C Display the current mode.
-D <mode> Specify a mode either normal or backup to
transition the volume to the mode. Specify -C to
display the current mode.
-H Displays a summary of the options in the
command window
-M <machine name> Specify the name or IP address of the machine
running the report server. In a report server
cluster the machine is the cluster manager.
The default is localhost.
-Port <port number> Specify the port number the report server uses
for SOAP messages. The default is 8000.
-U <username>
-P <password>
Specify the required user name and optionally
the password of the user who is a member of
the Operator role. The default for -P is , no
password.
-V Displays the version in the command window
-Vol <volume> Specify the required volume name.
The option letters s can be either in upper case or lower case. If the values
contain special characters such as a - dash or space, the values must be
enclosed in double quotation marks.
When working on a report server machine managing a single volume, you
don not need to specify the volume. If the report server manages more than
one volume, acmode lists the volumes. Use the -Vol option to specify the
volume.
When backing up a volume that is in online backup mode, do not back up the
volumes transaction log directory. You can specify a different partition for the
transaction log directory or exclude the transaction log directory from the
backup. For information about specifying the transaction log partition, see
Viewing volume information in Chapter 4, Performing system
This example connects to the local server as user Administrator with password
secret and put volume sales into online backup mode:
acmode -Vsales -Dbackup -UAdministrator -Psecret
This example connects to machine actuserver as user bkop and checks the
current mode of volume named default. The report server binds to the port
8008 for SOAP messages.
acmode -M actuserver -S 8009 -C -U bkop -P secret -V default
Using actoc
The command-line utility Actoc lets a user list the contents of an export
directory. You can list all or part of the contents of the export directory
The actoc utility uses the Actuate ICU library. You might need to specify the
The following are the actoc options: .
List option Description
ADMINISTRATION
INFORMATION
-admin List all administration information.
GENERAL
-all List contents of entire export file.
Using acupgrade
The acupgrade command-line utility converts and upgrades an a pre-Release 6
Report Encyclopedia volume to the current release version. Use acupgrade to
convert a Release 3, 4, or 5 Report Encyclopedia to work with the current
release e.Reporting Server. For information about upgrading Report
Encyclopedia volumes, see Upgrading to Actuate e.Reporting Suite 6.
I The report servers managing the previous release and current release
Report Encyclopedia volumes must be offline when using acupgrade. You
must rename or remove the encyc folder in the target current release report
-input <directory> Specifies the export directory to be
used. To display information from
an Actuate .acf file you must use the
all option with the input option
and specify the fully qualified path
and file name to the .acf file. The .acf
file must be created with the same
version acexport utility.
-what List file format version, source
server name and location,
parameters for acexport (or
acimport), time of export file
creation, and other related
information.
JOB
INFORMATION
-requests List all jobs associated with objects
listed when running actoc.
OBJECTS
-folders List directories pulled from the
source server and those excluded as
well.
-objects List all directories and all objects
included in the export file.
-rfolders List every directory pulled from the
source server, including those that
are subfolders exported through
recursion.
List option Description
server home directory $AC_SERVER_HOME/encyc before using
acupgrade.
I The acupgrade utility converts a Report Encyclopedia volume that is in the
admin, request, and object directories. The utility does not convert an
exported Report Encyclopedia volume that is in an .acf file.
I During conversion, acupgrade creates a copy of the admin, request, and
object directories in new report server home directory.
I If the export location specified by the -home option is not a valid
e.Reporting Server home directory, acupgrade does not convert the Report
Encyclopedia.
I If the old Report Encyclopedia volume uses an external security source and
an RSSE application, you must use the -external option. You must also use
the -rsse option if the location of the RSSE application is not
AC_SERVER_HOME\rsse\ldap\rsse.dll.
I Acupgrade converts notices in the old Report Encyclopedia to completed
jobs. Acupgrade does not add a name to the completed job. The completed
job name is blank in the converted volume.
I If the old Report Encyclopedia uses the Actuate autoarchive feature with
archive before deletion, as system administrator you must specify the
archive driver in the in volume properties general of the converted volume.
For information about volume properties general, see Viewing volume
information in Chapter 4, Performing system administration tasks.
If files in the volume use archive before deleting setting without an archive
driver, the files are not deleted from the volume when the report server
performs archiving. For information about autoarchive, see Archiving
files in Chapter 11, Managing e.reporting system resources.
I After converting an old Report Encyclopedia that contains user defined file
types and icons for the file types, the icons do not appear for the file types
when a user browses the converted volume.
As volume administrator, specify icons for file type in the volumes File
Types page. For information about the File Types page, see Understanding
the File Types page.Understanding the File Types page in Chapter 13,
Understanding Actuate e.Reporting Server options.
I The acupgrade utility shortens the following names:
I Report Encyclopedia folders names are truncated to 100 characters.
I Short file type descriptions are truncated to 40 characters, long file type
descriptions are truncated to 60 characters.
Acupgrade replaces the characters ;, *, ?, <, >, and " in volume names. If the
character is at the beginning or end of a name, acexport replaces the
character with an exclamation point ( ! ), otherwise acexport replaces the
character with a space.
Acupgrade creates a log file containing old and new names in the file
named truncate_<upgrade date>.log in the AC_SEVER_HOME/log
directory.
I A Japanese Release 5 Report Encyclopedia uses Shift JIS (SJIS) encoding
internally. If the machine running acupgrade uses EUC encoding or you
specify EUC with the -encoding option, acupgrade converts the Report
Encyclopedia using SJIS.
The acupgrade utility creates a log file containing conversion information in
the AC_SEVER_HOME/log directory.
The acupgrade utility uses the Actuate ICU library.You might need to specify
About acupgrade options
The following table describes the options available with acupgrade.
Option Description
-copy Convert an Report Encyclopedia volume
and create a copy of original one in the
new report server home.
-encoding <encoding> Specify an Actuate supported code page
or encoding if the old Report
Encyclopedia uses different encoding than
the machines system encoding. Default is
system encoding. For information about
valid code page and encoding values, see
Chapter 3, Understanding report
encoding, in e.Reporting for Multiple
Locales.
-external Convert an externalized Report
Encyclopedia volume used with an
Actuate RSSE application. External
security system used with RSSE
application must be running and
accessible. Default RSSE application
library path is AC_SERVER_HOME\rsse\
ldap\rsse.dll. Use -rsse option to specify
the Actuate RSSE application used with
the volume.
If the volume administrator in the existing Report Encyclopedia volume does
not have a password, use the following command to convert the volume:
acupgrade [-oldhome <home> ... ]
The following command using the -password option with no value also
converts the volume:
acupgrade -password [-oldhome <home> ... ]
If the volume administrator in the existing Report Encyclopedia volume has a
password, use the following command to convert the volume:
acupgrade -password <pwd> [-oldhome <home> ... ]
If you enter an incorrect password or do not specify a password the
conversion will fail.
When using an RSSE application, the system administrator can specify special
Actuate users and roles such as the Administrator user and operator role.
Using the -RSSE option maintains the users and roles.
-help Display help information
-nocheck Disable check for corruption in old data
store.
-nodisplay Disable display of information during
processing.
-oldhome <old server dir> Specify the directory of the old Report
Encyclopedia containing the admin,
object, request directories. The Report
Encyclopedia is converted and placed in
theAC_SERVER_HOME directory.
-password <password> Specify the old Report Encyclopedia
volume administrators password. Default
is a blank password.
-rsse <library path> Specify the fully qualified path to the
Actuate RSSE application used with the
Report Encyclopedia volume. Used with -
external option to convert an externalized
Report Encyclopedia used with an Actuate
RSSE application.
Option Description
Using acverify
The acverify command-line utility validates a Report Encyclopedia volume
and optionally attempts to repair problems found in the volume. Use acverify
with an offline volume. It cannot be used with an online volume.
Administrators can run the acverify on a regular basis to ensure the health of
their volume. Use acverify after the following events to detect volume
corruption:
I When a report server performance problem is observed that is associated
with a specific volume.
I When a report server error message or a report server log entry indicates
that there is a possible volume corruption
I After a report server crash or an abnormal shutdown that may leave the
volume in an inconsistent state
I After restoring a volume from a archive created while the report server was
in online backup mode
I Using the -check jobs option or -check jobs -repair option deletes the
completed notices associated with deleted users.
The acverify utility uses the Actuate ICU library.You might need to specify the
The following table describes the acverify options.
Option Description
-check <option list> Specifies tests to perform on the Report
Encyclopedia. Valid options are db, admin, files,
jobs, restore and all. Separate multiple options
by a space.
I db option checks detailed, low level, volume
integrity.
I admin option checks administrative
information such as users, roles, groups,
channels, and printers.
I files option checks file and folder
information.
I jobs option checks job related information.
I restore option checks the volume restored
from an archived snapshot.
I all option checks all available options.
If no option is provided, the default checks are
admin, files and jobs. The db not part of the
default, because the check can be lengthy and
corruption less common.
-config <config dir> Specifies the location of the report server system
configuration file.
-help Display help text of the utility, including all
command line options.
-log <logfile> Specifies the name of the log file to hold
acverify messages. The default is the file
acverify.log in the current directory.
-repair If specified, acverify attempts to fix corruption
that it finds.
-server <server name> Specifies the name of the current server (on
which the utility is run). If omitted, the physical
name of the current machine is assumed.
-vol <volume name> Specifies the name of the Report Encyclopedia
volume to be checked. If omitted, the primary
volume being served by the current server is
assumed.
When using acverify with a report server cluster node, the node must be
configured to access the volume to be checked. With a standalone report
server, run acverify from the report server machine.
To access the report server volume, acverify must read the cluster
configuration file and must know the logical name of volume. Specify the
report server configuration file and Report Encyclopedia volume using the
-config, -vol, and -server options.
I Specify the location of the cluster configuration using -config. As the
default, the cluster configuration file is located in the cluster manager
machine in the directory AC_SERVER_HOME/etc. To run acverify from a
non-master cluster node machine, the system administrator must share the
configuration file directory over the network.
You do not need the -config option if you are using acverify from the
cluster manager machine, or if you are using acverify with a standalone
report server. If you do not use -config, acverify uses the
acserverconfig.xml file in the directory AC_SERVER_HOME/etc.
On Microsoft Windows server operating systems the AC_SERVER_HOME
registry entry and value is located in HKEY_LOCAL_MACHINE\
Software\Actuate\Actuate e.Reporting Server\6. On UNIX systems
AC_SERVER_HOME is an environment variable.
I Specify the volume name using -vol. The volume name is the name
assigned by the Actuate system administrator. If you do not use the -vol
option on a standalone report server or on a cluster node that is the report
server for a volume, acverify checks only primary volume managed by the
report server on the machine. Without the -vol option, acverify displays an
error if the server manages more than one volume.
I Specify the cluster node or server name running acverify using -server. Use
this option to provide the report server name when the report server name
is not the same as the machine name. This option can be omitted if the
server name is the same as the machine name. If you do not specify a server
name, acverify uses by the machine name.
The following example used on a standalone server machine checks the report
server volumes administrative information, file and folder data, and job
related information. The example does not check detailed low, level volume
information, and does not attempt to fix any errors.
$ acverify -check
The following example used on a cluster node machine, checks the volume
named Sales checks detailed low, level volume information and administrative
information for corruption. The example attempts to fix any corruption it
finds. The cluster manager's configuration file is located in the UNC path
\\ClusterMaster\Server\etc.
$ acverify -config \\ClusterMaster\Server\etc -vol Sales -check db admin
-repair
The following example checks the volume SalesVol after it has been restored
from snapshot taken while the volume was in online backup mode. Specifying
the -repair option repairs detected errors.
acverify -vol SalesVol -check restore -repair
Using the UNIX PostScript font utility
The Actuate UNIX utility fontutils installs and uninstalls PostScript fonts to
the report server. The utility is in the $AC_SERVER_HOME/bin directory. For
information about using fonts with the report server, see Printing on UNIX
in Chapter 3, Configuring the e.Reporting Server.
Before you use the fontutils utility, make sure the following path:
$AC_SERVER_HOME/lib
is appended to the library path environment variable:
I On SunOS the environment variable is LD_LIBRARY_PATH
I On AIX the environment variable is LIBPATH
I On HP-UX the environment variable is SHLIB_PATH
Installing a PostScript font
Copy the fonts .afm and .pfb files to UNIX in the $AC_SERVER_HOME/bin
directory. Convert the .afm file to UNIX format using a utility such as
dos2unix. Do not convert the .pfb file to UNIX format. Change the permissions
to readable by all users.
With the .afm and .pfb files in the $AC_SERVER_HOME/bin, use fontutils
and the following options from a command line:
fontutils -CSoftFont -T1 -1<font name> -2<font file>.afm -3 <font file>.pfb
-4<CodePage>
where font name is the name of the font used in the report and CodePage is the
fonts code page. Enclose the font name in double quotes. Font file is the name
of the .afm or .pfb font. For example, to install a font with the name Ollie Small
using the .afm and .pfb files OllieSmall.afm and OllieSmall.pfb:
fontutils -CSoftFont -T1 -1"Ollie Small" -2 OllieSmall.afm -3 OllieSmall.pfb
Uninstalling a PostScript font
To uninstall a font use the fontutils utility and the following options from a
command line:
fontutils -CSoftFont -T2 -1<font name> -4<CodePage>
where font name is the name of the font used in the report and CodePage is the
fonts code page. Enclose the font name in double quotes. For example, to
remove the font Ollie Small:
fontutils -CSoftFont -T2 -1"Ollie Small"
Understanding PostScript font conversion issues
When converting a font using Fontographer 4.1 from Macromedia, choose
FileGenerateFontFile. In the dialog box, select Advanced and in the
Encoding section, select Adobe Standard. Do not change any other options.
If you used Fontographer 4.1 from Macromedia, check the fonts KernPair
value. There is a problem in Fontographer 4.1 in which it uses incorrect
KernPair values when converting some TTF fonts.
After you have converted a font with Fontographer and installed the font
using fontutils, go to the font metrics directory:
$AC_SERVER_HOME/operation/xprinter/fontmetrics
Use the grep utility to search for the string KPX in the fonts AFM file:
grep -c KPX mynewfont.afm
Open the .afm file in a text editor, search for StartKernPairs variable, and check
the value. If the StartKernPairs number is not the same as the number
displayed using the grep utility, replace the number with the one displayed
from the grep command.
Ch a p t e r 7 , S e t t i n g e . R e p o r t i n g S e r v e r p a r a me t e r s 245
C h a p t e r
7
Chapter7Setting e.Reporting
Server parameters
I About e.Reporting Server parameters
I About registry keys and environment variables
I About Release 5 variables in Release 6
About e.Reporting Server parameters
The report server system administrator uses the Actuate Management Console
to configure the report server system. The configuration information is
maintained as a set of report server system parameters. For information about
using the Management Console and about e.Reporting Server administration,
see Chapter 4, Performing system administration tasks.
The following table lists the Actuate e.Reporting server parameters that
configure e.Reporting Servers and e.Reporting Server clusters.
Display Name
Parameter Description
Active Portal URL Prefix
Parameter:
ActivePortalURLPrefix
Used when notifying users of report
generation status using Actuate Active
Portal URL.
Takes effect: immediately.
Administrator Password
Parameter: AuthPassword
Administrator password for system or
standalone server.
Base Socket Number for Reply
To Client
Parameter:
BaseSocketNumForReply
Needed for RSAPI. Specify the start of a
range of port numbers for ports used for
communication between the report server
and clients or Actuate ReportCast. The
maximum value is 32767. If the start of the
range of port numbers is not set, the
report server ignores the range setting. If
the start of the range is set and the range is
not set, the report server uses a default
range of 1.
Takes effect: server restart.
Base Socket Number for RPC
Parameter:
BaseSocketNumForRPC
Needed for RSAPI Specify the start of a
range of port numbers the report server
attempts to use for the request server RPC
ports. The maximum value is 32767. If the
start of the range of port numbers is not
set, the report server ignores the range
setting. If the start of the range is set and
the range is not set, the report server uses
a default range of 1. The report server
starts at the BASE port and attempts to
use up to BASE + COUNT - 1 port to find
a single port.
Buffer Pool Size (MB)
Parameter name:
BufferPoolSize
Buffer pool size for Volume in MB. Default
is 10.
Takes effect: Server restart.
Cache Size For Transient
Reports (MB)
Parameter:
TransientReportCacheSize
Maximum size allowed for all reports
stored in the transient report store.
Century Break
Parameter: CenturyBreak
How the report server converts two-digit
year values into four-digit years when the
two-digit values are used. Default is 30.
Client Idle Connection Time
Out
Parameter:
IdleConnectionTimeOut
Number of seconds to keep an idle
connection open. Default is 300.
Client Reply Read Buffer Size
(Bytes)
Parameter: ReadBufferSize
Specify the packet size of the data the
report server View process sends to a
requesting process. Default is 2048 bytes.
Compress DHTML Content
Parameter:
CompressDHTMLContent
Enable or disable view server GZIP
compression of DHTML output. A value
of 1 enables compression. A value of 0
disables compression. Default is 0, or
compression disabled.
Configuration Directory
Partition
Parameter:
ConfigHomePartition
Partition for system configuration file. If
no partition is specified, default is the
AC_SERVER_HOME/etc directory.
Configuration File For
Connections
Parameter: ConnConfigFile
Configuration file provides database
connection and data source information
used by Actuate report .rox files.
Currency Format
Parameter: CurrencyFormat
Default currency format. Default is
$#,##0.00;($#,##0.00)
Custom Database Log
Directory (FileSystem)
Parameter: TransLogPartition
Report server partition of Report
Encyclopedia volume transaction log file.
Display Name
248 A d mi n i s t e r i n g A c t u a t e e . Re p o r t i n g Sy s t e m
Custom Status File Directory
(file system)
Parameter:
VolumeStatusHomeFileSystem
File system of Report Encyclopedia
volume status file.
Database log directory
minimum space
Parameter:
TansLogPartitionMinSpace
Minimum free disk space required in
volume transaction log file partition. If
less than specified amount, report server
takes volume offline. Default is 128 MB.
Date Mode
Parameter: DateMode
Specify internal formatting. Date Mode.
Values are 0 1 2. 0 is m/d/y, 1 is d/m/y, 2
is y/m/d. Default is 0.
Date Separation Character
Parameter: DateSeparationChar
Date separation character. Default is /
Default System Encoding
Parameter name:
DefaultEncoding
Default encoding for the servers in the
cluster. Default is ASCII.
Takes effect: system restart.
Default system locale
Parameter name: DefaultLocale
Default locale for the servers in the cluster.
Default is C locale.
Delay After Creating Operation
Process (Sec)
Parameter:
DelayAfterCreatingOperation
Process
Delay after creating an Factory or Print
process in seconds. Default is 2.
Delay Between Contacting
Operation Process (Sec).
Parameter:
DelayBetweenContacting
OperationProcess
Specify the time delay between attempts
to communicate with a Factory and Print
Servers. in seconds. Default is 1.
Deletion log enabled
Parameter:
DeletionLogEnabled
Enables usage and error logging. Default
is false.
Takes effect: Immediately.
Deletion log level
Parameter: DeletionLogLevel
Usage and error logging level. Values are
Standard and Advanced. Default is
Standard.
Description
Parameter name: Description
Description of the volume.
Display Name
Description
Parameter name: Description
Description of the server.
DHTML Compression Buffer
Size (Bytes)
Parameter:
CompressionBufferSize
Specify the view server compression
buffer size. The default buffer size is
16,384 bytes, or 16KB.
DHTML Compression Level
Parameter: CompressionLevel
Specify the view server GZIP compression
level. Integer from 0 to 9. The default level
is 7.
DHTML Generator Information
Parameter:
DHTMLGeneratorInfo
DHTML Generator Information.
e.Analysis: Auto-Resize Vertical
Axis
Parameter:
eAnalysisAutoResizeVertical
Axis
Automatically expand the rows to fill the
height of the data display area. Boolean.
Default is true.
e.Analysis: Combine Pie Chart
subcategories that are less than
this % of total
Parameter:
eAnalysisPieChartCombine
Minimum
Combine Pie Chart subcategories that are
less than this percentage of total. Default
is 3.
e.Analysis: Decimal Points
Parameter:
eAnalysisDecimalPoint
Decimal precision. Default is 3.
e.Analysis: Hide Calculate Item
Parameter:
eAnalysisHideCalculate
Display calculated function columns in
e.Analysis graphs. Default is false.
e.Analysis: Hide Help Item
Parameter: eAnalysisHideHelp
Hide e.Analysis help. Default is false.
e.Analysis: Hide Home Button
Parameter:
eAnalysisHideHome
Hide e.Analysis home button. Default is
false.
e.Analysis: Hide Horizontal Bar
Chart Item
Parameter:
eAnalysisHideHorizontalBar
Chart
Hide e.Analysis horizontal bar chart item.
Default is false.
Display Name
e.Analysis: Hide Horizontal Fit
to Page Item
Parameter:
eAnalysisHideHorizontalFitTo
Page
Hide e.Analysis horizontal fit to page
item. Default is false.
e.Analysis: Hide Line Graph
Item
Parameter:
eAnalysisHideLineGraph
Hide e.Analysis line graph item. Default is
false.
e.Analysis: Hide Pie Chart Item
Parameter:
eAnalysisHidePieChart
Hide e.Analysis pie chart item. Default is
false.
e.Analysis: Hide Preferences
Item
Parameter:
eAnalysisHidePreferences
Hide e.Analysis preferences item. Default
is false.
e.Analysis: Hide Print Button
Parameter: eAnalysisHidePrint
Hide e.Analysis print item. Default is
false.
e.Analysis: Hide Save As
Microsoft Excel Item
Parameter:
eAnalysisHideSaveAsMicrosoft
Excel
Hide e.Analysis Save a Microsoft Excel
e.Analysis: Hide Save As
Microsoft Word Item
Parameter:
eAnalysisHideSaveAsMicrosoft
Word
Hide e.Analysis Save a Microsoft Word
e.Analysis: Hide Save Button
Parameter: eAnalysisHideSave
Hide e.Analysis Save item. Default is
false.
e.Analysis: Hide Table View
Item
Parameter:
eAnalysisHideTableView
Hide e.Analysis table view item. Default is
false.
e.Analysis: Hide Vertical Bar
Chart Item
Parameter:
eAnalysisHideVerticalBarChart
Hide e.Analysis vertical bar chart item.
Default is false
Display Name
e.Analysis: Hide Vertical Fit to
Page Item
Parameter:
eAnalysisHideVerticalFitTo
Page
Hide e.Analysis fit vertical to page item.
Default is false.
e.Analysis: Hide Work Offline
Button
Parameter:
eAnalysisHideWorkOffline
Hide e.Analysis work offline button.
Default is false
e.Analysis: Horizontal Axis
Color
Parameter:
eAnalysisHorizontalAxisColor
e.Analysis horizontal axis color. Default is
158, 158, 207.
e.Analysis: Main Title
Parameter: eAnalysisMainTitle
e.Analysis default main title text. Default
is Main Title.
e.Analysis: Show 3D
Histograms
Parameter:
eAnalysisShowHistogramIn3D
Show e.Analysis 3D Histograms. Default
is true.
e.Analysis: Show 3D Pie Chart
graphs
Parameter:
eAnalysisShowPieChartIn3D
Show e.Analysis 3D pie chart graphs.
Default is true.
e.Analysis: Show Column totals
Parameter:
eAnalysisShowColumnTotals
Show e.Analysis column totals. Default is
false.
e.Analysis: Show columns with
all zeros
Parameter:
eAnalysisShowZeroColumns
Show e.Analysis columns with all zeros.
Default is true.
e.Analysis: Show columns with
no data
Parameter:
eAnalysisShowEmptyColumns
Show columns with no data. Default is
true.
e.Analysis: Show Drill Controls
Parameter:
eAnalysisShowDrillControls
Show e.Analysis drill controls. Default is
true.
Display Name
e.Analysis: Show Empty Rows
Parameter:
eAnalysisShowEmptyRows
Show rows with no data. Default is false
e.Analysis: Show Grid Lines
Parameter:
eAnalysisShowGridLines
Show e.Analysis grid lines. Default is true.
e.Analysis: Show hierarchy of
column sub categories
Parameter:
eAnalysisShowColumnLevels
Show hierarchy of column sub categories
in e.Analysis. Default is true.
e.Analysis: Show Histogram
data values as numeric
Parameter:
eAnalysisShowHistogram
Values
Show e.Analysis histogram data values as
numeric data. Default is true
e.Analysis: Show Histogram
data values as percent
Parameter:
Percent
Show e.Analysis Histogram data values
as percent. Default is false.
e.Analysis: Show leading
Column totals
Parameter:
Leading
Show e.Analysis leading column totals.
Default is true.
e.Analysis: Show leading
Variable totals
Parameter:
eAnalysisShowVariableTotals
Leading
Show e.Analysis leading variable totals.
Default is true.
e.Analysis: Show Line Graph
data values as numeric
Parameter:
eAnalysisShowLineValues
Show e.Analysis line graph data values as
numeric data. Default is false.
data values as percent
Parameter:
eAnalysisShowLinePercent
Show e.Analysis line graph data values as
percent. Default is false.
Display Name
subcategory labels
Parameter:
eAnalysisShowLineLabels
Show e.Analysis line graph subcategory
labels. Default is false.
e.Analysis: Show Pie Chart data
values as numeric
Parameter:
eAnalysisShowPieChartValues
Show e.Analysis pie chart data values as
numeric data. Default is true.
e.Analysis: Show Pie Chart data
values as percent
Parameter:
eAnalysisShowPieChartPercent
Show e.Analysis pie chart data values as
percent. Default is true.
e.Analysis: Show Pie Chart sub
category label
Parameter:
eAnalysisShowPieChartLabels
Show e.Analysis pie chart sub category
label. Default is true.
e.Analysis: Show Variable
Levels
Parameter:
eAnalysisShowVariableLevels
Show e.Analysis variable levels. Default is
true.
e.Analysis: Show Variable
Totals
Parameter:
eAnalysisShowVariableTotals
Show e.Analysis variable totals. Default is
false.
e.Analysis: Show Zero
Variables
Parameter:
eAnalysisShowZeroVariables
Show e.Analysis zero rows. Default is
false.
e.Analysis: Vertical Axis Color
Parameter:
eAnalysisVerticalAxisColor
e.Analysis vertical axis color Default is
158, 207, 178.
e.Analysis: Watermark
Parameter:
eAnalysisWatermark
e.Analysis watermark. Default is
daedclejcpafef
e.Analysis: Window Title
Parameter:
eAnalysisWindowTitle
e.Analysis window title. Default is
Actuate e.Analysis.
Display Name
e.SpreadSheet Server Port
Number
Parameter:
eSpreadSheetServerPort
Port used for e.Spreadsheet server.
Default is 1568.
Enable Generation Service
Parameter name:
EnableGenerationService
Flag to enable or disable the generation
service. Default is false.
Enable Logging For All
Processes
Parameter: LoggingOn
Enable server-wide logging.
Enable Open Security
Parameter name:
EnableOpenSecurity
Flag to enable/disable open security.
Default is false.
Takes effect: Server restart.
Enable Page Level Security
Caching
Parameter name:
EnablePageSecureCaching
Flag to enable or disable the caching of
data when viewing Actuate e.reports with
page level security. Available only on
UNIX systems. Default is false.
Enable Request Service
Parameter name:
EnableRequestService
Flag to enable/disable the request service.
Default is false.
Enable Viewing Service
Parameter name:
EnableViewingService
Flag to enable or disable the viewing
service. Default is false.
Error log enabled
Parameter: ErrorLogEnabled
is false.
Error log level
Parameter: ErrorLogLevel
Standard.
Error logging extension name
Parameter:
ErrorLoggingExtensionName
Name of error logging .dll or shared
library. Default value is ErrorLoggingExt.
File Types Processed By this
Service
Parameter: FileTypeList
List of Report Encyclopedia file types
processed by reporting service.
Display Name
Generation log enabled
Parameter:
GenerationLogEnabled
is false.
Generation log level
Parameter:
GenerationLogLevel
Standard.
Heartbeat Failure Period
Parameter:
HeartbeatFailurePeriod
Interval in seconds before detecting that
the server has failed because periodic
communication was not received. Default
is 90.
Heartbeat Send Interval
Parameter:
HeartbeatSendPeriod
Interval in seconds between sending two
communication messages. Default is 30.
Internal Idle Connection Time
Out
Parameter:
InternalIdleConnectionTime
Out
Number of seconds to keep an idle
connection open. Default is 300.
Interval Before Purging Expired
Scheduled Requests (Seconds)
Parameter:
IntervalBeforePurgingExpired
ScheduledRequests
Set the length of time after which to
remove expired scheduled requests, in
seconds. Default is 86400, or 24 hours.
IP Address for Server SOAP
Endpoint
Parameter: ServerIPAddress
IP Address for Server SOAP Endpoint.
Location Of Disk Cache For
Transient Reports
Parameter:
TransientReportCacheLocation
The path to the transient report cache.
Location of FileSystem relative
to the Server
Parameter: Path
Location of file system relative to the
server.
Log Directory for Print
Processes
Parameter:
PrintProcessLogDirectory
Directory for Print processes logs.
Display Name
Log Directory
Parameter:
FactoryProcessLogDirectory
Directory for Factory processes log.
Log Directory
Parameter: LogDirectory
Directory of View service log file.
Log Directory
Parameter: LogDirectory
Directory for log file for core server.
Log Level for Print Processes
Parameter:
PrintProcessLogLevel
Level of logging for print process logging.
Range is from 0 to 8000
Log Level
Parameter:
FactoryProcessLogLevel
Level of logging for Factory process
logging. Range is from 0 to 8000.
Log Level
Parameter: LogLevel
Logging level of View service log file.
Levels are 0 to 8000. Default is 8000.
Log Level
Parameter: LogLevel
Level of logging for server-wide logging.
Range is from 0 to 8000.
Log Size (KB)
Parameter:
FactoryProcessLogSize
Size of Factory processes log.
Log Size (KB)
Parameter: LogSize
Server-wide log size (KB)
Log Size for Print Processes
(KB)
Parameter: PrintProcessLogSize
Maximum size of print process logs.
Log Size
Parameter: LogSize
Size of View service log file.
Long Date Format
Parameter: LongDateFormat
Report server long date format for locale-
specific data. Default is dddd, MMMM
dd, yyyy.
Max Page Level Security Cache
Size
Parameter name:
MaxProgramExecCacheSizePer
Process
Specify the maximum size of the cache
used when caching data for page level
security is enabled. Default is 300 MB.
Display Name
Maximum ACL Buffer Size
(Bytes)
Parameter:
RSSEMaxACLBufferSize
Open Security for Volume. Maximum
buffer size for ACL used by RSSE
application.
Maximum Cached Sessions Per
Process
Parameter:
SessionCacheSizePerProcess
Maximum number of view sessions (user
and .roi files) in the view session cache.
Default is 4096.
Maximum concurrent requests
Parameter name:
MaxConcurrentRequests
View Process max pending operations.
Default is 128.
Maximum Execution Time for
Transient Reports (Seconds)
Parameter:
MaxSyncJobRuntime
Maximum time allowed to complete the
transient or synchronous report
generation. Range is from 0 to 999. Default
is 300 seconds
Maximum File Cache Entries
Per Process
Parameter:
MaxFileCacheEntriesPer
Process
Maximum file cache entries per View
process. Default is 3000. Values from 5 to
20000. Cache for images, graphs, search
results, TOC an other related files.
Maximum File Cache Size Per
Process (MB)
Parameter:
MaxFileCacheSizePerProcess
Maximum file cache size per View
process. Default is 64 MB.
Maximum Log size for volume
(MB)
Parameter: MaxLogSize
Maximum log size for volume.
Maximum number of cached
ROX files
Parameter:
MaxROXCacheSizePerProcess
Maximum number of cached .rox files for
View process. Default is 128.
Maximum number of
connections
Parameter:
MaxEndpointThreads
Determines the maximum number of
threads. The maximum number of
connections which can be supported by
the SOAP end point. Default is 1000.
Display Name
Maximum Number of CSS
Template Classes
Parameter:
CSSTemplateClassLimit
Specify the maximum number of Actuate
report classes allowed in a report that uses
cascading style sheets. Default is 400.
Maximum number of elements
that can be returned in one
RSAPI request
Parameter: RSAPIFetchLimit
For applications that use the Actuate
Report Server API, specifies the maximum
number of elements returned. Default is
50000 elements.
Maximum Number Of Factory
Processes
Parameter:
MaxFactoryProcesses
Maximum number of print processes per
locale.
Maximum Number of File
Descriptors on UNIX
Parameter:
MaxFileDescriptorsOnUnix
UNIX only. Controls the maximum
number of file descriptors the report
server or ReportCast process can have
open in Each Server Process. Default: no
value is set.
Maximum Number of Pages
Convertible To Excel
Parameter:
MaxPagesConvertibleToExcel
Maximum number of pages convertible to
Excel format. Default is 50
Maximum Number Of Print
Processes
Parameter: MaxPrintProcesses
Maximum number of Factory processes
per Locale. Default is 4.
Maximum number of Processes
Parameter: MaxProcesses
Maximum number of View Processes per
Locale. Range is from 0 to 128. Default is 1
Maximum Number of Threads
Per Process
Parameter:
MaxThreadsPerProcess
Maximum he number of concurrent
service threads allowed in the View server
process before the reactor slows down
picking up new messages. Default is 4.
Maximum Number of XML
Translators
Parameter:
MaxXMLTranslatorsPerProcess
Maximum number of XML translators
per View server process. Default is 9.
Display Name
Maximum Open Security Cache
Entries
Parameter: RSSECacheSize
Open Security for volume. controls how
much information is stored in The RSSE
cache at any one time. Default is 4096
entries.
Maximum timeout for cached
ROX files (seconds)
Parameter name:
MaxROXCacheSizeTimeout
View Process cache timeout for .rox files.
Retaining view server process group
setting (previously set via the RSAPI).
Default is 3600.
Message Distribution Service IP
Address
Parameter:
SOAPDispatchIPAddress
IP address for SOAP endpoint for each
SOAP Redirector.
Message Distribution Service
Port
Parameter: SOAPDispatchPort
Port for SOAP endpoint for each SOAP
Redirector. Default is 8000.
Minimum Data Packet Size for
Agent (Bytes)
Parameter: MinDataPacketSize
The data packet size sent from the report
server View server process to the agent
programs. Default is 2048 bytes.
Minimum number of Processes
Parameter: MinProcesses
Minimum number of View processes per
locale. Range is from 0 to 128. Default is 0.
Minimum Partition Disk Space
Required for File Creation (MB)
Parameter: MinFreeSpaceMB
File creation requests in partition fail if
partition free disk space is less than
MinFreeSpaceMB. Default 128 MB.
Multicast Address
Parameter: MultiCastIPAddress
Multicast Group Address used by cluster
servers to heartbeat. Default is 6003.
Multicast Packet TTL
Parameter: MulticastTTL
If using Multicast, the maximum number
of point-to-point links (hops) allowed in a
packets transmission path. Default is 1
hop.
Multicast Port
Parameter: MulticastPort
Multicast Group Port used by cluster
servers to receive heartbeat.
Display Name
Name used by Operating
System To Identify Printer
Parameter: PrinterOSName
Printer name.
Takes effect: server restart
Number of Logs
Parameter:
NumFactoryProcessLogs
Number of Factory process logs.
Number of Logs
Parameter: NumLogs
Number of View process log files.
Number of Logs
Parameter: NumLogs
Number of log for Core Server.
Number of Logs per Print
Process
Parameter:
NumPrintProcessLogs
Number of logs per print process.
Number of Requests Before
Recycling Processes
Parameter:
PrintProcessRecycleCount
Specify the number of requests that
trigger a restart of the print processes.
Default is 1000.
Number of Requests Before
Recycling Processes
Parameter:
ProcessRecycleCount
Specify the number of requests that
trigger a restart of the Factory processes.
Default is 1000.
Number of RPC Sockets
Parameter:
NumSocketsForRPC
Needed for RSAPI Specify the range of
port numbers the report server attempts
to use for the request server RPC ports.
The maximum value is 32767. If the start
of the range of port numbers is not set, the
range of 1. The report server starts at the
BASE port and attempts to use up to
BASE + COUNT - 1 port to find a single
port.
Number of seconds to wait on
SOAP Socket
Parameter:
SOAPSocketReadTimeout
Number of seconds to wait on SOAP
socket. Default is 60.
Display Name
Number of Sockets for Reply To
Client
Parameter:
NumSocketsForReply
Needed for RSAPI. Specify the range of
port numbers for ports used for
communication between the report server
and clients or Actuate ReportCast. The
maximum value is 32767. If the start of the
range of port numbers is not set, the
range of 1.
Number of Synchronous
Factory Process
Parameter:
SyncFactoryProcesses
Number of Factory process allocated for
synchronous requests. Range 0 to
maximum number of factories allowed.
Default is 2.
Number of Times To Retry
Failed Requests
Parameter: NumRequestRetries
Number of times to retry failed generation
or print requests. Default is 0.
Numbers of hours for which
the authentication id is valid
Parameter: AuthIdExpires
Numbers of hours for which the
authentication id is valid Default is 24.
Object Archive DLL Location
Parameter: ObjectArchiveDLL
Specify archive DLL or shared object used
for Auto Archive.
Object Archive Thread
Schedule
Parameter:
ObjectArchiveSchedule
Specify times to start Auto Archive
process. Default is 2:15
Open Security Library is Multi-
Thread Safe (NT Only)
Parameter:
RSSEMultiThreadSafeLibrary
Open Security for Volume. Specify the
RSSE application is multithread safe by
setting the value to true. Default is false.
Open Security Library Location
Parameter: RSSELibrary
Open Security for Volume. Specify the
DLL or shared library.
Output Directory for Runtime-
generated Excel
Parameter:
OutputDirForRuntimeExcel
Specify the full path name of the directory
to which the report server sends Excel-
format report output.
Display Name
Page Count Update Interval
(Seconds)
Parameter:
PageCountUpdateInterval
Interval between page count updates
(seconds). Default is 15.
Page Level Security Cache
Timeout
Parameter name:
ProgramExecCacheTimeout
Specify the maximum time the cache data
is available when caching data for page
level security is enabled. Default is 20
minutes
Partition State
Parameter: State
Partition status. Values are Active,
Phaseout, Unused, and Unavailable
PDF Quality (Windows Only)
Parameter:
PDFQualityOnWindows
Windows only. Specify the resolution
quality of Actuate report graph images in
PDF files. Default is 100.
Port base for internal soap
messages
Parameter:
ServerSOAPPortBase
Port base for internal soap messages.
Default is 6000.
Port count from base for
internal soap messages
Parameter:
ServerSOAPPortCount
Port count from base for internal soap
messages. Default is 100.
Port Number for Server SOAP
Endpoint
Parameter: ServerSOAPPort
Port Number for Server SOAP Endpoint
Default is 6002.
PPD File Name on UNIX
Parameter: UNIXPPDFileName
PPD file name for UNIX printer.
Primary server
Parameter name:
PrimaryServer
Primary server for the volume. The server
that is the current owner of the volume.
Printing log enabled
Parameter: PrintingLogEnabled
is false.
Printing log level
Parameter: PrintingLogLevel
Standard.
Display Name
Recycle Processes
Parameter:
RecycleFactoryProcesses
Specify whether or not to disable
automatic Factory process or print process
restarts. Default is true.
Recycle Processes
Parameter:
RecyclePrintProcesses
Specify whether or not to disable
automatic Print process or print process
restarts. Default is true.
Report Timeout for Transient
Reports (Seconds)
Parameter: SyncJobQueueWait
Maximum time a transient and
synchronous report request spends in the
queue waiting for generation. Default is
1800 Seconds.
ReportCast URL Prefix
Parameter:
ReportCastURLPrefix
Prefix for the server hosting Actuate
ReportCast.
Request Queue Size for
Transient Reports
Parameter: SyncJobQueueSize
Maximum number of requests allowed in
the transient and synchronous report
request queue. Range is from 0 to 99,999.
Default is 100.
Request Queue Timeout for
Transient Reports (Minutes)
Parameter:
TransientReportTimeOut
Maximum lifetime for a transient report.
The report server deletes the transient
report if the report has not been accessed
in the specified time.
Schedule for Purging Notices
(24-hour format)
Parameter:
ScheduleForPurgingNotices
Specify that the report server remove
requests from the volumes Requests\
Completed folder based on a specific time
criteria. The format is a list of times
separated by semicolons, in ascending
order, using a 24-hour format. For
example, 03:15;16:15. The default is 02:15.
Search Path For Images
Parameter: ImageSearchpath
Search path for run-time embedding of
images.
Search Timeout (Seconds)
Parameter: SearchTimeout
View server search timeout in seconds. If
set to zero, search operations never time
out. Default is 180.
Display Name
Secondary servers that can
manage the volume Parameter
name: ServerList
List of secondary servers that can own the
volume in case of failover.
Session Cache Timeout
(Seconds)
Parameter:
SessionCacheTimeout
The number of seconds before
invalidating the contents of a view session
cache. Default is 3600 seconds or 1 hour.
Short Date Format
Parameter: ShortDateFormat
UNIX only. locale-specific settings short
date format. Default is M/d/yy.
Socket Base For Processes
Parameter:
SocketBaseForProcesses
Still supporting RSAPI; specify the
starting number for the View process
socket port to receive the ReportCast or
client viewing requests. Must be greater
than 1024. Default is 15500.
Socket Count for Processes
Parameter:
SocketCountForProcesses
Still supporting RSAPI; Specify the range
from the base up to which the view server
socket port number can go. The sum of
AC_VIEW_SERVER_SOCKET_BASE and
AC_VIEW_SERVER_SOCKET_COUNT
must be less than 65535. Default is 200.
Spool Command On UNIX
Parameter:
UNIXSpoolCommand
Spool command used with UNIX printer.
Synchronous Reporting Weight
Parameter:
SynchReportingWeight
Value used for distributing synchronous
report requests among cluster report
servers with View service enabled.
Default is 100.
System IP Address
Parameter: SystemIPAddress
SOAP endpoint IP address for the system.
System Name
Parameter: SystemName
Name of cluster, if it belongs to one.
System Port
Parameter: SystemPort
SOAP Endpoint for the System. Default is
6001.
Display Name
Time After Which to Retry
Failed Request (Seconds)
Parameter:
RequestRetryInterval
Time after which to retry failed factory,
print requests (Seconds). Default is 0.
Time Format
Parameter: TimeFormat
UNIX only. locale-specific settings short
date format. Default is h:mm:ss tt.
Time Separation Character
Parameter:
TimeSeparationChar
UNIX only. locale-specific settings time
separator. Default is colon (:).
Timeout for Open Security
Cache (Minutes)
Parameter: RSSECacheTimeout
Open Security for Volume. Controls when
the RSSE cached information times out in
minutes. Default is 60. Minimum is 1.
Timeout for Process File Cache
(Seconds)
Parameter: FileCacheTimeout
Control the timeout of the view server file
cache.
UDP Port
Parameter: UDPPort
UDP port to use to receive heartbeat
packets if multicast is not used. Default is
6003.
URL for E-mail Notifications
Parameter: EmailURLType
Type of URL specified in e-mails. Values
are Actuate Active Portal or ReportCast.
No default value.
Usage logging extension name
Parameter:
UsageLoggingExtensionName
Name of usage logging .dll or shared
library. Default value is
UsrActivityLoggingExt.
Use as default printer
Parameter: IsDefault
Specifies default printer. Default is false.
Takes effect: immediately
Use as default volume
Parameter:
SystemDefaultVolume
Default Report Encyclopedia volume.
Use C Locale as Default on NT
Parameter:
DefaultCLocaleOnWindows
NT only: Change the Factory process
default locale to. Default is C.
Display Name
Use Externalized Font File
Parameter:
UseExternalizedFonts
Specify how to use the master_fonts.rox
file when searching for fonts when
running or viewing Actuate e.reports by
setting the value to no, primary, or
secondary. Default is no.
Use Multicast for Cluster
Heartbeats
Parameter: UseMulticast
Flag to indicate multicast should be used
for heartbeat. Default is false.
Viewing log enabled
Parameter: ViewingLogEnabled
is false.
Viewing log level
Parameter: ViewingLogLevel
Standard.
Viewing Weight
Parameter: ViewingWeight
Value used for distributing viewing
requests among cluster report servers
with View service enabled. Default is 100.
Volume data store directory
minimum space
Parameter:
PrimaryPartitionMinSpace
Minimum free disk space required in
primary volume partition. If less than
specified amount, report server takes
volume offline. Default is 128 MB.
Volume data store location
Parameter: PrimaryPartition
Encyclopedia volume primary partition.
Volume used by the Requester
and Report Server APIs
Parameter:
RequesterRSAPIVolume
Volume used by the report server for
Requester and Report Server API.
Wait Period After Process
Startup (Seconds)
Parameter:
WaitPeriodForProcessStartup
Specify the time in seconds to wait for the
reply after the report server sends the first
communication message to the View
process. The default is 30 seconds.
Display Name
About volume variables
The following variable information is stored as Report Encyclopedia volume
information.
About registry keys and environment variables
Set registry keys on Microsoft Windows server operating systems or
environment variables on UNIX systems to provide performance tuning and
to control Actuate services and application execution at a system level. For
example, use of registry keys or environment variables includes setting the
amount of free space below which the report server shuts down, improving
performance by controlling the View Server data packet size, controlling the
quality of graphs, and controlling the number of requests that restart the
printing process.
Warning Threshold for Low
Partition Disk Space (MB)
Parameter: LowFreeSpaceMB
Warning displayed if user tries to create a
file in a partition with less than
LowFreeSpaceMB free disk space. File
creation succeeds. Default 512 MB.
Window For Purging
Temporary .rov files (Seconds)
Parameter:
WindowForPurgingTempROVs
Grace period in seconds before purging
temporary .rov files. Default is 900.
Release 5 Variable Name
Reason For Retaining,
Dropping or Adding
AC_DEFAULT_VIEWING_PREFERENCE This depends on the data to
be cached.
AC_DHTML_PAGE_CACHING This depends on the data to
be cached.
AC_SERVER_LOGICAL_NAME This depends on the data to
be cached.
AC_WEB_AGENT_PAGE_CACHING This depends on the data to
be cached.
Display Name
Setting registry keys on Microsoft Windows
server operating systems
Use Registry Editor to set registry key values on Microsoft Windows server
operating systems. Set the string registry entry in the key
HKEY_LOCAL_MACHINE\Software\Actuate\Actuate e.Reporting Server\
6.
To create a registry entry:
1 Choose StartRun.
2 In Run, type:
regedit.exe
3 Choose OK.
Registry Editor presents a hierarchical list of registry keys.
4 Highlight the key HKEY_LOCAL_MACHINE\Software\Actuate\Actuate
e.Reporting Server\6.
5 To create a new string entry for the report server key, choose
EditNewString value. Change the name of the key to the name of the
registry key.
6 To change the value for the entry, highlight the entry and choose
EditModify. Enter the appropriate value or strings of values for the
registry key.
For example, to set report generation status entries:
1 Choose StartRun.
2 In Run, type:
regedit.exe
3 Choose OK.
Registry Editor presents a hierarchical list of registry keys.
4 Highlight the key HKEY_LOCAL_MACHINE\Software\Actuate\Actuate
e.Reporting Server\6.
5 To create a new string entry for the report server key, choose
EditNewString value.
6 Change the name of the key to
AC_FACTORY_PAGE_COUNT_UPDATE_INTERVAL.
7 To change the value for the entry, highlight the entry. Choose EditModify.
The value is the number of seconds.
Setting environment variables on UNIX systems
To set an environment variable value on a UNIX system using the C Shell:
$ setenv <environment variable> <value>
where <environment variable> is the name of the environment variable and
<value> is the value to set. For some environment variables, you can automate
the setting by adding the environment variable to a UNIX Shell script. For
example, add two lines similar to the following to an appropriate UNIX Shell
script to automate setting an environment variable value:
export <environment variable>
<environment variable>=<value>
where <environment variable> is the name of the environment variable and
<value> is the value to set.
About environment variables
The following sections list the Actuate registry keys on NT and Windows 2000
systems or environment variables on UNIX systems that affect configuring
e.Reporting Servers and e.Reporting Server clusters. Each section includes a
table that lists registry keys and environment variables alphabetically by type.
For more information about each registry key or environment variable see
Variable Name Description
AC_DBMS_INFORMIX_MAXVARLEN Maximum column length Actuate
uses with Informix databases.
Default is 4000.
AC_DBMS_ODBC_MAXVARLEN Maximum column length Actuate
uses with ODBC databases.
Default is 8000.
AC_DBMS_ORACLE_MAXVARLEN Maximum column length Actuate
uses with Oracle databases.
Default is 4000.
AC_DBMS_PROGRESS_MAXVARLEN Maximum column length Actuate
uses with Progress databases.
Default is 4000.
AC_SERVER_HOME Specify the home directory of the
Actuate e.Reporting Server. The
default is the directory into which
you installed e.Reporting Server
CLASSPATH Specify the location of the Java
installation.
DB2COMM DB2 information
DB2DIR The path to the DB2 client
installation
DB2INSTANCE Specifies the DB2 instance name
DISPLAY UNIX only. Specifies the X
Windows server used by the
report server.
DLC Progress 9.1 installation directory.
ICU_DATA Specify the location of the ICU text
conversion library used by
Actuate software.
INFORMIXDIR The directory where the Informix
product is installed
INFORMIXSERVER Specify the name of the Informix
database
INSTHOME Inherited from shell and used by
3rd Party processes
LANG UNIX only. Specifies the machines
language code.
LD_LIBRARY_PATH SunOS library path environment
variable.
LIBPATH AIX library path environment
variable.
ORACLE_HOME The path to the Oracle installation.
PATH Windows only. Specify the full
path names to search to locate
command executables.
SHLIB_PATH HP-UX library path environment
variable.
SYBASE The path to the Sybase installation.
SYBASE_OCS The path to the Sybase OpenClient
12.0 installation.
XPHOME UNIX only. Specifies the location
of the Actuate report server
Xprinter home.
About Release 5 variables in Release 6
The following table lists Release 6 parameters and the corresponding Release 5
variables.
XPPATH UNIX only. Specifies the path to
the Actuate report server Xprinter
files.
XVFBDISPLAY UNIX only. Specifies the xvfb X
Windows server used by the
report server.
Parameter Release 5 variable name
AuthIdExpires System/AuthIdExpires
AuthPassword System/AuthPassword
BaseSocketNumForReply AC_SERVER_REPLY_SOCKET_BASE
BaseSocketNumForRPC AC_SERVER_RPC_SOCKET_BASE
BufferPoolSize AC_ENCYC_BUFFER_POOL_SIZE
CenturyBreak AC_CENTURY_BREAK
CompressDHTMLContent AC_VS_COMPRESS_DHTML_CONTENT
CompressionBufferSize AC_VS_COMPRESSION_BUFFER_SIZE
CompressionLevel AC_VS_COMPRESSION_LEVEL
ConfigHomeFileSystem System/ConfigHomeFileSystem
ConfigHomeOffset System/ConfigHomeOffset
ConnConfigFile AC_SERVER_CONFIG_FILE
CSSTemplateClassLimit AC_VS_CSS_TEMPLATE_CLASS_LIMIT
CurrencyFormat AC_CURRENCY_FORMAT
CustomMetaDescription System/CustomMetaDescription
DateMode AC_DATE_MODE
DateSeparationChar AC_DATE_SEPCH
DefaultCLocaleOnWindows AC_OPERATION_SERVER_DEFAULT_C
_LOCALE
DefaultLocale System/DefaultLocale
DelayAfterCreatingOperation
Process
AC_DELAY_AFTER_PROCESS_
CREATED
DelayBetweenContacting
OperationProcess
AC_DELAY_DURING_PROCESS_START
UP
Description Volume/Description
Description Server/Description
DHTMLGeneratorInfo AC_VIEWSERVER_GENERATOR_INFO
eAnalysisAutoResizeVertical
Axis
ViewingService/
eAnalysisAutoResizeVerticalAxis
eAnalysisDecimalPoint ViewingService/eAnalysisDecimalPoint
eAnalysisHideCalculate ViewingService/eAnalysisHideCalculate
eAnalysisHideHelp ViewingService/eAnalysisHideHelp
eAnalysisHideHome ViewingService/eAnalysisHideHome
eAnalysisHideHorizontalBar
Chart
ViewingService/
eAnalysisHideHorizontalBarChart
eAnalysisHideHorizontalFitTo
Page
ViewingService/
eAnalysisHideHorizontalFitToPage
eAnalysisHideLineGraph ViewingService/eAnalysisHideLineGraph
eAnalysisHidePieChart ViewingService/eAnalysisHidePieChart
eAnalysisHidePreferences ViewingService/
eAnalysisHidePreferences
eAnalysisHidePrint ViewingService/eAnalysisHidePrint
eAnalysisHideSave ViewingService/eAnalysisHideSave
eAnalysisHideSaveAs
MicrosoftExcel
ViewingService/
eAnalysisHideSaveAsMicrosoftExcel
eAnalysisHideTableView ViewingService/eAnalysisHideTableView
eAnalysisHideVerticalBarChart ViewingService/
eAnalysisHideVerticalFitTo
Page
ViewingService/
eAnalysisHideVerticalFitToPage
eAnalysisHideWorkOffline ViewingService/
eAnalysisHideWorkOffline
eAnalysisHorizontalAxisColor ViewingService/
eAnalysisMainTitle ViewingService/eAnalysisMainTitle
eAnalysisPieChartCombine
Minimum
ViewingService/
eAnalysisPieChartCombineMinimum
eAnalysisShowColumnLevels ViewingService/
eAnalysisShowColumnTotals ViewingService/
Leading
ViewingService/
eAnalysisShowColumnTotalsLeading
eAnalysisShowDrillControls ViewingService/
eAnalysisShowDrillControls
eAnalysisShowEmptyColumns ViewingService/
eAnalysisShowEmptyRows ViewingService/
eAnalysisShowEmptyRows
eAnalysisShowGridLines ViewingService/eAnalysisShowGridLines
eAnalysisShowHistogramIn3D ViewingService/
Percent
ViewingService/
eAnalysisShowHistogramPercent
Values
ViewingService/
eAnalysisShowHistogramValues
eAnalysisShowLineLabels ViewingService/
eAnalysisShowLineLabels
eAnalysisShowLinePercent ViewingService/
eAnalysisShowLinePercent
eAnalysisShowLineValues ViewingService/
eAnalysisShowLineValues
eAnalysisShowPieChartIn3D ViewingService/
eAnalysisShowPieChartIn3D
eAnalysisShowPieChartLabels ViewingService/
eAnalysisShowPieChartPercent ViewingService/
eAnalysisShowPieChartValues ViewingService/
eAnalysisShowRowLevels ViewingService/
eAnalysisShowRowLevels
eAnalysisShowRowTotals ViewingService/
eAnalysisShowRowTotals
eAnalysisShowRowTotals
Leading
ViewingService/
eAnalysisShowRowTotalsLeading
eAnalysisShowZeroColumns ViewingService/
eAnalysisShowZeroColumns
eAnalysisShowZeroRows ViewingService/eAnalysisShowZeroRows
eAnalysisVerticalAxisColor ViewingService/
eAnalysisVerticalAxisColor
eAnalysisWatermark AC_VIEWSERVER_ANALYSIS_
WATERMARK
eAnalysisWindowTitle AC_VIEWSERVER_ANALYSIS_TITLE
EnableGenerationService ReprotingService/
EnableGenerationService
EnableOpenSecurity Volume/EnableOpenSecurity
EnableRequestService SoapDispatchServiceService/
EnableRequestService
EnableViewingService ViewingService/EnableViewingService
FactoryProcessLogDirectory AC_FACTORY_LOG_DIRECTORY
FactoryProcessLogLevel AC_FACTORY_LOG_LEVEL
FactoryProcessLogSize AC_FACTORY_LOG_SIZE
FileCacheTimeout AC_VIEW_FILE_CACHE_TIMEOUT
FileTypeList ReportingService/FileTypeList
HeartbeatFailurePeriod System/HeartbeatFailurePeriod
HeartbeatSendPeriod System/HeartbeatSendPeriod
ImageSearchpath AC_IMAGE_SEARCH_PATH
IntervalBeforePurgingExpired
ScheduledRequests
AC_PURGE_EXPIRED_SCHEDULED_
REQUEST_DELAY
LogDirectory AC_VIEW_LOG_DIRECTORY
LogDirectory AC_OBJECT_LOG_DIRECTORY
LoggingOn AC_LOG_ON
LogLevel AC_VIEW_LOG_LEVEL
LogLevel AC_OBJECT_LOG_LEVEL
LogSize AC_VIEW_LOG_SIZE
LogSize AC_OBJECT_LOG_SIZE
LongDateFormat AC_LONG_DATE
MaxConcurrentRequests AC_SERVER_PARAM_MAX_PENDING_
OPERATIONS
MaxEndpointThreads SoapDispatchService/
MaxEndpointThreads
MaxFactoryProcesses ReportingService/MaxPrintProcesses
MaxFileCacheEntriesPer
Process
AC_MAX_FILE_CACHE_ENTRIES
MaxFileCacheSizePerProcess AC_VIEW_FILE_CACHE_SIZE
MaxFileDescriptorsOnUnix AC_SERVER_UNIX_FD_MAX
MaxLogSize AC_ENCYC_MAX_LOG_SIZE
MaxPagesConvertibleToExcel AC_MAX_PAGES_CONVERTIBLE_TO_
EXCEL
MaxPrintProcesses ReportingService/MaxFactoryProcesses
MaxProcesses MaxNumberOfProcesses(AC_VIEW_
SERVER)
MaxROXCacheSizePerProcess AC_VIEW_ROX_CACHE_SIZE
MaxROXCacheSizeTimeout AC_VIEW_ROX_CACHE_TIMEOUT
MaxSyncJobRuntime ReportingService/MaxReportRuntime
MaxThreadsPerProcess AC_VS_MAX_THREAD
MaxXMLTranslatorsPerProcess AC_VIEWSERVER_MAX_TRANSLATOR
MinDataPacketSize AC_VS_MIN_DATA_PACKET_SIZE
MinProcesses MinNumberOfProcesses(AC_VIEW_
SERVER)
MultiCastIPAddress System/MultiCastAddress
MulticastPort System/MulticastPort
MulticastTTL System/MulticastTTL
NumberOfPagesDownloaded System/TransactionLogReportViewing/
NumberOfPagesDownloaded
NumFactoryProcessLogs AC_FACTORY_LOG_NUMBER
NumLogs AC_VIEW_LOG_NUMBER
NumLogs AC_OBJECT_LOG_NUMBER
NumPrintProcessLogs AC_PRINT_LOG_NUMBER
NumRequestRetries AC_OPERATION_SERVER_NUMBER_
OF_RETRIES
NumSocketsForReply AC_SERVER_REPLY_SOCKET_COUNT
NumSocketsForRPC AC_SERVER_RPC_SOCKET_COUNT
ObjectArchiveDLL AC_OBJECT_ARCHIVE_DLL
OutputDirForRuntimeExcel AC_VIEWSERVER_EXCELOUTPUTDIR
PageCountUpdateInterval AC_FACTORY_PAGE_COUNT_UPDATE
_INTERVAL
PageNumbersDownloaded System/TransactionLogReportViewing/
PageNumbersDownloaded
Path Server/ServerFileSystemSettings/Path
PDFQualityOnWindows AC_PDF_QUALITY
PrimaryPartition AC_ENCYC_DB_DIR (FileSystem)
PrimaryServer Volume/PrimaryServer
PrintProcessLogDirectory AC_PRINT_LOG_DIRECTORY
PrintProcessLogLevel AC_PRINT_LOG_LEVEL
PrintProcessLogSize AC_PRINT_LOG_SIZE
PrintProcessRecycleCount AC_PRINT_SERVER_RECYCLE_COUNT
ProcessRecycleCount AC_FACTORY_SERVER_RECYCLE_
COUNT
ReadBufferSize AC_VS_READ_BUFFER_SIZE
RecycleFactoryProcesses AC_RECYCLE_OPERATION_SERVERS
RecyclePrintProcesses AC_RECYCLE_OPERATION_SERVERS
ReportCastPrefix AC_WEB_AGENT_NAME
ReportFormatDownloaded System/TransactionLogReportViewing/
ReportFormatDownloaded
ReportParams System/
TransactionLogReportGeneration/
ReportParams
ReportSize System/TransactionLogReportViewing/
ReportSize
ReportSize System/TransactionLogReportPrinting/
ReportSize
ReportSize System/
TransactionLogReportGeneration/
ReportSize
RequestRetryInterval AC_OPERATION_SERVER_RETRY_
INTERVAL
RSSECacheSize AC_RSSE_CACHE_SIZE
RSSECacheTimeout AC_RSSE_CACHE_TIMEOUT
RSSELibrary AC_RSSE_LIBRARY
RSSEMaxACLBufferSize AC_RSSE_MAX_ACL_BUFFER_SIZE
RSSEMultiThreadSafeLibrary AC_RSSE_MT_SAFE_LIBRARY
ScheduleForPurgingNotices AC_NOTICE_PURGE_THREAD_
SCHEDULE
SearchTimeout AC_VIEWSERVER_SEARCH_TIMEOUT
ServerIPAddress Server/IPAddress
ServerList Volume/ServerList
ServerSOAPPort Server/SOAPPort
ServerSOAPPortBase Server/SOAPPortBase
ServerSOAPPortCount Server/SOAPPortCount
SessionCacheSizePerProcess AC_VIEW_SESSION_CACHE_SIZE
SessionCacheTimeout AC_VIEW_SESSION_CACHE_TIMEOUT
ShortDateFormat AC_SHORT_DATE
SocketBaseForProcesses AC_VIEW_SERVER_SOCKET_BASE
SocketCountForProcesses AC_VIEW_SERVER_SOCKET_COUNT
SocketReadTimeout SoapDispatchService/SocketReadTimeout
SyncJobQueueSize ReportingService/SyncJobQueueSize
SyncJobQueueSize ReportingService/SyncJobQueueSize
SyncJobQueueWait ReportingService/MaxRequestQueueWait
SystemIPAddress System/SOAPAddress
SystemName System/SystemName
SystemPort System/SOAPPort
TimeFormat AC_TIME_FORMAT
TimeSeparationChar AC_TIME_SEPCH
TransientReportCacheLocation ReportingService/
About obsolete Release 5 variables
The following table lists the Release 5 variables that are not used in Release 6.
TransientReportCacheSize ReportingService/
TransientReportCacheSize
TransientReportTimeOut ReportingService/
TransientReportTimeOut
TransLogHomeFileSystem AC_ENCYC_LOG_DIR (FileSystem)
Type System/Type
UDPPort System/UDPPort
UseMulticast System/UseMulticast
VolumeStatusHomeFileSystem AC_ENCYC_STATUS_DIR (FileSystem)
WaitPeriodForProcessStartup AC_VIEWSERVER_STARTUP_TIMEOUT
WindowForPurgingTempROVs AC_PURGE_WINDOW
Variable Name Reason for obsolescence
AC_ADMIN_LOG_DIRECTORY Need only one group of log settings for
Encyclopedia Service (Core Server)
AC_ADMIN_LOG_LEVEL Need only one group of log settings for
AC_ADMIN_LOG_NUMBER Need only one group of log settings for
AC_ADMIN_LOG_SIZE Need only one group of log settings for
AC_DEAD_REQUEST_PURGE_
TIMES
No longer required.
AC_HIGH_QUALITY_GRAPH Currently set by default; no reason for
customers to unset
AC_HP10_FORCE_YIELD Platform not supported
AC_LOG_CHECK_FREQUENCY Administrator sends message to reload
config
AC_LOG_DIRECTORY Separate Log Settings for Core Server,
Operation Servers
AC_LOG_LEVEL Separate Log Settings for Core Server,
Operation Servers
AC_LOG_NUMBER Separate Log Settings for Core Server,
Operation Servers
AC_LOG_SIZE Separate Log Settings for Core Server,
Operation Servers
AC_OBJECT_ARCHIVE_
THREAD_SCHEDULE
Auto Archive now part of Volume
Meta-data
AC_REQUEST_LOG_
DIRECTORY
Need only one group of log settings for
AC_REQUEST_LOG_LEVEL Need only one group of log settings for
AC_REQUEST_LOG_NUMBER Need only one group of log settings for
AC_REQUEST_LOG_SIZE Need only one group of log settings for
AC_SERVER_PARAM_MAX_
PRIORITY (AC_FACTORY_
lSERVER)
Each Service can now handle Requests
of any Priority
AC_SERVER_PARAM_MAX_
PRIORITY (AC_PRINT_SERVER)
of any Priority
AC_SERVER_PARAM_MIN_
PRIORITY (AC_FACTORY_
SERVER)
of any Priority
AC_SERVER_PARAM_MIN_
PRIORITY (AC_PRINT_SERVER)
of any Priority
Variable Name Reason for obsolescence
C h a p t e r 8 , Un d e r s t a n d i n g R e p o r t E n c y c l o p e d i a v o l u me a d mi n i s t r a t i o n 281
C h a p t e r
8
Chapter8Understanding Report
Encyclopedia volume
administration
I Volume administration overview
I Connecting to a volume
I About volume administration pages
I Searching for data
I Filtering volume data
I Setting properties for more than one item at a time
I About the Administrator and the Operator
I Setting volume limits
Volume administration overview
You use the volume administration pages of Actuate Management Console to
manage volumes. Volume administration pages are web pages that can be
viewed with a web browser. Typical volume administration tasks include:
I User administration tasks
I Adding, modifying, and deleting users
I Defining the operations that users, or groups of users, can perform
I Creating and maintaining lists of users to be informed when specified
events take place
I Printer administration tasks
I Configuring printers
I Specifying a default printer
I Archiving tasks
I Specifying the volumes default archive rules
I Initiating an archive sweep
I Online backup tasks
I Scheduling online backups
I Initiating an online backup
I Channel administration tasks
I Adding, modifying, and deleting channels
I Defining which users, or groups of users, have access to which channels
I Security tasks
I Configuring and maintaining security information based on
information supplied by a third-party package for use with the volume.
If you have the e.Report option with the Page Level Security option, other
tasks include configuring the volume for Actuate Basic reports that use
page security, including:
I Giving security roles and users secure read privilege on reports using
page security
I Installing and configuring Report Server Security Extension (RSSE) if
needed
I Open server tasks:
I Creating open server file types to run open server reports
I Importing open server reports and assigning parameter values to the
reports as needed
I Maintaining the open server drivers and third-party report generation
software
Some administrative tasks must be performed using system administration
pages of Actuate Management Console. For more information about these
tasks, see Chapter 4, Performing system administration tasks.
Connecting to a volume
To connect to a volume and perform volume administration tasks, you use
Actuate Management Console. Using a web browser, navigate to the
appropriate URL and log in as administrator or as a user with the
administrator security role. For information about the administrator user and
security role, see About the administrator user and security role in Chapter
9, Managing Report Encyclopedia volume security.
If you are using Open Security, maintaining security for the volume is slightly
different. For more information, see About Actuate Open Security in
Chapter 9, Managing Report Encyclopedia volume security.
How to connect to a volume
1 Start your web browser and enter the URL to log in to Actuate
Management Console, for example:
http://mars:7070/acadmin/login.jsp?serverUrl=http://sun5:8000
http://mars:7070/acadmin/login.jsp is the URL for the login page on the
web server. The query string, serverUrl=http://sun5:8000, specifies the
SOAP endpoint or SOAP redirector for the e.reporting system. The SOAP
endpoint is usually port 2000 and the SOAP redirector is usually port 8000.
If no query string is specified, Actuate Management Console looks for the
report server on http://localhost:2000.
2 Select the appropriate volume.
Alternatively, you can specify the volume in the URL. For example, to log
in to the volume HQ directly, type:
http://mars:7070/acadmin/login.jsp?serverUrl=http://sun5:8000&Volume=HQ
3 For user name, type:
administrator
4 Type the administrator password.
If you are logging in for the first time, leave the password blank.
5 Select a language.
6 Select a time zone.
7 Choose Log In.
You can log in to only one volume at a time. To log in to multiple volumes,
open multiple web browser windows. Each web browser window handles one
connection to a volume.
How to solve login problems
If you get the message Log in Failed:
1 Confirm that you are using the correct volume information.
2 Confirm that the e.reporting system and the servers on which it is installed
are running. The servers or software not running is the most frequent
problem you will encounter.
3 Confirm that your computer has web access to the e.reporting system and
the servers on which it is installed.
About volume administration pages
When you log in to a volume as Administrator or as a user with the
Administrator security role, the page looks similar to the one in the following
illustration.
Understanding the banner
Each pages banner is similar to the following illustration.
The banner contains the following elements:
I A logo.
By default, Actuates logo is displayed. The Actuate logo is a link to the
Actuate home page.
I If you are connected to a system, the name of the system.
I If you are connected to a specific volume, the name of the volume.
I Your user name.
I A link to log out.
I A link to the Options page.
The Options page enables you to specify how many rows and which
columns appear on tabular list pages. For more information about the
Options page, see Setting display options, later in this chapter.
I A link to online help.
Using the sidebar menu
The sidebar menu on the left displays several icons.
Each icon links to a web page that can be used to perform certain tasks. For
more information about which pages perform which tasks, see About the
Administrator and the Operator, later in this chapter.
Setting display options
Use the Options page to set display options. To display the Options page,
choose Options in the upper right corner of any volume administration page.
Use the General tab on the Options page to set:
I The number of rows to display per page in normal lists
I The maximum number of rows to display in search results lists
I The locale
I The time zone
Use the other tabs on the Options page to specify:
I The columns to display on tabular list pages
I The order in which to display the columns
For example, the Users tab specifies that the following columns are displayed
on the Users page:
I Name
I E-mail address
I Home folder
I Description
The result of this display of 4 columns looks like the following illustration.
To display additional columns on the Users page, move the columns from the
Available columns list to the Selected columns list on the Users tab. To change
the order of the columns, use the up and down arrows to the right of the
Selected columns list.
Searching for data
You can search for data in the volume that meets certain criteria. You can also
specify which columns to display in the search results list. Name, however, is
always the first column in the search results list. Data is sorted in ascending
order by name. For example, users are sorted in ascending order by user name.
You can search for:
I Jobs
I Files and folders
I Users
I Security Roles
I Notification Groups
I Channels
Searching for strings that contain special
characters
If a search string contains one or more special characters, it must be enclosed
in quotation marks ("). Special characters include characters that are operators
in a search expression:
I Comma (,)
I Hyphen (-)
I Exclamation point (!)
I Less than sign (<)
I Greater than sign (>)
I Equal sign (=)
Searching for volume data
Suppose that you want to display a list of users that meet the following
criteria:
I E-mail address ends with @new-company.com
I Home folder starts with /Sales/Managers/
I Web viewing preference is DHTML
I Maximum job priority is greater than 500
I A completion notice is created for jobs that succeed
I Channel subscriptions include the Sales channel
You want to display the following columns from left to right:
I Name
I Priority
I E-mail Notification
I Completion Notices
To display the search results:
1 As Administrator, choose Users.
2 Choose Search.
3 Complete Criteria as shown in the following illustration.
4 Choose Columns.
5 Move the following columns from Available to Selected:
I Priority
I E-mail Notification
I Completion Notices
6 Choose Search.
Search Results appears.
7 To modify the criteria or columns, choose Change Search.
Filtering volume data
Many volume administration pages provide a filter. The filter enables you to
reduce the number of rows retrieved from the volumes data store, or to
reduce the number of items in an Available list.
For example, to display only users whose name starts with the letter A, type
A* in Filter on Users, and choose Apply.
To display only users whose log in is not disabled, select No from Log in
disabled, and choose Apply.
To display only security roles that start with sales in the Available list on the
Roles tab of the Users Properties page, type sales* in the Filter text box and
choose Apply Filter.
To clear a filter and retrieve all rows or items, choose Clear or Clear Filter.
Setting properties for more than one item at a time
When you set properties for multiple items simultaneously, a property is not
updated unless you change its value. To leave the property blank, enter a
space in its text box. For example, if you are setting the properties of more than
one channel at a time, and you do not change Large (32x32) icon URL, the
large icon URL for the selected channels is not updated when you choose OK.
To leave Large (32x32) icon URL blank, enter a space in its text box.
For more information about creating and maintaining channels, see Creating
and maintaining channels in Chapter 12, Administering the volume in the
web environment.
About the Administrator and the Operator
Some volume administration pages are available to all users. Other pages are
available only to the Administrator user or to users who are members of the
Administrator security role. To place the volume in online backup mode and
schedule online backups, you must log in as a user who is a member of the
Operator security role. The Administrator is a member of the Operator
security role.
The following chapters discuss volume administration pages available to
Administrators and Operators. For detailed information about pages available
to all users, see Using e.Reports.
Pages available to all users
The following pages are available to all users:
I Jobs
Jobs displays lists of scheduled, pending, running, and completed jobs
created by the user. If the user is logged in as Administrator or as a user
with the Administrator security role, Jobs displays all jobs along with the
owner of each job. Use Jobs to:
I Display information about a job.
I Set the properties of a job.
I Open a document.
I Print a document on the server.
I Create a job.
I Retry a failed job.
I Delete a job.
I Delete completion notices.
I Files and Folders
Files and Folders displays a list of files and folders to which the user has
access. If the user is logged in as Administrator or as a user with the
Administrator security role, Files and Folders displays all files and folders
in the volume. Use Files and Folders pages to:
I Set the properties of a file or folder.
I Add, copy, move, or delete a file or folder.
I Open a file or folder.
I Create a parameter values file.
I Download a file.
I Create a job.
I Channels
Channels displays a list of channels to which the user is subscribed. Use
Channels pages to:
I Display the contents of a channel.
I Delete notices from a channel.
I Display information about a job.
I Open a document.
I Create a job.
I Personal Settings.
Personal Settings does not appear in the sidebar menu if the user is logged
in as Administrator or the user is member of the Administrator security
role.
Use Personal Settings to modify various settings, for example:
I Your password
I Your email address
I The method of notification for completed jobs
I Channel subscriptions
I Printer settings
Use Personal Settings pages to view:
I The security roles assigned to you
I The notification groups of which you are a member
I Your privilege template
Pages available to Administrators
The following pages are available only to the Administrator user or to users
who are members of the Administrator security role:
I Users
Users displays a list of users that have access to the volume. Use Users
pages to:
I Set the properties of a user.
I Add and remove channel subscriptions.
I Add or delete a user.
I Security Roles
Security Roles displays a list of security roles. Use Security Roles pages to:
I Set the properties of a security role.
I Assign security roles to users.
I Add or delete a security role.
I Notification Groups
Notification Groups displays a list of notification groups. Use Notification
Groups pages to:
I Set the properties of a notification group.
I Add users to a notification group.
I Add or delete a notification group.
I Channels
Channels displays a list of channels. Use Channels pages to:
I Set the properties of a channel.
I Add or delete a channel.
I Display a list of subscribers to the channel.
I File Types
The File Types page displays a list of file types. Use the File Types pages to:
I Set the properties of a file type.
I Add or delete a file type.
I Add, modify, or delete the parameters associated with a file type.
I Upload icons associated with a file type.
I Volume Properties
Use the Volume Properties pages to:
I Set the properties of the volume, including:
- Default job retry policy
- Default browser settings
- Privileges on the volumes root folder
- Auto-archive policy for the volume
- Default printer settings
I Start an auto-archive sweep.
I Place the volume in online backup mode.
I Schedule online backups.
Setting volume limits
Many of the relationships in the volume have recommended and hard limits.
If you adhere to the recommended limits, the appearance, behavior, and
performance of volume administration pages is acceptable. The hard limits are
imposed by the web browser.
Relationship Limits
Channels notified from a single job. Recommended limit 100.
Hard limit 1000.
Channels to which a single user is
subscribed.
Recommended limit 15.
Hard limit 150.
Notification groups of which a single
user is a member.
Hard limit 2000.
Security roles of which a single user is a
member.
Hard limit 2000.
Security roles that are children of a
single security role.
Hard limit 2000.
Security roles that are parents of a
single security role.
Hard limit 2000.
Users and notification groups notified
from a single job.
Hard limit 1000.
Users and security roles in a single
Access Control List for a file, folder, or
channel, including Access Control Lists
created by jobs.
Hard limit 2000.
Users and security roles in a single
privilege template.
Hard limit 2000.
Users who are members of a single
notification group.
Unlimited (greater than 1,000,000).
Users who are members of a single
security role.
Users who are subscribed to a single
channel.
C h a p t e r 9 , Ma n a g i n g Re p o r t E n c y c l o p e d i a v o l u me s e c u r i t y 299
C h a p t e r
9
Chapter9Managing Report
Encyclopedia volume
security
I About volume security
I Managing users, privileges, and security roles
I Creating notification groups
I About Actuate report page security
I About Actuate Open Security
I Using the volume administration pages with open security
About volume security
An administrator controls access to a volume by creating users and assigning
passwords. The security of the data in the volume is based on the granting of
privileges to users. Privileges specify the operations that users can perform on
folders and report items.
The Actuate e.reporting system provides the following security features:
I Actuate report page security. Using page security, report developers create
a single Actuate Basic report that contains restrictions on the viewable
pages based on the user ID or security role. For information about page
security, see About Actuate report page security, later in this chapter.
Page security is available if you have the e.Report option, which is Actuate
Basic and Actuate e.Report Designer Java Edition, with the Page Level
Security option.
I Report Server Security Extension (RSSE). Using the RSSE, developers can
create applications that enhance the existing security model for the volume.
For example, developers can create an interface between an external,
third-party security system and the e.reporting system for the following
reasons:
I To grant access to the volume based on the external security system
I To restrict access to volume items based on information from an
external security system
I To restrict access to data in an Actuate Basic report using page security
based on external security information
Actuate supplies an RSSE application that can be installed and used with
the e.reporting system. The RSSE application uses security information
from a Netscape Directory Server, an LDAP server. For information about
Open Security and about the RSSE application, see About Actuate Open
Security, later in this chapter.
For information about setting up the RSSE application, see Chapter 6,
Whether you are using Actuates internal security functionality or using an
RSSE application to use external security information, the use of privileges to
control access to the volumes information and how privileges function
remains the same.
About users and passwords
To gain access to a volume, each user must provide a user name.
Administrators can improve the security of the data in the volume by
requiring users to enter passwords. As an administrator, you can require a
password from a user by setting a password when you create the users
account or by modifying the account and adding a password. Once you do so,
that user must enter the password correctly at each login attempt; otherwise
access to the volume is denied. Users can change their password once they are
logged in.
There is one special user account: Administrator, the volumes administrator.
For more information about this user, see About the administrator user and
security role, later in this chapter.
About privileges
A privilege is a relationship between a user and an item in the volume. The
privilege indicates whether the user can perform certain operations on the
item. For instance, the read privilege indicates that the user can view or print
the item, or see its contents if the item is a folder. Privileges are similar to the
file and folder attributes that are used in operating systems such as Windows
and UNIX. For example, in Windows, you can assign the Read-only attribute
to a file or folder to allow users to view but not change the file or folder.
In a volume, users without the appropriate privilege are not allowed to
perform the associated actions on the item. For example, users who do not
have delete privilege on a report document cannot delete it. Any attempt to
delete it is denied, and a message appears indicating the missing privilege.
All users can read from the volumes root folder.
A volumes administrator has full privileges to all items in the volume. For
more information, see About the administrator user and security role, later
in this chapter.
Types of privileges
The following table lists the privileges that can be applied to items in the
volume. Each row describes a single privilege and indicates what that
privilege means for different item types.
Privilege Item type Meaning
Delete Folder Users can delete the folder if they have
write and delete privilege on all the items in
the folder and delete privilege on the folder
itself.
All other types Users can delete the item if they have write
and delete privileges. If the user does not
have read privilege on the item, the user
cannot view the contents of the item.
Execute Report document Users can schedule a job for the associated
report executable if they also have read and
execute privilege on the report executable.
See execute privilege for report executable
for other requirements when running a
report.
Report executable Users can schedule a job for the report
executable. Users must also have read
privilege on the report executable.
In addition, users must have:
I Read and write privileges on the folder
where the generated report document is
stored
I Write privilege on the existing report
document if it is replaced by the new
report document
Write privilege on the existing report
document is not required to create a new
version of the report document.
Grant All types Users can grant any privilege on the item,
including the grant privilege, to other users
and security roles. The grant privilege does
not imply any other privileges.
Read Folder Users can see a folder and its contents.
Report document Users can view and print the report
document if they also have read privilege
on the associated report executable. Read
privilege is required to download or copy
the file.
Report executable Users can run the report executable if they
also have execute privilege. See execute
privilege on report executables for
requirements when running reports. Read
privilege is required to download or copy
the file.
Report parameter
values
Users can schedule a job for the associated
report executable if they also have read and
execute privilege on the report executable.
See execute privilege on report executables
for requirements when running reports.
Read privilege is required to download or
copy the file.
All other types Users can examine the items properties and
view or print the items contents.
Secure
read
Actuate Basic
report document
If the user has secure read privilege, but not
read privilege, the user can view the report
only in DHTML format with a web browser.
If you have the e.Report (Actuate
Basic/Java Report) Generation option with
the Page Level Security option, Actuate
page security is enabled for the report.
Without the Page Level Security option,
Actuate page security is disabled and
reports using page security are not
readable.
Users cannot copy the item from the
volume.
The secure read privilege has meaning only
for Actuate Basic report documents (ROIs).
The secure read privilege is ignored if the
user also has read privilege on the report
document. If the user has read privilege on
the report document, the report is viewable
with the LRX or the Windows viewer. Page
security, however, is not enabled with these
viewers.
Setting secure read privilege
Secure read on an Actuate report object instance (.roi) for a user means that the
user can only view or print the ROI in DHTML format or generate XML or
PDF output from the report using a web browser. The ROI cannot be
All other types The secure read privilege does not have
meaning for folders or file types other than
ROI.
Visible Folders If a user has the visible privilege, the user
can see the folder, its properties, and its
contents. The visible privilege is the same as
the read privilege for folders. If the user has
write privilege on the folder, however, the
user must be given visible or read privilege
to see the folder.
All other types Users can see the item and properties but
they cannot view or print the items
contents. For file types other than ROX, if
the user has read privilege on the file, the
user also has visible privilege. For ROI files,
if the user has secure read privilege on the
file, the user also has visible privilege. For
ROX files, if the user has read and execute
privilege on the file, the user also has visible
privilege. If the user has read but not
execute privilege on an ROX file, the user
cannot see the ROX file.
Write Folder Users can create new items in the folder,
remove items from the folder, copy or move
items into the folder, or rename the folder.
Users must also have read privilege on the
folder or the contents of the folder are not
visible. Users can move the folder to a
different containing folder if they have read
and write privileges on the destination
folder. Users cannot delete the folder unless
they have delete privilege.
All other types Users must have write privilege on a report
document to replace the latest version of the
document. Users do not need write
privilege to create a new version of a report
document.
downloaded, bundled, or e-mailed, or be viewed in native format using the
Actuate LRX, or other Actuate application such as the Viewer or End User
Desktop. Viewing the report in the native format requires the downloading of
the report to a cache on the users machine.
As administrator, you can also configure the ability of a users browser to
cache Actuate DHTML report pages on the users local system. For
information about caching options for DHTML reports, see Setting web
browser page caching options in Chapter 12, Administering the volume in
the web environment.
If an Actuate Basic report uses page security, setting a users privilege to
secure read on the report document enables the reports page security features.
Page security is available if you have the e.Report (Actuate Basic/Java Report)
Generation option with the Page Level Security option. For information about
report page security see About Actuate report page security, later in this
chapter.
Understanding the volumes default privileges
When a user creates an item, the volume automatically applies some privileges
to it. As the default privilege settings, the volume assigns the full set of
privileges to the items creator and the administrator, and no privileges to
other users. By modifying the users privilege template, administrators can
change the default privileges assigned to items a user creates. Users cannot
modify their own privilege template.
About home folder privileges
When an administrator specifies a home folder for a user, the user
automatically has all privileges for the folder. If the administrator changes the
location of the home folder, the previous home folders privilege settings do
not change. If the administrator changes the home folder to a folder that does
not exist, the volume creates the folder. For more information about specifying
a home folder, see How to add a user, later in this chapter.
Users cannot modify their own home folder setting.
If the volume uses the Actuate Open Security RSSE application, however, the
privileges on a users home folder are not automatically updated. The
volumes administrator must assign privileges on the users home folder.
What is a privilege template?
Every user has a privilege template. A privilege template specifies the
privileges that other users have on items the user creates. Privilege templates
override the default privileges. Administrators can modify any users
privilege template. Users cannot modify their own privilege template.
Administrators can change a privilege template when they create or modify a
users account. For more information about how to set up a user account, see
How to add a user, later in this chapter.
Why modify the privilege template?
Administrators typically modify the default privilege template to make it easy
for users to create new items and automatically grant privileges on those items
to other users. For example, if UserA wants UserB always to have read and
write privileges to items created by UserA, change UserBs privileges to
UserAs items accordingly. For more information about how to modify a users
privilege template, see How to add a user, later in this chapter.
The following illustration shows an example of a privilege template for a user,
LThompson. In the example, the privilege template assigns read, write, and
execute privileges to user DAdams, secure read and write privileges to user
BCarter, and the secure read privilege to users who are assigned to the Sales
security role. These privileges apply to all items created by LThompson. All
other users have no privileges for items created by LThompson.
When LThompson creates a folder, adds an item to the volume, or generates a
report document, privileges are automatically assigned to DAdams, BCarter,
and users assigned to the Sales security role.
Setting privileges on the volumes root folder
The following describe the privileges on the volumes root folder:
DAdams BCarter
S. Read
User LThompsons template
Sales role
Read
LThompson
Write
Execute
Delete
X
X
X
Visible
Grant
S. Read
Read
Write
Execute
Delete
X
X
Visible
Grant
S. Read
Read
Write
Execute
Delete
X
Visible
Grant
I An administrator can add or remove only the write and grant privilege for
users and security roles on the root folder. Other privileges for users and
security roles on the root folder cannot be changed.
I For items such as reports, or other folders in the root folder, users with
grant privileges on the item can change the privilege on the item.
I For a user to create folders in the root folder, the administrator must grant
write privilege on the root folder to the user, or a security role that contains
the user.
As administrator, you can create a folder in the volumes root folder and
assign write privilege to specific users or security roles on the newly
created folder. This option gives specific users the ability to create folders
within the newly created folder but not in the root folder.
About security roles
A security role is a name for a set of privilege levels. Security roles simplify the
task of ensuring that the same privileges are granted to a group of users.
Security roles also help you manage privilege sets as your environment
changes. There are special Actuate security roles, called the All security role
and the Operator security role. The All security role contains all users. The
Operator security role is used for special backup operations. For information
about the All security role, see About the All security role, later in this
chapter. For information about the Operator security role, see About the
Operator security role, later in this chapter.
Using security roles to relate sets of privileges and groups of users reduces the
complexity of administration tasks in two ways:
I Administrators can group privileges for many items into a single security
role and assign that security role to all users who need those privileges.
Modifying the privilege set associated with the security role automatically
modifies the privileges of all users who are assigned that security role.
I Administrators can assign one or more parents to a security role, causing
the security role to inherit all the privileges of its parents. Modifying the
privilege set of the parent automatically modifies the privileges of all
inheriting security roles. The final set of privileges for a security role is the
union of all privileges assigned to its parents, plus the privileges assigned
directly to it.
When an administrator removes a privilege from a security role, it must be
removed from the security role where the privilege was granted. The privilege
cannot be removed from a security role that inherited the privilege.
Users can use the roles an administrator creates to assign privileges for folders
or files they create. Users, however, cannot create or modify the definition of
roles. They also cannot determine which users an administrator has included
in the different roles. Administrators should therefore provide users with a list
of roles and the users included in each role.
Strategies for defining security roles
To make effective use of the flexibility of security roles, administrators should
decide on a strategy for employing them. Two general types of strategies exist:
I A flat strategy that simply allocates privileges in groups
I A hierarchical strategy that depends on inheritance from one security role
to another
Use the flat strategy when groups have distinct functions and require access to
separate sets of reports. Use the hierarchical strategy when groups have
functions that overlap and access to reports is based on a hierarchical scheme.
For more information, see Defining security roles, later in this chapter.
In theory it is possible to mix these two strategies. In practice such mixtures
are difficult to understand and maintain and should be avoided.
Defining security roles
To compare these two strategies, suppose that your organization has sales
offices in several cities. Each office has a number of sales representatives.
These representatives report to managers, each of whom manages two or more
offices. The executive in charge of the region is the Regional VP of Sales. Sales
people need access to information about current inventory levels, prices, and
shipping schedules. Managers need this information, plus access to
comparisons among sales offices and measurements of sales against quotas.
The Regional VP needs summary reports for the region.
About the flat strategy
With the flat strategy, administrators create:
I One security role that allows access to inventory, pricing, and shipping
information
I One security role that allows access to office comparisons and quota
measurements
I One security role that allows access to regional summary reports
Sales people are assigned only the first of these security roles; the first two
security roles are assigned to managers. All three security roles are assigned to
the Regional VP. The major advantage of this strategy is the simplicity of
creating and tracking privilege sets. It often requires the assignment of
multiple security roles to individual users, as with the managers and Regional
VP in this example.
The hierarchical strategy
With the hierarchical strategy, administrators create:
I One security role that allows access to inventory, pricing, and shipping
information
I One security role in which the parent is the first security role and also
allows access to office comparisons and quota measurements
I One security role in which the parent is the second security role and also
allows access to regional summary reports
Sales people are assigned the first security role, as in the flat strategy, while
managers are assigned the second, inheriting security role, and the Regional
VP is assigned to the third security role. The major advantage of this strategy
is its ability to propagate changes through security role inheritance, with the
result that only one security role needs to be assigned to most individuals.
Inventory
Pricing
Shipping
Comparisons
Quotas
Summary
Sales Manager Regional VP Role
Reports
Role
Reports
Sales
Manager
Regional VP
Comparisons
Quotas
Summary
Inventory
Pricing
Shipping
Determining the source of a users privilege, however, can be more involved
because of the layers of inheritance.
About the administrator user and security role
A volumes administrator is either the administrator user or a user that is
assigned the administrator security role.
The administrator user and security role have the following properties:
I Both exist as soon as you add the volume to the e.reporting system.
I Administrators cannot delete the administrator user or security role.
I Initially, the administrator user is the only user that can add, modify, and
delete administration items, including users. As administrator, you can
create new security roles in which the parent is the administrator security
role and the new security roles have the same capabilities as their parent.
I Administrators have all privileges on all items in the volume.
Only administrators can add and delete users and security roles and perform
other administrative tasks.
The administrator user has the additional property of automatic ownership of
any items belonging to a user whose account is deleted.
About the Operator security role
The Operator security role has the following properties:
I It exists as soon as you add the volume to the e.reporting system.
I The administrator user is assigned to the Operator security role.
I Administrators cannot delete the Operator security role.
I Administrators can add or remove users from the Operator security role.
I Administrators and other assigned users can use the Operator security role
to place the volume in online backup mode using either the volume
administration pages or the Actuate e.Reporting Server utilities.
About the All security role
The All security role is a system-created security role that includes all users.
The All security role has the following properties:
I It exists as soon as you add the volume to the e.reporting system.
I Administrators and users can use the All security role to give all users
privileges to items, including new users added after the privileges are
granted on the items.
Ch a p t e r 9 , Ma n a g i n g Re p o r t E n c y c l o p e d i a v o l u me s e c u r i t y 311
I Administrators cannot delete the All security role.
I All users are members of the All security role. An administrator cannot
remove a user from the All security role.
I An administrator cannot use the All security role as a child or parent of
other security roles.
Managing users, privileges, and security roles
As Administrator, managing users, privileges, and security roles involves
planning what security roles to create to meet your organizational needs and
what users to assign to those security roles. Once that plan is in place,
assigning privileges is one means of providing security.
If the volume is using the Actuate Open Security feature, see About Actuate
Open Security, later in this chapter.
How to add a user
1 As Administrator, select Users from the sidebar menu.
2 On Users, choose Create User.
New User appears. New User has the following tabs:
I General specifies user log in information, email address, home folder,
and web viewing preference. General also specifies whether or not the
users log in is disabled.
I Jobs specifies the users maximum job priority and how users are
informed when jobs are completed.
I Roles assigns the user to security roles.
I Groups assigns the user to notification groups.
I Privilege Template assigns privileges to other users and security roles
for items this user creates.
I Printing specifies a default printer and printer settings for the user.
3 On General, type a user name, description, and password for this user:
I User names and passwords are strings of 1 to 256 characters. User
names can include any character except the control characters.
Passwords cannot include control characters or spaces.
I The user name is not case sensitive. It is, however, stored in the user
name database in mixed case and will always be displayed exactly as
you type it during creation. If you enter the name of an existing user, the
users current settings are displayed.
I The password is not required. If you use passwords, security experts
recommend passwords of at least eight characters, including
mixed-case alphabetic as well as numeric characters. Passwords are
case-sensitive.
Administrators can change any users password. Users can change their
own passwords.
4 Confirm the password.
5 Enter the users email address.
6 As administrator, you can specify a path and a folder name as a home
folder. The path must be preceded by the volume name. If you specify a
home folder, the user is automatically granted all privileges for the folder.
If the volume is using the Actuate Open Security RSSE application, the
volumes administrator must assign privileges on the users home folder.
The users home folder privileges are not automatically updated.
As administrator, you must provide read privilege for the user on the
folders in the path to the home folder. For example if the home folder
location is /Sales/users/home/myfolder, grant read privilege for the user
on the folders /Sales/users and /Sales/users/home. Sales is the name of
the volume.
If you enter a path and folder name, the path and folder name must exist in
the volume before you can apply your changes. If the folder does not exist,
you are prompted to create it. For more information about home folders,
see About home folder privileges, earlier in this chapter.
7 Set the users web viewing preference.
For more information about web viewing preferences, see Viewing reports
configuration in Chapter 12, Administering the volume in the web
environment.
8 To prevent the user from logging in, select Log in disabled.
9 To set the maximum priority this user can specify for jobs, choose Jobs and
set the users priority level.
10 On Jobs, specify the users notification properties for both jobs that succeed
and jobs that fail. If a user can create a job, these settings specify how the
user is notified when the job completes.
If you select the Send e-mail notification option, the e.reporting system
mails notifications to the user when the job completes. As a notification
option, you can also select Attach document to specify that the report be
sent as an attachment with the e-mail. If you select the Send e-mail
notification option, type the appropriate e-mail address in General.
Selecting Send e-mail notification sends e-mail to the users e-mail address.
The e-mail notification contains the location of completed reports. If the
user selects Attach document and has read privilege on the report, the
volume attaches the report to the e-mail notification. If the user does not
have read privilege, only the location of the report is in the e-mail notice.
If you select Create completion notice, users determine the completion of a
job by checking their personal channel. You can select the notifications for
successful or failed jobs and can specify when to delete completion notices.
Users can change their own notification and e-mail address settings.
11 Choose Roles and select the appropriate security roles for this user.
For more information about security roles, see About security roles,
12 Choose Groups and select the appropriate notification groups for this user.
For more information about notification groups, see Creating notification
groups, later in this chapter.
13 If you want to change the users privilege template and assign privileges to
other users or security roles for items this user creates, choose Privilege
Template. Set the privileges for the users and security roles. For more
information about privileges, see Understanding the volumes default
privileges, earlier in this chapter.
14 Choose Printing to specify a default printer and printer settings for the
user.
15 Choose OK to accept these settings.
How to modify a users properties
2 On Users, hover the cursor over the icon to the left of the users name and
choose Properties.
3 Modify the users properties.
For more information about user properties, see How to add a user,
4 Choose OK.
How to subscribe a user to channels
choose Channel Subscriptions.
3 On Channel Subscriptions, move the appropriate channels from Available
to Selected.
4 Choose OK.
5 Grant the user read access to the channels to which he is subscribed, either
directly or through a security role.
The user must have read access to view the contents of the channels to
which he is subscribed. For information about granting channel privileges
to users and security roles, see How to modify the privileges for more
than one channel at a time in Chapter 12, Administering the volume in
the web environment.
How to clone a user
You can create a new user by cloning, or copying the properties of, an existing
user.
choose Clone.
3 On New User, modify the cloned users name and other properties as
necessary.
For more information about user properties, see How to add a user,
4 On Users, hover the cursor over the icon to the left of the cloned users
name and choose Channel Subscriptions.
5 On Channel Subscriptions, modify the cloned users channel subscriptions
as necessary.
For more information about Users Channel Subscriptions, see How to
subscribe a user to channels, earlier in this chapter.
How to delete a users account
choose Delete.
When you delete a user, the ownership of any folders or files owned by the
user changes to the administrator user.
3 Confirm the delete action when prompted.
How to modify properties for more than one user at a time
For more information about modifying properties for more than one user at a
time, see:
I How to modify security roles for more than one user at a time
I How to modify notification groups for more than one user at a time
I How to modify privilege templates for more than one user at a time
2 On Users, check the names of the users whose properties you want to
modify.
To select all users, select Select all users. To select all users on the current
page, select the box to the left of the Name column heading.
3 Hover the cursor over Act upon selected users and choose Properties.
4 On Properties, modify the properties and choose OK.
How to modify security roles for more than one user at a time
2 On Users, select the names of the users whose security roles you want to
modify.
To select all users, check Select all users. To select all users on the current
4 On Properties, choose Roles.
5 To remove security roles, move the security roles from Available to Remove
these roles.
To remove all security roles from the selected users, check Remove all.
6 To add security roles, move the security roles from Available to Add these
roles.
7 Choose OK.
How to modify notification groups for more than one user at a time
2 On Users, select the names of the users whose notification groups you want
to modify.
4 On Properties, choose Groups.
5 To remove notification groups, move the groups from Available to Remove
these groups.
To remove all notification groups from the selected users, check Remove
all.
6 To add notification groups, move the groups from Available to Add these
groups.
7 Choose OK.
How to modify privilege templates for more than one user at a time
2 On Users, check the names of the users whose privilege templates you
want to modify.
4 On Properties, choose Privilege Template.
5 To remove privileges:
1 Move the security role or user from Available to Remove these
privileges.
2 Unselect the privileges you do not want to remove.
3 Repeat steps 5.1 and 5.2 for the appropriate security roles and users.
To remove all security roles and users from the selected users privilege
templates, select Remove all.
6 To add privileges:
1 Move the security role or user from Available to Add these privileges.
2 Select the privileges you want to add.
7 Choose OK.
How to modify channel subscriptions for more than one user at a
time
2 On Users, select the names of the users whose channel subscriptions you
want to modify.
3 Hover the cursor over Act upon selected users and choose Channel
Subscriptions.
4 To remove channel subscriptions, move the channel subscriptions from
Available to Remove these subscriptions.
To remove all channel subscriptions from the selected users, select Remove
all.
5 To add channel subscriptions, move the channel subscriptions from
Available to Add these subscriptions.
6 Choose OK.
7 Grant the users read access to the channels to which they are subscribed,
either directly or through a security role.
The users must have read access to view the contents of the channels to
which they are subscribed. For information about granting channel
privileges to users and security roles, see How to modify the privileges for
more than one channel at a time in Chapter 12, Administering the
volume in the web environment.
How to delete more than one user account at a time
2 On Users, check the names of the users whose accounts you want to delete.
3 Hover the cursor over Act upon selected users and choose Delete.
4 Confirm the deletion.
How to create a security role
1 As Administrator, select Security Roles from the sidebar menu.
2 On Security Roles, choose Create Role.
New Security Role appears.
3 In General, enter the name of the security role and a description.
4 In Parent Roles, select parent roles for this security role.
For more information about parent roles, see About security roles, earlier
in this chapter.
5 In Child Roles, select child roles for this security role.
6 In Channel Privileges, assign channel privileges for this security role.
For more information about channel privileges, see Creating and
maintaining channels in Chapter 12, Administering the volume in the
web environment.
7 Choose OK.
How to modify a security roles properties
2 On Security Roles, hover the cursor over the icon to the left of the security
roles name and choose Properties.
3 Modify the security roles properties.
For more information about security role properties, see How to create a
security role, earlier in this chapter.
4 Choose OK.
How to add and remove users from a security role
roles name and choose Users.
3 To add users:
1 Choose Add.
2 Move the users you want to add from Available to Add.
3 Choose OK.
4 To remove users:
1 In Users, select the users you want to remove.
2 Choose Remove.
3 Confirm.
5 Choose Close.
How to clone a security role
You can create a new security role by cloning, or copying the properties of, an
existing security role.
roles name and choose Clone.
3 On New Role, modify the cloned security roles name and other properties
as necessary.
For more information about security role properties, see How to create a
security role, earlier in this chapter.
4 On Security Roles, hover the cursor over the icon to the left of the cloned
security roles name and choose Users.
5 On Users, modify the cloned security roles users as necessary.
For more information about Security Roles Users, see How to add and
remove users from a security role, earlier in this chapter.
How to delete a security role
roles name and choose Delete.
3 Confirm the delete action when prompted.
How to modify properties for more than one security role at a time
For more information about modifying properties for more than one security
role at a time, see:
I How to modify parent roles for more than one security role at a time
I How to modify child roles for more than one security role at a time
2 On Security Roles, select the names of the security roles whose properties
you want to modify.
To select all security roles, select Select all roles. To select all security roles
on the current page, select the box to the left of the Name column heading.
3 Hover the cursor over Act upon selected Roles and choose Properties.
How to modify parent roles for more than one security role at a
time
2 On Security Roles, select the names of the security roles whose parent roles
you want to modify.
4 On Properties, choose Parent Roles.
5 To remove parent roles, move the security roles from Available to the
Remove these roles list.
To remove all parent roles from the selected security roles, select Remove
all.
6 To add parent roles, move the security roles from Available to Add these
roles.
7 Choose OK.
How to modify child roles for more than one security role at a time
2 On Security Roles, select the names of the security roles whose child roles
you want to modify.
4 On Properties, choose Child Roles.
5 To remove child roles, move the security roles from Available to Remove
these roles.
To remove all child roles from the selected security roles, select Remove all.
6 To add child roles, move the security roles from Available to Add these
roles.
7 Choose OK.
How to add and remove users from more than one security role at
a time
2 On Security Roles, select the names of the security roles from which you
want to add or remove users.
3 Hover the cursor over Act upon selected Roles and choose Users.
4 To remove users, move the users from Available to Remove these users.
5 To add users, move the users from Available to Add these users.
6 Choose OK.
How to delete more than one security role at a time
2 On Security Roles, check the names of the security roles you want to delete.
3 Hover the cursor over Act upon selected Roles and choose Delete.
How administrators assign privileges on a file or folder
1 As Administrator, select Files and Folders.
2 On Files and Folders, hover the cursor over the icon to the left of the name
of the file or folder and choose Properties.
3 On Properties, choose Privileges.
4 On Privileges, assign the appropriate privileges for the file or folder.
You can assign privileges for both users and security roles. The following
illustration shows Privileges for a folder.
5 Choose OK.
How administrators assign privileges on the volumes root folder
1 As Administrator, select Volume Properties from the sidebar menu.
2 On Volume, choose Properties.
3 On Volume Properties, choose Privileges.
4 On Privileges, assign the appropriate privileges for the volumes root
folder.
You can assign privileges for both users and security roles.
5 Choose OK.
How to use a security role to assign privileges to users
1 For each file or folder, assign privileges to security roles.
For instructions, see How administrators assign privileges on a file or
folder, earlier in this chapter.
2 When you have set all the relevant privileges, assign the security roles to
the appropriate users. You must be an administrator to assign security roles
to a user.
For instructions, see How to modify security roles for more than one user
at a time, earlier in this chapter.
Creating notification groups
Notification groups provide a convenient way to inform sets of users that jobs
are completed and reports are available. When users schedule jobs, they have
the option of indicating notification groups. If a notification group is indicated,
the volume notifies each member of the group when the job completes, using
the notification method specified for each users account.
Only administrators can create notification groups; users cannot create or
modify notification groups.
If the volume is using the Actuate Open Security feature, see About Actuate
Open Security, later in this chapter.
How to create a notification group
1 As Administrator, select Notification Groups from the sidebar menu.
2 On Notification Groups, choose Create Group.
3 On New Group, enter the name of the group and a description.
4 Choose OK.
How to add and remove users from a notification group
2 Hover the cursor over the icon to the left of the notification groups name
and choose Users.
3 To add users:
1 Choose Add.
2 Move the users you want to add from Available to Add.
3 Choose OK.
4 To remove users:
1 In the Users list, select the users you want to remove.
2 Choose Remove.
3 Confirm.
5 On Users, choose Close.
How to rename or delete a notification group
I To rename a notification group, hover the cursor over the icon to the left of
the notification groups name and choose Properties. Then type the new
name on the groups Properties page.
When you change the name of a notification group, its membership
remains the same. If there are outstanding reports for the old group name,
they will be delivered.
I To delete a notification group, hover the cursor over the icon to the left of
the notification groups name and choose Delete. Confirm your intention to
delete the group when prompted.
Notifications for a deleted group name are not delivered.
How to clone a notification group
You can create a new notification group by cloning, or copying the properties
of, an existing notification group.
2 On Notification Groups, hover the cursor over the icon to the left of the
groups name and choose Clone.
3 On New Group, modify the cloned groups name and description.
4 Choose OK.
5 On Notification Groups, hover the cursor over the icon to the left of the
cloned groups name and choose Users.
6 On Users, modify the cloned groups users as necessary.
For more information about Notification Groups Users, see How to add
and remove users from a notification group, earlier in this chapter.
How to modify the description for more than one notification
group at a time
2 On the Notification Groups page, check the names of the groups whose
description you want to modify.
To select all groups, select Select all groups. To select all groups on the
current page, select the box to the left of the Name column heading.
3 Hover the cursor over Act upon selected Groups and choose Properties.
4 On Properties, enter the description.
5 Choose OK.
How to add and remove users from more than one notification
group at a time
2 On Notification Groups, select the names of the groups from which you
want to add or remove users.
To select all groups, select Select all groups. To select all groups on the
3 Hover the cursor over Act upon selected Groups and choose Users.
4 To remove users, move the users from Available to Remove these users.
5 To add users, move the users from Available to Add these users.
6 Choose OK.
How to delete more than one notification group at a time
2 On Notification Groups, select the names of the groups you want to delete.
3 Hover the cursor over Act upon selected Groups and choose Delete.
About Actuate report page security
Actuate report page security is available if you have the e.Report (Actuate
Basic/Java Report) Generation option with the Page Level Security option.
With report page security, Actuate Basic report developers create a report
document using security rules that determine which pages a user can view. If
the Page Level Security option is not available, the page security features of a
report are disabled and users are notified that the Page Level Security option is
required to read the report.
Using report page security, the report developer creates a report that defines a
list of users and security roles associated with the reports groups and sections.
In the report design, the list can be in the form of a static list or an expression
that generates a list based on information in the report. This list is used to
generate the Access Control List (ACL) for each report page. For more
information about creating reports using page security, see Chapter 19,
Designing reports with page level security, in Developing Advanced e.Reports.
Viewing reports with page security
When the report is in the volume and viewed, the View process retrieves
information about the user from the volume. The users information is then
compared against the ACL for each page in the report to determine which
pages the user can view.
Using the Report Server Security Extension
Using the Report Server Security Extension (RSSE) and page security,
developers can create an RSSE application that associates security IDs in an
ACL to one or more users or security roles. For example, a report developer
can create an Actuate Basic report that contains Demo as a security ID in some
of the reports ACLs. Using an RSSE application, Demo does not have to be a
user or security role. The RSSE application can take the security ID Demo and
map it to a set of users. When a user associated with Demo views the report,
that user can see the report pages where the pages ACL contains Demo.
Enabling report page security
To use page security in Actuate Basic reports, administrators set the following
privileges for a user or security role:
I The report executable (.rox) requires read and execute privilege.
I The report document (.roi) requires secure read privilege.
If the report document has read privilege, page security is disabled and
users with read privilege on the report document can view the entire
report.
For more information about the secure read privilege, see Setting secure read
privilege, earlier in this chapter.
How to enable page security
To enable page security on an Actuate Basic report document, apply the secure
read privilege on the report document. Any user who wants to run the report
must also have read and execute privilege on the report executable (.rox).
How to disable page security
To disable page security on a report, apply the read privilege to the report.
Any user with read privilege can read the entire report, even if the report
contains page security.
About Actuate Open Security
Actuate Open Security is available with the e.Reporting Server. Using Open
Security, Actuate developers use the Actuate Report Server Security Extension
(RSSE) to create an interface to an external security source such as a
Lightweight Directory Access Protocol (LDAP) server. Using the interface, the
e.reporting system retrieves information from the external security source to
control access to the volume. Developers create an interface to the volume that
performs various levels of authentication based on an external security source.
Authentication is the process of verifying the login information received from
a user. A user sends the login information to authenticate the users identity.
As an example of authentication, a password confirms that the user is entitled
to use a particular user ID. More complex authentication mechanisms include
smart cards that a user must run through a reader, digital certificates, or
biometric data such as fingerprints.
Authorization is the process of determining whether an authenticated user is
allowed to access a particular resource. As an example, the e.reporting system
determines whether a user has the right to access a particular item in a
volume.
Actuate supplies an Open Security application with the e.Reporting Server.
The Open Security application uses security information from a Netscape
Directory Server, an LDAP server, to control logins into the volume. The Open
Security application that ships with the e.Reporting Server uses external user
registration where all user information is stored within the LDAP server. For
more information about external user registration, see About external user
registration later in this chapter. For information about requirements for
using the Open Security application and configuration information, see
Chapter 6, Working with e.Reporting Server utilities.
Actuate Open Security can be configured for one of several levels of use. The
Open Security application that ships with the e.Reporting Server uses the
external user registration level. The following table lists and describes all the
available Open Security levels.
Level Description
Open Security not
used
This option is the default. All information about
users, security roles, and notification groups is
specified and stored in the volume.
All privilege information used for authorization
is stored in the volume.
External user
authentication
Users, security roles, and notification groups are
At login, a Report Server Security Extension
application authenticates users externally.
A Report Server Security Extension application
maps the user to an Actuate user.
Complex credentials are supported.
The Open Security not used level, External user authentication level, and
External user registration level are mutually exclusive.
Use the External user properties level with the Open Security not used level or
with the External user authentication level.
About external user authentication
Using a Report Server Security Extension (RSSE) application, the e.reporting
system accesses an external security source to authenticate user credentials
such as a user name and password when a user attempts to log in to the
volume. The security source determines whether the user credentials are valid
and what Actuate user account should be used to access the volume.
The e.reporting system passes the users log in credentials to the security
extension application. The application evaluates the credentials and
determines whether the user is allowed access to the volume.
At this Open Security level, Actuate user accounts and Actuate security roles
are defined in the volume. Each user must be defined in the volume. Privileges
are defined, using Actuate user names and security roles, for access to folders
and other items such as reports, jobs, and channels.
About external user properties
Using Open Security functionality, any combination of the following Actuate
user properties can be stored in an external security source:
I E-mail address
I Web viewing preference
I Home folder
External user
properties
Some or all user properties are specified in an
external security source.
External or internal user authentication can be
used.
External user
registration
specified in an external security source. They are
not specified or stored in the volume.
All user properties are obtained externally.
External user authentication must be used.
Level Description
I Privilege template
I Maximum job priority
I Security IDs (used for page security)
I Notification preferences
I Channels to which the user subscribes
If a property is specified externally, the propertys value in the volume is
ignored. You cannot use the volume administration pages to update the
property.
At this Open Security level, the following information is managed within the
volume:
I User name
I Security role membership
I Notification group membership
I Privilege rules in the form of access control lists for folders and other items
such as reports, jobs, and channels
About external user registration
Using this level of Open Security functionality, an RSSE application obtains all
user information from the external security source. The RSSE application
determines whether the user credentials are valid and specifies the users
properties.
At this Open Security level, the volume passes the users log in ID and
credentials to the RSSE application. The application evaluates the credentials
and determines whether the user is allowed access to the volume and, if so,
what the user properties are.
The following information about the user is maintained externally:
I User name
I E-mail address
I Web viewing preference
I Home folder
I Privilege template
I Maximum job priority
I Security role membership
I Security IDs (used for page security)
I Notification preference
I Notification group membership
I Channels to which the user subscribes
At this Open Security level, you do not specify or store the user in the volume.
If you have a security source with user profiles that contain the appropriate
user information, developers can create an RSSE application that uses this
information. You do not have to duplicate the user information in the
volume.Use the volume administration pages to assign privileges.
At this Open Security level, the external security source provides the identities
of users, security roles, and notification groups and there is no distinction
between the external name and the name in the volume. The external security
source provides a single, unique identity for each user, security role, and
notification group.
Master lists of users, security roles, and notification groups are not stored in
the volume. Instead, the volume uses the RSSE application to retrieve lists of
users, security roles, and notification groups and their properties.
The volume stores access control lists for each folder and other items such as
reports and other files in the volume, jobs, and channels, containing the names
of users and security roles from the RSSE and the privileges assigned to each
user and security role.
About externally defined Actuate security roles
When using an RSSE application with externally defined Actuate security
roles, the security roles cannot be nested. For example, if the Actuate security
roles supervisor and manager are defined externally, the supervisor security
role cannot be a member of the manager security role.
About the All security role and external registration
The All security role is a system security role assigned to all users. When using
external registration, developers can create an RSSE application that enables or
disables the All security role in the volume.
If the RSSE application enables the volumes All security role, a security role
with the name All can exist in the external security source, but volume
administrators might not want to use the security role name All as the
volumes All security role. Developers can use Open Security functionality to
use a different security role name that is assigned to all users.
About the Administrator security role and external
registration
The Administrator security role is a system security role with administrative
privileges. Users assigned to the security role named Administrator have the
capabilities of an administrator user in the volume and can perform
administrative functions and can access any item in the volume.
A security role with the name Administrator can exist in the external security
source, but volume administrators might not want to use the administrator
security role to administer the volume. To support a separate Actuate
Administrator security role, Open Security functionality can translate an
external security role name to indicate which security role defined in the
external security sources is used as the Actuate Administrator security role.
About the administrator user and external registration
The administrator user is automatically created in the volume. The
administrator user can access and administer any item in the volume.
When using external user registration, the administrator user stored in the
volume is not available. For users to administer the volume, they must belong
to the Administrator security role.
About the Operator security role and external
authentication
The Operator security role is a system security role. Members of the volumes
Operator security role can configure the volume into read-only mode for
online backup and can return the volume to normal mode from read-only
mode. When using external registration, the Operator security role is defined
in the volume. Users assigned to the security role named Operator have the
same capabilities in the volume.
A security role with the name Operator can exist in the external security
source, but volume administrators might not want to use this security role for
online backup in the volume. To support a separate Actuate Operator, Open
Security functionality can translate an external security role name to indicate
which security role defined in the external security source is used as the
Operator security role.
About channels and external authentication
The volume maintains a list of channels. The volume or an external security
source maintains the list of channels to which a user subscribes.
Using the volume administration pages with open
security
This section describes the differences in the volume administration pages
when using the Actuate open security application that ships with the
e.Reporting Server.
Log in with open security
Using the Active Portal Security Extension, developers can create a custom
login for use when a user accesses the volume with a web browser and
Actuate Active Portal. Using Actuate Open Security functionality, developers
can create a custom login from an Actuate desktop product to the volume. The
login application passes the login information from the desktop product to the
volume for authentication.
About home folder privileges with externally defined users
If the volume uses the Actuate Open Security RSSE application that ships with
the e.Reporting Server, the volumes administrator must assign privileges on
the users home folder. The privileges on a users home folder are not
automatically updated.
About printer properties for externally defined users
Three levels exist for setting printer properties:
I Default printer properties for the volume
I Default printer properties for a user
I Printer properties for a specific job
If users are defined externally, the volume administration pages disable the
ability to modify default printer properties for a user.
About external properties
Any fields used for properties that are defined externally are disabled. The
following illustration shows how user properties appear when the user name,
password, e-mail address, viewing preference, and home folder are defined
externally. Each of these fields is read-only.
About the wildcard character
You cannot use the wildcard character, the asterisk (*), in the Filter text box on
any of the volume administration pages if the volume is using open security.
C h a p t e r 1 0 , Ma n a g i n g p r i n t e r s a n d p r i n t j o b s 345
C h a p t e r
10
Chapter10Managing printers and
print jobs
I About e.reporting system printers
I About printer properties
I Setting up printers
I Managing print jobs as administrator
About e.reporting system printers
The e.reporting system recognizes and supports network printers set up for
your Windows or UNIX servers. You do not have to install printers specifically
for the e.reporting system. You do, however, customize printer settings for
each printer available to the e.reporting system.
As an administrator, you need to prepare the network printers so that users
can use them to print reports in the volume. You typically perform this task
only once, after installing the e.reporting system. Preparing the network
printers entails setting the volume-level properties for each printer. Once these
are set, users can use the volume-level properties, use their own default
printer settings, or change the printer settings when they submit a print job.
About printer properties
When a user prints a report, the network printer gets its printing options from
three sources, in the following order:
1 The printer properties the user sets for the print job.
2 The printer properties the administrator or user sets as the default settings
for a specific printer. The users default settings take precedence.
3 The printers volume-level properties that the administrator sets.
If the volume is using Actuate Open Security and users are defined externally,
the e.reporting system disables the ability to modify default printer properties
for a user. For information about Open Security see About Actuate Open
Security in Chapter 9, Managing Report Encyclopedia volume security.
The following diagram illustrates how a printer determines what printer
properties to use for a print job.
Setting up printers
As administrator, you need to set up the network printers before users can
print to them. For each printer available to the e.reporting system, you specify
default settings, such as scale or number of copies to print. Administrators or
users can then change these default settings. Some printer properties, such as
resolution and color, are available only if the printer supports them.
For information about how an administrator can change a users default
printer settings, see How to add a user in Chapter 9, Managing Report
Encyclopedia volume security. For information about how a user can change
his default printer settings or change the printer settings for a print job, see
Chapter 3, Viewing and printing reports, in Using e.Reports.
How to set volume-level printer properties
1 As Administrator, select Volume Properties from the sidebar menu.
3 On Volume Properties, choose Printing.
4 On Printing, specify a default printer and printer settings for the volume.
I For Windows servers, the following fields are read-only:
- Manufacturer
- Model
- Description
- Location
Printer uses
these settings
Yes
Yes
Properties set for
the print job?
Properties set for
the printer?
Volume defaults
No
No
Yes
To change these fields, run the Windows Printer Manager on the server
and change the information there.
I For UNIX servers, you must specify the printer model.
5 When you have finished setting the properties for a printer, you can set
properties for another network printer by selecting a different printer.
6 Choose OK.
Managing print jobs as administrator
All scheduled, pending, running, and completed print jobs for the volume can
be viewed with the Jobs pages when you log on as administrator. To display
Jobs, choose Jobs from the sidebar menu.
Jobs pages track both print and report generation jobs, providing information
about who submitted a job, the date and time it was scheduled, the file size,
the priority, and so on.
The following illustration shows the jobs currently running on the volume.
To cancel a print job, cancel the job on the Jobs - Pending or Jobs - Running
pages.
Ch a p t e r 1 1 , Ma n a g i n g e . r e p o r t i n g s y s t e m r e s o u r c e s 351
C h a p t e r
11
Chapter11Managing e.reporting
system resources
I Administering jobs
I Archiving files
I Backing up the volume
Administering jobs
Administrators can create report generation or print jobs and can allow users
to create jobs. An administrator can also control how the jobs are handled by
the e.reporting system by setting:
I A jobs execution schedule
I A users maximum job priority
I A scheduled jobs priority
I For scheduled jobs, a retry schedule for failed jobs
For more information about scheduling jobs, see Chapter 4, Running
reports, in Using e.Reports.
A user must have execute privilege on a report executable (ROX) to run it and
create a job to generate a report document (ROI). If the user creates a report
document using values from a parameters value file (ROV), the user must also
have read access to the parameter values file. Finally, the user must have write
access to the item and the directory to which the report document is written.
Only the submitter of a job and an administrator can cancel the job. Any user
can get or delete the job information that is associated with his or her user
name. Only an administrator, however, can cancel and get the job information
for other users.
About scheduled jobs
To let users generate and print reports, the e.reporting system incorporates a
flexible job scheduling model. The scheduled jobs appear on the Job Schedules
page. For more information about scheduling jobs, see Chapter 4, Running
reports, in Using e.Reports.
After a scheduled job completes, the job remains on the Jobs - Completed page
for at least 24 hours. After 24 hours, the scheduled job remains on the Jobs -
Completed page until all the completion notices related to the scheduled job
are removed from the users personal channel. At this point the job is
considered obsolete.
About job priorities
Each job has a priority, which is an integer between 1 and 1000. Higher
numbers indicate higher priorities.
About users job priorities
As the administrator, you set the users maximum job priority. For information
about assigning a users maximum job priority, see How to set a users
maximum job priority, later in this chapter. By controlling the priority, you
influence the scheduling of the job.
When a user submits a job to generate or print a report, the user assigns a
priority. The e.reporting system uses the jobs priority to schedule the
generation of the report. For example, when a user submits a job to generate a
report, the user can assign a High priority to the job.
Administering open server jobs
Users can create jobs using open server reports. Jobs for generating or printing
open server reports are managed by the e.reporting system along with other
report generation and printing jobs, including scheduling and handling the
priority of the job. The report generation or printing is handled by the open
server driver.
For example, if your e.reporting system is configured to generate a Crystal
Reports report document, the e.reporting system creates and handles the jobs
schedule and priority. The open server driver and the Crystal Reports
reporting tool from Crystal Decisions generate the report document.
As administrator, you should make sure the open server jobs account for
usage of the external reporting tool. For information about Actuate open
server see About Actuate open server, in Chapter 13, Understanding
Setting a maximum job priority
As the volumes administrator, you control a users maximum job priority. The
user chooses a priority when he submits a job to generate or print a report.
With Actuate Open Security enabled, if the users maximum job priority is
defined in an external security source, it cannot be changed from the volume
administration pages. For information about Open Security, see About
Actuate Open Security in Chapter 9, Managing Report Encyclopedia
volume security.
How to set a users maximum job priority
2 Hover the cursor over the icon to the left of the users name and choose
Properties.
3 On Users Properties, choose Jobs.
4 On Jobs, set the users maximum job priority.
Setting the default job retry policy
As administrator, you can configure job retry options to retry scheduled report
generation or print jobs that have failed:
I The volumes default job retry settings are the default settings for
scheduled jobs.
I For a scheduled job, the scheduled job settings override the volumes
default settings. For information about setting scheduled job retry options,
see Chapter 4, Running reports, in Using e.Reports.
Setting the volumes default job retry policy
As administrator, you can configure the volume to retry scheduled report
generation or print jobs that have failed. Users who can submit jobs can
override the defaults for their scheduled jobs. Only administrators can change
the volumes default job retry policy.
I Retry settings do not apply to jobs that are not scheduled. Reports are set to
run using the Right now option.
I For Retry N times; wait H hours M minutes between attempts, when N is
not 0 and H and M are set to 0, the volume resubmits the job immediately
after a failure.
I New instances of a scheduled job are canceled with an appropriate
message if the previous instance is still retrying. The retry count (N) for the
existing instance is not incremented.
How to set the volumes default job retry policy
1 As Administrator, select Volume from the sidebar menu.
3 On Volume Properties, choose General.
4 On General, specify the default job retry policy, and choose OK.
Running scheduled jobs after a system restart
If the e.reporting system is down at the time a job is scheduled to be run, the
job is run when the e.reporting system is restarted.
Archiving files
Using the volumes autoarchive features, administrators and users specify
parameters to delete and archive files automatically, such as Actuate reports,
open server reports, and other documents stored in the volume.
I Volume administrators can set autoarchive rules for the entire volume and
on specific folders and files.
I System administrators can specify the archive library used to archive files.
A single archive library is specified for the volume.
I Non-administrator users can set autoarchive rules on folders and files. A
user must have delete permission on the folder and file to set autoarchive
rules. When submitting jobs, users can also set autoarchive rules. For
information about setting autoarchive rules for folders and files, see
Chapter 2, Accessing a Report Encyclopedia volume, in Using e.Reports.
The following autoarchive rules can be set on folders or files:
I Do not automatically delete files based on an autoarchive rule.
I Delete files older than a specified age.
I Delete files after a specified date.
I Archive files before deleting if an archive library is specified.
Use the Auto Archive tab to view autoarchive rules for files and folders:
I The Auto Archive tab on a folders or files Properties page indicates the
autoarchive rule used.
I Users can see autoarchive information by choosing View Policy on the
Auto Archive tab of the files or folders Properties page.
The following autoarchive rules can be set for jobs:
I Do not automatically delete the output document based on an autoarchive
rule.
I Delete the output document if it is older than a specified age.
I Delete the output document after a specified date.
I Archive the output document before deleting if an archive library is
specified.
The following describes the scope of autoarchive rules:
I An autoarchive age or date rule set using a folders Properties applies to all
files contained in subfolders within the starting folder. Folders are never
deleted, only their contents. An autoarchive rule on a file overrides any
rule inherited from a folder that contains the file.
I Dependent files are also aged.
I From a folders Properties, a user can specify a rule for a particular file type
such as .roi or .rox.
I From the volumes Properties, the volume administrator can specify a
default rule for a particular file type such as .roi or .rox.
I If a system administrator specifies an archive library for the volume, the
Archive files before deletion option is enabled as the default whenever an
age-based or date-based rule is specified.
The Archive files before deletion option is enabled even if the age-based or
date-based rule is set before the archive library is specified.
I If a user changes between a date-based rule and an age-based rule, the
volume administration pages initialize the value of the age or date control
by calculating the time span up to the last date or age specified.
The following describes what the e.reporting system does during the
autoarchive process:
I When performing autoarchive, the e.reporting system uses the most
specific autoarchive rule. The e.reporting system uses autoarchive rules in
the following order:
I The setting on the file itself
I The setting for the specific file type from the files folder setting
I The folders default setting
I The file type from the containing folder
I The containing folders default setting
I The settings for the folders in the hierarchy.
I The volumes settings
I By default, the e.reporting system performs aging once during the day. The
system administrator can specify when and how many times a day aging is
performed.
When the e.reporting system performs auto-archiving, it starts from the
volumes root folder. For each file that meets the age criteria, it deletes the
file. If the Archive files before deletion option is enabled, the e.reporting
system calls the archive library specified for the volume, and then deletes
the file if the archive process is successful. If the archive process is not
successful, the file is not deleted.
Understanding archiving with autoarchive
As part of autoarchive, a system administrator can specify an archive library
that the system uses to archive files in the volume before they are deleted. The
archive library is software that is the interface between the e.reporting system
and an external archiving tool. On Windows systems, the archive library is a
DLL. On UNIX systems, the archive library is a shared library. The name of the
archive library is specified on the General tab of the Volumes Properties page
in the system administration pages. For information about creating an archive
library, see Chapter 11, Aging and archiving Report Encyclopedia items, in
When the e.reporting system performs aging, it loads the archive library.
During auto-archiving, if a file is set to be deleted and the Archive files before
deletion option is set, the file is exported to the external archiving tool. The file
is read-locked during the archive process so that no other process can delete or
change the file during archival.
After the archive library signals that the archive process is successful, the file is
deleted. The file is not deleted if the archive library signals a failure.
Setting the volumes autoarchive rules
Administrators can set the autoarchive policy for files in the volume. The
volumes administrator can:
I Set the autoarchive rule for all the files in the volume.
I Set an autoarchive rule for a specific file type.
Administrators set the autoarchive rules for the volume on the Auto Archive
tab of the Volume Properties page. Only an administrator can set the volumes
autoarchive rules.
The volumes autoarchive rules are overridden by setting an autoarchive rule
on a folder, file, or job.
How to set the volumes autoarchive rules
3 On Volume Properties, choose Auto Archive.
4 On Auto Archive, specify the autoarchive policy for the volume.
You can specify a default autoarchive policy and an autoarchive policy for
each file type known to the volume, including open server file types. For
information about open server file types, see About predefined open
server file types in Chapter 13, Understanding Actuate e.Reporting
Archive
software
Volume
External
archive
software
Actuate
e.reporting
system
Actuate
software
Archive
library
Archive
location
Server options. If you do not specify an autoarchive policy for a file type,
the volume uses the default autoarchive policy.
5 Choose OK.
How to start an aging cycle
2 On Volume, choose Auto Archive Now and confirm.
Backing up the volume
Using online backup, a user who is a member of the Operator role can place
the volume into online backup mode or return it to normal mode from online
backup mode. Once the volume is in online backup mode, a volume
administrator can use a third-party utility to back up a snapshot, which is a
consistent image of the volume. As the backup is going on, users continue to
access and view reports from the volume. Using the snapshot of the volume,
volume administrators can restore a consistent, usable version of the volume.
The volume is in either normal mode or online backup mode. Normal mode is
the normal operation mode. Online backup mode is the state used to backup a
snapshot the volume.
In online backup mode, users cannot create, update, or delete volume file
types. All other operations are supported in online backup mode.
Placing the volume in online backup mode ensures the snapshot taken during
the backup can be used to restore the volume. To restore a snapshot after
retrieving the volume from the backup media, Actuate supplies a volume
recovery utility.
When backing up a volume that is in online backup mode, do not back up the
volumes transaction log directory. You can specify a different partition for the
transaction log directory or exclude the transaction log directory from the
backup. For information about specifying the transaction log partition, see
Viewing volume information, in Chapter 4, Performing system
A user assigned to the Operator role can place the volume in online backup
mode using either the volume administration pages or command line utilities
that ship with the e.Reporting Server. For more information about e.Reporting
Server utilities, see Chapter 6, Working with e.Reporting Server utilities.
If you restore the volume using a snapshot, the volume restores to the state it
was in before online backup mode was invoked. Changes made to the volume
between the time you placed the volume in online backup mode and the time
when you last backed up the volume are not restored.
Setting online backup mode
Switch to online backup mode is available on Volume if you are a member of
the Operator role.
Current mode displays the volumes current mode, Normal or Online backup.
Choosing Switch to online backup mode enables operators to initiate the
online backup mode for the volume.
Choosing Switch to normal mode changes the volumes mode of operation to
normal from online backup.
Scheduling online backups
The Online Backup Schedule button is on the Volume page. Use this button to
schedule an online backup on a regular basis.
The Duration default is 3 hours, and the valid range is between 1 and 1440
minutes. The Start date and the End date specify the duration of the schedule.
Ch a p t e r 1 2 , A d mi n i s t e r i n g t h e v o l u me i n t h e we b e n v i r o n me n t 363
C h a p t e r
12
Chapter12Administering the
volume in the web
environment
I Viewing reports configuration
I Setting web browser page caching options
I About channels
I Viewing channels and their contents
I Creating and maintaining channels
I Scheduling jobs for channels
Viewing reports configuration
When displaying an Actuate Basic report in a web browser in DHTML format,
the e.reporting system uses the Actuate View process and Actuate Active
Portal.
The View process converts pages and other Actuate Basic report document
data to DHTML as needed. The volume stores and manages report documents
as report instances (.roi files). Administrators can use the extensive security
provided by the volume. Because the Actuate Basic reports are not stored as
separate HTML files there is no need to maintain separate HTML and .roi
report files.
Using the View process, when a user views a page of an Actuate Basic report
document over the web, the View process converts the page and other
required report data to DHTML and delivers the page to Actuate Active
Portal. Actuate Active Portal and the web server deliver this page to the user
as a DHTML page. Actuate supports viewing Actuate Basic report documents
over the web without the need to install any client software aside from a
standard web browser that supports JavaScript and dynamic HTML
(DHTML).
The following illustration shows the interaction of the components when
using the View process to view Actuate Basic reports.
For information about using DHTML reports, see Part 1, Using reports with
Active Portal, in Using e.Reports.
Users can also view Actuate Basic reports in the native ROI format with the
Actuate LRX plugin for Netscape Navigator or Microsoft Internet Explorer
Server software
Actuate
Active
Portal
User
Volume
Web
browser
Internet
Web server
Actuate
e.reporting
system
View
process
and a web browser. Desktop viewing uses the Actuate End User Desktop or
Actuate Viewer applications.
Specifying report viewing modes
Administrators can specify the viewing mode for viewing Actuate Basic
reports over the web. Specify either DHTML or LRX. The mode can be set for
the volume and for individual users. The users preference overrides the
administrators settings for the user and the default setting for the volume:
I DHTMLActuate Basic reports converted to DHTML using the Actuate
View process. Users need a JavaScript and Dynamic HTML capable
browser. The web browser must have the use of style sheets enabled.
I LRXActuate Basic reports view in the native format. Users must install
the Actuate LRX with their web browser.
Specifying the default web viewing mode
The volumes default web viewing mode for Actuate Basic reports is specified
on the Volume Properties page. Administrators can specify either DHTML or
LRX modes.
Specifying the users viewing mode
The administrator can specify the web viewing mode for Actuate Basic reports
for individual users. Select Default, DHTML, or LRX. The Default setting uses
the volumes default setting. If the settings for the user and the volume differ,
the users viewing mode takes precedence.
The user can also set his own viewing options.
Setting web browser page caching options
From the General tab of the Volume Properties page, an administrator can
enable or disable caching of DHTML reports by a web browser. Checking
Allow browser-side caching of DHTML reports enables a users browser to
store Actuate Basic report DHTML pages on the users local machine in the
browsers cache directory. An administrator can specify the length of time
before the pages cached on the users system expire.
About channels
Users can subscribe to channels on the web and view Actuate reports available
on those channels. Channels use push technology, also called webcasting,
push/distribution, and publish/subscribe, to push reports to channels, where
users can access and view them. When new reports become available, the
appropriate channel receives a notification. Using Actuate Active Portal,
subscribed users can check the channels web page to get a listing of available
reports. When users click on a report link, the report appears in a web browser
window. The following are channel features:
I Channels are available in Actuate Active Portal and Actuate Management
Console. They are administered with Actuate Management Console.
As administrator, you can customize Actuate Active Portal by modifying
the Actuate Active Portal JSP. For more information about customizing
Actuate Active Portal, see Customizing e.Reporting Web Applications.
I Channels are secure.
I Channels have unique names.
I Channels receive notifications when reports generated for the channel
complete.
I Reports in channels can display headlines that describe the reports. This
headline appears when listing the contents of a channel.
I Channel items expire after a given time period and are removed from the
channel.
A user can:
I Retrieve the list of available channels.
I Subscribe to a channel.
I Drop a channel subscription.
I View the list of reports in a channel.
I View the reports in a channel.
I Update a channels contents.
Users can subscribe to channels and drop channel subscriptions using Actuate
Active Portal. After connecting to a volume, users can go to a page that lists all
channels to which the user has access.
Actuate Active Portal provides web pages that:
I Display the contents of a channel. The contents are completed jobs that
appear in descending chronological order.
I Enable the user to subscribe to or unsubscribe from a channel.
Actuate Management Console provides web pages that:
I Enable the administrator to subscribe users to or unsubscribe users from a
channel.
I Let an administrator create, delete, and modify channels.
I Display a list of subscribers to a channel.
Viewing channels and their contents
Users can view a list of channels to which they are subscribed with Actuate
Active Portal. From this page, the user can view a channels contents. The
following illustration shows Channels for a user.
As the default, when the user views the contents of a channel, the contents
appear as a list containing the headline, the job name, the name of the output
document, the owner, and so on. Clicking on the link for an output document
displays the report itself.
The contents of a channel remain in the channel even after the user has viewed
them. The web browser uses a different color to display visited reports, so the
user can easily track which reports have been read.
Creating and maintaining channels
Only a volumes administrator can create, modify, or delete channels. The
volumes administrator has access to all channels defined for the volume. The
administrator specifies which security roles and users have access to which
channels.
How to create a channel
1 As Administrator, select Channels from the sidebar menu.
2 On Channels, choose Create Channel.
3 On New Channel, complete General.
NameThe channel name can be any length, but must be unique.
DescriptionA description of the channel.
Refresh everyA rate that determines how often the web browser
refreshes a view of the channel. The default is 180 seconds. The minimum
allowed is 60 seconds.
Auto delete afterThe length of time the report is available in the channel.
After that, the volume deletes the report notice from the channel. The
default is 14 days.
Small (16x16) icon URLThe full URL of an image file. If this URL is not
set, a default image is used to represent the channel.
Large (32x32) icon URLThe full URL of an image file. If this URL is not
set, a default image is used to represent the channel.
The Actuate Management Console displays the small icon. Actuate Active
Portal displays either the small icon or the large icon.
4 Choose Get Images to display the images on New Channel.
5 On New Channel, complete Privileges.
Specify the security roles and users that have Read or Write privilege on the
channel. You must specify which security roles and users have which
privileges on a specific report. For information about assigning privileges
on a report, see How administrators assign privileges on a file or folder
in Chapter 9, Managing Report Encyclopedia volume security.
6 Choose OK.
How to update a channel
2 On Channels, hover the cursor over the icon to the left of the channels
name and choose Properties.
3 Modify the channels properties and choose OK.
For more information about channel properties, see How to create a
channel, earlier in this chapter.
How to show subscribers to a channel
2 Hover the cursor over the icon to the left of the channels name and choose
Show Subscribers.
3 Choose Close.
How to clone a channel
You can create a new channel by cloning, or copying the properties of, an
existing channel.
2 On Channels, hover the cursor over the icon to the left of the channels
name and choose Clone.
3 On New Channel, modify the channels name and choose OK.
4 Display the list of subscribers to the channel.
For more information about displaying a list of subscribers to a channel,
see How to show subscribers to a channel, earlier in this chapter.
5 Unsubscribe users from the channel as necessary.
6 Subscribe additional users to the channel as necessary.
For more information about subscribing users to and unsubscribing users
from a channel, see How to modify channel subscriptions for more than
one user at a time in Chapter 9, Managing Report Encyclopedia volume
security.
7 Modify the channels other properties as necessary.
A user must have read access to the channel, either directly or through a
security role, to view the contents of the channel.
For more information about channel properties, see How to create a
channel, earlier in this chapter.
How to delete a channel
2 Hover the cursor over the icon to the left of the channels name and choose
Delete.
How to modify properties for more than one channel at a time
For more information about modifying properties for more than one channel
at a time, see How to modify the privileges for more than one channel at a
time, later in this chapter.
2 On Channels, select the names of the channels whose properties you want
to modify.
To select all channels, select Select all channels. To select all channels on the
3 Hover the cursor over Act upon selected channels and choose Properties.
How to modify the privileges for more than one channel at a time
2 On Channels, select the names of the channels whose privileges you want
to modify.
To select all channels, select Select all channels. To select all channels on the
3 Hover the cursor over Act upon selected channels and choose Properties.
4 On Properties, choose Privileges.
5 To remove privileges:
1 Move the security role or user from Available to Remove these
privileges.
2 Uncheck the privilege you do not want to remove.
To remove all security roles and users from the selected channels, select
Remove all.
6 To add privileges:
1 Move the security role or user from Available to Add these privileges.
2 Select the privileges you want to add.
7 Choose OK.
How to delete more than one channel at a time
2 On Channels, check the names of the channels you want to delete.
3 Hover the cursor over Act upon selected channels and choose Delete.
Scheduling jobs for channels
When you schedule a job, you can specify which channels to notify when the
report generates. You still need the appropriate privileges to generate and
view a report. The users viewing the report by way of a channel also need the
appropriate privileges. For information about privileges, see About
privileges in Chapter 9, Managing Report Encyclopedia volume security.
When the e.reporting system generates the report, a notification message is
displayed in the channel. A subscriber to the channel can view the report by
selecting the name of the output document in the channel notification.
When you generate a report for a channel, you can specify a headline that
generates as part of the channel notification. Users who generate the report
can enter a value for the headline on the Output tab of the job schedules
Properties page, as shown in the following illustration.
Report developers can also specify the headline. By default, the volume copies
the value of the headline into the Headline field. Changing the headline for a
job does not change the value of the variable in the report. That is, if the report
is run from an .rov file, then changing the headline for the job does not change
the original value in the .rov file.
How to schedule a job for a channel
1 Select Jobs from the sidebar menu.
2 On Jobs, choose Scheduled.
3 Hover the cursor over the icon to the left of the job name and choose
Properties.
4 On Job Schedules Properties, choose Channels.
5 On Channels, select the appropriate channels.
6 Choose OK.
C h a p t e r 1 3 , Un d e r s t a n d i n g A c t u a t e e . Re p o r t i n g S e r v e r o p t i o n s 377
C h a p t e r
13
Chapter13Understanding Actuate
e.Reporting Server
options
I About Actuate open server
I Understanding the interface between the open server shell and the driver
I Understanding open server framework Unicode compliance
I Administering e.Spreadsheet reports
I Using e.Reports Java Edition
About Actuate open server
Using the core e.Reporting Server, users can manage report executables and
reports from third-party vendors such as Crystal and SQRIBE.
The e.Reporting Server supplies open server drivers for Crystal Decisions
Crystal reports and SQRIBE SQR reports on Windows. Actuate does not
provide any Crystal reports or SQRIBE software. Obtaining third-party
software such as Crystal reports or SQRIBE software and any required licenses
is the responsibility of the customer. For information about creating other open
server drivers, see Chapter 12, Working with Actuate Open Security, in
The Crystal report extensions defined by the e.Reporting Server are:
I RPX, defined as Crystal executable file RPT
I RPW, defined as Crystal web report file RPW
I RPT, defined as Crystal report file RPT
The SQRIBE report extensions defined by the e.Reporting Server are:
I SPF, defined as SQRIBE report file SPF
I SQR, defined as an uncompiled SQRIBE report file SQR
I SQT, defined as SQRIBE report file SQT
Volume administrators can:
I Manage the various open server report generation tools that are used with
the e.reporting system. These include such administration server-related
tasks as adding, removing, and editing properties and settings for these
tools.
I Access external files using open server functionality. These might include
files that are external to the volume but are accessible to the e.reporting
system.
I Handle the generation and printing of open server reports.
I Specify that an open server file type be temporarily copied to a web server
file system for viewing. Users can then view files using web server viewing
technologies that require direct access to the file on the web server file
system.
Users can:
I Import open server reports. For information about importing open server
reports, see Chapter 1, Introduction to Active Portal and the e.Reporting
system, in Using e.Reports.
I Schedule jobs to generate and print open server reports. For information
about scheduling jobs, see Chapter 4, Running reports, in Using e.Reports.
To use the Actuate open server functionality, you must install the following
software:
I The Actuate core e.Reporting Server
I Open server report files such as third-party report executable or report
document files
I The appropriate open server driver
The open server driver must be installed on all reporting engines.
I A third-party report generation engine and any required supporting
software, such as Crystal Decisions Crystal Reports or the SQRIBE SQR
Server
In the volume, you must specify the parameters and settings for the open
server report executable and documents, including:
I Location of the open server driver and the third-party report generation
engine
I Parameters and settings required to generate the open server reports
I Report-specific parameters and settings
If you are specifying viewing using a web server file system, you must install
the appropriate software on the appropriate web server.
Using the open server
After the e.reporting system is configured to handle open server reports, users
can submit jobs to run or print open server reports from the volume. When the
volume runs a job, it exports a copy of the third-party report and passes
parameters and other information about the open server report to the open
server driver. The open server driver communicates with the e.reporting
system and the third-party report generation tool to generate or print a report
document, and signals the e.reporting system that the report is complete. The
e.reporting system can import the completed report document into the
volume.
The following illustration shows the interaction of the components.
About predefined open server file types
Actuate e.Reporting Server defines a set of open server file types:
I HTML files
I Crystal report files
I SQR report files
I Text files
Specifying open server file types
With the e. Reporting Server, volume administrators use the open server
features to generate reports such as Crystal reports or other open server
reports.
After you set up and configure the third-party report generation software, you
must specify the settings for the open server file types:
I Location of the open server driver and report generation engine
I Parameters and settings required for open server report generation
I Open server report specific parameters and settings
The open server file types are listed on the File Types page. You create and
modify open server file type information on this page.
Open
server
report files
Non-Actuate
software
Volume
Third-party
report
engine
Open
server
driver
Actuate
e.reporting
system
Actuate
software
Third-party
support
software
Understanding the File Types page
The following groups of file types are automatically defined on the File Types
page:
I Actuate native file types
I HTML file types
I Crystal file types
I SQRIBE file types
I Text and PDF file types
The following file types are Actuate native file types:
I bas
Actuate Basic source file
I jod
Actuate Java e.report design
I rod
Actuate Basic report design
I roi
Actuate Basic report document
I rol
Actuate Basic design library
I rop
Actuate parameter template
I ros
Actuate search definition
I rov
Actuate report parameter values
I row
Actuate HTML report document
I rox
Actuate Basic report executable
I vtf
Actuate e.Spreadsheet template package
I vtx
Actuate e.Spreadsheet template
I xls
Microsoft Excel spreadsheet
How to define an open server file type
If you are defining an open server file type that uses an open server driver, the
developer of the open server driver must provide you with the parameters
and the information needed on the New File Type page, as well as the software
needed to use the open server driver.
1 As Administrator, choose File Types from the sidebar menu.
2 On the File Types page, choose Create File Type.
3 On the New File Type page, enter the following:
I File type
I File extension
File extension is the file extension used by the operating system.
I Content Type
Content Type is the mime type for the file type.
I Short description
I Long description
4 In Category, choose Document or Executable.
If you choose Document:
1 To use the web server file system, check Use web server file system.
For more information about using the web server file system, see
Using the web server file system for viewing open server files, later in
this chapter.
2 To indicate that documents of this file type can be printed by the
e.reporting system, check Printable.
If you choose Executable:
3 Choose a default file type for output documents generated by the
executable.
The drop-down list displays all the non-native file types in the
Document category.
4 To indicate that output documents generated by the executable can be
printed by the e.reporting system, check Can print output document.
5 In Driver:
1 Enter the name of the driver to use for this file type.
If a relative path is specified for an open server driver, the path is
relative to the report servers \driver directory.
2 If only a single instance of this driver may be running at any one time,
enter a name for the mutual exclusion class that enforces this.
The mutual exclusion class is used to serialize open server processes.
Normally, the e.reporting system tries to schedule as many jobs as
possible. For open server reports, if the open server driver or the
third-party report generation tool cannot handle more than one job at a
time, you can specify a mutual exclusion class to allow only one job at a
time to run.
For example, you can create two file types, one with the mutual
exclusion class RPT-TYPE1 and the other with RPT-TYPE2. If users
create multiple RPT-TYPE1 jobs, the e.reporting system runs only one
RPT-TYPE1 job at a time. If, however, RPT-TYPE1 and RPT-TYPE2 jobs
are created, both jobs can be run at the same time.
6 In Web Images:
1 Enter the URL of a 16x16 pixel image that represents the file type.
2 Enter the URL of a 32x32 pixel image that represents the file type.
The Actuate Management Console displays the small icon. Actuate
Active Portal displays either the small icon or the large icon.
3 Choose Get Images to display the images on the New File Type page.
7 Choose OK.
How to modify an open server file types properties
You cannot modify the short description or the long description for Actuate
native file types. You can modify these descriptions for other file types. If you
do so, however, the same descriptions are used regardless of the users locale.
To revert to the default description, enter an empty string in the description
field. The default descriptions are localized for the users locale.
2 On the File Types page, hover the cursor over the icon to the left of the file
type and choose Properties.
3 Modify the properties and choose OK.
For more information about file type properties, see How to define an
open server file type, earlier in this chapter.
How to specify parameters for a file type
For native file types that are executable and non-native file types that are
either executable or printable, use the File Types Parameters page to:
I Add, edit, and delete parameters
I Import parameters from an ROP or ROV file
I Export parameters to an ROP file
The parameters defined for a file type are used for all reports associated with
the file type. These parameters are not visible to the report user. If a report
developer creates a report parameter with the same name as a file type
parameter, report generation fails.
The e.reporting system has reserved parameter names that begin with AC_.
For more information about reserved parameter names, see Working with
AC_PARAMETERS.txt, later in this chapter.
type and choose Parameters.
3 On the File Types Parameters page:
I To add a parameter:
1 Choose Add.
2 Complete the Add Parameter dialog and choose OK.
For more information about adding parameters, see How to add a
parameter, later in this chapter.
I To edit a parameter:
3 Choose Edit.
4 Complete the Edit Parameter dialog and choose OK.
I To delete a parameter:
5 Select a parameter to delete.
6 Choose Delete.
I To import parameters from a file:
8 Choose Import from File.
9 Enter the name of the ROP or ROV file and choose Upload.
I To export parameters to a file:
10 Choose Export to File.
11 In File Download, choose Save this file to disk and choose OK.
12 In Save As, enter the name of the file and choose Save.
4 In File Types Parameters, choose OK.
How to add a parameter
1 In Add Parameter:
I Parameter name is the name of your parameter.
I Type of data can be:
- Currency
- Date
- Double
- Integer
- String
I Default value is the parameters value.
2 Check Required.
3 In Add Parameter, choose OK.
How to upload images
You can upload images to represent a file type in Actuates desktop products
and in ReportCast.
type and choose Upload Images.
3 On the File Types Upload Images page:
1 Enter the name of the Windows icon file that represents the file type in
Actuates desktop products.
The file must have the extension .ico.
2 Enter the name of the web image file (large web icon) that represents the
file type in ReportCast.
3 Enter the name of the web image file (small web icon) that represents
the file type in ReportCast.
4 Choose OK.
How to delete a file type
type and choose Delete.
Using the web server file system for viewing open
server files
Some web server viewing technologies require direct access to a file by reading
the file from the web server file system. When files are managed by the
e.reporting system, they are stored in the volume and not on the web server. To
use these web server viewing technologies, the corresponding reports have to
be copied from the volume to the web servers file system to be viewed.
If you enable Use web server file system for the open server file type and a
user opens the file for viewing, the e.reporting system temporarily transfers
this file to the web server associated with Actuate Active Portal for viewing.
Using the Actuate Management Console system administration pages, a
system administrator configures the following items:
I The directory where the files are temporarily stored.
I The length of time the files are kept in the directory.
I The maximum size of the directory.
Copying the file to the web server drive means the volumes security does not
apply while the report is on the web server drive. There are two security
issues:
I Anybody who has access to the web server machine and the directory
where the reports are stored can see the documents while the open server
file is on the web server machine. Restricting access or logon to that
machine reduces that security risk.
I Users who have access to the directory from the Web and know the name of
a file directory can access it. To reduce this risk, system administrators
should disable directory listing. To further reduce the risk, Actuate uses a
unique file name for the temporary file that is unique for that viewing
instance, so the risk of a user guessing the file name is small.
About the open server for SQRIBE
The Actuate open server driver for SQRIBE reports handles only SQRIBE
compiled executable files (.sqt) that are analogous to Actuate Basic report
object executable (.rox) files. Actuates open server driver for SQRIBE does not
support SQRIBE SQR report files.
The SQRIBE open server driver can generate the following output file types
from a SQRIBE SQT report:
I Output file type SPF, proprietary SQRIBE output, similar to an Actuate
Basic report object instance, or .roi.
I Output file type SQW, Web format output. This file type is not printable.
I Output file type TXT, a plain text file.
To run SQRIBE reports, the database connection parameter is required. The
open server parameter name is SQR_DB_CONNECT and is a string
parameter.
Setting the SQRIBE report printing parameter
Using the SQRIBE software, the open server driver cannot redirect output to
different printers. The default volume printer is used. For printing SPF files,
the Sqrwp.exe program is assumed to be at the default install path:
C:\Sqribe\Sqr\ODB\Binw\Sqrwp.exe
Users can set a parameter to specify a different path. The string parameter is
SQRIBE_SQRWP_PATH. In most cases, this parameter can be set as a file type
parameter for SPF file type definition.
You can print Sqribe reports (spf) on Windows systems, but not on UNIX
systems. You cannot print Sqribe report executables (sqt) on Windows or
UNIX systems.
Using the parameter for bursting web output
By default, SQRIBE web reports appear as one large HTML file. The open
server driver for SQRIBE can also specify that the SQRIBE web report be
separated into multiple, linked HTML files using the SQRIBE burst mode
option.
The Actuate parameter for burst mode is a string parameter SQR_BURSTING.
SQR_BURSTING accepts either P<n> or S<n> where n is an integer:
I Pn specifies burst with n pages per HTML file
I Sn specifies burst with n symbolic or logical group sections per HTML file
Working with report level parameters
SQRIBE does not provide a way for other applications to read parameters from
an SQT report file. Report developers must supply the parameter information
to the volume administrator or the person uploading the SQRIBE report.
For SQRIBE reports, the order of parameters is important. Users uploading a
report must specify SQRIBE report parameter names in a special format. The
format for SQRIBE report parameters is SQR<n>_<parameter_name>.
The n is an integer specifying the order of the parameter from lowest to
highest in the parameter file. The parameter name is the name of the
parameter used in the SQRIBE report.
About the open server for Crystal reports
The Actuate open server driver for Crystal Reports from Crystal Decisions
handles the following Crystal report files:
I Crystal reports with a .rpt file extension
I Crystal web reports with a .rpw file extension
Crystal parameters using ranges of values are not supported.
Using Crystal reports with a .rpt file extension
Crystal reports use the .rpt file extension for both report executables and
report documents. When importing a Crystal RPT file, you specify whether the
.rpt file is a:
I Crystal report executable with a .rpx type
From the volume, users can run the .rpx report executable by submitting a
job.
I Crystal report with a .rpt type
From the volume, users can open and print the .rpt Crystal report on
Windows systems.
The open server driver for Crystal can generate the following output file types
from a Crystal report executable:
I .rpt, a Crystal report
I .rpw, a Crystal web report
I .txt, a plain text file
Specifying a mutual exclusion class for Crystal reports
Because of a limitation with Crystal Reports 7, you cannot run multiple
Crystal reports simultaneously. To ensure multiple Crystal reports are not run
simultaneously on an e.reporting system, specify a mutual exclusion class for
the Crystal report executable open server file type. For more information on
mutual exclusion classes, see How to define an open server file type, earlier
in this chapter.
Crystal Reports 8 can run multiple Crystal reports simultaneously.
Setting parameters for Crystal reports executable files
When specifying parameters used with a Crystal report with the RPX file type,
use the underscore character ( _ ) to represent a space. For example, if a Crystal
report uses the parameter name ID NUMBER, the Actuate parameter name is
ID_NUMBER.
For Crystal reports, you can specify the following parameters that are used by
the Actuate-supplied open server driver when generating a Crystal report.
Using Crystal web reports with a .rpw file extension
Crystal web reports with .rpw file extension are given the file type RPW. Users
can open and print Crystal web reports. To print an RPW report, open the
report in a browser and use the browsers print function. From the browser,
choose FilePrint.
Parameter Use
CRYSTAL_DB_DLL A string value. Specifies the location of the
Crystal reports DLL.
CRYSTAL_DB_NAME A string value. Specifies the database
name.
CRYSTAL_DB_PASSWORD A string value. Specifies the database user
names password.
CRYSTAL_DB_SERVER A string value. Specifies the database
server machine name.
CRYSTAL_DB_USER A string value. Specifies the database user
name.
Printing Crystal reports
You can print Crystal reports (rpt) on Windows systems, but not on UNIX
systems. You cannot print Crystal report executables (rpx) on Windows or
UNIX systems. Using the Crystal reports software, the open server driver uses
the default volume printer. Use the AC_PRINTER_NAME parameter to
specify a different printer name. Enter the parameter as an open server file
type system parameter. The printer must be available to the volume.
When printing Crystal report files, the open server driver also uses the
number of copies parameter.
Understanding the interface between the open
server shell and the driver
The Factory Process invokes open server driver programs to execute and print
non-Actuate reports. Interaction between the Factory Process and the open
server drivers is through an interface called the open server driver interface.
When executing a report, the e.reporting system forwards any report
generation task to a Factory Process. If the report is not a native Actuate report,
it finds an appropriate open server driver program to handle report
generation. The Factory Process creates a workspace directory, places the
report program and enough information about the report generation context
into the workspace, and invokes the appropriate open server driver. The open
server driver is responsible for generating report output into the workspace
directory, and also for generating status information about the report
generation task. The Factory Process integrates the report generation status
and the report output files into the volume.
When printing a report, the e.reporting system forwards the report-printing
task to the Factory Process. If the report is not a native Actuate report, the
Factory Process tries to find an appropriate open server driver program to
handle report printing. A workspace directory is created, and enough
information is placed into the directory to let the open server driver know the
context of the report printing job, the report printing parameters, etc. The open
server driver is responsible for printing the report and for writing the tasks
status to the workspace directory, so that status can be incorporated back into
the volume.
About the open server driver interface
The open server driver interface is a file-based interface that the Factory
Process uses to communicate with the open server driver program. All files in
this interface reside in the workspace directory.
About the report generation interface
When generating a non-Actuate report, the Factory Process:
I Supplies the non-Actuate report executable to the open server driver
I Supplies sufficient context information, parameters or settings associated
with the executable objects file type, and parameters or settings associated
with this particular report generation task, to the open server driver
program
I Invokes the open server driver program
I Periodically monitors the status of the open server driver program, and
forwards status messages from the driver program to the e.reporting
system so that users can examine the status of the request
I Stops the open server driver program if it runs beyond the report
generation timeout period
I Gathers the set of report output files generated by the open server driver
and integrates them into the volume
Running the open server driver program from the command line
The Factory Process invokes the open server driver program using the
following command.
<driver_path> <workspace_path>/AC_PARAMETERS.txt
<workspace_path>/AC_STATUS.txt
The AC_PARAMETERS.txt file specifies the set of effective parameters for the
report generation task, including the full context of the report generation, the
parameters associated with the executables file type, and the parameters
associated with the report generation task.
The AC_STATUS.txt file is the file into which the open server driver writes
status messages indicating progress toward executing the report, and then
writes a final status message indicating whether report generation succeeded
or failed. If the driver generates output files, the driver then writes a
specification of the set of output files and how they are to be integrated into
the volume into AC_STATUS.txt.
About the report printing interface
The open server driver interface for report printing is very similar to that for
report execution. When printing a non-Actuate report, the Factory Process:
I Supplies the location of the non-Actuate printable file to the open server
driver
I Supplies sufficient context information, parameters or settings associated
with the printable objects file type, and print job settings (for example,
number of copies to be printed, page orientation, etc.) to the open server
driver program
I Invokes the open server driver program
I Periodically monitors the status of the open server driver program, and
forwards status messages from the driver program to the e.reporting
system so that users can examine the status of the request
I Stops the open server driver program if it runs beyond the report printing
timeout period
Printing with the open server driver program from the command
line
The Factory Process invokes the open server driver program using the
following command.
<driver_path> <workspace_path>/AC_PARAMETERS.txt
<workspace_path>/AC_STATUS.txt
The AC_PARAMETERS.txt file specifies the set of effective parameters for the
report generation task, including the full context of the report printing, the
parameters associated with the printable files file type, and the printing
parameters.
The AC_STATUS.txt file is the file into which the open server driver writes
status messages indicating progress toward printing the report file, and then
writes a final status message indicating whether report printing succeeded or
failed.
Working with AC_STATUS.txt
The following topics discuss the format of the AC_STATUS.txt file.
About intermediate and final status message format
The first portion of the status file (up to the final success or failure status
message) consists of status messages. All but the last status message appear in
the form: STATUS 0 "status_message". The 0 must appear, and is a placeholder
reserved for future use. The final status message indicating success appears in
the form: SUCCESS 0 "final_status_message"; the final status message
indicating failure appears in the form: FAILURE 0 "final_status_message".
About output file specification
In report execution/generation jobs, a final status message indicating success
in report generation may be followed by an output file specification. This
specification indicates how files generated as report output are to be
integrated into the volume, and also how dependencies among the output
files, and also between the output files and the original report executable, are
to be set up.
Some output file specification lines indicate that a file is to be incorporated
directly into the volume. Such a line appears in the following form.
OUTPUT <tag> <version_mode> "<encyclopedia_path>" <local_file_name>
The <tag> is a tag that can be used to refer to this file in other statements
within the output file specification. The <version_mode> is either
"NEW_VERSION" or "REPLACE", "NEW_VERSION" indicating a new version
of this file in the volume should be created, whereas "REPLACE" indicates the
latest existing version of the file in the volume (if it exists) should be replaced
with this file. The <encyclopedia_path> represents the location within the
volume where the file should be integrated. The <local_file_name> specifies
the name of the local file to be incorporated into the volume.
Some output file specification lines indicate that a structured storage file in
Microsoft Structured Storage format is to be created in the volume at a given
path. Typically, such files will then aggregate one or more local files into a
single file in the volume. An output file specification line indicating a
structured storage file should be created is of the following form.
STRUCTURED_OUTPUT <tag> <version_mode> <encyclopedia_path>
The <tag> is again a tag used to refer to this file in other statements in the
output file specification. The <version_mode> serves the same purpose as
before. The <encyclopedia_path> refers to the location in the volume where
the file is to be created.
Some output file specification lines indicate that a local file is to be
incorporated into the volume as part of a structured storage file. Such a line
appears in the following form.
OUTPUT <tag> <structured_storage_tag> <structured_storage_element>
<local_file_name>
Here <tag> is a tag that can be used to refer to this file in other statements in
the output file specification. The <structured_storage_tag> refers to the <tag>
for a STRUCTURED_OUTPUT statement. This is the structured storage file
into which this component will be placed. The <structured_storage_element>
indicates the element name the file will have when incorporated into the
structured storage file. Finally, <local_file_name> indicates the name of the
local file to be incorporated into the structured storage file in the volume.
Dependencies among output files, or between output files and the executable
are also possible. To create a dependency, a line of this form must appear.
DEPENDENCY <depending_tag> <depended_on_tag>
The <depending_tag> refers to the output file that depends on another item.
The <depended_on_tag> refers to either another output file, or to the
executable file that generated the output file(s) that are part of the report. To
indicate a dependency on the executable, the <depended_on_tag> must be
"ReportExecutable".
In the following output file specification, a single file generated by a report
generator named ac_executable.lis is incorporated into the volume at
/Reports/MyReport.txt. The existing versions of the file in the volume are not
removed. A dependency between the output file and the executable is also
created.
OUTPUT main NEW_VERSION "/Reports/MyReport.txt" ./ac_executable.lis
DEPENDENCY main ReportExecutable
In the following output file specification, a structured storage file is created at
/Reports/MyWebReport.sqw. Various files generated as part of the report are
then integrated into the structured storage file.
STRUCTURED_OUTPUT row NEW_VERSION "/Reports/MyWebReport.sqw"
OUTPUT firstpg.gif row firstpg.gif firstpg.gif
OUTPUT lastpg.gif row lastpg.gif lastpg.gif
OUTPUT nextpg.gif row nextpg.gif nextpg.gif
OUTPUT prevpg.gif row prevpg.gif prevpg.gif
OUTPUT rpt.htm row rpt.htm rpt.htm
OUTPUT rpt_frm.htm row main.html rpt_frm.htm
OUTPUT rpt_toc.htm row rpt_toc.htm rpt_toc.htm
Note that the local "rpt.htm" is incorporated into the structured storage file as
"main.html". Because the structured storage file contains a "main.html"
component, the output file is treated as a Web-based HTML report. Links
among the .htm files still work after incorporation into the structured storage
files, and the image files (.gif) also appear when examining the report through
the browser.
Working with AC_PARAMETERS.txt
The following topics discuss the format for the AC_PARAMETERS.txt file.
About open server framework version, language, and request type
The first section of the AC_PARAMETERS.txt file is as follows:
OpenServerVersion_1.0
<language_string>
<job_type>
where <language_string> represents the language used on the server ("ENU"
for American English, for example), and <job_type> represents the type of
Actuate request for a non-Actuate item ("EXECUTE_JOB" or "PRINT_JOB").
The "OpenServerVersion_1.0" string indicates that the file is in the initial open
server format.
About other parameters
The remaining parameters all appear on individual lines, and follow the
simple format
<parameter_name> <parameter_type> <parameter_value>
The parameter types, and the way in which their values are expressed, are as
follows:
I STRING
Strings appear between double quotes. Note that each byte in the string is
printed in ASCII form if it is printable and not the % (percent) or "
(double-quote) character. The %, ", and non-printable ASCII characters are
printed in the form "%XX" where XX is the two-digit hexadecimal
representation for the byte. Hexadecimal digits A to F appear in
upper-case.
I INTEGER
Integers are 32-bit signed integers and appear in normal decimal form, as
in 12345.
I DATETIME
Date/time parameters appear in the form YYYY MM DD HH:MM:SS.
I TIME
Actuate date/time parameters can be entered through the user interface
without a date, representing a time-of-day only. Date/time parameters of
this form appear in the form HH:MM:SS.
I DOUBLE
A double (real number) value appears in the form [-]NN.NN[e[-]XX] where
the minus signs are optional. There are arbitrary numbers of digits for NN
and XX, and the exponent portion of the number is also optional. Examples
of value double values are: -12.357, 1.125e-15, and -5.7e69.
I CURRENCY
A currency value is represented as a 64-bit signed integer, and it is implied
the last four digits of the currency value represent the fractional part of the
currency. For example, a value 425600 might represent US$42.56.
All parameters whose names start with "AC_" are reserved for Actuates use.
When you define file-type parameters or report-specific parameters do not use
names that start with "AC_".
About rules for parameter accumulation
Parameters for report execution/generation jobs are accumulated in the
following order: system-level parameters, file-type parameters, and
report-specific parameters.
Parameters for report printing jobs are accumulated in the following order:
system-level parameters, file-type parameters, and printing parameters (for
example, number of copies, page orientation, etc.).
About system-level parameters that cannot be overridden
Many system-level parameters cannot be overridden by file-type parameters
or report-specific parameters. For example, the AC_HOST_NAME parameter
cannot be overridden by a report-specific parameter. Those parameters that
can be overridden are:
I AC_KEEP_WORKSPACE_DIRECTORY
I AC_REPORT_OUTPUT_PATH
I AC_REPORT_OUTPUT_ROTP_PATH
I AC_REPORT_OUTPUT_FILE_TYPE
I AC_REPORT_OUTPUT_LOCAL_FILE_EXTENSION
I AC_REPORT_OUTPUT_VERSION_NAME
I AC_REPORT_HEADLINE
I AC_DRIVER_TIMEOUT
I AC_DRIVER_POLLING_INTERVAL
The AC_DRIVER_TIMEOUT and AC_DRIVER_POLLING_INTERVAL
parameters are treated in a special way. First, the default is to have no open
server driver timeout, and to have a status message polling interval of five
seconds. The file-type parameters or report-specific parameters may override
one or both of these defaults. For example, if you want to assume for all
Crystal report executions that the report generation is hung on a failed
database login after 120 seconds, you can set the AC_DRIVER_TIMEOUT for
the RPX file type (the Crystal report executable file type) to be an INTEGER
value of 120.
Understanding open server framework Unicode
compliance
The interface between the open server shell and third-party executables are
two files, AC_PARAMETERS.txt and AC_STATUS.txt. These files are in UTF-8
format.
The first line of AC_PARAMETERS.txt indicates the version of the OSI layer
format. From the second line all the parameters are specified as
<Parameter Name> < Parameter Type> <Parameter Value>
The following parameters are in AC_PARAMETERS.txt:
I AC_REQUEST_LOCALE_IDSTRING <Value>
I AC_REQUEST_LOCALE_CODE STRING<Value>
I AC_SERVER_HOMESTRING<Value>
I AC_REQUEST_TYPESTRING<Value>
I AC_JDRV_PORTINTEGER<Value>
These parameters are system level parameters and cannot be overridden.
String values in AC_PARAMETERS.txt appear between double quotes. If a
string contains a non-printable character, %, or " (double-quote) characters,
they are printed in the form "%XX" where XX is the two-digit hexadecimal
representation for the byte. Hexadecimal digits A to F appear in upper case.
The possible values for AC_REQUEST_TYPE are EXECUTE_JOB and
PRINT_JOB. The parameter AC_JDRV_PORT is used by the reporting engine
to shut down the JAVA process in the case of the e.Spreadsheet driver. The
value of this parameter is stored in the configuration file and is not report
specific.
The messages in AC_STATUS.txt are written in UTF-8 and sent to the
Encyclopedia Service and displayed. The third-party driver program
externalizes the messages written in the status file. The output file
specifications should be written in UTF-8 to be read by the open server shell.
The name/path of the output file in the volume is written between quotes. The
third party drivers write the following characters in %XX form: non-printable
characters, %, " (double-quote).
Administering e.Spreadsheet reports
Using e.Spreadsheet Designer, you can:
I Connect external data to a worksheet range
I Manipulate and format the data
I Provide the data to users as an Excel spreadsheet
In the e.Spreadsheet Designer, the developer:
I Creates the workbook (.vts)
I Optionally, creates a stylesheet to change the layout and style of the
incoming data (.xsl)
I Provides a report parameters file (.rop)
The following conditions describe which files are added to the e.reporting
server volume. In all cases, you import the ROP file after the VTS or VTF file is
added.
I VTS if no stylesheet or graphics are used in the spreadsheet report, and the
file name does not contain multibyte characters.
I VTF if the spreadsheet report includes a stylesheet, graphics files, or a
combination.
The developer must use WinZip or Jar to compress the workbook, the
stylesheet, and any graphics (.gif and .png) files used in the workbook into
a VTF file.
I VTF if the spreadsheet report file name has multibyte characters
The developer uses Jar to compress the workbook or the workbook with
associated stylesheet and graphics files into a VTF file.
When you use a VTF file, the files that make up the VTF file (.vts, .xsl, and
graphics files) must be located in the same directory or in a subdirectory in the
same directory. The VTS or VTF file and the ROP file must be accessible to the
e.reporting system.
When you run the spreadsheet report on the server, the e.Spreadsheet option
performs the following tasks:
1 Reads in the workbook created in the e.Spreadsheet Designer.
2 Sets the e.Spreadsheet parameters attached to the workbook.
3 Executes the callback class, if one exists.
4 Refreshes the data from data sources such as databases, XML files, and text
files in the workbook.
5 Applies the stylesheet formatting.
6 Saves the report as an Excel file, viewable from the volume.
The e.Reporting Server assigns the following file types to spreadsheet reports.
I VTF to the e.Spreadsheet template files (.vtf) that comprise the report.
I VTX to e.Spreadsheet files (.vts).
Setting parameters for e.Spreadsheet reports
e.Spreadsheet reports are generated by a separate process called the
e.Spreadsheet factory. While administering e.Spreadsheet reports on the
e.reporting system, you may encounter runtime errors due to environment
settings. If so, review the following table to select a parameter that can correct
the problem.
To ensure that these settings are always used, you must supply these
parameters with both e.Spreadsheet .vtf and .vtx file types. To duplicate these
settings on the e.reporting system, you can set the parameters for one file type,
choose to export the parameters to a ROP file, and import the ROP file to the
other file type.
If you need to: Use this parameter:
Resolve the following
message: Unable to connect to
Java helper.
AC_ JDRV_LAUNCH_WAIT
If you receive this message or find the system
too busy, you may need to increase the
launch timeout beyond the default of 10
seconds to allow the e.Spreadsheet factory
more time to start up.
Supply an integer indicating the number of
seconds for the timeout.
Resolve the following message:
Couldnt find Java runtime
environment.
AC_JRE_HOME
Provide a string as the full path to set the
JAVA Runtime (JRE) installation directory.
If you set the JRE_HOME environment
variable on UNIX, this parameter is not
required.
If JRE_HOME appears in the Actuate
e.Reporting Server registry keys on
Windows, this parameter is not required. The
value in the Windows Registry is used.
Tune the performance of the
Java Virtual Machine.
AC_JVM_PARAMETERS
Provide a string for parameters to pass to the
JAVA Virtual Machine (JVM). There is no
default value.
The options you set for this parameter vary
by platform. For example, to see a list of
options for the Sun Windows JVM, refer to:
http://java.sun.com/j2se/1.3/docs/tooldoc
s/win32/java.html#options
In the Sun Windows JVM, you can set the
maximum heap size with the -Xmx
parameter and the minimum heap size using
-Xms. Adapt the JVM options as your system
requires. For example, you could change the
maximum heap size to ensure that JVM has
enough memory to run the largest report.
Resolve a message similar to:
Driver or file not found.
AC_JDRV_CLASSPATH
Supply a string for the location of the
spreadsheet population class, database
drivers, or alternate XML/XSL processors.
Separate multiple entries in Windows using a
semicolon ( ; ) and in UNIX using a
colon ( : ).
Note that e.Spreadsheet uses an internal class
loader, not the system CLASSPATH.
If you have a port conflict where another process is listening on the same port
assigned to the e.Spreadsheet factory, you can get unpredictable results, such
as error messages generated from the conflicting process or spreadsheet
reports that do not complete because the port is not available.
How to change the port assigned to e.Spreadsheet
1 In the System Administration Console, choose Servers from the sidebar
menu.
2 On the Servers page, select the server with the port conflict.
3 On the Properties page, choose the Advanced tab.
Decrease the system resources
used.
AC_ JDRV _TIMEOUT
Use this parameter to consume fewer
resources. Note that this may result in a
longer initial report generation time.
Changes to this parameter take effect only
when you restart the report server.
Provide an integer indicating the number of
seconds to timeout after the last completed
report request.
The default value -1 specifies to keep the
e.Spreadsheet factory up and not to exit. The
value 0 specifies to exit immediately after
completing every report request.
Set the debugging options. AC_JDRV_LOG_LEVEL
You can change the debugging level by
supplying an integer (from 1 to 4) for the
logging level, where:
1 logs errors.
2 logs warnings.
3 logs status information (the default setting).
4 logs debug messages.
4 In Properties settings, choose Factory service properties from the
drop-down list.
5 Scroll down and select e.SpreadSheet Server Port Number.
6 Choose Edit.
7 Change the Property Value to the correct port number and choose OK.
This change takes effect when the server is restarted.
8 On the Properties page, choose OK.
Using e.Reports Java Edition
With the e.Report (Actuate Basic/Java Edition) option, users can import an
e.Report Java Edition design file (.jod) into the volume and run the report in a
manner similar to an Actuate Basic report executable (.rox).
The e.reporting system generates the following types of files from an Actuate
e.Report Java Edition:
I ROW
ROW is an Actuate HTML report document. ROW is the default.
I HTML and DHTML
I PDF
I Text in comma separated values CSV format
For e.Reports Java Edition that require access to external data, you or the
system administrator must configure the proper environment. For example, if
the e.Report Java Edition accesses data using Java database connectivity JDBC,
you must configure the environment on the e.reporting system.
The following are the supported data sources that can be embedded in a
report.
About e.Report Java Edition data source
connection requirements
The e.Reports Java Edition (.jod) files are created using e.Report Designer Java
Edition. If the report contains a data field for which data needs to be extracted
from a data source, the type and connectivity information for the data source
needs to be embedded in the report. A report can contain direct references
such as a control in the report or an indirect references such as a grouping
criteria.
To embed the data source information in a report, the developer building the
report can use the e.Report Designer Java Edition:
1 Choose ToolsOptions.
2 In Options, choose Template.
3 Select Save Datasource In Template.
4 Choose FileSave.
Data source Connectivity information required
ASCII Text data file and a property file to define the schema
EJB JNDI name of remote EJB and context Factory class
name
JDBC Driver, URL, encrypted authentication information
such as user name and password, and tables used in
report
To confirm that data source information is in a report, open the report in any
text editor and ensure that an EMBEDDED_DATASOURCE_* block exists.
e.Reports Java Edition that extract data from a Java application using the
application data source are not supported. One alternative for a report with
this type of connection would be to transform the report design to use an EJB
data source with the connectivity information, the JNDI name, embedded in
the report.
If the e.Report Java Edition contains only static labels or forms which do not
extract data from any data source the report does not need to store embedded
data source type and connectivity information.
Using parameters with e.Report Java Edition
For an e.Report Java Edition, use the following parameters to control the JVM
environment and output format.
The following driver control parameters specify the JVM environment
settings:
Name Data type Value
DCP_DEBUG_LEVEL Integer 0 for no debugging
information, 1 for
summary, and 2 for
detailed information. 0 is
the default.
DCP_ESPRESSO_LIB String Location of Acjruntime.jar
that runs an e.Report
Designer Java Edition and
generates the output. If
left blank, the e.reporting
system driver determines
the location.
The following output property parameters specify output settings.
When running a .jod file with report-specific parameters from the e.reporting
system, the RSP_ prefix is required for the parameter name. For example, if the
.jod uses the report parameter MINVALUE, add the parameter
RSP_MINVALUE to the reports properties in the volume.
DCP_JRE_HOME String Location of the JRE used
with the Acjruntime.jar. If
left blank, the e.reporting
system driver determines
the location.
DCP_OTHER_LIBS String Location of any additional
java archives or libraries
required for the run time
environment such as JDBC
drivers or client stubs.
Separate each .jar, .zip, or
directory name by
semicolons (;) on
Windows or colons (:) on
UNIX.
Name Data type Value
Name Data Type Values
OPP_DHTML_BROWSER String IE or NS. Specifies the
browser-specific output. IE
is the default.
OPP_OUTPUT
_TYPE
String DHTML or HTML. This
property specifies the type
of HTML output generated.
Used only when output
type is HTML.
DHTML is the default.
OPP_TOC_ENABLED String YES or NO. Specifies if the
table of contents appears in
the output. This parameter
is ignored for CSV output.
YES is the default.
I n d e x 409
Index
Symbols
* wildcard 344
Numerics
32-bit drivers 191
A
about page 147
AC_ JDRV _LAUNCH_WAIT parameter 401
AC_ JDRV _LOG_LEVEL parameter 403
AC_ JDRV _TIMEOUT parameter 403
AC_ JVM_PARAMETERS parameter 402
AC_DBMS_INFORMIX_MAXVARLEN
variable 188, 269
AC_DBMS_ODBC_MAXVARLEN
variable 193, 269
AC_DBMS_ORACLE_MAXVARLEN
variable 201, 269
AC_DBMS_PROGRESS_MAXVARLEN
variable 207, 269
AC_DEFAULT_VIEWING_PREFERENCE
variable 267
AC_DHTML_PAGE_CACHING
variable 267
AC_JDRV _CLASSPATH parameter 402
AC_JDRV_CLASSPATH parameter 35
AC_JRE_HOME parameter 401
AC_PRINTER_NAME parameter 38, 392
AC_RCBF_WRITE_BUFFER_SIZE
variable 80
AC_ROOT_FOLDER variable 70
AC_SERVER_HOME variable 31, 269
AC_SERVER_LOGICAL_NAME
variable 267
AC_SERVER_UNIX_FD_MAX variable 28
AC_SS_POPULATION_CLASS parameter 35
AC_WEB_AGENT_PAGE_CACHING
variable 267
acacfconvert utility 218
Access Control Lists (ACLs)
adding security IDs to 48, 52
default length 52
defined 51
generating 336
getting 53
storing 341
access controls 300
access permissions. See privileges
access restrictions 48, 301
sample application for 51
accessing
data 28
Encyclopedia volumes 14, 300
external data sources 35
external security sources 25, 338, 339, 340
multi-language databases 180
online reports 374
volume content 115
accounts
changing 24
creating for report server 25
Microsoft Exchange and 41
registering mail 39, 40
resources and 26
setting privileges for 25
setting up 2425, 41
accrpdrv.exe 37
AcDBUtil.log 219
acexport utility 219224
command-line options for 221
file dependencies 220
getting information 236
restrictions 68
acextern utility 224226
running 50, 68, 69
acf option (acexport) 223
acf option (acimport) 230
acimport utility 226232
creating volumes with 227
getting information 236
resolving conflicts 227, 228
restrictions 68
acintern utility 232234
running 50, 68, 70
ACJRuntime.jar 406, 407
ACLs. See Access Control Lists
acmode utility 234235
AcOracleConnection property 197
acorcl80 value 197
acorcl81 value 197
acprg9.dll 203
AcPrg9.sl 205
AcPrg9.so 205
AcProgressConnection class 204
AcProgressSQL92Connection class 203, 204
acsqrdrv.exe 37
Active Portal 86
Active Portal JSP pages 367
Active Portal option 166, 364
Active Portal Security Extension 343
active request 348
ActivePortalURLPrefix parameter 246
activity logs 130
actoc utility 235
Actuate
home page xix
release notes xix
Actuate LRX xix
Actuate Management Console. See
Management Console
Actuate product summary xvii
Actuate Reporting System 2
acupgrade utility 236239
acverify utility 77, 78, 240243
Add Server page 148
adding
factory processes 81
licenses 143
nodes to clusters 102
partitions 106, 173
printers 126, 176
Report Encyclopedia volumes 14
resources 81
secondary partitions 14
view processes 87, 88
volumes 115, 116, 163
addresses (e-mail) 39, 41
specifying for LDAP servers 59
testing 42
adjusting restarts 83
admin option (actoc) 235
ADMIN_ROLE_NAME parameter 56, 64
admindata option 68
administration pages 133
administrative databases
exporting 221, 235
importing 229
Administrative failover option 120, 170
administrator (defined) 310
Administrator Desktop
creating custom login applications for 48
registering e-mail addresses for 41
Administrator role 56, 293, 341, 342
administrators 310
assigning privileges 301
basic tasks for 12, 92, 112, 282
configuring LDAP servers 54, 66
exporting files 220
maintaining backups 167, 359
maintaining failover 156
maintaining report archives 282, 355, 357
managing Encyclopedia volumes 5, 13, 15,
285
managing print jobs 348
managing services 2
managing systems 92, 133
preparing network printers 346, 347
reconfiguring clusters 9
reducing administrative overhead 75
restoring volumes 234
setting open security parameters 50
setting up user accounts 24, 25
setting volume limits 296297
specifying users as 342
updating information for 50, 68
upgrading Encyclopedia volumes 236
working with e.Report Java Edition 405
working with external reports 379, 380,
382
adminRole option (acextern) 225
adminUser option (acextern) 225
I n d e x 411
adminUser option (acintern) 232
Adobe PDF files. See PDF files
advanced properties page 160, 162
afm character encoding 43
afm files 45, 243, 244
age-based rules 356
aggregate reports
generating 81
aging interval 357
AIX servers
configuring open server driver 36
DB2 clients and 184
installing/uninstalling fonts 243
Java Virtual Machine for 36
printing from 27
Progress9 clients and 206
setting up environments 182
all option (acexport) 223
all option (acimport) 230
all option (actoc) 235
All role 56, 310
ALL_ROLE_NAME parameter 56, 63
allocating memory 84
allocating resources 87
allRole option (acextern) 225
analysis tools (third-party) xvii
analytical tool 19
analyzing data 19
application programming interfaces
(APIs) xvii, 3
application servers 21
application-level partitioning 15
applications
accessing resources for 26
creating custom login 48
creating security 300
extracting data from Java 406
implementing report server for 3
running 267
Apply Filter option 292
Archive before deletion option 356
archive driver 7071
displaying current settings 166
archive library 70, 356, 357
archive.dll 70
archive.log 71
archiving 355359
administrative tasks for 282
objects in volumes 70, 71
setting rules for 356, 358
viewing information for 356
ASCII data sources 405
ASCII files
generating 405, 407
sending mail notifications from 42
assigning passwords 301, 311
assigning privileges
defaults for 305
for LDAP servers 58
from Management Console 315, 330331
to administrators 301
to external users 343
to folders 305, 306
to report files 228, 301, 302
to user accounts 25
to users 301, 302
assigning roles 307311
for all users 310
strategies for 308, 309
to channels 370
assigning security IDs 52
attachments 42, 313
attributes 301
See also properties
defining LDAP 55, 56
information logs 132
system usage information 130
authentication
defined 338
external users 338, 339
open security functionality for 48
AuthIdExpires parameter 261, 271
authorization 55, 340
defined 338
AuthPassword parameter 246, 271
auto archiving 71, 356, 357
auto-archive rules
scope 356
setting 356, 358
automatic restarts 83
automatic startups 26
automating reporting tasks xviii
B
backing up volumes 359361
command-line utility for 234
from Management Console 167
backup mode 234
backup nodes 11
backup servers 116, 118119
backup utility 234
banner 285
BaseSocketNumForReply parameter 246, 271
BaseSocketNumForRPC parameter 246, 271
benchmarks 82
bf option (acexport) 222
bio-metric data 338
bitmaps 369
BookModelCallback interface 35
browsers. See web browsers
browser-specific output 407
buffer size parameter 52
BufferPoolSize parameter 247, 271
buffers 80
bundling report files 73
bursting 389
C
C option (acmode) 234
C locale 33
C shells (UNIX)
adding environment variables to 269
connecting to databases 186
setting home directory 31
cache
controlling 50, 89
DHTML reports and 72, 305
increasing size 88, 153, 155
maintaining 87
synchronizing 89
caching options (web pages) 366
callback classes 35
capacity planning 31
cascading style sheets 258
case sensitivity 311
CenturyBreak parameter 39, 247, 271
changing
cluster manager 111
current properties 162
default accounts 24
default locales 33
license keys 98
passwords 301, 312
printers 348
privilege templates 315
privileges 305, 307
property values 293
security IDs 52
security type 50
startup parameters 96
channel attribute 56
Channel Privileges page (New Security
Role) 324
channels xviii
attaching images to 369
creating 369370
displaying contents 367, 368
exporting administrative information
for 220
importing 228
mapping to LDAP servers 55, 58
naming 369
overview 367
scheduling jobs for 374376
setting page caching options 366
subscribing to 342, 367
updating contents 369
viewing available 368
char datatypes 190
character lengths 190
character strings. See strings
charts. See graphs
check option (acverify) 241
checking disk space 30, 78
Child Roles page (New Security Role) 323
CJK languages 44, 46
class libraries 21
CLASSPATH variable 269
engine configurations and 35
Clear Filter option 292
client classes 36
client configuration program 214
Client Networking (NT servers) 209
client requests 2
I n d e x 413
client stubs 36
client/server applications
database connections and 180
clients
bundling reports for 73
open server reports and 37
client-side caching 72
cloning notification groups 334
cluster manager 9
backup nodes for 11
changing 111
specifying 103
cluster manager successor 99
cluster manager successors 11
cluster master
defined 11
cluster nodes
adding 102
creating multiple 9
distributing services among 9
example for 15
failing 12, 13
managing 12
overview 2, 102
removing 110
taking offline 110
clusters
adding partitions 106, 173
adding printers 126
adding report servers 102, 104106
adding volumes to 117, 164
administrative tasks for 92, 97
configuring 4, 9, 12, 18, 103
controlling 11
creating 99101, 137
creating configuration files for 128
displaying partition information for 124,
166, 172
displaying servers in 146
networking requirements for 97
overview 103
removing membership 13
removing printers 126
server options for 97
cn attribute 55, 56
column length
DB2 data sources and 185
Informix data sources and 188
ODBC data sources and 192
Oracle data sources and 201
Progress data sources and 207
Sybase data sources and 213
command-line arguments
acacfconvert 218
acexport 221
acextern 225
acimport 229
acintern 232
acmode 234
actoc 235
acupgrade 238
acverify 241
getting server version 32
running fontutils 243, 244
setting UNIX environments 183
starting Progress servers 209
testing connections 184, 190, 200, 215
testing mail notifications 42
command-line utilities
acacfconvert 218
acexport 219224
acextern 224226
acimport 226232
acintern 232234
acmode 234235
actoc 235
acupgrade 236239
acverify 240243
open server 68
reporting server 217
comma-separated text files 405, 407
comments 52
common name attribute 55
communication fields 138, 140
communication information 151
communication protocols
Oracle databases 199
Progress connections 203, 208
comparing web browser performance 72
Completed Folder option 77
completed notices
creating 77, 313
completed notices (continued)
sending over LDAP servers 59, 61
completed requests 348
importing 228
CompressDHTMLContent parameter 73,
247, 271
compressed DHTML formats 73
compressing exported volumes 221
CompressionBufferSize parameter 249, 271
CompressionLevel parameter 249, 271
concurrent client requests 2
concurrent processes 81
concurrent threads 87
config option (acexport) 223
config option (acextern) 225
config option (acimport) 230
config option (acverify) 241
ConfigHomeFileSystem parameter 271
ConfigHomeOffset parameter 271
ConfigHomePartition parameter 247
configuration files
changing location for 110
creating for stand-alone servers 129
default location for 100, 128, 129
font mappings in 43
specifying 28
configurations
clusters 4, 9, 12, 18, 103
custom login applications 48
database 28
default 9, 12
default locales 33, 38
Encyclopedia volumes 1314
external font file 34
managing 9
open security 5368
open server reports 3638
partitions 14, 123124
report server engines 3436
report server processes 33
report server system 133
report servers 2, 11, 18, 112
services 151
setting parameters for 246
stand-alone report server 13
standalone report server 112
supported 3
volumes 115, 116
configuring open server reports 379, 380, 382
ConnConfigFile parameter 247, 271
connection components 180
connection parameters (Progress tables) 209,
210
connection strings
Informix tables 186
ODBC drivers and 192
Oracle tables 198
connections
balancing workload for 88
data sources 35, 405
database 28, 180
DB2 databases 182185
EJB data sources 36
Encyclopedia volumes 283284
Informix databases 185188
MS/SQL databases 189191
PeopleSoft databases 193
Progress8 databases 206212
as self-service client 209
Progress9 databases 201206
Red Brick databases 194196
remote servers 24, 25
Sybase databases 212215
ConnectOptions setting 29
content generation capabilities 19
contents 407
controller processes (Oracle tables) 200
controls
searching for 72
conversion utilities 224, 232
conversions
years 39
converters 87
converting volume administration
information 69
copy option (acupgrade) 238
copying
items in volumes 303
report executables 74
report files 388
volumes 221
corruption 240
I n d e x 415
CPUs
adding 81
assigning factory processes to 81
comparing operating speed for 82
displaying number of licensed 107, 148
estimating resources for 82, 84
memory requirements for 83
monitoring usage 87
paging rate 83
resource requirements 80
server allocation for 81
support for multiple 19, 80
crashes 12
fail-over service for 13
Create Channel command 369
Create Cluster option 100
creating
archive driver 70, 71
backup servers 118119
channels 369370
clusters 99101, 137
completed notices 77, 313
configuration files 128, 129
DHTML reports 87
diagnostic logs 132
external security interfaces 48
folders 74, 307
headlines 375
local printers 26
multiple cluster nodes 9
multiple volumes 13
PDF files 87
registry entries 268
report documents 352
report files 352
reports 304
RSSE applications 48, 300, 336
server accounts 25
temporary files 32
creating report-specific online help xxvi
credentials 48
Crystal Report Engine 37
Crystal report extensions 378
Crystal reports 18, 390392
configuring open server driver for 37
CRYSTAL_DB_DLL parameter 391
CRYSTAL_DB_NAME parameter 391
CRYSTAL_DB_PASSWORD parameter 391
CRYSTAL_DB_SERVER parameter 391
CRYSTAL_DB_USER parameter 391
CSSTemplateClassLimit parameter 258, 271
CSV formats 405, 407
ctlib connections 212
CurrencyFormat parameter 247, 271
current status 146
custom logins 48, 343
customizing printer settings 347
CustomMetaDescription parameter 271
D
D option (acmode) 234
daemon IP address parameter 149
data
accessing 28
analyzing 19
caching 87, 89
displaying 286
exporting 68
importing 68, 227, 228
retrieving
from data stores 291
from databases 180
from XML data sources 184
data extraction 405
data filters 291292
data sets 181
data sources 26
accessing external 35
connecting to 35, 36, 405
embedding 405
ODBC drivers and 191, 192, 193
specifying for databases 28
stored procedures as 181
supported 405
data stores 32, 291
data types 200
Database property 203
database servers
allocating CPUs for 81
connecting to 180
specifying as SQL-specific 189
DatabaseList property 209, 210
databases xviii
accessing data in 28
accessing multi-language 180
connecting to 28, 180
defining environment variables for 182
exporting administration 221
importing administration 229
listing administration export
information 235
optimizing report generation for 81
running LDAP security 49
specifying configurations for 28
DataDirect ODBC drivers 191
date formats 256, 264
date-based rules 356
DateMode parameter 248, 271
dates
year conversions for 39
DateSeparationChar parameter 248, 271
-db parameter (Progress connections) 209
db directory 127
DB2 databases 182185
testing connections 184
DB2 Factory server 183, 184
db2 program 184
DB2CODEPAGE variable 183
DB2COMM variable 270
DB2DIR variable 183, 270
DB2INSTANCE variable 183, 270
db2set command 183
DBInterface property 197
Db-library API 190
DCP_AC_DEBUG_LEVEL parameter 406
DCP_ESPRESSO_LIB parameter 406, 407
DCP_OTHER_LIBS parameter 36, 407
debugging 84
debugging information 406
default accounts 24
default aging interval 357
default configurations 3, 9, 12
default fonts 45
default open security level 338
default privileges
described 305
overriding 305
default system locale 33, 38
DefaultCLocaleOnWindows parameter 265,
271
DefaultEncoding parameter 248
DefaultLocale parameter 248, 271
DelayAfterCreatingOperationProcess
parameter 248, 272
DelayBetweenContactingOperationProcess
parameter 248, 272
delays 82
delete privilege 302
deleting
cluster nodes 110
folders 302, 356
jobs 352
notification groups 333
partitions 125, 174
print requests 349
printers 126
Report Encyclopedia volumes 14
temporary files 32
volumes 125, 171
DeletionLogEnabled parameter 248
DeletionLogLevel parameter 248
dependencies 71, 228
export utilities and 220
Description parameter 248, 249, 272
detail reports 81
detailed information 406
developing reports 19
DH_PASSWD variable 205
DHTML Compression Level parameter 73
DHTML formats 73
DHTML mode 365
DHTML reports
caching 72, 305
compressing 73
controlling access to 304
converting XML reports to 87
displaying 72
generating 405, 407
optimizing 7273
searching 72, 86
setting page caching options for 366
view processes for 85
viewing 3, 304, 364
DHTMLGeneratorInfo parameter 249, 272
I n d e x 417
DHTMLLong formats 73
DHTMLRaw formats 73
diagnostic logs
creating 132
setting up 160, 161
diagnostic trace information 132
digital certificates 338
directories
partitions as 14
setting Excel output 30
setting JDK installation 202
specifying home 31, 269
structuring for volumes 127128
Directory Manager (LDAP) 67
disabling
automatic restarts 83
page security 337
disk I/O
improving speed 79
performance and 81
disk space
checking 30, 78
freeing 31
disk striping 79
dispatching requests 3, 7
redirector nodes and 11
display options 286288, 366
DISPLAY variable 27, 270
displaying
channel contents 367
data 286
DHTML reports 3, 304, 364
folder contents 302, 304
images 73
license keys 98
online documentation xxiii
partition information 124, 166, 172
print requests 348
properties 304
report documents 18
report server properties 150
report server version 32
reports 305
in web browsers 72, 85, 364
on UNIX servers 27
search results 289
server properties 107
status information 94, 134, 135, 146
system information 147
system printers 175
system properties 160
volumes 163, 165
distinguished names 54, 58
distributing reports 73
DLC variable 202, 205, 207, 208, 270
DLLPath property 187, 203
overriding 188
DLLs
archiving 70
Informix connections and 187
MS/SQL connections and 190
Oracle connections and 199
Progress connections and 205, 207
Red Brick databases and 195
document files
creating 352
enabling page security for 336, 337
restricting access to 301, 303
documentation xx, xxii
online xxiii
syntax conventions xxvii
typographical conventions xxvi
documents
creating 352
enabling page security for 305
optimizing display of 72
storing 18
viewing 18
domain servers 24
dos2unix utility 243
downloading PDF files 73
downloading reports 87, 305
drivers
caution for AIX servers and ODBC 184
creating archive 70, 71
ODBC version supported 190
dynamic-link libraries. See DLLs
E
e.Analysis application xviii
e.Analysis option 19
e.Report Designer xvii
e.Report Designer Java Edition xvii
e.Report Designer Professional xvii, 210
e.Report option 19
e.Reporting Server xviii
administrative tasks for 92, 112, 282
configuration options for 18, 23
default configuration for 9, 12
enhancing functionality 18
estimating resources required for 82, 84
features 20
managing systems for 92, 126, 133
open security and 48
operations affecting performance 84
optimizing performance 71, 72, 73, 80, 84
overview xix, 2, 17, 18, 337
resource requirements for 80, 83
running 180
AIX servers and 184
in UNIX environments 25, 80
in Windows environments 24
Solaris servers and 187
starting automatically 30
supported configurations for 3
supported database connections 185, 189,
191, 196
systems described 4
e.Reporting Suite xv
product summary xvii
e.Reports Engine Java Edition
configuring 35
overview 21
e.Reports Java Edition
connection requirements for 405
control parameters for 406
overview 404
e.Spreadsheet Designer xix
e.Spreadsheet Engine
configuring 34
overview 21
e.Spreadsheet file types 401
e.Spreadsheet option 19, 34
eadmin option (acexport) 221
eAnalysisAutoResizeVerticalAxis
parameter 249, 272
eAnalysisDecimalPoint parameter 249, 272
eAnalysisHideCalculate parameter 249, 272
eAnalysisHideHelp parameter 249, 272
eAnalysisHideHome parameter 249, 272
eAnalysisHideHorizontalBarChart
parameter 249, 272
eAnalysisHideHorizontalFitToPage
parameter 250, 272
eAnalysisHideLineGraph parameter 250, 272
eAnalysisHidePieChart parameter 250, 272
eAnalysisHidePreferences parameter 250,
272
eAnalysisHidePrint parameter 250, 272
eAnalysisHideSave parameter 250, 272
eAnalysisHideSaveAsMicrosoftExcel
parameter 250, 272
eAnalysisHideSaveAsMicrosoftWord
parameter 250
eAnalysisHideTableView parameter 250, 272
parameter 250, 272
eAnalysisHideVerticalFitToPage
parameter 251, 272
eAnalysisHideWorkOffline parameter 251,
272
parameter 251, 272
eAnalysisMainTitle parameter 251, 272
eAnalysisPieChartCombineMinimum
parameter 249, 273
parameter 252, 273
eAnalysisShowColumnTotals parameter 251,
273
eAnalysisShowColumnTotalsLeading
parameter 252, 273
eAnalysisShowDrillControls parameter 251,
273
parameter 251, 273
eAnalysisShowEmptyRows parameter 252,
273
eAnalysisShowGridLines parameter 252, 273
I n d e x 419
parameter 251, 273
eAnalysisShowHistogramPercent
parameter 252, 273
eAnalysisShowHistogramValues
parameter 252, 273
eAnalysisShowLineLabels parameter 253,
273
eAnalysisShowLinePercent parameter 252,
273
eAnalysisShowLineValues parameter 252,
273
eAnalysisShowPieChartIn3D parameter 251,
273
parameter 253, 273
parameter 253, 273
parameter 253, 273
eAnalysisShowRowLevels parameter 273
eAnalysisShowRowTotals parameter 274
eAnalysisShowRowTotalsLeading
parameter 274
eAnalysisShowVariableLevels parameter 253
eAnalysisShowVariableTotals parameter 253
eAnalysisShowVariableTotalsLeading
parameter 252
eAnalysisShowZeroColumns parameter 251,
274
eAnalysisShowZeroRows parameter 274
eAnalysisShowZeroVariables parameter 253
eAnalysisVerticalAxisColor parameter 253,
274
eAnalysisWatermark parameter 253, 274
eAnalysisWindowTitle parameter 253, 274
echannels option (acexport) 221
ef option (acexport) 222
efiles option (acexport) 222
efiletypes option (acexport) 222
egroups option (acexport) 222
EJB data sources 405
connecting to 36
ejobs option (acexport) 223
e-mail
cloning notification groups for 334
managing notifications for 77
notification options for 166
registering accounts 40
setting up notifications for 3942
unavailable notifications for 25
email
adding attachments 313
Email Notification dialog 40
e-mail notification option 313
EmailURLType parameter 265
Embedded SQL-92 (ESQL) 201
embedding data source information 405
EnableGenerationService parameter 254, 274
EnableOpenSecurity parameter 254, 274
EnablePageSecureCaching parameter 254
EnableRequestService parameter 254, 274
EnableViewingService parameter 254, 274
encoding option (acupgrade) 238
encoding 38, 180
Encoding parameter 143
Encyclopedia service
configuring volumes 1314
controlling 108
enabling 14
managing multiple volumes 13
overview 2, 6
storing items 2
encycsrvr6.exe 32
End User Desktop xvii
engines
configuring 3436
overview 21
ENU locale 33
environment variables
DB2 databases 183
defining for database connections 182
listed 269
overview 267
Progress8 databases 207, 208, 210
Progress9 databases 202, 205, 206
setting in startup scripts 36
setting with C shell 269
erequests option (acexport) 223
error logs 131, 132, 142
ErrorLogEnabled parameter 254
ErrorLoggingExtensionName parameter 254
ErrorLogLevel parameter 254
errors
mail notifications 41
eSpreadSheetServerPort parameter 254
ESQL utility (Informix) 187
ESQL32.DLL 207, 208
estimating
CPU resources 82
memory requirements 84
eusers option (acexport) 222
Excel spreadsheets 18
setting data output directory 29
.exe files. See executable files
executable files
accessing multi-language databases 180
bundling 73
caching 88, 89
connecting to databases from 28
defining in volumes 122
exporting 220
report server specific 32
restricting access to 303
running services from 3
storing in volumes 74
updating configurations for 29
execute privilege 302, 352
executing applications 267
executing jobs 352
executing queries
on LDAP servers 57, 66
executing reports 7, 21
adjusting factory timing for 82
estimating memory resources for 84
expiration dates 369
export directory 219
copying 221
export files 221
generating 218
listing contents 235
export utilities 219, 235
exporting data 68
exporting Encyclopedia items 219
exporting volume information 220
external option (acafcconvert) 218
external option (acupgrade) 238
external archiving tools 357
external data sources 35
external security application 50
external security cache 50
external security sources 15, 68
accessing 25, 50, 338, 339, 340
converting administrative information
for 224, 232
creating interfaces for 48, 300
mapping security IDs for 51
printing from 343
user properties for 339
external user authentication 338, 339
external user authorization 340
external user logins 343
external user properties 339, 343
external user registrations 338, 339, 340
external user roles 341
externalized volumes 68
F
F1 key xxiv
Factory process
allocating resources for 81
factory process 7
adjusting timing 82
configuring default locales 33
generating reports 33
managing 81
running 83
running multiple 81
stopping 29
Factory server installations
DB2 databases 184
UNIX-specific platforms 215
Factory service
enabling 151
overview 3, 7
setting properties for 154
FactoryProcessLogDirectory parameter 256,
274
I n d e x 421
FactoryProcessLogLevel parameter 256, 274
FactoryProcessLogSize parameter 256, 274
factsrvr database 215
factsrvr.db2 file 185
failed jobs 352
fail-over service 13, 120, 170
failover, volumes
failures 12, 13
fctsrvr5 server 215
FetchRowBufferCount property 203
export utilities and 220
import utilities and 228
file descriptors 28
file directory 127
file size limits (UNIX) 27
file type attributes 301
FileCacheTimeout parameter 265, 274
files
adding to Encyclopedia 14
archiving 70, 355359
bundling 73
caching 88, 89
changing location for configuration 110
compressing 73
copying 388
creating report 352
creating temporary 32
defining open server report 382
deleting temporary 32
enabling page security for report 336
exporting 219, 221
generating report 405
importing 228
predefined open server report 380, 381
setting privileges for 228, 301, 302
storing 74, 127
types for Crystal reports 390
types for SQRIBE reports 389
Files Type folder 381
fileType directory 127
FileTypeList parameter 254, 274
filtering data 291292
filters 291
fingerprints 338
flat role strategy 308
folders option (actoc) 236
folders
creating 74, 307
deleting 302, 356
exporting 219
for open server file types 381
importing 228
moving 304
non-protected 301
setting privileges for 305, 306
setting up home 312
viewing contents 302, 304
font attributes 44
font metrics files 45, 243, 244
encoding for 43
Fontographer 244
fonts 44
converting 244
embedding 45
installing standard 45
installing/uninstalling PostScript 243, 244
mapping 42, 45
not supported 43
fonts used with Excel data 30
fontutils (UNIX) 243, 244
force option (acimport) 230
forceGroup option (acintern) 233
forceRole option (acintern) 233
forceUser option (acintern) 233
free disk space 31
checking for 30, 78
functions
fundamental data types. See data types
G
General page (New Security Role) 323
General page (New Users) 311
generating report files 405
generating reports 7, 155
factory processes and 33
optimizing performance for 81
generation jobs
running 83
generation requests 7
generation requests (continued)
for 221
GenerationLogEnabled parameter 255
GenerationLogLevel parameter 255
grace periods 120
grant privilege 302
graphics
displaying in PDF files 73
setting search paths for 29
graphs
font mappings for 4546
printing text elements in 45
GROUP_BASE_DN parameter 56, 63
GROUP_OBJECT parameter 57, 63
GROUP_TO_NOTIFY parameter 57, 63
groups
See also notification groups
exporting 220
importing 227
GZIP encoding 73
H
-H parameter (Progress connections) 209
H option (acextern) 225
H option (acintern) 233
H option (acmode) 234
hardware devices 26
headlines 375
heartbeat parameters 137
setting 138, 140
HeartbeatFailurePeriod parameter 255, 274
HeartbeatSendPeriod parameter 255, 274
help option (acafcconvert) 218
help option (acexport) 223
help option (acimport) 230
help option (actoc) 235
help option (acupgrade) 239
help option (acverify) 241
help xxivxxvi
creating report-specific xxvi
usage overview xxiv
help topics xxiv
hierarchical role strategy 309
home option (acexport) 223, 230
home directory 31, 269
home folder
default privileges for 305
external users and 343
setting up 312
specifying for open security 60
Host property 203
Hostname parameter 149
hosts
database-specific 180
OBDC drivers and 191
Sybase connections and 215
HP-UX systems
optimizing 80
printing from 27
setting up DB2 clients 184
setting up Progress9 clients 206
HTML reports
See also DHTML reports
generating 405, 407
hypertext links 166
I
I/O. See input; output
iadmin option (acimport) 229
iallf option (acimport) 229
IBM Database2 tables. See DB2 databases
IBM-AIX systems
DB2 clients and 184
printing from 27
Progress9 clients and 206
ichannels option (acimport) 229
icons 286, 369
ICU_DATA environment variable 218, 219,
225, 227, 232, 234, 235, 238, 240
ICU_DATA variable 270
IdleConnectionTimeOut parameter 247, 255
if option (acimport) 229
I n d e x 423
ifiletypes option (acimport) 229
igroups option (acimport) 229
ijobs option (acimport) 231
images 369
displaying in PDF files 73
ImageSearchpath parameter 263, 274
import utilities 226
importing administrative information 226
importing data 68, 227, 228
indexed searches 67, 72
Information Delivery API 3
Informix Connect 187
determining version 188
INFORMIXDIR variable 186, 270
INFORMIXSERVER variable 186, 270
-inp parameter (Progress connections) 210
input option (acafcconvert) 218
input option (acimport) 231
input option (actoc) 236
input
optimizing 79
performance and 81
input files
exporting 221
importing 229
installation scripts (UNIX) 186
installing
archive driver 70
Factory server 184, 196, 215
fonts 45
Management Console 2
PostScript fonts 243244
printers 346, 347
RSSE applications 49, 52
installing online documentation xxiv
INSTHOME variable 270
interfaces
See also application programming
interfaces
creating for external security sources 48,
300
internalized volumes 68
Internet Explorer 72
IntervalBeforePurgingExpiredScheduled
Requests parameter 255, 274
IP addresses 11, 99, 101, 127, 149
iprinters option (acimport) 229
irequests option (acimport) 231
IsDefault parameter 265
isql program 215
isqlw program 190
iusers option (acimport) 229
J
jar files
data source connections and 35
Java application servers 21
Java applications 406
java archives 407
Java documents 18, 19
Java Naming and Directory Interface. See
JNDI
Java Report Generation option 404
Java stored procedures 198, 201
Java version requirements 35
Java Virtual Machines 36, 406
JDBC data sources 405
accessing 35
JDK installation 202
JDKHOME variable 202, 205
JNDI client classes 36
jobs 352355
archiving 356
cancelling 352
deleting 352
exporting 221
generating for channels 374376
importing 228
processing 33
scheduling 302, 352
setting priorities 352, 353
setting retry options 354
submitting 353
.jod files 404, 405
JPG files 73
JRE 36
jre_home directory 35
JVM 36
environment settings 406
jvm.dll 35
K
kerning 244
L
LANG variable 270
large files 27
large reports 82
latest option (acexport) 222
LD_LIBRARY_PATH variable 36, 182, 270
LDAP Directory Manager 67
LDAP objects 54
assigning user roles to 56
defining attributes 55, 56
LDAP security databases 49
LDAP servers 48, 67, 338
accessing 58
associating with specific channels 56
associating with specific roles 55
associating with specific volumes 54, 54
56
configuring open security for 5368
performance tuning for 66
running queries on 57, 66
specifying 58
specifying viewing preferences 62
ldap.conf 54
default properties in 55
parameters described 56
setting up 62
libacprg9.sl 205, 206
libacprg9.so 205, 206
libacprg9_share.a 205, 206
libdb2.so 184
libjvm.a 36
libjvm.sl 36
libjvm.so 36
LIBPATH variable 36, 182, 270
libraries
archiving 70, 356, 357
Progress connections and 205, 207
Red Brick databases and 195
required 407
third-party servers and 21
library paths 270
license keys 98, 137
licenses 143
Lightweight Directory Access Protocol
(LDAP) 338
links 367, 368
listener processes (Oracle tables) 200
Live Report Extension. See LRX
load balancer 11
load balancing 2, 5, 88, 180
local machines 24
locale map file 38
Locale parameter 143
localemap.xml 38
locales
accessing multi-language databases 180
font mappings for 45
getting client information for 181
setting up 38, 144
specifying default 33
specifying time zones for 129, 145
log option (acverify) 241
log directory 128
log files
generating 141, 142
storing 128
types described 130133
LogDirectory parameter 256, 274
logging into Encyclopedia 283
as external user 343
logging into multiple volumes 284
logging levels 131, 142
logging operations
export utility 219, 238
import utility 227
overview 129
running 84
system errors 142
system information and 114
system usage 140
upgrade utility 238
logging RSSE messages 52
I n d e x 425
LoggingOn parameter 254, 274
login applications 48
login checks 338
login names 55
login page (Management Console) 133
login scripts (Oracle tables) 199
logins 88, 93
failing 284
open security applications 55
LogLevel parameter 256, 274
LogSize parameter 256, 274, 275
LongDateFormat parameter 256, 275
LowFreeSpaceMB parameter 31, 267
LRX (Live Report Extension) xix
LRX mode 365
M
M option (acmode) 234
mail accounts 39
mail. See e-mail
mailinst program 40
Management Console 2
availability of pages 294296
banner for 285
filtering data in 291
installing RSSE applications 52
logging into 133
login page for 283
overview 12, 282, 285
registering e-mail addresses for 39
searching from 288
setting display options 286288
setting properties in 293
sidebar menu for 286
starting and stopping report server 113
system administration pages for 133
updating system information 113
manager cluster
changing 111
Manuals directory xxiv
mapping administration information 5456
master cluster
defined 11
master_fonts.rox 30, 33, 34
max ACL buffer size parameter 52
Max cache size property 153
Max cache timeout property 153
Max concurrent requests property 153
Max concurrent SOAP requests property 152
Max Excel pages property 153
Max view processes property 153
MaxConcurrentRequests parameter 257, 275
MaxEndpointThreads parameter 257, 275
MaxFactoryProcesses parameter 258, 275
MaxFileCacheEntriesPerProcess
parameter 257, 275
MaxFileCacheSizePerProcess parameter 257,
275
MaxFileDescriptorsOnUnix parameter 258,
275
MaximumStringLength property 185, 197,
213
MaxLogSize parameter 257, 275
MaxPagesConvertibleToExcel
parameter 258, 275
MaxPrintProcesses parameter 258, 275
MaxProcesses parameter 258, 275
MaxProgramExecCacheSizePerProcess
parameter 256
MaxROXCacheSizePerProcess
parameter 257, 275
MaxROXCacheSizeTimeout parameter 259,
275
MaxSyncJobRuntime parameter 257, 275
MaxThreadsPerProcess parameter 258, 275
MaxVarLen setting 188, 193, 201, 207
MaxXMLTranslatorsPerProcess
parameter 258, 275
memory 81
adding additional 81
allocating 84
resource requirements for 83
memory blocks 83
menus 286
Message Distribution IP Address
property 152
message distribution parameters 97
Message Distribution Port property 152
Message Distribution service
enabling 9, 106, 151
overview 3, 6, 99
running 11
server configurations for 4
Message Distribution service (continued)
messages
logging RSSE 52
meta option (acexport) 222
metadata 14, 79, 127
metadata directories 127
mf option (acimport) 229
Microsoft Active Directory servers 48
Microsoft Exchange 41
setting up profiles for 39
Microsoft Internet Explorer. See Internet
Explorer
Min view processes property 153
MinDataPacketSize parameter 259, 275
MinFreeSpaceMB parameter 31, 259
MinProcesses parameter 259, 275
moving Encyclopedia volumes 14, 77, 120,
121
moving folders 304
testing connections to 190
Multi-application option 5, 6, 13, 19
multicast clusters 97, 101, 138, 140
MultiCastIPAddress parameter 259, 275
MulticastPort parameter 259, 275
MulticastTTL parameter 259, 275
multi-language databases 180
multiprocessor support 19, 80
multithread safe parameter 53
multithreading 80
N
-N TCP parameter (Progress
connections) 209
names
See also user names
ReportCast channels 369
validating volume 69
naming conflicts 228
native file systems 71
native formats 305
Netscape Directory Server 49, 53
Netscape Navigator 72
network administrators. See administrators
Network File System (NFS) 80
network router 5
networks
managing clusters on 97
printing from 26, 346
New User command 311, 322, 332
NFS-mounted volumes 80
NLS_LANG variable 199
nocheck option (acupgrade) 239
nodes. See cluster nodes
nodisplay option (acupgrade) 239
notices. See notifications
cloning 334
defining for LDAP servers 57
deleting 333
getting LDAP 57
mapping to LDAP objects 56
renaming 333
notification messages 367, 375
adding headlines 375
sending 313
notification options 166, 313
Notification page 313
notification records 77
notifications
managing 77
reducing number of persistent 77
setting up mail 3942
specifying LDAP maximum 61
specifying preferred form 59
unavailable 25
NTWDBLIB MS/SQL library 190
NumberOfPagesDownloaded parameter 275
NumFactoryProcessLogs parameter 260, 275
NumLogs parameter 260, 275
NumPrintProcessLogs parameter 260, 275
NumRequestRetries parameter 261, 276
NumSocketsForReply parameter 261, 276
NumSocketsForRPC parameter 260, 276
O
ObjectArchiveDLL parameter 261, 276
ObjectArchiveSchedule parameter 261
objects option (actoc) 236
I n d e x 427
objects
access controls 338
ociw32.dll 199
ODBC data sources 192
ODBC databases 180
ODBC drivers 191
caution for AIX servers 184
PeopleSoft databases 193
version supported 190
ODBC Server version 190
odbc.ini files 191
offline status 94, 104, 110, 135
changing 171
offline systems 95
oldhome option (acupgrade) 239
OLE Automation 24
online backup 359361
See also backing up
scheduling 361
Online Backup Schedule page 361
online documentation xx, xxiii
online help xxivxxvi
creating report-specific xxvi
usage overview xxiv
online reports. See reports
online status 94
changing 171
online systems 94
Open Client mechanism 212
Open Interface Broker (Progress tables) 209,
210
open security 337344
configuring for LDAP servers 5368
enabling 52, 168
importing and exporting with 6870
levels described 338
login scripts for 55
overview 25, 48, 343
performance considerations 6667
open security parameters 50, 51
setting 52, 62, 168
open security sample application 49, 4950,
53
running 25
open security utilities 68
open server drivers
availability 378
setting up 382
open server parameters
described 56
open server processes 7
open server reports 7, 378389
archiving 355
configuring 3638
configuring engine for 36
creating jobs for 353
defining file types 382
for Crystal reports 390392
for SQRIBE 389390
predefined file types 380, 381
required software 379
storing volume information as 15
viewing 388
open server sample application
enabling e.Spreadsheet Option for 35
operations servers 80
Operator role 57, 293, 310, 342
OPERATOR_ROLE_NAME parameter 57, 64
operatorRole option (acextern) 225
OPP_DHTML_BROWSER parameter 407
OPP_HTML_OUTPUT_TYPE parameter 407
OPP_TOC_ENABLED parameter 407
optimizing performance 71, 72, 73, 80
optimizing view processes 8589
options 1819
Options page (Management Console) 144,
286
ora7nt.dll 199
maximum column length 201
supported data types 200
version compatibility 196, 197
Oracle listener process 200
ORACLE_HOME variable 199, 270
orant71.dll 199
output option (acafcconvert) 218
output option (acexport) 223
output
caching 72
font mappings for 43, 45
optimizing 79
performance and 81
placing restrictions on 304
redirecting 37
writing to disk 80
output directories 29
output file types
Crystal reports 390
SQRIBE reports 389
output files
exporting 221
importing 229
output formats 405
OutputDirForRuntimeExcel parameter 261,
276
overriding default privileges 305
ownership 228
P
P option (acmode) 234
page caching options 366
Page Level Security option 19, 49
securing 51
page security 48, 336337
disabled 303
enabling 305, 336
overview 300
Page Security option 303
page security sample application 49, 5152
PageCountUpdateInterval parameter 262,
276
PageNumbersDownloaded parameter 276
paging rate 83
parameter values files
parameterized queries. See stored procedures
parameters
changing startup 96, 136
compatibility with previous versions 271
Crystal reports and 391
displaying startup 136
overview 246
running Java reports 406
setting open security 50
setting open server 52, 62, 168, 382
SQRIBE reports and 390
parameters values files
creating documents from 352
Parent Roles page (New Security Role) 323
partition states 172
partitions
adding 106, 173
assigning volumes to 116
configuring 14, 123124
displaying information for 124, 166, 172
removing 125, 174
setting paths 173
setting properties for 158, 169
password option (acafcconvert) 218
password option (acimport) 231
password option (acupgrade) 239
Password property 203
passwords
assigning 311
changing 312
leaving blank 284
Microsoft Exchange and 41
open security reports and 338
overview 300, 301
setting for LDAP servers 55
setting system 139
Path parameter 255, 276
PATH variable
described 270
engine configurations and 35
open server configurations and 36
Progress connections and 202, 207, 208
setting for UNIX servers 205
PDF files xix
creating from XML reports 87
downloading 73
generating 405
PDF formats 6, 86
PDFQualityOnWindows parameter 262, 276
I n d e x 429
pending requests
importing 228
Pentium processors 81
PeopleSoft Configuration Manager 194
PeopleSoft databases
connecting to 193
performance
enhancing view process 8589
optimizing for report generation 81
web browsers compared 72
performance benchmarks 82
performance degradation 80, 83
performance tuning 66, 71, 72, 73, 80, 267
permissions. See privileges
personal folders 305
See also home folders
pfb files 243
pmd6.sh 182
PORT parameter 57, 63
Port property 203
ports 99, 101, 127
PostScript files 45
PostScript font utility 243244
PostScript fonts
installing/uninstalling 243244
-P parameter (Progress connections) 211
preferences
specifying LDAP viewing 62
primary partition 14
primary volume 155
PrimaryPartition parameter 266, 276
PrimaryPartitionMinSpace parameter 30, 266
PrimaryServer parameter 262, 276
print jobs 7, 348349
See also printing reports
submitting 353
printed documentation xx, xxii
printer properties. See printer settings
printer settings 346, 347
for external users 343
PrinterOSName parameter 260
printers
accessibility 26, 27
adding 126, 176
changing 348
creating local 26
displaying system 175
importing 228
open server reports and 37, 38
overview 346
removing 126
setting properties for 159, 177
setting up 347348
specifying system-level properties 346,
347
printing graphs 45
printing options 346
printing reports 103, 155, 345349
See also print processes
access restrictions and 303, 304
Crystal Reports 392
external security sources and 343
from UNIX servers 27, 4245, 177
SQRIBE open server 389
printing requests 7
PrintingLogEnabled parameter 262
PrintingLogLevel parameter 262
PrintProcessLogDirectory parameter 255,
276
PrintProcessLogLevel parameter 256, 276
PrintProcessLogSize parameter 256, 276
PrintProcessRecycleCount parameter 260,
276
priorities
setting job 353
priority levels 313, 352, 353
Priority page 313
priority ranges 352
privilege templates 58, 305
changing 315
privileges 2, 301307, 352, 370
assigning
for LDAP servers 58
from Management Console 315, 330
331
to user accounts 25
changing 305, 307
creating for imported files 228
default 305
export information and 220
privileges (continued)
granting all 302
overriding default 305
overview 300, 311
setting for LDAP roles 55
setting roles for 307
specifying report object 85
types described 302
Privileges page 315
process group information 88
Process Manager
overview 3, 8
registering 24
running 9
starting report server and 11
processes 7
adding 81, 87, 88
adjusting timing 82
allocating resources for 81
balancing workload for view 88
controlling cache for 89
optimizing 85
restarting 83
running concurrently 81
setting up view 87
processmgmt.exe 32
processors
adding 81
assigning factory processes to 81
comparing operating speed for 82
displaying number of licensed 107, 148
estimating resources for 82, 84
memory requirements for 83
monitoring usage 87
paging rate 83
resource requirements 80
server allocation for 81
support for multiple 19, 80
ProcessRecycleCount parameter 260, 276
PROCFG variable 207, 208
product summary xvii
product updates xix
profiles 39
ProgramExecCacheTimeout parameter 262
programming interfaces xvii
programming interfaces. See application
programming interfaces (APIs)
Progress Open Interface Broker 209, 210
Progress option 19
Progress8 databases
connecting to 206212
as self-service clients 209
connecting to Progress9 tables with 204
defining environment variables 208, 210
setting up environment 207
Progress9 databases
accessing dynamic link libraries 205
defining environment variables 202, 205,
206
logging onto multiple 204
version compatibility 202
PROMSGS variable 207, 208
PROOIBRK variable 210
PROOIDRV variable 210
properties
changing service 108
displaying 107, 160, 304
external security sources 339, 343
mapping LDAP user 55
printer setup 346, 347
resetting 162
setting for multiple items 293
setting open security 168
setting partition 158, 169
setting primary volume 155
setting printer 159, 177
setting report server 150
setting service 152, 154
setting system 138
storing for LDAP servers 54
usage log settings for 140
Properties dialog box 311
PROSTARTUP variable 207
PROTERMCAP variable 208
providing report-specific online help xxvi
Q
queries
parameterized. See stored procedures
running on LDAP servers 57, 66
I n d e x 431
queries (continued)
QUERY_ACCOUNT parameter 57, 63
QUERY_PASSWORD parameter 57, 63
queues
removing jobs 352
R
RAID devices 80
RAM 83
rb_client utility (UNIX) 196
rbf option (acexport) 222
rc.local 186
RDBMS servers 4, 5
read privilege 302, 337
ReadBufferSize parameter 247, 276
readers 338
read-only data 89
ReadOnlyQuery property 203
records
retrieving 291
recovery utility 360
Recycle Processes parameter 83
RecycleFactoryProcesses parameter 263, 276
RecyclePrintProcesses parameter 263, 276
Red Brick databases
checking connections 196
installing Factory server 196
UNIX servers 195
reducing
administrative overhead 75
number of persistent notices 77
ref option (acexport) 222
refresh rates (channel) 369
regedit.exe 268
regional settings 143
registering
e-mail addresses 39
mail accounts 39, 40
Process Manager 24
Registry Editor 268
Registry entries
changing values for 268
getting home directory from 31
setting for view process 89
registry keys
listed 269
overview 267
setting 268
relational databases. See databases
release notes xix
remote servers 2
connecting to 24, 25
rename option (acimport) 229
renaming
repair option (acverify) 241
replace option (acimport) 229
report bursting 389
Report Encyclopedia. See Encyclopedia
service; volumes
report execution requests 7
report extensions 378, 401
report files
adding to Encyclopedia 14
archiving 70, 355359
bundling 73
caching 88, 89
compressing 73
copying 388
creating 352
defining open server types 382
deleting temporary 32
exporting 219
generating 405
importing 228
open server types 380, 381
setting privileges for 228, 301, 302
storing 74, 127
report generation jobs
running 83
report generation requests 7
for 221
report generation status 268
report object executables. See executable files
report object instances
placing restrictions on 304
report objects
setting privileges 85
report server
See also e.Reporting Server
accessing external security sources 25
adding resources for 81
adding to clusters 102, 104106
adding to system 149
allocating CPUs for 81
assigning to Encyclopedia volume 14
assigning volumes to 115
auto disk space checking for 30
configuration options for 36
configuring 2, 11, 18, 112
configuring as stand-alone 13, 129
configuring as standalone 112
configuring engines for 3436
configuring for open server reports 379,
380, 382
creating accounts for 25
creating standalone 113
displaying properties 107
displaying system information for 147
displaying version 32
getting home directory 31
managing 92
monitoring 129
not starting 31
optimizing performance 8085
optimizing view processes for 88
options compatibility 19
overview 1
printing reports with 347
restarting 9, 12
running on UNIX servers 27
running online backup facilities 77
running reports from 7, 21
running view processes 86
running with default security 68
securing 25, 51, 304
setting IP and port information 101
setting up accounts 2425, 41
shutting down 108109
starting 11, 108109
status values for 103
system configurations for 133
system states for 94, 134
tracking object relationships 74
updating system information for 113
report server API xviii, 3
report server executable 3
report server nodes 4
configuring 9
controlling 11
example for 15
managing 12, 106
reconfiguring 13
removing cluster membership 13
starting 102
report server processes
configuring 33
Report Server Security Extension 4753
See also RSSE applications
cache timeout parameter for 50
logging messages for 52
overview 300, 336, 339
ReportCast 86
ReportCast channels. See channels
ReportCast process
setting UNIX file descriptors for 28
ReportCastPrefix parameter 276
ReportCastURLPrefix parameter 263
ReportFormatDownloaded parameter 276
report-generation requests 348, 353
reporting solutions xvi
ReportParams parameter 276
reports
accessing on web sites 374
assigning expiration dates 369
attaching to e-mail accounts 313
changing security type for 50
creating 304
creating online help for xxvi
developing 19
display timing out 73
displaying 305
on UNIX servers 27
distributing 73
downloading 87, 305
generating 7, 155
factory processes and 33
I n d e x 433
reports (continued)
not readable 303
optimizing 72, 81, 82
printing 155
restricting access to 48, 51
running 7, 21
support for third-party 18
ReportSize parameter 276, 277
request message routing 11
Requester API xvii
RequesterRSAPIVolume parameter 266
RequestRetryInterval parameter 265, 277
requests option (actoc) 236
requests 2
archiving 356
avoiding backups 87
dispatching 3, 7
redirector nodes and 11
displaying print 348
distributing 5
executing 7
export options for 223
importing 228
notification options 313
setting priorities 313
specifying LDAP maximum 61
submitting 353
tracking 348
types described 7
validating 6
resources 2, 346
accessing 2627
adding 81
allocating 87
changing UNIX system 27
controlling cache 89
CPU requirements for 80
estimating 82, 84
memory allocation and 8384
optimizing 81, 84
restarting
processes 83
servers 9, 12
restore option (acextern) 225
restore option (acintern) 233
restoring snapshots 359
restructuring Encyclopedia volumes 7476
result sets 181
retrieving data
from data stores 291
from databases 180
from XML data sources 184
retry options 354
rfolders option (actoc) 236
ROLE_BASE_DN parameter 57, 63
ROLE_OBJECT parameter 58, 63
roles 220, 311
assigning privileges with 331
assigning to all users 310
assigning to external users 341
assigning to LDAP objects 56, 59
assigning to privileges 331
defined 307
defining for web environments 370
defining security 307311
exporting 220
filtering 292
getting names for LDAP 58
importing 227
mapping external security IDs for 51
mapping to LDAP objects 55
minimizing assigned 85
Roles page 314
root processes 25
routers 5
.rov files. See parameter values files
rows
retrieving 291
.rox files. See executable files
.rpt files 390
RSAPI, using with volumes 115
RSAPIFetchLimit parameter 258
RSSE option (acacfconvert) 218
RSSE option (acextern) 69, 225
RSSE option (acintern) 233
rsse option (acupgrade) 239
RSSE applications
See also Report Server Security Extension
accessing external security sources 25
changing volume security for 224, 232
creating 48, 300, 336
customizing 51
installing 52
overview 47, 53
RSSE applications (continued)
replacing internal IDs for 68
running sample 49, 51
RSSE cache size property 168
RSSE cache timeout property 168
RSSE library name property 168
RSSE max ACL buffer size property 168
RSSE multithread safe property 53, 168
Rsse.log 52
RSSECacheSize parameter 259, 277
RSSECacheTimeout parameter 265, 277
RSSELibrary parameter 261, 277
RSSEMaxACLBufferSize parameter 257, 277
RSSEMultiThreadSafeLibrary parameter 261,
277
run time environments 407
running applications 267
running concurrent processes 81
running queries
on LDAP servers 57, 66
running reports 7, 21
adjusting factory timing for 82
estimating memory resources for 84
S
-S parameter (Progress connections) 209
Port option (acmode) 234
sample application xviii
sample applications 49
scalability 80, 82
scheduled requests 348
importing 228
ScheduleForPurgingNotices parameter 263,
277
schedules 7
scheduling jobs 302, 352
scheduling online backup 361
search criteria 290
search extension API xvii
search paths 270
specifying image 29
search results 288
Search Results page 291
search timeout intervals 72
Search Timeout parameter 72
Searchable property 72
searches (help topics) xxv
searches (indexed) 67, 72
searching
DHTML reports 72, 86
for special characters 289
for volume data 288291
on LDAP servers 67
SearchNoIndex setting 72
SearchTimeout parameter 263, 277
SearchWithIndex setting 72
secure read privilege 303, 304, 337
security 300311
accessing external sources 338
changing type implemented 50
controlling external caches 50
converting administrative information
for 224, 232
disabling report page 337
enabling open 52
enabling report page 336, 337
for 220
filtering roles for 292
importing administrative information
for 227
integration types described 48
overview 25
RSSE sample applications for 49, 51
running report server with default 68
security databases 49
security IDs
adding 52
associating with ACLs 48, 336
changing 52
mapping external 51
self-service clients (NT servers) 209
Sender ID cache 89
sending mail 313
See also e-mail; notification messages
open server security and 59
setting up notifications for 3942
sendmail program 41
serialization 53
server option (acextern) 226
I n d e x 435
server option (acintern) 233
server option (acverify) 241
SERVER parameter 58, 62
server processes
configuring 33
ServerIPAddress parameter 255, 277
ServerList parameter 264, 277
servers xviii
See also report server; e.Reporting Server
adding to system 149
assigning as backup 116, 118119
configuration options for 4, 5
configuring multiple report 4
connecting to remote 24, 25
creating standalone report 2, 3
Directory Manager as LDAP 67
displaying 146
displaying current status 146
displaying properties 107
estimating resources required for 82, 84
managing clusters for 2, 98
managing remote 2
optimizing view processes for 88
overview to e.Reporting xix
resource requirements for 80, 83
restarting 9, 12
specifying SQL-specific 189
starting 11, 108109
support for third-party application 21
servers page 147
ServerSOAPPort parameter 262, 277
ServerSOAPPortBase parameter 262, 277
ServerSOAPPortCount parameter 262, 277
Service property 203
service threads 87
services
changing properties 108
configuring 151
controlling 267
distribution in clusters 9
enabling 9
overview 2, 6
registering process managers for 24
relationship to processes 7
running 3
setting properties 152, 154
types described 2
services file
Informix databases and 187
Progress databases and 208
Progress8 databases and 208
session information 88
SessionCacheSizePerProcess parameter 257,
277
SessionCacheTimeout parameter 264, 277
sessions
caching report files for 88
controlling cache for 89
timing out 89
setenv command (UNIX) 183, 269
setnet program 187
SETNET32 utility 188
setting display options 286288
setting up
accounts 2425, 41
mail notifications 3942
printers 347348
settings. See properties; attributes
shared libraries
shell scripts (UNIX)
adding environment variables to 269
connecting to databases 186
setting home directory 31
SHLIB_PATH variable 36, 182, 270
ShortDateFormat parameter 264, 277
shutting down reporting servers 108109
sidebar menu 286
SIDs. See security IDs
Simple Object Access Protocol. See SOAP
smart cards 338
snapshots
backing up 359
restoring 359
SOAP (defined) 3
SOAP redirector 283
SOAP requests 152
SOAPDispatchIPAddress parameter 259
SOAPDispatchPort parameter 259
SOAPSocketReadTimeout parameter 260
SocketBaseForProcesses parameter 264, 277
SocketCountForProcesses parameter 264, 277
SocketReadTimeout parameter 277
Software Development Kit xvii
Solaris systems
printing from 27
special characters
searching for 289
SPF files 37
spool command (UNIX) 177
spreadsheets 18
configuring engine for 34
content generation for 19
writing to 29
SQL Client Configuration Utility 189
SQL ODBC Server version 190
SQL Server ODBC driver 190
SQL*Net version-specific connections 198,
199
sqledit program 214
sqlplus program 200
SQR_BURSTING parameter 390
SQRIBE burst mode option 389
SQRIBE report extensions 378
SQRIBE reports 18, 389390
configuring open server driver for 37
SQRIBE_SQRWP_PATH parameter 37
sqrwp.exe 37
stand-alone configurations 18
standalone configurations 3, 9
stand-alone report server
configuring 13, 112
creating configuration files for 129
managing 92
standalone report server 2, 3
adding to clusters 102
creating 113
creating clusters for 137
defined 4
displaying startup parameters for 136
managing 13
restarting 12
setting system properties for 139
starting 11
validating volumes for 242
standard data types. See data types
Start/Stop Online Backup Mode dialog 360
start_srvr.sh 36
starting
report servers 11, 108109
startup parameters
changing 96, 136
displaying 136
entering license keys as 99
startup scripts (UNIX)
creating 186
setting environment variables in 36
StartUpParameters property 209, 210
State parameter 262
status information
displaying 94, 134, 135, 146
generating 268
stopping reporting servers 108109
storage 83
stored procedure components 181
Stored Procedure Data Source Builder 181
stored procedures
overview 181, 204
PeopleSoft ODBC connections and 193
Progress databases and 201
returning result sets in Java 198
stores 32, 291
storing
report files 74, 127
session information 88
volumes 80
strings
maximum character lengths for 190
passwords as 311
specifying as registry entries 268
stubs 36
style sheets 72, 258
subfolders 74
subscribing to channels 342, 367
successor clusters 11
summary data 81
summary information 406
Sun systems
DB2 clients 184
Progress9 clients 206
Supported Products Matrix 26
I n d e x 437
-SV parameter (Progress connections) 210
Sybase databases
$SYBASE_OCS variable 214
SYBASE variable 214, 270
SYBASE_OCS variable 270
sybinit utility 214
symbolic names (Oracle tables) 199
SyncFactoryProcesses parameter 261
SynchReportingWeight parameter 264
SyncJobQueueSize parameter 263, 277
SyncJobQueueWait parameter 263, 277
syntax conventions (documentation) xxvii
system administration pages 133
system administrators. See administrators
System applet (Windows servers) 183
system configurations 18
system environment. See environment
variables
system error logs 131
system heartbeat parameters 97
system identifiers (Oracle tables) 199
system login page 93
system properties 138, 160
system states 94, 134
system status page 94, 135
system usage log 130
SystemIPAddress parameter 264, 277
SystemName parameter 264, 277
SystemPort parameter 264, 277
T
table of contents 407
TansLogPartitionMinSpace parameter 248
temp option (acafcconvert) 218
template files 35
template package files 35
templates 58, 305
temporary directories 218
temporary files
creating 32
temporary reports 7, 32, 155
testing connections
DB2 databases 184
testing UNIX mail notifications 42
text 190
text attributes 44
text files
generating 405, 407
sending mail notifications from 42
text strings. See strings
third-party analysis tools xvii
third-party application servers 21
third-party reports 7, 18
third-party security information 6
thrashing 87
threads 80, 87
throughput 78, 82
time 143
time formats 265
time zones 129, 145
TimeFormat parameter 265, 277
timeout intervals
external security cache 50
LDAP servers 66
search operations 72
view processes 89
TimeSeparationChar parameter 265, 277
tnsnames.ora file 199
transaction logging 166
transient store directory 32
parameter 255, 277
TransientReportCacheSize parameter 247,
278
TransientReportTimeOut parameter 263, 278
TransLogHomeFileSystem parameter 278
TransLogPartition parameter 247
TransLogPartitionMinSpace parameter 30
triggers 202, 204
TrueType fonts 244
truncate.log 238
turning off
archive logging 71
RSSE message logging 52
turning off (continued)
RSSE serialization 53
type option (acexport) 222, 229
Type parameter 278
syntax xxvii
U
-U parameter (Progress connections) 211
U option (acmode) 234
UCS-2 character set 38, 180
UDP ports 138, 140
UDPPort parameter 265, 278
uid attribute 55, 67
ulimit command (UNIX) 27, 28
unavailable notifications 25
unicast clusters 97, 138, 140
Unicode characters 190
encoding for 180
UCS-2 character set 38, 180
Uniform Resource Locators. See URLs
uninstalling PostScript fonts 244
UNIX hosts 215
UNIX servers
accessing databases 28
archive driver for 357
attaching to
Informix tables and 186, 187
ODBC drivers and 191, 195
Oracle tables and 199
Progress tables and 205, 208, 209
Sybase tables and 214
configuring Java Edition Engine for 35
controlling file descriptors for 28
creating temporary files on 32
defining environment variables
Informix tables and 186
displaying report server version 32
file size limits 27
installing archive driver 70
installing Factory server 215
installing fonts for 45
installing/uninstalling fonts 243, 244
maintaining security on 25
optimizing disk writes 80
printing from 27, 4245, 177, 346
resetting file size limits for 27
running client software on 180
running Process Manager 9
setting environment variables 267, 269
setting home directories for 31
setting up DB2 clients 184
setting up environments 182, 269
setting up mail notifications 4142
setting up printers 348
setting up user accounts for 25
starting report server automatically
from 30
testing mail notifications 42
UNIXPPDFileName parameter 262
UNIXSpoolCommand parameter 264
unrestricted Directory Server 67
unsupported fonts 43
unused disk space 30, 78
updates xix
updating
administrative information 50, 68
locale maps 38
property values 293
ReportCast channels 369
upgrades 226, 236
URLs
connection parameters and 28
image files 369
logging into volumes from 283
system login page 93
usage logging page 140
UsageLoggingExtensionName
parameter 265
UseExternalizedFonts parameter 266
UseMulticast parameter 266, 278
user accounts
export information and 220
resources and 26
setting privileges for 25
setting up UNIX-specific 25
I n d e x 439
user accounts (continued)
setting up Windows-specific 24
user addresses 39, 41
specifying for LDAP servers 59
testing 42
user names
accessing volumes and 301
associating with LDAP objects 61
entering 311
USER_BASE_DN parameter 58, 63
USER_CHANNEL_LIST_ATTR
parameter 58, 66
USER_CHANNEL_LIST_DEFAULT
parameter 58, 66
USER_DEFAULT_PRIV_ATTR parameter 58,
65
USER_DEFAULT_PRIV_DEFAULT
parameter 59, 65
USER_EMAIL_FORM_ATTR parameter 59,
64
USER_EMAIL_FORM_DEFAULT
parameter 59, 64
USER_EMAIL_ID_ATTR parameter 59, 64
USER_EMAIL_WHEN_ATTR parameter 59,
64
USER_EMAIL_WHEN_DEFAULT
parameter 60, 64
USER_FAIL_NOTICE_EXPIRATION_ATTR
parameter 60, 65
USER_FAIL_NOTICE_EXPIRATION_
DEFAULT parameter 60, 65
USER_FOLDER_WHEN_ATTR
parameter 60, 64
USER_FOLDER_WHEN_DEFAULT
parameter 60, 64
USER_HOME_FOLDER_ATTR
parameter 60, 64
USER_MAX_COMPLETED_ATTR
parameter 61, 66
USER_MAX_COMPLETED_DEFAULT
parameter 61, 66
USER_MAX_PRIO_ATTR parameter 61, 66
USER_MAX_PRIO_DEFAULT parameter 61,
66
USER_OBJECT parameter 61, 63
USER_SUCCESS_NOTICE_EXPIRATION_
ATTR parameter 61, 65
USER_SUCCESS_NOTICE_EXPIRATION_
DEFAULT parameter 62, 65
USER_VIEWING_PREF_ATTR
parameter 62, 66
USER_VIEWING_PREF_DEFAULT
parameter 62, 66
Userids.txt
changing 51
creating 51
userids.txt 52
UserName property 203
users
activity logs for 130
assigning job priorities 353
assigning passwords 301, 311
assigning privileges 301, 302
assigning roles for external users 341
assigning security IDs 52
authentication for external 338, 339
authorization for external 340
deleting job information 352
for 220
external information for 338, 340
getting job information 352
importing administrative information
for 227
logging into Encyclopedia as external 343
managing 311
mapping properties 55
minimizing privileges for 85
properties for external 339, 343
setting up LDAP servers for 54
specifying as administrators 342
submitting requests 353
testing mail accounts for 39, 41
verifying login information for 338
UTF-8 code pages 180
UTF-8 encoding 38
utilities. See command-line utilities
V
v option 32
V option (acmode) 234
validating
requests 6
volume content 240
volume names 69
varchar datatypes 190
variables 267
compatibility with previous versions 278
verifying
external user properties 340
login information 338
Veritas file system 80
version option (acimport) 230
version numbers
displaying report server 32
view process
configuring for external fonts 34
View processes
setting search time for 72
view processes 6
adding 87, 88
balancing workload for 88
controlling cache 89
overview 85, 87, 88, 364
page security and 336
preparing downloadable output 73
running 83
setting up 87
storing session information 88
View service
enabling 151
overview 2, 6
view session objects 88
Viewer xix
viewing
channel contents 367
data 286
DHTML reports 3, 304, 364
folder contents 302, 304
images 73
license keys 98
online documentation xxiii
partition information 124, 166, 172
print requests 348
properties 304
report documents 18
report server properties 150
report server version 32
reports 305
on UNIX servers 27
search results 289
server properties 107
status information 94, 134, 135, 146
system printers 175
system properties 160
volumes 163, 165
viewing modes 365
viewing options 286288, 366
viewing preferences
specifying LDAP 62
ViewingLogEnabled parameter 266
ViewingLogLevel parameter 266
ViewingWeight parameter 266
virtual IP addresses 11
virtual memory 83, 84
virtual X server 27
visible privilege 304
vol option (acexport) 223
vol option (acextern) 226
vol option (acimport) 231
vol option (acintern) 232, 233
Vol option (acmode) 234
vol option (acverify) 241
volume file types 122
volume metadata 79
volume with RSAPI enabled 115
VolumeHomeFileSystem parameter 265
volumes 2, 6
See also Encyclopedia service
adding 115, 116, 163
adding secondary partitions for 14
allocating space for 78
archiving objects in 70, 71
assigning backup servers to 118, 119
assigning to reporting servers 115
backing up 167, 359361
I n d e x 441
volumes (continued)
capacity planning for 31
changing online/offline status for 119
changing security type for 50
configuring 1314, 115, 116
controlling access to 25, 48, 301, 305
copying 221
copying items 303
creating folders for 74
creating from import utility 227
creating multiple 13
deleting 125, 171
directory structures for 127128
displaying 163, 165
enabling/disabling page security for 336,
337
exporting information only 220
exporting items 219
failover 156
fail-over service for 120
filtering data in 291292
importing administrative information 226
importing/exporting data 68
logging into multiple 284
managing 5, 13, 15, 285
mapping administration information 54
56
mapping user information 54
moving 77, 120, 121
open security applications and 343
open server applications and 379
overview 282, 285
partitioning 14, 15
removing items in 302
removing partitions 15
restoring 234
restructuring 7476
searching 288291
securing 300
setting auto-archive rules 358
setting limits 296297
setting up primary 155
storing 80
support for multiple 19
taking offline 14, 125, 171
updating administration information
for 68
upgrading 236
validating 69, 240
VolumeStatusHomeFileSystem
parameter 248, 278
.vtf files 34, 401
.vts files 34, 401
.vtx files 401
W
WaitPeriodForProcessStartup parameter 266,
278
waits 82
warnings 132
web browsers xix, 2
caching DHTML output for 72
connecting to volumes 283
displaying reports 72, 85
enabling view options 366
opening multiple windows for 284
performance comparisons 72
setting page caching options 366
viewing available channels 368
web casting 367
web pages
accessing 368
web servers 86
installing Management Console 2
open server reports on 379
subscribing to channels 342, 367
web sites
accessing reports 374
Actuate home page xix
creating ReportCast channels 369370
overview 367
what option (actoc) 236
wildcards 344
WindowForPurgingTempROVs
parameter 267, 278
Windows 2000 systems
Windows 95 connections 207
Windows messaging 39
Windows NT environments
archive driver for 357
caution for network printers and 26
open server driver for 378
printing from 346
setting up printers 347
Windows server environments
installing archive driver 70
Windows servers
accessing databases 28
attaching to
MS/SQL tables and 189
ODBC drivers and 191, 193, 195
Progress tables and 207, 209
configuring default locales 33
configuring open server driver 36, 37
defining environment variables
MS/SQL tables and 190
getting home directory 31
getting registry keys 268
installing fonts for 45
report server accounts and 25
running Process Manager 9
running stored procedures from 181
setting registry keys 267, 268
setting up environments 182, 269
setting up mail notifications 3941
setting up user accounts for 24
workload 83
adding factory processes for 81
balancing 2, 5, 88
estimating resources for 82
factory process timing and 82
load balancer for 11
World Wide Web. See Web
write operations 80
write privilege 304
X
X Windows servers 27, 270
XML data sources 184
XML Extender 184
XML formats 6, 86
XML reports
converting 87
XPHOME variable 270
Xprinter files 271
xvfb application 27
XVFBDISPLAY variable 271
Y
year conversions 39

Administering Report System

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Administering Report System

Transféré par

Droits d'auteur :

Formats disponibles

Administering Actuate e.

Vous aimerez peut-être aussi